diff 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
line wrap: on
line diff
--- a/doc/user_guide.txt	Wed Apr 12 11:20:14 2023 -0400
+++ b/doc/user_guide.txt	Wed Apr 12 20:49:21 2023 -0400
@@ -456,7 +456,7 @@
 If the subject line contains a prefix in ``[square brackets]`` then
 we're looking at case 3 or 4 above. Spaces are allowed inside the
 brackets and after the class item name. So ``[issue2]`` and
-``[ issue 2 ]`` are treted the same where any whitespace is optional.
+``[ issue 2 ]`` are treated the same where any white space is optional.
 Any "re:" or "fwd:" prefixes are stripped off the subject line before
 we start looking for real information.
 
@@ -767,6 +767,8 @@
   -S <string>       -- when outputting lists of data, string-separate them
   -s                -- when outputting lists of data, space-separate them.
                Same as '-S " "'.
+  -V                -- be verbose when importing
+  -v                -- report Roundup and Python versions (and quit)
 
   Only one of -s, -c or -S can be specified.
 
@@ -780,26 +782,35 @@
   commit
   create classname property=value ...
   display designator[,designator]*
-  export [class[,class]] export_dir
+  export [[-]class[,class]] export_dir
+  exporttables [[-]class[,class]] export_dir
+  filter classname propname=value ...
   find classname propname=value ...
+  genconfig <filename>
   get property designator[,designator]*
   help topic
-  history designator
+  history designator [skipquiet]
   import import_dir
+  importtables export_dir
   initialise [adminpw]
-  install [template [backend [admin password]]]
+  install [template [backend [key=val[,key=val]]]]
   list classname [property]
+  migrate
   pack period | date
-  reindex
+  perftest [mode] [arguments]*
+  pragma setting=value
+  reindex [classname|designator]*
+  restore designator[,designator]*
   retire designator[,designator]*
   rollback
   security [Role name]
   set items property=value property=value ...
   specification classname
   table classname [property[,property]*]
- Commands may be abbreviated as long as the abbreviation matches only one
- command, e.g. l == li == lis == list.
-
+  templates [trace_search]
+  updateconfig <filename>
+ Commands may be abbreviated as long as the abbreviation
+ matches only one command, e.g. l == li == lis == list.
 
 All commands (except help) require a tracker specifier. This is just the
 path to the roundup tracker you're working with. A roundup tracker is

Roundup Issue Tracker: http://roundup-tracker.org/