Mercurial > p > roundup > code

annotate share/man/man1/roundup-admin.1 @ 7797:8bdf0484215c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Summary: feat: roundup-admin history command has human interpretable output Reformat journal entries and make try to make readable sentences out of them. Set up translation markers and added hints for the tanslators by marking translator comments with; # .Hint text for translator on the line before _() markers. Doc'ed changes in roundup-admin docs and added info to upgrading.txt. If the user wants old format, they can call history designator raw
author John Rouillard <rouilj@ieee.org>
date Sun, 10 Mar 2024 21:59:20 -0400
parents d7d68da9878f
children d614d8e1c09d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
1 .TH ROUNDUP-ADMIN 1 "24 January 2003"
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
2 .SH NAME
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
3 roundup-admin \- administrate roundup trackers
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
4 .SH SYNOPSIS
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
5 \fBroundup-admin\fP [\fIoptions\fP] \fI<command>\fP \fI<arguments>\fP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
6 .SH OPTIONS
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
7 .TP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
8 \fB-i\fP \fIinstance home\fP
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
9 Specify the issue tracker "home directory" to administer
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
10 .TP
4706
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
11 \fB-u\fP \fIuser\fP[\fB:\fP\fIpassword\fP]
7098
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
12 The user and password to use for commands (partial implemention, see
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
13 Security Notes below).
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
14 .TP
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
15 \fB-h\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
16 Print help text.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
17 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
18 \fB-d\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
19 Print full designators (e.g. issue1) not just id numbers (1).
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
20 .TP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
21 \fB-c\fP
4706
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
22 When outputting lists of data, comma-separate them. Same as
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
23 \fB-S ","\fP.
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
24 .TP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
25 \fB-S\fP \fIstring\fP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
26 When outputting lists of data, separate items with given string.
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
27 .TP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
28 \fB-s\fP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
29 When outputting lists of data, space-separate them. Same as
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
30 \fB-S " "\fP.
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
31 .TP
7546
534f8bdb8f94 Add -P pragma=value command line option to roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 7395
diff changeset
32 \fB-P pragma=value\fP
534f8bdb8f94 Add -P pragma=value command line option to roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 7395
diff changeset
33 Set a pragma on the command line. Multiple \fB-P\fP options can be
534f8bdb8f94 Add -P pragma=value command line option to roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 7395
diff changeset
34 specified to set multiple pragmas.
534f8bdb8f94 Add -P pragma=value command line option to roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 7395
diff changeset
35 .TP
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
36 \fB-V\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
37 Be verbose when importing data.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
38 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
39 \fB-v\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
40 Report Roundup and Python versions and quit.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
41 .PP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
42 Only one of \fB-s\fP, \fB-c\fP or \fB-S\fP can be specified.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
43 .SH COMMANDS
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
44 If no command is provided on the command line, roundup-admin will
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
45 enter an interactive mode. More details about these commands are
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
46 available using the help command.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
47
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
48 A designator is a classname and a nodeid concatenated,
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
49 eg. bug1, user10, ....
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
50
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
51 Roundup-admin takes a number of commands:
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
52 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
53 \fBhelp\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
54 prints help (same as \fB-h\fP)
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
55 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
56 \fBhelp\fP \fI<subcommand>\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
57 Print command-specific help
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
58 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
59 \fBhelp all\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
60 Print available help for all commands.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
61 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
62 \fBcommit\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
63 Commit changes made to the database during an interactive session.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
64
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
65 The changes made during an interactive session are not
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
66 automatically written to the database - they must be committed
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
67 using this command.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
68
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
69 One-off commands on the command-line are automatically committed if
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
70 they are successful. See also rollback.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
71 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
72 \fBcreate\fP \fIclassname property=value ...\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
73 This creates a new entry of the given class using the property
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
74 name=value arguments provided on the command line after the "create"
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
75 command.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
76 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
77 \fBdisplay\fP \fIdesignator[,designator]*\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
78 This lists the properties and their associated values for the given
7549
73dfa9df9fb0 issue685275 - show retired/unretired items in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7546
diff changeset
79 node. The pragma \fBdisplay_header\fP can be used to add a header
73dfa9df9fb0 issue685275 - show retired/unretired items in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7546
diff changeset
80 between designators that includes the active/retired status of
73dfa9df9fb0 issue685275 - show retired/unretired items in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7546
diff changeset
81 the item.
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
82 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
83 \fBexport\fP \fI[[-]class[,class]] export_dir\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
84 Export the database to colon-separated-value files.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
85 To exclude the files (e.g. for the msg or file class),
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
86 use the exporttables command.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
87
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
88 Optionally limit the export to just the named classes
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
89 or exclude the named classes, if the 1st argument starts with '-'.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
90
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
91 This action exports the current data from the database into
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
92 colon-separated-value files that are placed in the nominated
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
93 destination directory.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
94 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
95 \fBexporttables\fP \fI[[-]class[,class]] export_dir\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
96 Export the database to colon-separated-value files, excluding the
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
97 files below $TRACKER_HOME/db/files/ (which can be archived separately).
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
98 To include the files, use the export command.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
99 .TP
6176
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6172
diff changeset
100 \fBfilter\fP \fIclassname propname=value ...\fP
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6172
diff changeset
101 Find the nodes of the given class with a given property value.
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6172
diff changeset
102 Multiple values can be specified by separating them with commas.
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6172
diff changeset
103 If property is a string, all values must match. I.E. it's an
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6172
diff changeset
104 'and' operation. If the property is a link/multilink any value
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6172
diff changeset
105 matches. I.E. an 'or' operation.
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6172
diff changeset
106 .TP
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
107 \fBfind\fP \fIclassname propname=value ...\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
108 Find the nodes of the given class with a given link property value.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
109 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
110 \fBgenconfig\fP \fI<filename>\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
111 Generate a new tracker config file (ini style) with default values
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
112 in \fI<filename>\fP. Note that this does not preserve any settings from
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
113 the current tracker. Use updateconfig for that.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
114 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
115 \fBget\fP \fIproperty designator[,designator]*\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
116 Get the given property of one or more designator(s).
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
117
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
118 Retrieves the property value of the nodes specified
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
119 by the designators.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
120
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
121 .TP
7797
8bdf0484215c Summary: feat: roundup-admin history command has human interpretable output
John Rouillard <rouilj@ieee.org>
parents: 7795
diff changeset
122 \fBhistory\fP \fIdesignator [skipquiet] [raw]\fP
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
123 Lists the journal entries viewable by the user for the
7797
8bdf0484215c Summary: feat: roundup-admin history command has human interpretable output
John Rouillard <rouilj@ieee.org>
parents: 7795
diff changeset
124 node identified by the designator. If skipquiet is added, journal
8bdf0484215c Summary: feat: roundup-admin history command has human interpretable output
John Rouillard <rouilj@ieee.org>
parents: 7795
diff changeset
125 entries for quiet properties are not shown. Without the raw option
8bdf0484215c Summary: feat: roundup-admin history command has human interpretable output
John Rouillard <rouilj@ieee.org>
parents: 7795
diff changeset
126 a more human readable output format is used.
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
127 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
128 \fBimport\fP \fIimport_dir\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
129 Import a database from the directory containing CSV files,
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
130 two per class to import.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
131
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
132 The imported nodes will have the same nodeid as defined in the
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
133 import file, thus replacing any existing content.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
134
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
135 The new nodes are added to the existing database - if you want to
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
136 create a new database using the imported data, then create a new
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
137 database (or, tediously, retire all the old data). See also export.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
138 .TP
6216
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
139 \fBimporttables\fP \fIimport_dir\fP
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
140 Import a database from the directory containing CSV files,
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
141 two per class to import.
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
142
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
143 The imported nodes will have the same nodeid as defined in the
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
144 import file, thus replacing any existing content.
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
145
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
146 This only imports database tables. It does not import files/message
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
147 content. It is used to import data exported by exporttables. See also
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
148 exporttables.
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
149 .TP
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
150 \fBinitialise\fP \fI[adminpw]\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
151 Initialise a new Roundup tracker.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
152
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
153 The administrator details will be set at this step.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
154 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
155 \fBinstall\fP \fI[template [backend [key=val[,key=val]]]]\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
156 Install a new roundup tracker.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
157
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
158 The command will prompt for the tracker home directory
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
159 (if not supplied through TRACKER_HOME or the -i option).
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
160 The template and backend may be specified on the command-line
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
161 as arguments, in that order.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
162
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
163 Command line arguments following the backend allows you to
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
164 pass initial values for config options. For example, passing
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
165 "web_http_auth=no,rdbms_user=dinsdale" will override defaults
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
166 for options http_auth in section [web] and user in section [rdbms].
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
167 Please be careful to not use spaces in this argument! (Enclose
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
168 whole argument in quotes if you need spaces in option value).
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
169
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
170 The initialise command must be called after this command in order
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
171 to initialise the tracker's database. You may edit the tracker's
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
172 initial database contents before running that command by editing
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
173 the tracker's dbinit.py module init() function.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
174
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
175 See also initopts help.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
176
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
177 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
178 \fBlist\fP \fIclassname [property]\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
179 Lists all instances of the given class. If the property is not
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
180 specified, the "label" property is used. The label property is
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
181 tried in order: the key, "name", "title" and then the first
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
182 property, alphabetically.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
183
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
184 With \fB-c\fP, \fB-S\fP or \fB-s\fP print a list of item id's if no
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
185 property specified. If property specified, print list of that
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
186 property for every class instance.
7549
73dfa9df9fb0 issue685275 - show retired/unretired items in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7546
diff changeset
187
73dfa9df9fb0 issue685275 - show retired/unretired items in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7546
diff changeset
188 The pragma \fBshow_retired\fP can be used to print only retired items
73dfa9df9fb0 issue685275 - show retired/unretired items in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7546
diff changeset
189 or to print retired and active items. The default is to print only
73dfa9df9fb0 issue685275 - show retired/unretired items in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7546
diff changeset
190 active items.
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
191 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
192 \fBmigrate\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
193 Update a tracker's database to be compatible with the Roundup
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
194 codebase.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
195
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
196 You should run the "migrate" command for your tracker once you've
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
197 installed the latest codebase.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
198
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
199 Do this before you use the web, command-line or mail interface and
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
200 before any users access the tracker.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
201
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
202 This command will respond with either "Tracker updated" (if you've
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
203 not previously run it on an RDBMS backend) or "No migration action
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
204 required" (if you have run it, or have used another interface to the
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
205 tracker, or possibly because you are using anydbm).
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
206
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
207 It's safe to run this even if it's not required, so just get into
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
208 the habit.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
209 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
210 \fBpack\fP \fIperiod | date\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
211 Remove journal entries older than a period of time specified or
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
212 before a certain date.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
213 .TP
7209
c1227f883177 Implement password hash testing using new roundup-admin perftest.
John Rouillard <rouilj@ieee.org>
parents: 7098
diff changeset
214 \fBperftest\fP \fI[mode] [arguments]*\fP
c1227f883177 Implement password hash testing using new roundup-admin perftest.
John Rouillard <rouilj@ieee.org>
parents: 7098
diff changeset
215 Run performance test. For example test the effect
c1227f883177 Implement password hash testing using new roundup-admin perftest.
John Rouillard <rouilj@ieee.org>
parents: 7098
diff changeset
216 of changing password hashing parameters.
c1227f883177 Implement password hash testing using new roundup-admin perftest.
John Rouillard <rouilj@ieee.org>
parents: 7098
diff changeset
217 .TP
7252
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
218 \fBpragma\fP \fIsetting=value\fP|\fBlist\fP
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
219 Set internal settings to a value. E.G.
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
220
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
221 pragma verbose=True
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
222 pragma verbose=yes
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
223 pragma verbose=on
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
224 pragma verbose=1
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
225
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
226 will turn on verbose mode for roundup-admin.
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
227
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
228 pragma list
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
229
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
230 will show all settings and their current values. If verbose
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
231 is enabled hidden settings and descriptions will be shown.
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
232 .TP
7395
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7252
diff changeset
233 \fBreindex\fP \fI[classname|classname:#-#|designator]*\fP This will
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7252
diff changeset
234 re-generate the search indexes for a tracker. You can specify a
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7252
diff changeset
235 specific item (or items) (e.g. issue23), range(s) of items
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7252
diff changeset
236 (e.g. issue:1-1000), class(es) (e.g. issue) or reindex all items in
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7252
diff changeset
237 the database if no arguments are supplied.
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
238 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
239 \fBrestore\fP \fIdesignator[,designator]*\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
240 Restore the retired node specified by designator.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
241
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
242 The given nodes will become available for users again.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
243 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
244 \fBretire\fP \fIdesignator[,designator]*\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
245 This action indicates that a particular node is not to be retrieved
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
246 by the list or find commands, and its key value may be re-used. See
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
247 also restore.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
248 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
249 \fBrollback\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
250 Undo all changes that are pending commit to the database.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
251
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
252 The changes made during an interactive session are not
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
253 automatically written to the database - they must be committed
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
254 manually. This command undoes all those changes, so a commit
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
255 immediately after would make no changes to the database.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
256 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
257 \fBsecurity\fP \fI[Role name]\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
258 Display the Permissions available to one or all Roles.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
259 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
260 \fBset\fP \fIitems property=value property=value ...\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
261 Set the given properties of one or more items(s).
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
262
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
263 The items are specified as a class or as a comma-separated
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
264 list of item designators (ie "designator[,designator,...]").
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
265
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
266 This command sets the properties to the values for all designators
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
267 given. If the value is missing (ie. "property=") then the property
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
268 is un-set. If the property is a multilink, you specify the linked
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
269 ids for the multilink as comma-separated numbers (ie "1,2,3").
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
270 .TP
6172
78a7e54fbf41 Fix broken formatting directive.
John Rouillard <rouilj@ieee.org>
parents: 5968
diff changeset
271 \fBspecification\fP \fIclassname\fP
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
272 Show the properties for a classname.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
273 .TP
6957
f924af12ef50 issue2551233 - create new roundup-admin command "templates"
John Rouillard <rouilj@ieee.org>
parents: 6216
diff changeset
274 \fBtemplates\fP \fI[trace_search]]\fP
f924af12ef50 issue2551233 - create new roundup-admin command "templates"
John Rouillard <rouilj@ieee.org>
parents: 6216
diff changeset
275 Lists the names, location and description of all known templates.
f924af12ef50 issue2551233 - create new roundup-admin command "templates"
John Rouillard <rouilj@ieee.org>
parents: 6216
diff changeset
276 .TP
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
277 \fBtable\fP \fIclassname [property[,property]*]\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
278 Lists all instances of the given class. If the properties are not
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
279 specified, all properties are displayed. By default, the column
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
280 widths are the width of the largest value.
7549
73dfa9df9fb0 issue685275 - show retired/unretired items in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7546
diff changeset
281
73dfa9df9fb0 issue685275 - show retired/unretired items in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7546
diff changeset
282 The pragma \fBshow_retired\fP can be used to print only retired items
73dfa9df9fb0 issue685275 - show retired/unretired items in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7546
diff changeset
283 or to print retired and active items. The default is to print only
73dfa9df9fb0 issue685275 - show retired/unretired items in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7546
diff changeset
284 active items.
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
285 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
286 \fBupdateconfig\fP \fI<filename>\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
287 This is used when updating software. It merges the \fBconfig.ini\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
288 from the tracker with new settings from the new software. The
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
289 merged/updated config file is written to \fI<filename>\fP.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
290 .PP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
291 Commands may be abbreviated as long as the abbreviation
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
292 matches only one command, e.g. l == li == lis == list.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
293
7795
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
294 .SH READLINE SUPPORT
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
295
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
296 You can edit the command line and interact with history in
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
297 roundup-admin's interactive mode. On Linux like systems, GNU Readline
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
298 is required. On Mac's libedit can be used as well. On Windows
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
299 pyreadline3 is required. See:
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
300 https://docs.python.org/3/library/readline.html for details on
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
301 readline.
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
302
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
303 Roundup-admin will save the history between roundup-admin
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
304 sessions. The commands are saved to the \fB.roundup_admin_history\fP
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
305 file in the user's home directory. You can set the pragma
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
306 \fBhistory_length\fP on the roundup-admin command line to change the
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
307 amount of available and stored history for the session.
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
308
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
309 If you are using GNU readline, you can persistently change the history
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
310 size by adding: \fBset history-size 100\fP to the init file
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
311 \fB.roundup_admin_rlrc\fP located in the user's home directory.
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
312
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
313 Mac users using libedit should be able to persistently save history
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
314 and set the history size by adding \fBhistory size 100\fP.
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
315
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
316 Users of pyreadline3 can use: \fBhistory_length(100)\fP.
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7549
diff changeset
317
7098
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
318 .SH SECURITY NOTES
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
319
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
320 The \fB-u user\fP setting does not currently operate like a
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
321 user logging in via the web. The user running roundup-admin
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
322 must have read access to the tracker home directory. As a
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
323 result the user has access to the files and the database
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
324 info contained in config.ini.
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
325
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
326 Using \fB-u user\fP sets the actor/user parameter in the
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
327 journal. Changes that are made are attributed to that
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
328 user. The password is ignored if provided. Any existing
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
329 username has full access to the data just like the admin
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
330 user. This is an area for further development so that
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
331 roundup-admin could be used with sudo to provide secure
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
332 command line access to a tracker.
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
333
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
334 .SH ENVIRONMENT VARIABLES
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
335
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
336 .TP
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
337 \fBROUNDUP_LOGIN\fP
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
338 Provides an alternate way to set the user.
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
339
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
340 .SH FURTHER HELP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
341 roundup-admin -h
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
342 roundup-admin help -- this help
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
343 roundup-admin help <command> -- command-specific help
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
344 roundup-admin help all -- all available help
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
345 .SH AUTHOR
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
346 This manpage was written by Bastian Kleineidam
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
347 <calvin@debian.org> for the Debian distribution of roundup.
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
348
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
349 The main author of roundup is Richard Jones
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
350 <richard@users.sourceforge.net>.
Roundup Issue Tracker: http://roundup-tracker.org/