Mercurial > p > roundup > code

comparison doc/admin_help.html @ 8394:8aaa22abe6cc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: commit new generated admin help output.
author John Rouillard <rouilj@ieee.org>
date Sat, 12 Jul 2025 22:56:16 -0400
parents ea1f377c87d6
children
comparison
equal deleted inserted replaced
8393:e5d07fac0249 8394:8aaa22abe6cc
1 <table> 1 <table>
2 2
3 <tr><td valign=top><strong>commit</strong></td> 3 <tr><td valign=top><strong>commit</strong></td>
4 <td><tt>- commit</tt> 4 <td><p><tt></tt></p>
5 <pre> 5
6 <p>
6 Commit changes made to the database during an interactive session. 7 Commit changes made to the database during an interactive session.
7 8 </p><p>
8 The changes made during an interactive session are not 9 The changes made during an interactive session are not
9 automatically written to the database - they must be committed 10 automatically written to the database - they must be committed
10 using this command. 11 using this command.
11 12 </p><p>
12 One-off commands on the command-line are automatically committed if 13 One-off commands on the command-line are automatically committed if
13 they are successful. 14 they are successful.
14 15 </p><p>
15 </pre></td></tr> 16 </td></tr>
16 17
17 18
18 <tr><td valign=top><strong>create</strong></td> 19 <tr><td valign=top><strong>create</strong></td>
19 <td><tt>- create classname property=value ...</tt> 20 <td><p><tt>classname property=value ...</tt></p>
20 <pre> 21
22 <p>
21 Create a new entry of a given class. 23 Create a new entry of a given class.
22 24 </p><p>
23 This creates a new entry of the given class using the property 25 This creates a new entry of the given class using the property
24 name=value arguments provided on the command line after the "create" 26 name=value arguments provided on the command line after the "create"
25 command. 27 command.
26 28 </p><p>
27 </pre></td></tr> 29 </td></tr>
28 30
29 31
30 <tr><td valign=top><strong>display</strong></td> 32 <tr><td valign=top><strong>display</strong></td>
31 <td><tt>- display designator[,designator]*</tt> 33 <td><p><tt>designator[,designator]*</tt></p>
32 <pre> 34
35 <p>
33 Show the property values for the given node(s). 36 Show the property values for the given node(s).
34 37 </p><p>
35 A designator is a classname and a nodeid concatenated, 38 A designator is a classname and a nodeid concatenated,
36 eg. bug1, user10, ... 39 eg. bug1, user10, ...
37 40 </p><p>
38 This lists the properties and their associated values 41 This lists the properties and their associated values
39 for the given node. 42 for the given node.
40 43 </p><p>
41 </pre></td></tr> 44 </td></tr>
42 45
43 46
44 <tr><td valign=top><strong>export</strong></td> 47 <tr><td valign=top><strong>export</strong></td>
45 <td><tt>- export [[-]class[,class]] export_dir</tt> 48 <td><p><tt>[[-]class[,class]] export_dir</tt></p>
46 <pre> 49
50 <p>
47 Export the database and file content. 51 Export the database and file content.
48 52 </p><p>
49 Database content is exported to colon separated files. 53 Database content is exported to colon separated files.
50 To exclude the files (e.g. for the msg or file class), 54 To exclude the files (e.g. for the msg or file class),
51 use the exporttables command. 55 use the exporttables command.
52 56 </p><p>
53 Optionally limit the export to just the named classes 57 Optionally limit the export to just the named classes
54 or exclude the named classes, if the 1st argument 58 or exclude the named classes, if the 1st argument
55 starts with '-'. 59 starts with '-'.
56 60 </p><p>
57 This action exports the current data from the database into 61 This action exports the current data from the database into
58 colon-separated-value files that are placed in the nominated 62 colon-separated-value files that are placed in the nominated
59 export_dir directory. 63 export_dir directory.
60 64 </p><p>
61 </pre></td></tr> 65 </td></tr>
62 66
63 67
64 <tr><td valign=top><strong>exporttables</strong></td> 68 <tr><td valign=top><strong>exporttables</strong></td>
65 <td><tt>- exporttables [[-]class[,class]] export_dir</tt> 69 <td><p><tt>[[-]class[,class]] export_dir</tt></p>
66 <pre> 70
71 <p>
67 Export only the database to files, no file content. 72 Export only the database to files, no file content.
68 73 </p><p>
69 Database content is exported to colon separated files. 74 Database content is exported to colon separated files.
70 The files below $TRACKER_HOME/db/files/ (which can be 75 The files below $TRACKER_HOME/db/files/ (which can be
71 archived separately) are not part of the export. 76 archived separately) are not part of the export.
72 To include the files, use the export command. 77 To include the files, use the export command.
73 78 </p><p>
74 Optionally limit the export to just the named classes 79 Optionally limit the export to just the named classes
75 or exclude the named classes, if the 1st argument 80 or exclude the named classes, if the 1st argument
76 starts with '-'. 81 starts with '-'.
77 82 </p><p>
78 This action exports the current data from the database into 83 This action exports the current data from the database into
79 colon-separated-value files that are placed in the export_dir 84 colon-separated-value files that are placed in the export_dir
80 destination directory. 85 destination directory.
81 86 </p><p>
82 </pre></td></tr> 87 </td></tr>
83 88
84 89
85 <tr><td valign=top><strong>filter</strong></td> 90 <tr><td valign=top><strong>filter</strong></td>
86 <td><tt>- filter classname propname=value ...</tt> 91 <td><p><tt>classname propname=value ...</tt></p>
87 <pre> 92
93 <p>
88 Find the nodes of the given class with a given property value. 94 Find the nodes of the given class with a given property value.
89 95 </p><p>
90 Find the nodes of the given class with a given property value. 96 Find the nodes of the given class with a given property value.
91 Multiple values can be specified by separating them with commas. 97 Multiple values can be specified by separating them with commas.
92 If property is a string, all values must match. I.E. it's an 98 If property is a string, all values must match. I.E. it's an
93 'and' operation. If the property is a link/multilink any value 99 'and' operation. If the property is a link/multilink any value
94 matches. I.E. an 'or' operation. 100 matches. I.E. an 'or' operation.
95 101 </p><p>
96 </pre></td></tr> 102 </td></tr>
97 103
98 104
99 <tr><td valign=top><strong>find</strong></td> 105 <tr><td valign=top><strong>find</strong></td>
100 <td><tt>- find classname propname=value ...</tt> 106 <td><p><tt>classname propname=value ...</tt></p>
101 <pre> 107
108 <p>
102 Find the nodes of the given class with a given link property value. 109 Find the nodes of the given class with a given link property value.
103 110 </p><p>
104 Find the nodes of the given class with a given link property value. 111 Find the nodes of the given class with a given link property value.
105 The value may be either the nodeid of the linked node, or its key 112 The value may be either the nodeid of the linked node, or its key
106 value. 113 value.
107 114 </p><p>
108 </pre></td></tr> 115 </td></tr>
109 116
110 117
111 <tr><td valign=top><strong>genconfig</strong></td> 118 <tr><td valign=top><strong>genconfig</strong></td>
112 <td><tt>- genconfig filename</tt> 119 <td><p><tt>filename</tt></p>
113 <pre> 120
121 <p>
114 Create a new tracker config file with default values in filename. 122 Create a new tracker config file with default values in filename.
115 123 See also updateconfig.
116 </pre></td></tr> 124 </p><p>
125 </td></tr>
117 126
118 127
119 <tr><td valign=top><strong>get</strong></td> 128 <tr><td valign=top><strong>get</strong></td>
120 <td><tt>- get property designator[,designator]*</tt> 129 <td><p><tt>property designator[,designator]*</tt></p>
121 <pre> 130
131 <p>
122 Get the given property of one or more designator(s). 132 Get the given property of one or more designator(s).
123 133 </p><p>
124 A designator is a classname and a nodeid concatenated, 134 A designator is a classname and a nodeid concatenated,
125 eg. bug1, user10, ... 135 eg. bug1, user10, ...
126 136 </p><p>
127 Retrieves the property value of the nodes specified 137 Retrieves the property value of the nodes specified
128 by the designators. 138 by the designators.
129 139 </p><p>
130 </pre></td></tr> 140 </td></tr>
131 141
132 142
133 <tr><td valign=top><strong>help</strong></td> 143 <tr><td valign=top><strong>help</strong></td>
134 <td><tt>- help topic</tt> 144 <td><p><tt>topic</tt></p>
135 <pre> 145
146 <p>
136 Give help about topic. 147 Give help about topic.
137 148 </p><p>
138 commands -- list commands 149 commands -- list commands
139 &lt;command&gt; -- help specific to a command 150 &lt;command&gt; -- help specific to a command
140 initopts -- init command options 151 initopts -- init command options
141 all -- all available help 152 all -- all available help
142 153 </p><p>
143 </pre></td></tr> 154 </td></tr>
144 155
145 156
146 <tr><td valign=top><strong>history</strong></td> 157 <tr><td valign=top><strong>history</strong></td>
147 <td><tt>- history designator [skipquiet] [raw]</tt> 158 <td><p><tt>designator [skipquiet] [raw]</tt></p>
148 <pre> 159
160 <p>
149 Show the history entries of a designator. 161 Show the history entries of a designator.
150 162 </p><p>
151 A designator is a classname and a nodeid concatenated, 163 A designator is a classname and a nodeid concatenated,
152 eg. bug1, user10, ... 164 eg. bug1, user10, ...
153 165 </p><p>
154 Lists the journal entries viewable by the user for the node 166 Lists the journal entries viewable by the user for the node
155 identified by the designator. If skipquiet is added, journal 167 identified by the designator. If skipquiet is added, journal
156 entries for quiet properties are not shown. If raw is added, 168 entries for quiet properties are not shown. If raw is added,
157 the output is the raw representation of the journal entries. 169 the output is the raw representation of the journal entries.
158 170 </p><p>
159 </pre></td></tr> 171 </td></tr>
160 172
161 173
162 <tr><td valign=top><strong>import</strong></td> 174 <tr><td valign=top><strong>import</strong></td>
163 <td><tt>- import import_dir</tt> 175 <td><p><tt>import_dir</tt></p>
164 <pre> 176
177 <p>
165 Import a database and file contents from the directory. 178 Import a database and file contents from the directory.
166 179 </p><p>
167 The directory should have the same format as one containing 180 The directory should have the same format as one containing
168 the output of export. There are two files imported per class. 181 the output of export. There are two files imported per class.
169 The files used in the import are: 182 The files used in the import are:
170 183 </p><p>
171 &lt;class&gt;.csv 184 &lt;class&gt;.csv
172 This must define the same properties as the class (including 185 This must define the same properties as the class
173 having a "header" line with those property names.) 186 (including having a "header" line with those
187 property names.)
188 </p><p>
174 &lt;class&gt;-journals.csv 189 &lt;class&gt;-journals.csv
175 This defines the journals for the items being imported. 190 This defines the journals for the items
176 191 being imported.
192 </p><p>
177 The imported nodes will have the same nodeid as defined in the 193 The imported nodes will have the same nodeid as defined in the
178 import file, thus replacing any existing content. 194 import file, thus replacing any existing content.
179 195 </p><p>
180 The new nodes are added to the existing database - if you want to 196 The new nodes are added to the existing database - if you want to
181 create a new database using the imported data, then create a new 197 create a new database using the imported data, then create a new
182 database (or, tediously, retire all the old data.) 198 database (or, tediously, retire all the old data.)
183 199 </p><p>
184 </pre></td></tr> 200 </td></tr>
185 201
186 202
187 <tr><td valign=top><strong>importtables</strong></td> 203 <tr><td valign=top><strong>importtables</strong></td>
188 <td><tt>- importtables export_dir</tt> 204 <td><p><tt>export_dir</tt></p>
189 <pre> 205
206 <p>
190 This imports the database tables exported using exporttables. 207 This imports the database tables exported using exporttables.
191 208 </p><p>
192 It does not import the content of files like msgs and files. 209 It does not import the content of files like msgs and files.
193 210 </p><p>
194 </pre></td></tr> 211 </td></tr>
195 212
196 213
197 <tr><td valign=top><strong>initialise</strong></td> 214 <tr><td valign=top><strong>initialise</strong></td>
198 <td><tt>- initialise [adminpw]</tt> 215 <td><p><tt>[adminpw]</tt></p>
199 <pre> 216
217 <p>
200 Initialise a new Roundup tracker. 218 Initialise a new Roundup tracker.
201 219 </p><p>
202 The administrator details will be set at this step. 220 The administrator details will be set at this step.
203 221 </p><p>
204 Execute the tracker's initialisation function dbinit.init() 222 Execute the tracker's initialisation function dbinit.init()
205 223 </p><p>
206 </pre></td></tr> 224 </td></tr>
207 225
208 226
209 <tr><td valign=top><strong>install</strong></td> 227 <tr><td valign=top><strong>install</strong></td>
210 <td><tt>- install [template [backend [key=val[,key=val]]]]</tt> 228 <td><p><tt>[template [backend [key=val[,key=val]]]]</tt></p>
211 <pre> 229
230 <p>
212 Install a new Roundup tracker. 231 Install a new Roundup tracker.
213 232 </p><p>
214 The command will prompt for the tracker home directory 233 The command will prompt for the tracker home directory
215 (if not supplied through TRACKER_HOME or the -i option). 234 (if not supplied through TRACKER_HOME or the -i option).
216 The template and backend may be specified on the command-line 235 The template and backend may be specified on the command-line
217 as arguments, in that order. 236 as arguments, in that order.
218 237 </p><p>
219 Command line arguments following the backend allows you to 238 Command line arguments following the backend allows you to
220 pass initial values for config options. For example, passing 239 pass initial values for config options. For example, passing
221 "web_http_auth=no,rdbms_user=dinsdale" will override defaults 240 "web_http_auth=no,rdbms_user=dinsdale" will override defaults
222 for options http_auth in section [web] and user in section [rdbms]. 241 for options http_auth in section [web] and user in section [rdbms].
223 Please be careful to not use spaces in this argument! (Enclose 242 Please be careful to not use spaces in this argument! (Enclose
224 whole argument in quotes if you need spaces in option value). 243 whole argument in quotes if you need spaces in option value).
225 244 </p><p>
226 The initialise command must be called after this command in order 245 The initialise command must be called after this command in order
227 to initialise the tracker's database. You may edit the tracker's 246 to initialise the tracker's database. You may edit the tracker's
228 initial database contents before running that command by editing 247 initial database contents before running that command by editing
229 the tracker's dbinit.py module init() function. 248 the tracker's dbinit.py module init() function.
230 249 </p><p>
231 See also initopts help. 250 See also initopts help.
232 251 </p><p>
233 </pre></td></tr> 252 </td></tr>
234 253
235 254
236 <tr><td valign=top><strong>list</strong></td> 255 <tr><td valign=top><strong>list</strong></td>
237 <td><tt>- list classname [property]</tt> 256 <td><p><tt>classname [property]</tt></p>
238 <pre> 257
258 <p>
239 List the instances of a class. 259 List the instances of a class.
240 260 </p><p>
241 Lists all instances of the given class. If the property is not 261 Lists all instances of the given class. If the property is not
242 specified, the "label" property is used. The label property is 262 specified, the "label" property is used. The label property is
243 tried in order: the key, "name", "title" and then the first 263 tried in order: the key, "name", "title" and then the first
244 property, alphabetically. 264 property, alphabetically.
245 265 </p><p>
246 With -c, -S or -s print a list of item id's if no property 266 With -c, -S or -s print a list of item id's if no property
247 specified. If property specified, print list of that property 267 specified. If property specified, print list of that property
248 for every class instance. 268 for every class instance.
249 269 </p><p>
250 </pre></td></tr> 270 </td></tr>
251 271
252 272
253 <tr><td valign=top><strong>migrate</strong></td> 273 <tr><td valign=top><strong>migrate</strong></td>
254 <td><tt>- migrate</tt> 274 <td><p><tt></tt></p>
255 <pre> 275
276 <p>
256 Update a tracker's database to be compatible with the Roundup 277 Update a tracker's database to be compatible with the Roundup
257 codebase. 278 codebase.
258 279 </p><p>
259 You should run the "migrate" command for your tracker once 280 You should run the "migrate" command for your tracker once
260 you've installed the latest codebase. 281 you've installed the latest codebase.
261 282 </p><p>
262 Do this before you use the web, command-line or mail interface 283 Do this before you use the web, command-line or mail interface
263 and before any users access the tracker. 284 and before any users access the tracker.
264 285 </p><p>
265 This command will respond with either "Tracker updated" (if 286 This command will respond with either "Tracker updated" (if
266 you've not previously run it on an RDBMS backend) or "No 287 you've not previously run it on an RDBMS backend) or "No
267 migration action required" (if you have run it, or have used 288 migration action required" (if you have run it, or have used
268 another interface to the tracker, or possibly because you are 289 another interface to the tracker, or possibly because you are
269 using anydbm). 290 using anydbm).
270 291 </p><p>
271 It's safe to run this even if it's not required, so just get 292 It's safe to run this even if it's not required, so just get
272 into the habit. 293 into the habit.
273 294 </p><p>
274 </pre></td></tr> 295 </td></tr>
275 296
276 297
277 <tr><td valign=top><strong>pack</strong></td> 298 <tr><td valign=top><strong>pack</strong></td>
278 <td><tt>- pack period | date</tt> 299 <td><p><tt>period | date</tt></p>
279 <pre> 300
301 <p>
280 Remove journal entries older than the date/period. 302 Remove journal entries older than the date/period.
281 303 </p><p>
282 A period is specified using the suffixes "y", "m", and "d". The 304 A period is specified using the suffixes "y", "m", and "d". The
283 suffix "w" (for "week") means 7 days. 305 suffix "w" (for "week") means 7 days.
284 306 </p><p>
285 "3y" means three years 307 <pre> "3y" means three years</pre>
286 "2y 1m" means two years and one month 308 <pre> "2y 1m" means two years and one month</pre>
287 "1m 25d" means one month and 25 days 309 <pre> "1m 25d" means one month and 25 days</pre>
288 "2w 3d" means two weeks and three days 310 <pre> "2w 3d" means two weeks and three days</pre>
289 311 </p><p>
290 Date format is "YYYY-MM-DD" eg: 312 Date format is "YYYY-MM-DD" eg:
291 2001-01-01 313 <pre> 2001-01-01</pre>
292 314 </p><p>
293 315 </p><p>
294 </pre></td></tr> 316 </td></tr>
295 317
296 318
297 <tr><td valign=top><strong>perftest</strong></td> 319 <tr><td valign=top><strong>perftest</strong></td>
298 <td><tt>- perftest [mode] [arguments]*</tt> 320 <td><p><tt>[mode] [arguments]*</tt></p>
299 <pre> 321
322 <p>
300 Time operations in Roundup. 323 Time operations in Roundup.
301 324 </p><p>
302 Supported arguments: 325 Supported arguments:
303 326 </p><p>
304 [password] [rounds=&lt;integer&gt;] [scheme=&lt;scheme&gt;] 327 <pre> [password] [rounds=&lt;integer&gt;] [scheme=&lt;scheme&gt;]</pre>
305 328 </p><p>
306 'password' is the default mode. The tracker's config.ini 329 'password' is the default mode. The tracker's config.ini
307 setting for 'password_pbkdf2_default_rounds' is the default 330 setting for 'password_pbkdf2_default_rounds' is the default
308 value for 'rounds'. On the command line, 'rounds' can include 331 value for 'rounds'. On the command line, 'rounds' can include
309 thousands separator of ',' or '.'. 'scheme' is the default 332 thousands separator of ',' or '.'. 'scheme' is the default
310 coded into Roundup. List supported schemes by using 'scheme='. 333 coded into Roundup. List supported schemes by using 'scheme='.
311 334 </p><p>
312 335 </p><p>
313 </pre></td></tr> 336 </td></tr>
314 337
315 338
316 <tr><td valign=top><strong>pragma</strong></td> 339 <tr><td valign=top><strong>pragma</strong></td>
317 <td><tt>- pragma setting=value | 'list'</tt> 340 <td><p><tt>setting=value | 'list'</tt></p>
318 <pre> 341
342 <p>
319 Set internal admin settings to a value. 343 Set internal admin settings to a value.
320 344 </p><p>
321 For example: 345 For example:
322 346 </p><p>
323 pragma verbose=True 347 <pre> pragma verbose=True</pre>
324 pragma verbose=yes 348 <pre> pragma verbose=yes</pre>
325 pragma verbose=on 349 <pre> pragma verbose=on</pre>
326 pragma verbose=1 350 <pre> pragma verbose=1</pre>
327 351 </p><p>
328 will turn on verbose mode for roundup-admin. 352 will turn on verbose mode for roundup-admin.
329 353 </p><p>
330 pragma list 354 <pre> pragma list</pre>
331 355 </p><p>
332 will show all settings and their current values. If verbose 356 will show all settings and their current values. If verbose
333 is enabled hidden settings and descriptions will be shown. 357 is enabled hidden settings and descriptions will be shown.
334 358 </p><p>
335 </pre></td></tr> 359 </td></tr>
336 360
337 361
338 <tr><td valign=top><strong>reindex</strong></td> 362 <tr><td valign=top><strong>reindex</strong></td>
339 <td><tt>- reindex [classname|classname:#-#|designator]*</tt> 363 <td><p><tt>[classname|classname:#-#|designator]*</tt></p>
340 <pre> 364
365 <p>
341 Re-generate a tracker's search indexes. 366 Re-generate a tracker's search indexes.
342 367 </p><p>
343 This will re-generate the search indexes for a tracker. 368 This will re-generate the search indexes for a tracker.
344 This will typically happen automatically. 369 This will typically happen automatically.
345 370 </p><p>
346 You can incrementally reindex using an argument like: 371 You can incrementally reindex using an argument like:
347 372 </p><p>
348 reindex issue:23-1000 373 <pre> reindex issue:23-1000</pre>
349 374 </p><p>
350 to reindex issue class items 23-1000. Missing items 375 to reindex issue class items 23-1000. Missing items
351 are reported but do not stop indexing of the range. 376 are reported but do not stop indexing of the range.
352 377 </p><p>
353 </pre></td></tr> 378 </td></tr>
354 379
355 380
356 <tr><td valign=top><strong>restore</strong></td> 381 <tr><td valign=top><strong>restore</strong></td>
357 <td><tt>- restore designator[,designator]*</tt> 382 <td><p><tt>designator[,designator]*</tt></p>
358 <pre> 383
384 <p>
359 Restore the retired node specified by designator. 385 Restore the retired node specified by designator.
360 386 </p><p>
361 A designator is a classname and a nodeid concatenated, 387 A designator is a classname and a nodeid concatenated,
362 eg. bug1, user10, ... 388 eg. bug1, user10, ...
363 389 </p><p>
364 The given nodes will become available for users again. 390 The given nodes will become available for users again.
365 391 </p><p>
366 </pre></td></tr> 392 </td></tr>
367 393
368 394
369 <tr><td valign=top><strong>retire</strong></td> 395 <tr><td valign=top><strong>retire</strong></td>
370 <td><tt>- retire designator[,designator]*</tt> 396 <td><p><tt>designator[,designator]*</tt></p>
371 <pre> 397
398 <p>
372 Retire the node specified by designator. 399 Retire the node specified by designator.
373 400 </p><p>
374 A designator is a classname and a nodeid concatenated, 401 A designator is a classname and a nodeid concatenated,
375 eg. bug1, user10, ... 402 eg. bug1, user10, ...
376 403 </p><p>
377 This action indicates that a particular node is not to be retrieved 404 This action indicates that a particular node is not to be retrieved
378 by the list or find commands, and its key value may be re-used. 405 by the list or find commands, and its key value may be re-used.
379 406 </p><p>
380 </pre></td></tr> 407 </td></tr>
381 408
382 409
383 <tr><td valign=top><strong>rollback</strong></td> 410 <tr><td valign=top><strong>rollback</strong></td>
384 <td><tt>- rollback</tt> 411 <td><p><tt></tt></p>
385 <pre> 412
413 <p>
386 Undo all changes that are pending commit to the database. 414 Undo all changes that are pending commit to the database.
387 415 </p><p>
388 The changes made during an interactive session are not 416 The changes made during an interactive session are not
389 automatically written to the database - they must be committed 417 automatically written to the database - they must be committed
390 manually. This command undoes all those changes, so a commit 418 manually. This command undoes all those changes, so a commit
391 immediately after would make no changes to the database. 419 immediately after would make no changes to the database.
392 420 </p><p>
393 </pre></td></tr> 421 </td></tr>
394 422
395 423
396 <tr><td valign=top><strong>security</strong></td> 424 <tr><td valign=top><strong>security</strong></td>
397 <td><tt>- security [Role name]</tt> 425 <td><p><tt>[Role name]</tt></p>
398 <pre> 426
427 <p>
399 Display the Permissions available to one or all Roles. 428 Display the Permissions available to one or all Roles.
400 429 </p><p>
401 Also validates that any properties defined in a 430 Also validates that any properties defined in a
402 permission are valid. 431 permission are valid.
403 432 </p><p>
404 Run this after changing your permissions to catch 433 Run this after changing your permissions to catch
405 typos. 434 typos.
406 435 </p><p>
407 </pre></td></tr> 436 </td></tr>
408 437
409 438
410 <tr><td valign=top><strong>set</strong></td> 439 <tr><td valign=top><strong>set</strong></td>
411 <td><tt>- set items property=value [property=value ...]</tt> 440 <td><p><tt>items property=value [property=value ...]</tt></p>
412 <pre> 441
442 <p>
413 Set the given properties of one or more items(s). 443 Set the given properties of one or more items(s).
414 444 </p><p>
415 The items are specified as a class or as a comma-separated 445 The items are specified as a class or as a comma-separated
416 list of item designators (ie "designator[,designator,...]"). 446 list of item designators (ie "designator[,designator,...]").
417 447 </p><p>
418 A designator is a classname and a nodeid concatenated, 448 A designator is a classname and a nodeid concatenated,
419 eg. bug1, user10, ... 449 eg. bug1, user10, ...
420 450 </p><p>
421 This command sets the properties to the values for all 451 This command sets the properties to the values for all
422 designators given. If a class is used, the property will be 452 designators given. If a class is used, the property will be
423 set for all items in the class. If the value is missing 453 set for all items in the class. If the value is missing
424 (ie. "property=") then the property is un-set. If the property 454 (ie. "property=") then the property is un-set. If the property
425 is a multilink, you specify the linked ids for the multilink 455 is a multilink, you specify the linked ids for the multilink
426 as comma-separated numbers (ie "1,2,3"). 456 as comma-separated numbers (ie "1,2,3").
427 457 </p><p>
428 458 </p><p>
429 </pre></td></tr> 459 </td></tr>
430 460
431 461
432 <tr><td valign=top><strong>specification</strong></td> 462 <tr><td valign=top><strong>specification</strong></td>
433 <td><tt>- specification classname</tt> 463 <td><p><tt>classname</tt></p>
434 <pre> 464
465 <p>
435 Show the properties for a classname. 466 Show the properties for a classname.
436 467 </p><p>
437 This lists the properties for a given class. 468 This lists the properties for a given class.
438 469 </p><p>
439 </pre></td></tr> 470 </td></tr>
440 471
441 472
442 <tr><td valign=top><strong>table</strong></td> 473 <tr><td valign=top><strong>table</strong></td>
443 <td><tt>- table classname [property[,property]*]</tt> 474 <td><p><tt>classname [property[,property]*]</tt></p>
444 <pre> 475
476 <p>
445 List the instances of a class in tabular form. 477 List the instances of a class in tabular form.
446 478 </p><p>
447 Lists all instances of the given class. If the properties are not 479 Lists all instances of the given class. If the properties are not
448 specified, all properties are displayed. By default, the column 480 specified, all properties are displayed. By default, the column
449 widths are the width of the largest value. The width may be 481 widths are the width of the largest value. The width may be
450 explicitly defined by defining the property as "name:width". 482 explicitly defined by defining the property as "name:width".
451 For example:: 483 For example::
452 484 </p><p>
453 roundup&gt; table priority id,name:10 485 <pre> roundup&gt; table priority id,name:10</pre>
454 Id Name 486 <pre> Id Name</pre>
455 1 fatal-bug 487 <pre> 1 fatal-bug</pre>
456 2 bug 488 <pre> 2 bug</pre>
457 3 usability 489 <pre> 3 usability</pre>
458 4 feature 490 <pre> 4 feature</pre>
459 491 </p><p>
460 Also to make the width of the column the width of the label, 492 Also to make the width of the column the width of the label,
461 leave a trailing : without a width on the property. For example:: 493 leave a trailing : without a width on the property. For example::
462 494 </p><p>
463 roundup&gt; table priority id,name: 495 <pre> roundup&gt; table priority id,name:</pre>
464 Id Name 496 <pre> Id Name</pre>
465 1 fata 497 <pre> 1 fata</pre>
466 2 bug 498 <pre> 2 bug</pre>
467 3 usab 499 <pre> 3 usab</pre>
468 4 feat 500 <pre> 4 feat</pre>
469 501 </p><p>
470 will result in a the 4 character wide "Name" column. 502 will result in a the 4 character wide "Name" column.
471 503 </p><p>
472 </pre></td></tr> 504 </td></tr>
473 505
474 506
475 <tr><td valign=top><strong>templates</strong></td> 507 <tr><td valign=top><strong>templates</strong></td>
476 <td><tt>- templates [trace_search]</tt> 508 <td><p><tt>[trace_search]</tt></p>
477 <pre> 509
510 <p>
478 List templates and their installed directories. 511 List templates and their installed directories.
479 512 </p><p>
480 With trace_search also list all directories that are 513 With trace_search also list all directories that are
481 searched for templates. 514 searched for templates.
482 515 </p><p>
483 </pre></td></tr> 516 </td></tr>
484 517
485 518
486 <tr><td valign=top><strong>updateconfig</strong></td> 519 <tr><td valign=top><strong>updateconfig</strong></td>
487 <td><tt>- updateconfig &lt;filename&gt;</tt> 520 <td><p><tt>&lt;filename&gt;</tt></p>
488 <pre> 521
522 <p>
489 Merge existing tracker config with new settings. 523 Merge existing tracker config with new settings.
490 524 </p><p>
491 Output the updated config file to &lt;filename&gt;. Use current 525 Output the updated config file to &lt;filename&gt;. Use current
492 settings from existing roundup tracker in tracker home. 526 settings from existing roundup tracker in tracker home.
493 527 </p><p>
494 </pre></td></tr> 528 </td></tr>
495 529
496 </table> 530 </table>
Roundup Issue Tracker: http://roundup-tracker.org/