Mercurial > p > roundup > code
comparison share/man/man1/roundup-admin.1 @ 7549:73dfa9df9fb0
issue685275 - show retired/unretired items in roundup-admin
add pragma display_header to print headers for display command. Header
displays designator and retired/active status.
Add doc of pragma to affected commands.
Add test for code paths.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Fri, 14 Jul 2023 22:07:23 -0400 |
| parents | 534f8bdb8f94 |
| children | d7d68da9878f |
comparison
equal
deleted
inserted
replaced
| 7548:793f4b63c538 | 7549:73dfa9df9fb0 |
|---|---|
| 74 name=value arguments provided on the command line after the "create" | 74 name=value arguments provided on the command line after the "create" |
| 75 command. | 75 command. |
| 76 .TP | 76 .TP |
| 77 \fBdisplay\fP \fIdesignator[,designator]*\fP | 77 \fBdisplay\fP \fIdesignator[,designator]*\fP |
| 78 This lists the properties and their associated values for the given | 78 This lists the properties and their associated values for the given |
| 79 node. | 79 node. The pragma \fBdisplay_header\fP can be used to add a header |
| 80 between designators that includes the active/retired status of | |
| 81 the item. | |
| 80 .TP | 82 .TP |
| 81 \fBexport\fP \fI[[-]class[,class]] export_dir\fP | 83 \fBexport\fP \fI[[-]class[,class]] export_dir\fP |
| 82 Export the database to colon-separated-value files. | 84 Export the database to colon-separated-value files. |
| 83 To exclude the files (e.g. for the msg or file class), | 85 To exclude the files (e.g. for the msg or file class), |
| 84 use the exporttables command. | 86 use the exporttables command. |
| 180 property, alphabetically. | 182 property, alphabetically. |
| 181 | 183 |
| 182 With \fB-c\fP, \fB-S\fP or \fB-s\fP print a list of item id's if no | 184 With \fB-c\fP, \fB-S\fP or \fB-s\fP print a list of item id's if no |
| 183 property specified. If property specified, print list of that | 185 property specified. If property specified, print list of that |
| 184 property for every class instance. | 186 property for every class instance. |
| 187 | |
| 188 The pragma \fBshow_retired\fP can be used to print only retired items | |
| 189 or to print retired and active items. The default is to print only | |
| 190 active items. | |
| 185 .TP | 191 .TP |
| 186 \fBmigrate\fP | 192 \fBmigrate\fP |
| 187 Update a tracker's database to be compatible with the Roundup | 193 Update a tracker's database to be compatible with the Roundup |
| 188 codebase. | 194 codebase. |
| 189 | 195 |
| 270 .TP | 276 .TP |
| 271 \fBtable\fP \fIclassname [property[,property]*]\fP | 277 \fBtable\fP \fIclassname [property[,property]*]\fP |
| 272 Lists all instances of the given class. If the properties are not | 278 Lists all instances of the given class. If the properties are not |
| 273 specified, all properties are displayed. By default, the column | 279 specified, all properties are displayed. By default, the column |
| 274 widths are the width of the largest value. | 280 widths are the width of the largest value. |
| 281 | |
| 282 The pragma \fBshow_retired\fP can be used to print only retired items | |
| 283 or to print retired and active items. The default is to print only | |
| 284 active items. | |
| 275 .TP | 285 .TP |
| 276 \fBupdateconfig\fP \fI<filename>\fP | 286 \fBupdateconfig\fP \fI<filename>\fP |
| 277 This is used when updating software. It merges the \fBconfig.ini\fP | 287 This is used when updating software. It merges the \fBconfig.ini\fP |
| 278 from the tracker with new settings from the new software. The | 288 from the tracker with new settings from the new software. The |
| 279 merged/updated config file is written to \fI<filename>\fP. | 289 merged/updated config file is written to \fI<filename>\fP. |