Mercurial > p > roundup > code

comparison doc/user_guide.txt @ 1098:c5819344714c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
more doc
author Richard Jones <richard@users.sourceforge.net>
date Tue, 10 Sep 2002 07:07:16 +0000
parents 43ab730ee194
children cd58a8603424
comparison
equal deleted inserted replaced
1097:98f3d41f41d9 1098:c5819344714c
1 ========== 1 ==========
2 User Guide 2 User Guide
3 ========== 3 ==========
4 4
5 :Version: $Revision: 1.6 $ 5 :Version: $Revision: 1.7 $
6 6
7 .. contents:: 7 .. contents::
8 8
9 Note: this document will refer to *issues* as the primary store of information 9 Note: this document will refer to *issues* as the primary store of information
10 in the tracker. This is the default of the classic template, bubt may vary in 10 in the tracker. This is the default of the classic template, bubt may vary in
13 Web Interface 13 Web Interface
14 ------------- 14 -------------
15 15
16 Index views may be modified by the following arguments: 16 Index views may be modified by the following arguments:
17 17
18 +-----------+--------------------------------------------------------------+ 18 ========== =============================================================
19 | :sort | sort by prop name, optionally preceeded with '-' | 19 Argument Description
20 | | to give descending or nothing for ascending sorting. | 20 ========== =============================================================
21 +-----------+--------------------------------------------------------------+ 21 :sort sort by prop name, optionally preceeded with '-'
22 | :group | group by prop name, optionally preceeded with '-' or | 22 to give descending or nothing for ascending sorting.
23 | | to sort in descending or nothing for ascending order. | 23 :group group by prop name, optionally preceeded with '-' or
24 +-----------+--------------------------------------------------------------+ 24 to sort in descending or nothing for ascending order.
25 | :filter | selects which props should be displayed in the filter | 25 :filter selects which props should be displayed in the filter
26 | | section. Default is all. | 26 section. Default is all.
27 +-----------+--------------------------------------------------------------+ 27 :columns selects the columns that should be displayed.
28 | :columns | selects the columns that should be displayed. | 28 Default is all.
29 | | Default is all. | 29 propname selects the values the item properties given by propname
30 +-----------+--------------------------------------------------------------+ 30 must have (very basic search/filter).
31 | propname | selects the values the item properties given by propname | 31 ========== =============================================================
32 | | must have (very basic search/filter). |
33 +-----------+--------------------------------------------------------------+
34 32
35 Searching 33 Searching
36 ~~~~~~~~~ 34 ~~~~~~~~~
37 35
38 TODO: some information about how searching works 36 TODO: some information about how searching works
190 188
191 189
192 Command Line Tool 190 Command Line Tool
193 ----------------- 191 -----------------
194 192
195 Usage: ``roundup-admin [-i tracker home] [-u login] [-c] <command> <arguments>`` 193 The basic usage is::
196 194
197 Options: 195 Help:
198 196 roundup-admin -h
199 -i tracker home specify the issue tracker "home directory" to administer 197 roundup-admin help -- this help
200 -u the ``user[:password]`` to use for commands 198 roundup-admin help <command> -- command-specific help
201 -c when outputting lists of data, comma-separate them 199 roundup-admin help all -- all available help
202 200
203 +-----------------------------------------------------------------------------+ 201 Options:
204 | Command Help | 202 -i instance home -- specify the issue tracker "home directory" to administer
205 +=============+===============================================================+ 203 -u -- the user[:password] to use for commands
206 |commit |Usage: commit | 204 -c -- when outputting lists of data, just comma-separate them
207 | |The changes made during an interactive session are not | 205
208 | |automatically written to the database - they must be committed | 206 Commands:
209 | |using this command. | 207 commit
210 | | | 208 create classname property=value ...
211 | |One-off commands on the command-line are automatically | 209 display designator
212 | |committed if they are successful. | 210 export [class[,class]] export_dir
213 +-------------+---------------------------------------------------------------+ 211 find classname propname=value ...
214 |create |Usage: create classname property=value ... | 212 get property designator[,designator]*
215 | |This creates a new entry of the given class using the property | 213 help topic
216 | |name=value arguments provided on the command line after the | 214 history designator
217 | |"create" command. | 215 import import_dir
218 +-------------+---------------------------------------------------------------+ 216 initialise [adminpw]
219 |display |Usage: display designator | 217 install [template [backend [admin password]]]
220 | |This lists the properties and their associated values for the | 218 list classname [property]
221 | |given item. | 219 pack period | date
222 +-------------+---------------------------------------------------------------+ 220 reindex
223 |export |Usage: export class[,class] destination dir | 221 retire designator[,designator]*
224 | |This action exports the current data from the database into | 222 rollback
225 | |tab-separated-value files that are placed in the nominated | 223 security [Role name]
226 | |destination | 224 set designator[,designator]* propname=value ...
227 | |directory. The journals are not exported. | 225 specification classname
228 +-------------+---------------------------------------------------------------+ 226 table classname [property[,property]*]
229 |find |Usage: find classname propname=value ... | 227
230 | |Find the items of the given class with a given link property | 228 Commands may be abbreviated as long as the abbreviation matches only one
231 | |value. The | 229 command, e.g. l == li == lis == list.
232 | |value may be either the itemid of the linked item, or its key | 230
233 | |value. | 231 All commands (except help) require a tracker specifier. This is just the
234 +-------------+---------------------------------------------------------------+ 232 path to the roundup tracker you're working with. A roundup tracker is where
235 |get |Usage: get property designator[,designator]* | 233 roundup keeps the database and configuration file that defines an issue
236 | |Retrieves the property value of the items specified by the | 234 tracker. It may be thought of as the issue tracker's "home directory".
237 | |designators. | 235 It may be specified in the environment variable ``TRACKER_HOME`` or on
238 +-------------+---------------------------------------------------------------+ 236 the command line as "``-i tracker``".
239 |help |Usage: help topic |
240 | |commands -- list commands |
241 | |x -- help specific to a command |
242 | |initopts -- init command options |
243 | |all -- all available help |
244 +-------------+---------------------------------------------------------------+
245 |history |Usage: history designator |
246 | |Lists the journal entries for the item identified by the |
247 | |designator. |
248 +-------------+---------------------------------------------------------------+
249 |import |Usage: import class file |
250 | |The file must define the same properties as the class |
251 | |(including having |
252 | |a "header" line with those property names.) The new items are |
253 | |added to |
254 | |the existing database - if you want to create a new database |
255 | |using the |
256 | |imported data, then create a new database (or, tediously, |
257 | |retire all |
258 | |the old data.) |
259 +-------------+---------------------------------------------------------------+
260 |initialise |Usage: initialise [template [backend [admin password]]] |
261 | |The command will prompt for the tracker home directory (if not |
262 | |supplied |
263 | |through INSTANCE HOME or the -i option. The template, backend |
264 | |and admin |
265 | |password may be specified on the command-line as arguments, in |
266 | |that |
267 | |order. |
268 | | |
269 | |See also initopts help. |
270 +-------------+---------------------------------------------------------------+
271 |list |Usage: list classname [property] |
272 | |Lists all trackers of the given class. If the property is not |
273 | |specified, the "label" property is used. The label property is|
274 | |tried |
275 | |in order: the key, "name", "title" and then the first property,|
276 | |alphabetically. |
277 +-------------+---------------------------------------------------------------+
278 |retire |Usage: retire designator[,designator]* |
279 | |This action indicates that a particular item is not to be |
280 | |retrieved by |
281 | |the list or find commands, and its key value may be re-used. |
282 +-------------+---------------------------------------------------------------+
283 |rollback |Usage: rollback |
284 | |The changes made during an interactive session are not |
285 | |automatically written to the database - they must be committed |
286 | |manually. This command undoes all those changes, so a commit |
287 | |immediately after would make no changes to the database. |
288 +-------------+---------------------------------------------------------------+
289 |set |Usage: set designator[,designator]* propname=value ... |
290 | |Sets the property to the value for all designators given. |
291 +-------------+---------------------------------------------------------------+
292 |specification|Usage: specification classname |
293 | |This lists the properties for a given class. |
294 +-------------+---------------------------------------------------------------+
295 |table |Usage: table classname [property[,property]*] |
296 | |Lists all trackers of the given class. If the properties are |
297 | |not |
298 | |specified, all properties are displayed. By default, the column|
299 | |widths |
300 | |are the width of the property names. The width may be |
301 | |explicitly defined |
302 | |by defining the property as "name:width". For example:: |
303 | | |
304 | | roundup> table priority id,name:10 |
305 | | Id Name |
306 | | 1 fatal-bug |
307 | | 2 bug |
308 | | 3 usability |
309 | | 4 feature |
310 +-------------+---------------------------------------------------------------+
311
312
313 All commands (except help) require a tracker specifier. This is just the path to
314 the roundup tracker you're working with. A roundup tracker is where roundup
315 keeps the database and configuration file that defines an issue tracker. It may be
316 thought of as the issue tracker's "home directory". It may be specified in the
317 environment variable ``ROUNDUP_INSTANCE`` or on the command line as "``-i
318 tracker``".
319 237
320 A designator is a classname and an itemid concatenated, eg. bug1, user10, ... 238 A designator is a classname and an itemid concatenated, eg. bug1, user10, ...
321 Property values are represented as strings in command arguments and in the printed 239 Property values are represented as strings in command arguments and in the printed
322 results: 240 results:
323 241
342 - Multilink values are printed as lists of item designators joined by 260 - Multilink values are printed as lists of item designators joined by
343 commas. When given as an argument, item designators and key strings are 261 commas. When given as an argument, item designators and key strings are
344 both accepted; an empty string, a single item, or a list of items joined 262 both accepted; an empty string, a single item, or a list of items joined
345 by commas is accepted. 263 by commas is accepted.
346 264
347 When multiple items are specified to the roundup get or roundup set commands, the 265 When multiple items are specified to the roundup get or roundup set
348 specified properties are retrieved or set on all the listed items. When multiple 266 commands, the specified properties are retrieved or set on all the listed
349 results are returned by the roundup get or roundup find commands, they are printed 267 items. When multiple results are returned by the roundup get or roundup
350 one per line (default) or joined by commas (with the "``-c``" option). 268 find commands, they are printed one per line (default) or joined by commas
269 (with the "``-c``" option).
351 270
352 Where the command changes data, a login name/password is required. The login may 271 Where the command changes data, a login name/password is required. The login may
353 be specified as either "``name``" or "``name:password``". 272 be specified as either "``name``" or "``name:password``".
354 273
355 - ``ROUNDUP_LOGIN`` environment variable 274 - ``ROUNDUP_LOGIN`` environment variable
Roundup Issue Tracker: http://roundup-tracker.org/