Mercurial > p > roundup > code

annotate doc/admin_help.html @ 8506:b6c6891754e9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
bug: fix mis-commit of perf tests and crash fix for setTranslation The commit included more than it should have. It included some memory dump code that is not part of production. Also removed WIP for fixing crash bug when translation unable to create .mo file - issue2551405
author John Rouillard <rouilj@ieee.org>
date Thu, 25 Dec 2025 12:14:53 -0500
parents 8aaa22abe6cc
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1 <table>
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
2
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
3 <tr><td valign=top><strong>commit</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
4 <td><p><tt></tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
5
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
6 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
7 Commit changes made to the database during an interactive session.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
8 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
9 The changes made during an interactive session are not
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
10 automatically written to the database - they must be committed
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
11 using this command.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
12 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
13 One-off commands on the command-line are automatically committed if
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
14 they are successful.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
15 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
16 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
17
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
18
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
19 <tr><td valign=top><strong>create</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
20 <td><p><tt>classname property=value ...</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
21
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
22 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
23 Create a new entry of a given class.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
24 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
25 This creates a new entry of the given class using the property
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
26 name=value arguments provided on the command line after the "create"
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
27 command.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
28 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
29 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
30
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
31
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
32 <tr><td valign=top><strong>display</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
33 <td><p><tt>designator[,designator]*</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
34
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
35 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
36 Show the property values for the given node(s).
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
37 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
38 A designator is a classname and a nodeid concatenated,
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
39 eg. bug1, user10, ...
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
40 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
41 This lists the properties and their associated values
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
42 for the given node.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
43 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
44 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
45
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
46
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
47 <tr><td valign=top><strong>export</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
48 <td><p><tt>[[-]class[,class]] export_dir</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
49
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
50 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
51 Export the database and file content.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
52 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
53 Database content is exported to colon separated files.
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
54 To exclude the files (e.g. for the msg or file class),
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
55 use the exporttables command.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
56 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
57 Optionally limit the export to just the named classes
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
58 or exclude the named classes, if the 1st argument
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
59 starts with '-'.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
60 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
61 This action exports the current data from the database into
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
62 colon-separated-value files that are placed in the nominated
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
63 export_dir directory.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
64 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
65 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
66
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
67
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
68 <tr><td valign=top><strong>exporttables</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
69 <td><p><tt>[[-]class[,class]] export_dir</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
70
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
71 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
72 Export only the database to files, no file content.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
73 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
74 Database content is exported to colon separated files.
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
75 The files below $TRACKER_HOME/db/files/ (which can be
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
76 archived separately) are not part of the export.
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
77 To include the files, use the export command.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
78 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
79 Optionally limit the export to just the named classes
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
80 or exclude the named classes, if the 1st argument
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
81 starts with '-'.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
82 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
83 This action exports the current data from the database into
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
84 colon-separated-value files that are placed in the export_dir
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
85 destination directory.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
86 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
87 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
88
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
89
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
90 <tr><td valign=top><strong>filter</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
91 <td><p><tt>classname propname=value ...</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
92
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
93 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
94 Find the nodes of the given class with a given property value.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
95 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
96 Find the nodes of the given class with a given property value.
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
97 Multiple values can be specified by separating them with commas.
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
98 If property is a string, all values must match. I.E. it's an
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
99 'and' operation. If the property is a link/multilink any value
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
100 matches. I.E. an 'or' operation.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
101 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
102 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
103
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
104
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
105 <tr><td valign=top><strong>find</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
106 <td><p><tt>classname propname=value ...</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
107
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
108 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
109 Find the nodes of the given class with a given link property value.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
110 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
111 Find the nodes of the given class with a given link property value.
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
112 The value may be either the nodeid of the linked node, or its key
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
113 value.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
114 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
115 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
116
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
117
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
118 <tr><td valign=top><strong>genconfig</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
119 <td><p><tt>filename</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
120
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
121 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
122 Create a new tracker config file with default values in filename.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
123 See also updateconfig.
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
124 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
125 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
126
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
127
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
128 <tr><td valign=top><strong>get</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
129 <td><p><tt>property designator[,designator]*</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
130
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
131 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
132 Get the given property of one or more designator(s).
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
133 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
134 A designator is a classname and a nodeid concatenated,
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
135 eg. bug1, user10, ...
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
136 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
137 Retrieves the property value of the nodes specified
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
138 by the designators.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
139 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
140 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
141
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
142
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
143 <tr><td valign=top><strong>help</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
144 <td><p><tt>topic</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
145
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
146 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
147 Give help about topic.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
148 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
149 commands -- list commands
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
150 &lt;command&gt; -- help specific to a command
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
151 initopts -- init command options
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
152 all -- all available help
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
153 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
154 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
155
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
156
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
157 <tr><td valign=top><strong>history</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
158 <td><p><tt>designator [skipquiet] [raw]</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
159
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
160 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
161 Show the history entries of a designator.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
162 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
163 A designator is a classname and a nodeid concatenated,
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
164 eg. bug1, user10, ...
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
165 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
166 Lists the journal entries viewable by the user for the node
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
167 identified by the designator. If skipquiet is added, journal
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
168 entries for quiet properties are not shown. If raw is added,
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
169 the output is the raw representation of the journal entries.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
170 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
171 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
172
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
173
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
174 <tr><td valign=top><strong>import</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
175 <td><p><tt>import_dir</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
176
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
177 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
178 Import a database and file contents from the directory.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
179 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
180 The directory should have the same format as one containing
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
181 the output of export. There are two files imported per class.
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
182 The files used in the import are:
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
183 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
184 &lt;class&gt;.csv
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
185 This must define the same properties as the class
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
186 (including having a "header" line with those
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
187 property names.)
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
188 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
189 &lt;class&gt;-journals.csv
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
190 This defines the journals for the items
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
191 being imported.
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
192 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
193 The imported nodes will have the same nodeid as defined in the
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
194 import file, thus replacing any existing content.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
195 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
196 The new nodes are added to the existing database - if you want to
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
197 create a new database using the imported data, then create a new
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
198 database (or, tediously, retire all the old data.)
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
199 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
200 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
201
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
202
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
203 <tr><td valign=top><strong>importtables</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
204 <td><p><tt>export_dir</tt></p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
205
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
206 <p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
207 This imports the database tables exported using exporttables.
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
208 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
209 It does not import the content of files like msgs and files.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
210 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
211 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
212
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
213
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
214 <tr><td valign=top><strong>initialise</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
215 <td><p><tt>[adminpw]</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
216
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
217 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
218 Initialise a new Roundup tracker.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
219 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
220 The administrator details will be set at this step.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
221 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
222 Execute the tracker's initialisation function dbinit.init()
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
223 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
224 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
225
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
226
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
227 <tr><td valign=top><strong>install</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
228 <td><p><tt>[template [backend [key=val[,key=val]]]]</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
229
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
230 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
231 Install a new Roundup tracker.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
232 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
233 The command will prompt for the tracker home directory
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
234 (if not supplied through TRACKER_HOME or the -i option).
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
235 The template and backend may be specified on the command-line
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
236 as arguments, in that order.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
237 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
238 Command line arguments following the backend allows you to
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
239 pass initial values for config options. For example, passing
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
240 "web_http_auth=no,rdbms_user=dinsdale" will override defaults
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
241 for options http_auth in section [web] and user in section [rdbms].
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
242 Please be careful to not use spaces in this argument! (Enclose
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
243 whole argument in quotes if you need spaces in option value).
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
244 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
245 The initialise command must be called after this command in order
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
246 to initialise the tracker's database. You may edit the tracker's
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
247 initial database contents before running that command by editing
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
248 the tracker's dbinit.py module init() function.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
249 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
250 See also initopts help.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
251 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
252 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
253
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
254
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
255 <tr><td valign=top><strong>list</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
256 <td><p><tt>classname [property]</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
257
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
258 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
259 List the instances of a class.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
260 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
261 Lists all instances of the given class. If the property is not
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
262 specified, the "label" property is used. The label property is
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
263 tried in order: the key, "name", "title" and then the first
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
264 property, alphabetically.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
265 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
266 With -c, -S or -s print a list of item id's if no property
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
267 specified. If property specified, print list of that property
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
268 for every class instance.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
269 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
270 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
271
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
272
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
273 <tr><td valign=top><strong>migrate</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
274 <td><p><tt></tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
275
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
276 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
277 Update a tracker's database to be compatible with the Roundup
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
278 codebase.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
279 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
280 You should run the "migrate" command for your tracker once
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
281 you've installed the latest codebase.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
282 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
283 Do this before you use the web, command-line or mail interface
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
284 and before any users access the tracker.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
285 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
286 This command will respond with either "Tracker updated" (if
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
287 you've not previously run it on an RDBMS backend) or "No
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
288 migration action required" (if you have run it, or have used
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
289 another interface to the tracker, or possibly because you are
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
290 using anydbm).
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
291 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
292 It's safe to run this even if it's not required, so just get
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
293 into the habit.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
294 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
295 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
296
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
297
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
298 <tr><td valign=top><strong>pack</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
299 <td><p><tt>period | date</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
300
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
301 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
302 Remove journal entries older than the date/period.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
303 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
304 A period is specified using the suffixes "y", "m", and "d". The
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
305 suffix "w" (for "week") means 7 days.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
306 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
307 <pre> "3y" means three years</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
308 <pre> "2y 1m" means two years and one month</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
309 <pre> "1m 25d" means one month and 25 days</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
310 <pre> "2w 3d" means two weeks and three days</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
311 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
312 Date format is "YYYY-MM-DD" eg:
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
313 <pre> 2001-01-01</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
314 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
315 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
316 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
317
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
318
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
319 <tr><td valign=top><strong>perftest</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
320 <td><p><tt>[mode] [arguments]*</tt></p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
321
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
322 <p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
323 Time operations in Roundup.
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
324 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
325 Supported arguments:
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
326 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
327 <pre> [password] [rounds=&lt;integer&gt;] [scheme=&lt;scheme&gt;]</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
328 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
329 'password' is the default mode. The tracker's config.ini
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
330 setting for 'password_pbkdf2_default_rounds' is the default
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
331 value for 'rounds'. On the command line, 'rounds' can include
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
332 thousands separator of ',' or '.'. 'scheme' is the default
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
333 coded into Roundup. List supported schemes by using 'scheme='.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
334 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
335 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
336 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
337
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
338
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
339 <tr><td valign=top><strong>pragma</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
340 <td><p><tt>setting=value | 'list'</tt></p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
341
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
342 <p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
343 Set internal admin settings to a value.
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
344 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
345 For example:
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
346 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
347 <pre> pragma verbose=True</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
348 <pre> pragma verbose=yes</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
349 <pre> pragma verbose=on</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
350 <pre> pragma verbose=1</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
351 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
352 will turn on verbose mode for roundup-admin.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
353 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
354 <pre> pragma list</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
355 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
356 will show all settings and their current values. If verbose
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
357 is enabled hidden settings and descriptions will be shown.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
358 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
359 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
360
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
361
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
362 <tr><td valign=top><strong>reindex</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
363 <td><p><tt>[classname|classname:#-#|designator]*</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
364
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
365 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
366 Re-generate a tracker's search indexes.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
367 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
368 This will re-generate the search indexes for a tracker.
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
369 This will typically happen automatically.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
370 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
371 You can incrementally reindex using an argument like:
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
372 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
373 <pre> reindex issue:23-1000</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
374 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
375 to reindex issue class items 23-1000. Missing items
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
376 are reported but do not stop indexing of the range.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
377 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
378 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
379
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
380
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
381 <tr><td valign=top><strong>restore</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
382 <td><p><tt>designator[,designator]*</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
383
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
384 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
385 Restore the retired node specified by designator.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
386 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
387 A designator is a classname and a nodeid concatenated,
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
388 eg. bug1, user10, ...
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
389 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
390 The given nodes will become available for users again.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
391 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
392 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
393
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
394
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
395 <tr><td valign=top><strong>retire</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
396 <td><p><tt>designator[,designator]*</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
397
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
398 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
399 Retire the node specified by designator.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
400 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
401 A designator is a classname and a nodeid concatenated,
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
402 eg. bug1, user10, ...
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
403 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
404 This action indicates that a particular node is not to be retrieved
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
405 by the list or find commands, and its key value may be re-used.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
406 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
407 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
408
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
409
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
410 <tr><td valign=top><strong>rollback</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
411 <td><p><tt></tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
412
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
413 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
414 Undo all changes that are pending commit to the database.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
415 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
416 The changes made during an interactive session are not
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
417 automatically written to the database - they must be committed
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
418 manually. This command undoes all those changes, so a commit
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
419 immediately after would make no changes to the database.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
420 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
421 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
422
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
423
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
424 <tr><td valign=top><strong>security</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
425 <td><p><tt>[Role name]</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
426
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
427 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
428 Display the Permissions available to one or all Roles.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
429 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
430 Also validates that any properties defined in a
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
431 permission are valid.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
432 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
433 Run this after changing your permissions to catch
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
434 typos.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
435 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
436 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
437
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
438
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
439 <tr><td valign=top><strong>set</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
440 <td><p><tt>items property=value [property=value ...]</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
441
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
442 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
443 Set the given properties of one or more items(s).
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
444 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
445 The items are specified as a class or as a comma-separated
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
446 list of item designators (ie "designator[,designator,...]").
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
447 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
448 A designator is a classname and a nodeid concatenated,
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
449 eg. bug1, user10, ...
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
450 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
451 This command sets the properties to the values for all
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
452 designators given. If a class is used, the property will be
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
453 set for all items in the class. If the value is missing
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
454 (ie. "property=") then the property is un-set. If the property
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
455 is a multilink, you specify the linked ids for the multilink
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
456 as comma-separated numbers (ie "1,2,3").
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
457 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
458 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
459 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
460
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
461
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
462 <tr><td valign=top><strong>specification</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
463 <td><p><tt>classname</tt></p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
464
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
465 <p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
466 Show the properties for a classname.
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
467 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
468 This lists the properties for a given class.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
469 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
470 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
471
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
472
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
473 <tr><td valign=top><strong>table</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
474 <td><p><tt>classname [property[,property]*]</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
475
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
476 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
477 List the instances of a class in tabular form.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
478 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
479 Lists all instances of the given class. If the properties are not
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
480 specified, all properties are displayed. By default, the column
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
481 widths are the width of the largest value. The width may be
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
482 explicitly defined by defining the property as "name:width".
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
483 For example::
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
484 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
485 <pre> roundup&gt; table priority id,name:10</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
486 <pre> Id Name</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
487 <pre> 1 fatal-bug</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
488 <pre> 2 bug</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
489 <pre> 3 usability</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
490 <pre> 4 feature</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
491 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
492 Also to make the width of the column the width of the label,
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
493 leave a trailing : without a width on the property. For example::
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
494 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
495 <pre> roundup&gt; table priority id,name:</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
496 <pre> Id Name</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
497 <pre> 1 fata</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
498 <pre> 2 bug</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
499 <pre> 3 usab</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
500 <pre> 4 feat</pre>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
501 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
502 will result in a the 4 character wide "Name" column.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
503 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
504 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
505
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
506
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
507 <tr><td valign=top><strong>templates</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
508 <td><p><tt>[trace_search]</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
509
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
510 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
511 List templates and their installed directories.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
512 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
513 With trace_search also list all directories that are
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
514 searched for templates.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
515 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
516 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
517
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
518
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
519 <tr><td valign=top><strong>updateconfig</strong></td>
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
520 <td><p><tt>&lt;filename&gt;</tt></p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
521
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
522 <p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
523 Merge existing tracker config with new settings.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
524 </p><p>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
525 Output the updated config file to &lt;filename&gt;. Use current
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
526 settings from existing roundup tracker in tracker home.
8394
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
527 </p><p>
8aaa22abe6cc doc: commit new generated admin help output.
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
528 </td></tr>
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
529
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
530 </table>
Roundup Issue Tracker: http://roundup-tracker.org/