Mercurial > p > roundup > code
comparison doc/user_guide.txt @ 7252:9c067ed4568b
add pragma command to roundup-admin
Added basic pragma command. Can assign settings, list settings.
Most settings are not yet implemented.
Only the pragma command respects unhidden pragma settings at this
point. Also added tests, doc updates for roundup-admin.
CHANGES.txt not updated because currently only pragma references the
unhidden settings.
Also fixed a couple of long lines.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Wed, 12 Apr 2023 20:49:21 -0400 |
| parents | 86862ed039fa |
| children | e2f257ef737f |
comparison
equal
deleted
inserted
replaced
| 7251:ab0ea9f03866 | 7252:9c067ed4568b |
|---|---|
| 454 registration confirmation. | 454 registration confirmation. |
| 455 | 455 |
| 456 If the subject line contains a prefix in ``[square brackets]`` then | 456 If the subject line contains a prefix in ``[square brackets]`` then |
| 457 we're looking at case 3 or 4 above. Spaces are allowed inside the | 457 we're looking at case 3 or 4 above. Spaces are allowed inside the |
| 458 brackets and after the class item name. So ``[issue2]`` and | 458 brackets and after the class item name. So ``[issue2]`` and |
| 459 ``[ issue 2 ]`` are treted the same where any whitespace is optional. | 459 ``[ issue 2 ]`` are treated the same where any white space is optional. |
| 460 Any "re:" or "fwd:" prefixes are stripped off the subject line before | 460 Any "re:" or "fwd:" prefixes are stripped off the subject line before |
| 461 we start looking for real information. | 461 we start looking for real information. |
| 462 | 462 |
| 463 If an item designator (class name and id number, for example | 463 If an item designator (class name and id number, for example |
| 464 ``issue123``) is found there, a new "msg" item is added to the | 464 ``issue123``) is found there, a new "msg" item is added to the |
| 765 -c -- when outputting lists of data, comma-separate them. | 765 -c -- when outputting lists of data, comma-separate them. |
| 766 Same as '-S ","'. | 766 Same as '-S ","'. |
| 767 -S <string> -- when outputting lists of data, string-separate them | 767 -S <string> -- when outputting lists of data, string-separate them |
| 768 -s -- when outputting lists of data, space-separate them. | 768 -s -- when outputting lists of data, space-separate them. |
| 769 Same as '-S " "'. | 769 Same as '-S " "'. |
| 770 -V -- be verbose when importing | |
| 771 -v -- report Roundup and Python versions (and quit) | |
| 770 | 772 |
| 771 Only one of -s, -c or -S can be specified. | 773 Only one of -s, -c or -S can be specified. |
| 772 | 774 |
| 773 Help: | 775 Help: |
| 774 roundup-admin -h | 776 roundup-admin -h |
| 778 | 780 |
| 779 Commands: | 781 Commands: |
| 780 commit | 782 commit |
| 781 create classname property=value ... | 783 create classname property=value ... |
| 782 display designator[,designator]* | 784 display designator[,designator]* |
| 783 export [class[,class]] export_dir | 785 export [[-]class[,class]] export_dir |
| 786 exporttables [[-]class[,class]] export_dir | |
| 787 filter classname propname=value ... | |
| 784 find classname propname=value ... | 788 find classname propname=value ... |
| 789 genconfig <filename> | |
| 785 get property designator[,designator]* | 790 get property designator[,designator]* |
| 786 help topic | 791 help topic |
| 787 history designator | 792 history designator [skipquiet] |
| 788 import import_dir | 793 import import_dir |
| 794 importtables export_dir | |
| 789 initialise [adminpw] | 795 initialise [adminpw] |
| 790 install [template [backend [admin password]]] | 796 install [template [backend [key=val[,key=val]]]] |
| 791 list classname [property] | 797 list classname [property] |
| 798 migrate | |
| 792 pack period | date | 799 pack period | date |
| 793 reindex | 800 perftest [mode] [arguments]* |
| 801 pragma setting=value | |
| 802 reindex [classname|designator]* | |
| 803 restore designator[,designator]* | |
| 794 retire designator[,designator]* | 804 retire designator[,designator]* |
| 795 rollback | 805 rollback |
| 796 security [Role name] | 806 security [Role name] |
| 797 set items property=value property=value ... | 807 set items property=value property=value ... |
| 798 specification classname | 808 specification classname |
| 799 table classname [property[,property]*] | 809 table classname [property[,property]*] |
| 800 Commands may be abbreviated as long as the abbreviation matches only one | 810 templates [trace_search] |
| 801 command, e.g. l == li == lis == list. | 811 updateconfig <filename> |
| 802 | 812 Commands may be abbreviated as long as the abbreviation |
| 813 matches only one command, e.g. l == li == lis == list. | |
| 803 | 814 |
| 804 All commands (except help) require a tracker specifier. This is just the | 815 All commands (except help) require a tracker specifier. This is just the |
| 805 path to the roundup tracker you're working with. A roundup tracker is | 816 path to the roundup tracker you're working with. A roundup tracker is |
| 806 where roundup keeps the database and configuration file that defines an | 817 where roundup keeps the database and configuration file that defines an |
| 807 issue tracker. It may be thought of as the issue tracker's "home | 818 issue tracker. It may be thought of as the issue tracker's "home |