diff 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
line wrap: on
line diff
--- a/share/man/man1/roundup-admin.1	Fri Jul 14 21:56:27 2023 -0400
+++ b/share/man/man1/roundup-admin.1	Fri Jul 14 22:07:23 2023 -0400
@@ -76,7 +76,9 @@
 .TP
 \fBdisplay\fP \fIdesignator[,designator]*\fP
 This lists the properties and their associated values for the given
-node.
+node. The pragma \fBdisplay_header\fP can be used to add a header
+between designators that includes the active/retired status of
+the item.
 .TP
 \fBexport\fP \fI[[-]class[,class]] export_dir\fP
 Export the database to colon-separated-value files.
@@ -182,6 +184,10 @@
 With \fB-c\fP, \fB-S\fP or \fB-s\fP print a list of item id's if no
 property specified.  If property specified, print list of that
 property for every class instance.
+
+The pragma \fBshow_retired\fP can be used to print only retired items
+or to print retired and active items. The default is to print only
+active items.
 .TP
 \fBmigrate\fP
 Update a tracker's database to be compatible with the Roundup
@@ -272,6 +278,10 @@
 Lists all instances of the given class. If the properties are not
 specified, all properties are displayed. By default, the column
 widths are the width of the largest value.
+
+The pragma \fBshow_retired\fP can be used to print only retired items
+or to print retired and active items. The default is to print only
+active items.
 .TP
 \fBupdateconfig\fP \fI<filename>\fP
 This is used when updating software. It merges the \fBconfig.ini\fP

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