Mercurial > p > roundup > code

annotate share/man/man1/roundup-admin.1 @ 6176:d25638d1826c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add roundup-admin filter command; fix bad doc example; add tests admin_guide.txt had an example using find with username prop. This is wrong. Find only works with links not string. Fix it to use filter. Add filter command to roundup-admin. Add tests for filter, specification and find.
author John Rouillard <rouilj@ieee.org>
date Mon, 18 May 2020 23:28:03 -0400
parents 78a7e54fbf41
children 9d3b4472a47d
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]
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
12 The user and password to use for commands
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
13 \fB-h\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
14 Print help text.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
15 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
16 \fB-d\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
17 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
18 .TP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
19 \fB-c\fP
4706
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
20 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
21 \fB-S ","\fP.
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
22 .TP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
23 \fB-S\fP \fIstring\fP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
24 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
25 .TP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
26 \fB-s\fP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
27 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
28 \fB-S " "\fP.
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
29 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
30 \fB-V\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
31 Be verbose when importing data.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
32 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
33 \fB-v\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
34 Report Roundup and Python versions and quit.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
35 .PP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
36 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
37 .SH COMMANDS
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
38 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
39 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
40 available using the help command.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
41
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
42 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
43 eg. bug1, user10, ....
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
44
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
45 Roundup-admin takes a number of commands:
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
46 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
47 \fBhelp\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
48 prints help (same as \fB-h\fP)
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
49 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
50 \fBhelp\fP \fI<subcommand>\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
51 Print command-specific help
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 all\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
54 Print available help for all commands.
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 \fBcommit\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
57 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
58
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
59 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
60 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
61 using this command.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
62
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
63 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
64 they are successful. See also rollback.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
65 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
66 \fBcreate\fP \fIclassname property=value ...\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
67 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
68 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
69 command.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
70 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
71 \fBdisplay\fP \fIdesignator[,designator]*\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
72 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
73 node.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
74 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
75 \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
76 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
77 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
78 use the exporttables command.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
79
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
80 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
81 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
82
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
83 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
84 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
85 destination directory.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
86 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
87 \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
88 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
89 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
90 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
91 .TP
6176
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6172
diff changeset
92 \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
93 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
94 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
95 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
96 '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
97 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
98 .TP
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
99 \fBfind\fP \fIclassname propname=value ...\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
100 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
101 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
102 \fBgenconfig\fP \fI<filename>\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
103 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
104 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
105 the current tracker. Use updateconfig for that.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
106 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
107 \fBget\fP \fIproperty designator[,designator]*\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
108 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
109
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
110 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
111 by the designators.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
112
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
113 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
114 \fBhistory\fP \fIdesignator [skipquiet]\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
115 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
116 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
117 second argument, journal entries for quiet properties
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
118 are not shown.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
119 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
120 \fBimport\fP \fIimport_dir\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
121 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
122 two per class to import.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
123
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
124 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
125 import file, thus replacing any existing content.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
126
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
127 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
128 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
129 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
130 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
131 \fBinitialise\fP \fI[adminpw]\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
132 Initialise a new Roundup tracker.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
133
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
134 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
135 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
136 \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
137 Install a new roundup tracker.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
138
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
139 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
140 (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
141 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
142 as arguments, in that order.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
143
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
144 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
145 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
146 "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
147 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
148 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
149 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
150
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
151 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
152 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
153 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
154 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
155
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
156 See also initopts help.
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 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
159 \fBlist\fP \fIclassname [property]\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
160 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
161 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
162 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
163 property, alphabetically.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
164
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
165 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
166 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
167 property for every class instance.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
168 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
169 \fBmigrate\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
170 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
171 codebase.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
172
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
173 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
174 installed the latest codebase.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
175
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
176 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
177 before any users access the tracker.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
178
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
179 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
180 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
181 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
182 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
183
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
184 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
185 the habit.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
186 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
187 \fBpack\fP \fIperiod | date\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
188 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
189 before a certain date.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
190 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
191 \fBreindex\fP \fI[classname|designator]*\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
192 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
193 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
194 \fBrestore\fP \fIdesignator[,designator]*\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
195 Restore the retired node specified by designator.
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 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
198 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
199 \fBretire\fP \fIdesignator[,designator]*\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
200 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
201 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
202 also restore.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
203 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
204 \fBrollback\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
205 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
206
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
207 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
208 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
209 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
210 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
211 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
212 \fBsecurity\fP \fI[Role name]\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
213 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
214 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
215 \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
216 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
217
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
218 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
219 list of item designators (ie "designator[,designator,...]").
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
220
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
221 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
222 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
223 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
224 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
225 .TP
6172
78a7e54fbf41 Fix broken formatting directive.
John Rouillard <rouilj@ieee.org>
parents: 5968
diff changeset
226 \fBspecification\fP \fIclassname\fP
5968
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
227 Show the properties for a classname.
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
228 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
229 \fBtable\fP \fIclassname [property[,property]*]\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
230 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
231 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
232 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
233 .TP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
234 \fBupdateconfig\fP \fI<filename>\fP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
235 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
236 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
237 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
238 .PP
e8d64096fb08 issue2550885 - man page documentation update. roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
239 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
240 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
241
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
242 .SH FURTHER HELP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
243 roundup-admin -h
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
244 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
245 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
246 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
247 .SH AUTHOR
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
248 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
249 <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
250
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
251 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
252 <richard@users.sourceforge.net>.
Roundup Issue Tracker: http://roundup-tracker.org/