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