Mercurial > p > roundup > code

annotate share/man/man1/roundup-admin.1 @ 7252:9c067ed4568b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add pragma command to roundup-admin Added basic pragma command. Can assign settings, list settings. Most settings are not yet implemented. Only the pragma command respects unhidden pragma settings at this point. Also added tests, doc updates for roundup-admin. CHANGES.txt not updated because currently only pragma references the unhidden settings. Also fixed a couple of long lines.
author John Rouillard <rouilj@ieee.org>
date Wed, 12 Apr 2023 20:49:21 -0400
parents c1227f883177
children 312d52305583
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
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
32 \fB-V\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
33 Be verbose when importing data.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
34 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
35 \fB-v\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
36 Report Roundup and Python versions and quit.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
37 .PP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
38 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
39 .SH COMMANDS
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
40 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
41 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
42 available using the help command.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
43
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
44 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
45 eg. bug1, user10, ....
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
46
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
47 Roundup-admin takes a number of commands:
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
48 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
49 \fBhelp\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
50 prints help (same as \fB-h\fP)
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
51 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
52 \fBhelp\fP \fI<subcommand>\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
53 Print command-specific help
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
54 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
55 \fBhelp all\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
56 Print available help for all commands.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
57 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
58 \fBcommit\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
59 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
60
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
61 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
62 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
63 using this command.
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 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
66 they are successful. See also rollback.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
67 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
68 \fBcreate\fP \fIclassname property=value ...\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
69 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
70 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
71 command.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
72 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
73 \fBdisplay\fP \fIdesignator[,designator]*\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
74 This lists the properties and their associated values for the given
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
75 node.
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 \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
78 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
79 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
80 use the exporttables command.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
81
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
82 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
83 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
84
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
85 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
86 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
87 destination directory.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
88 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
89 \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
90 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
91 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
92 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
93 .TP
6176
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6172
diff changeset
94 \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
95 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
96 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
97 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
98 '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
99 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
100 .TP
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
101 \fBfind\fP \fIclassname propname=value ...\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
102 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
103 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
104 \fBgenconfig\fP \fI<filename>\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
105 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
106 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
107 the current tracker. Use updateconfig for that.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
108 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
109 \fBget\fP \fIproperty designator[,designator]*\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
110 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
111
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
112 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
113 by the designators.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
114
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
115 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
116 \fBhistory\fP \fIdesignator [skipquiet]\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
117 Lists the journal entries viewable by the user for the
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
118 node identified by the designator. If skipquiet is the
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
119 second argument, journal entries for quiet properties
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
120 are not shown.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
121 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
122 \fBimport\fP \fIimport_dir\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
123 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
124 two per class to import.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
125
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
126 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
127 import file, thus replacing any existing content.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
128
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
129 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
130 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
131 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
132 .TP
6216
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
133 \fBimporttables\fP \fIimport_dir\fP
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
134 Import a database from the directory containing CSV files,
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
135 two per class to import.
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
136
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
137 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
138 import file, thus replacing any existing content.
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
139
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
140 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
141 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
142 exporttables.
9d3b4472a47d Add doc for importtables.
John Rouillard <rouilj@ieee.org>
parents: 6176
diff changeset
143 .TP
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
144 \fBinitialise\fP \fI[adminpw]\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
145 Initialise a new Roundup tracker.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
146
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
147 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
148 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
149 \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
150 Install a new roundup tracker.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
151
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
152 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
153 (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
154 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
155 as arguments, in that order.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
156
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
157 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
158 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
159 "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
160 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
161 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
162 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
163
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
164 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
165 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
166 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
167 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
168
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
169 See also initopts help.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
170
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
171 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
172 \fBlist\fP \fIclassname [property]\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
173 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
174 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
175 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
176 property, alphabetically.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
177
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
178 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
179 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
180 property for every class instance.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
181 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
182 \fBmigrate\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
183 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
184 codebase.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
185
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
186 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
187 installed the latest codebase.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
188
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
189 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
190 before any users access the tracker.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
191
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
192 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
193 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
194 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
195 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
196
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
197 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
198 the habit.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
199 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
200 \fBpack\fP \fIperiod | date\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
201 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
202 before a certain date.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
203 .TP
7209
c1227f883177 Implement password hash testing using new roundup-admin perftest.
John Rouillard <rouilj@ieee.org>
parents: 7098
diff changeset
204 \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
205 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
206 of changing password hashing parameters.
c1227f883177 Implement password hash testing using new roundup-admin perftest.
John Rouillard <rouilj@ieee.org>
parents: 7098
diff changeset
207 .TP
7252
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
208 \fBpragma\fP \fIsetting=value\fP|\fBlist\fP
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
209 Set internal settings to a value. E.G.
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
210
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
211 pragma verbose=True
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
212 pragma verbose=yes
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
213 pragma verbose=on
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
214 pragma verbose=1
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
215
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
216 will turn on verbose mode for roundup-admin.
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
217
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
218 pragma list
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
219
9c067ed4568b add pragma command to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 7209
diff changeset
220 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
221 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
222 .TP
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
223 \fBreindex\fP \fI[classname|designator]*\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
224 This will re-generate the search indexes for a tracker.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
225 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
226 \fBrestore\fP \fIdesignator[,designator]*\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
227 Restore the retired node specified by designator.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
228
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
229 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
230 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
231 \fBretire\fP \fIdesignator[,designator]*\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
232 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
233 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
234 also restore.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
235 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
236 \fBrollback\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
237 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
238
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
239 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
240 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
241 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
242 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
243 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
244 \fBsecurity\fP \fI[Role name]\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
245 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
246 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
247 \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
248 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
249
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
250 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
251 list of item designators (ie "designator[,designator,...]").
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
252
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
253 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
254 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
255 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
256 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
257 .TP
6172
78a7e54fbf41 Fix broken formatting directive.
John Rouillard <rouilj@ieee.org>
parents: 5968
diff changeset
258 \fBspecification\fP \fIclassname\fP
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
259 Show the properties for a classname.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
260 .TP
6957
f924af12ef50 issue2551233 - create new roundup-admin command "templates"
John Rouillard <rouilj@ieee.org>
parents: 6216
diff changeset
261 \fBtemplates\fP \fI[trace_search]]\fP
f924af12ef50 issue2551233 - create new roundup-admin command "templates"
John Rouillard <rouilj@ieee.org>
parents: 6216
diff changeset
262 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
263 .TP
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
264 \fBtable\fP \fIclassname [property[,property]*]\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
265 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
266 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
267 widths are the width of the largest value.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
268 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
269 \fBupdateconfig\fP \fI<filename>\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
270 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
271 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
272 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
273 .PP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
274 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
275 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
276
7098
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
277 .SH SECURITY NOTES
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
278
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
279 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
280 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
281 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
282 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
283 info contained in config.ini.
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
284
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
285 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
286 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
287 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
288 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
289 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
290 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
291 command line access to a tracker.
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
292
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
293 .SH ENVIRONMENT VARIABLES
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
294
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
295 .TP
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
296 \fBROUNDUP_LOGIN\fP
fbc0ac8555ca Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6957
diff changeset
297 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
298
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
299 .SH FURTHER HELP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
300 roundup-admin -h
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
301 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
302 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
303 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
304 .SH AUTHOR
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
305 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
306 <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
307
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
308 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
309 <richard@users.sourceforge.net>.
Roundup Issue Tracker: http://roundup-tracker.org/