Mercurial > p > roundup > code

comparison doc/index.html @ 461:b579418f7ed1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Implemented file store rollback. As a bonus, the hyperdb is now capable of storing more than one file per node - if a property name is supplied, the file is called designator.property. I decided not to migrate the existing files stored over to the new naming scheme - the FileClass just doesn't specify the property name.
author Richard Jones <richard@users.sourceforge.net>
date Mon, 17 Dec 2001 03:52:48 +0000
parents 141aacfdb34f
children d35e51360175
comparison
equal deleted inserted replaced
460:9c895b44240a 461:b579418f7ed1
1 <html><head> 1 <html><head>
2 <title>Roundup: an Issue-Tracking System for Knowledge Workers</title> 2 <title>Roundup: an Issue-Tracking System for Knowledge Workers</title>
3 </head><body> 3 </head><body>
4 4
5 <h1 align=center>Roundup (0.3.0)</h1> 5 <h1 align=center>Roundup (0.3.1)</h1>
6 <h3 align=center>An Issue-Tracking System for Knowledge Workers</h2> 6 <h3 align=center>An Issue-Tracking System for Knowledge Workers</h2>
7 7
8 <h1>Contents</h1> 8 <h1>Contents</h1>
9 9
10 <ul> 10 <ul>
44 <h1><a name="installation">Installation</a></h1> 44 <h1><a name="installation">Installation</a></h1>
45 45
46 46
47 <h2><a name="requires">Prerequisites</a></h2> 47 <h2><a name="requires">Prerequisites</a></h2>
48 48
49 <dl> 49 <p>
50 <dd>Python 2.1.1 is required for the correct operation of roundup 50 Python 2.1.1 is required for the correct operation of roundup.
51 </dl> 51 </p>
52 52
53 <p>
53 Download the latest version from 54 Download the latest version from
54 <a href="http://www.python.org/">http://www.python.org/</a>. 55 <a href="http://www.python.org/">http://www.python.org/</a>.
56 </p>
55 57
56 58
57 59
58 <h2><a name="getting">Getting Roundup</a></h2> 60 <h2><a name="getting">Getting Roundup</a></h2>
59 61
340 <tr><td>-c </td><td>when outputting lists of data, just comma-separate them 342 <tr><td>-c </td><td>when outputting lists of data, just comma-separate them
341 </td></tr> 343 </td></tr>
342 </table> 344 </table>
343 345
344 <p> 346 <p>
345 <table border=1 cellspacing=0> 347 <table width=100% border=1 cellspacing=0>
346 <tr><th colspan=2>Command Help</th></tr> 348 <tr><th colspan=2>Command Help</th></tr>
349
350
351 <tr><td valign=top><strong>commit</strong></td>
352 <td><tt>Usage: commit</tt><p>
353 <pre>
354 The changes made during an interactive session are not
355 automatically written to the database - they must be committed
356 using this command.
357
358 One-off commands on the command-line are automatically committed if
359 they are successful.
360
361 </pre></td></tr>
362
363
364 <tr><td valign=top><strong>create</strong></td>
365 <td><tt>Usage: create classname property=value ...</tt><p>
366 <pre>
367 This creates a new entry of the given class using the property
368 name=value arguments provided on the command line after the "create"
369 command.
370
371 </pre></td></tr>
372
373
374 <tr><td valign=top><strong>display</strong></td>
375 <td><tt>Usage: display designator</tt><p>
376 <pre>
377 This lists the properties and their associated values for the given
378 node.
379
380 </pre></td></tr>
381
382
383 <tr><td valign=top><strong>export</strong></td>
384 <td><tt>Usage: export class[,class] destination_dir</tt><p>
385 <pre>
386 This action exports the current data from the database into
387 tab-separated-value files that are placed in the nominated destination
388 directory. The journals are not exported.
389
390 </pre></td></tr>
391
392
393 <tr><td valign=top><strong>find</strong></td>
394 <td><tt>Usage: find classname propname=value ...</tt><p>
395 <pre>
396 Find the nodes of the given class with a given link property value. The
397 value may be either the nodeid of the linked node, or its key value.
398
399 </pre></td></tr>
400
401
402 <tr><td valign=top><strong>get</strong></td>
403 <td><tt>Usage: get property designator[,designator]*</tt><p>
404 <pre>
405 Retrieves the property value of the nodes specified by the designators.
406
407 </pre></td></tr>
408
409
410 <tr><td valign=top><strong>help</strong></td>
411 <td><tt>Usage: help topic</tt><p>
412 <pre>
413 commands -- list commands
414 <command> -- help specific to a command
415 initopts -- init command options
416 all -- all available help
417
418 </pre></td></tr>
419
420
347 <tr><td valign=top><strong>history</strong></td> 421 <tr><td valign=top><strong>history</strong></td>
348 <td><tt>history designator</tt><p> 422 <td><tt>Usage: history designator</tt><p>
349 Lists the journal entries for the node identified by the designator. 423 <pre>
350 </td></tr> 424 Lists the journal entries for the node identified by the designator.
351 425
352 <tr><td valign=top><strong>find</strong></td> 426 </pre></td></tr>
353 <td><tt>find classname propname=value ...</tt><p> 427
354 Find the nodes of the given class with a given property value. The 428
355 value may be either the nodeid of the linked node, or its key value. 429 <tr><td valign=top><strong>import</strong></td>
356 </td></tr> 430 <td><tt>Usage: import class file</tt><p>
357 431 <pre>
432 The file must define the same properties as the class (including having
433 a "header" line with those property names.) The new nodes are added to
434 the existing database - if you want to create a new database using the
435 imported data, then create a new database (or, tediously, retire all
436 the old data.)
437
438 </pre></td></tr>
439
440
441 <tr><td valign=top><strong>initialise</strong></td>
442 <td><tt>Usage: initialise [template [backend [admin password]]]</tt><p>
443 <pre>
444 The command will prompt for the instance home directory (if not supplied
445 through INSTANCE_HOME or the -i option. The template, backend and admin
446 password may be specified on the command-line as arguments, in that
447 order.
448
449 See also initopts help.
450
451 </pre></td></tr>
452
453
358 <tr><td valign=top><strong>list</strong></td> 454 <tr><td valign=top><strong>list</strong></td>
359 <td><tt>list classname [property]</tt><p> 455 <td><tt>Usage: list classname [property]</tt><p>
360 Lists all instances of the given class along. If the property is not 456 <pre>
361 specified, the "label" property is used. The label property is tried 457 Lists all instances of the given class. If the property is not
362 in order: the key, "name", "title" and then the first property, 458 specified, the "label" property is used. The label property is tried
363 alphabetically. 459 in order: the key, "name", "title" and then the first property,
364 </td></tr> 460 alphabetically.
365 461
462 </pre></td></tr>
463
464
366 <tr><td valign=top><strong>retire</strong></td> 465 <tr><td valign=top><strong>retire</strong></td>
367 <td><tt>retire designator[,designator]*</tt><p> 466 <td><tt>Usage: retire designator[,designator]*</tt><p>
368 This action indicates that a particular node is not to be retrieved by 467 <pre>
369 the list or find commands, and its key value may be re-used. 468 This action indicates that a particular node is not to be retrieved by
370 </td></tr> 469 the list or find commands, and its key value may be re-used.
371 470
372 <tr><td valign=top><strong>create</strong></td> 471 </pre></td></tr>
373 <td><tt>create classname property=value ...</tt><p> 472
374 This creates a new entry of the given class using the property 473
375 name=value arguments provided on the command line after the "create" 474 <tr><td valign=top><strong>rollback</strong></td>
376 command. 475 <td><tt>Usage: rollback</tt><p>
377 </td></tr> 476 <pre>
378 477 The changes made during an interactive session are not
379 <tr><td valign=top><strong>get</strong></td> 478 automatically written to the database - they must be committed
380 <td><tt>get property designator[,designator]*</tt><p> 479 manually. This command undoes all those changes, so a commit
381 Retrieves the property value of the nodes specified by the designators. 480 immediately after would make no changes to the database.
382 </td></tr> 481
383 482 </pre></td></tr>
384 <tr><td valign=top><strong>spec</strong></td> 483
385 <td><tt>spec classname</tt><p> 484
386 This lists the properties for a given class.
387 </td></tr>
388
389 <tr><td valign=top><strong>set</strong></td> 485 <tr><td valign=top><strong>set</strong></td>
390 <td><tt>set designator[,designator]* propname=value ...</tt><p> 486 <td><tt>Usage: set designator[,designator]* propname=value ...</tt><p>
391 Sets the property to the value for all designators given. 487 <pre>
392 </td></tr> 488 Sets the property to the value for all designators given.
393 489
394 <tr><td valign=top><strong>init</strong></td> 490 </pre></td></tr>
395 <td><tt>init [template [backend [admin password]]]</tt><p> 491
396 The command will prompt for the instance home directory (if not supplied 492
397 through INSTANCE_HOME or the -i option. The template, backend and admin 493 <tr><td valign=top><strong>specification</strong></td>
398 password may be specified on the command-line as arguments, in that order. 494 <td><tt>Usage: specification classname</tt><p>
399 </td></tr> 495 <pre>
400 496 This lists the properties for a given class.
401 <tr><td valign=top><strong>export</strong></td> 497
402 <td><tt>export class[,class] destination_dir</tt><p> 498 </pre></td></tr>
403 This action exports the current data from the database into 499
404 comma-separated files that are placed in the nominated destination 500
405 directory. The journals are not exported. 501 <tr><td valign=top><strong>table</strong></td>
406 </td></tr> 502 <td><tt>Usage: table classname [property[,property]*]</tt><p>
407 503 <pre>
408 <tr><td valign=top><strong>import</strong></td> 504 Lists all instances of the given class. If the properties are not
409 <td><tt>import class file</tt><p> 505 specified, all properties are displayed. By default, the column widths
410 The file must define the same properties as the class (including having 506 are the width of the property names. The width may be explicitly defined
411 a "header" line with those property names.) 507 by defining the property as "name:width". For example::
412 </td></tr> 508 roundup> table priority id,name:10
413 509 Id Name
414 <tr><td valign=top><strong>freshen</strong></td> 510 1 fatal-bug
415 <td><tt>freshen</tt><p> 511 2 bug
416 <strong>**DO NOT USE**</strong> 512 3 usability
417 <p> 513 4 feature
418 This currently kills databases!!!! 514
419 <p> 515 </pre></td></tr>
420 This action should generally not be used. It reads in an instance 516
421 database and writes it again. In the future, is may also update
422 instance code to account for changes in templates. It's probably wise
423 not to use it anyway. Until we're sure it won't break things...
424 </td></tr>
425
426 <tr><td><strong>help</strong></td>
427 <td><tt>help [command]</tt><p>
428 Short help about roundup-admin or the specific command.
429 </td></tr>
430
431 <tr><td><strong>morehelp</strong></td>
432 <td><tt>morehelp</tt><p>
433 All available help from the roundup-admin tool.
434 </td></tr>
435 </table> 517 </table>
436 518
437 <p> 519 <p>
438 All commands (except help) require an instance specifier. This is just the path 520 All commands (except help) require an instance specifier. This is just the path
439 to the roundup instance you're working with. A roundup instance is where 521 to the roundup instance you're working with. A roundup instance is where
1195 Go Ping, you rock! Also, go Bizar Software for letting me implement this 1277 Go Ping, you rock! Also, go Bizar Software for letting me implement this
1196 system on their time. 1278 system on their time.
1197 1279
1198 <p>&nbsp;</p> 1280 <p>&nbsp;</p>
1199 <hr> 1281 <hr>
1200 $Id: index.html,v 1.21 2001-12-13 00:20:01 richard Exp $ 1282 $Id: index.html,v 1.22 2001-12-17 03:52:47 richard Exp $
1201 <p>&nbsp;</p> 1283 <p>&nbsp;</p>
1202 1284
1203 </body></html> 1285 </body></html>
1204 1286
Roundup Issue Tracker: http://roundup-tracker.org/