"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "share/man/man1/roundup-admin.1" between
roundup-1.6.1.tar.gz and roundup-2.0.0.tar.gz

About: Roundup is an highly customisable issue-tracking system with command-line, web and e-mail interfaces (written in Python).

roundup-admin.1  (roundup-1.6.1):roundup-admin.1  (roundup-2.0.0)
ROUNDUP-ADMIN(1) General Commands Manual ROUNDUP-ADMIN(1) ROUNDUP-ADMIN(1) General Commands Manual ROUNDUP-ADMIN(1)
NAME NAME
roundup-admin - administrate roundup trackers roundup-admin - administrate roundup trackers
SYNOPSIS SYNOPSIS
roundup-admin [options] <command> <arguments> roundup-admin [options] <command> <arguments>
OPTIONS OPTIONS
-i instance home -i instance home
specify the issue tracker "home directory" to administer Specify the issue tracker "home directory" to administer
-u user[:password] -u user[:password]
the user and password to use for commands The user and password to use for commands -h Print help text.
-d Print full designators (e.g. issue1) not just id numbers (1).
-c When outputting lists of data, comma-separate them. Same as -S "," . -c When outputting lists of data, comma-separate them. Same as -S "," .
-S string -S string
When outputting lists of data, separate items with given string. When outputting lists of data, separate items with given string.
-s When outputting lists of data, space-separate them. Same as -S " " . -s When outputting lists of data, space-separate them. Same as -S " " .
-V Be verbose when importing data.
-v Report Roundup and Python versions and quit.
Only one of -s, -c or -S can be specified.
COMMANDS
If no command is provided on the command line, roundup-admin will
enter an interactive mode. More
details about these commands are available using the help command.
A designator is a classname and a nodeid concatenated, eg. bug1, user10,
....
Roundup-admin takes a number of commands:
help prints help (same as -h)
help <subcommand>
Print command-specific help
help all
Print available help for all commands.
commit Commit changes made to the database during an interactive session.
The changes made during an interactive session are not automatical
ly written to the database -
they must be committed using this command.
One-off commands on the command-line are automatically committed i
f they are successful. See also
rollback.
create classname property=value ...
This creates a new entry of the given class using the property nam
e=value arguments provided on
the command line after the "create" command.
display designator[,designator]*
This lists the properties and their associated values for the give
n node.
export [[-]class[,class]] export_dir
Export the database to colon-separated-value files. To exclude
the files (e.g. for the msg or
file class), use the exporttables command.
Optionally limit the export to just the named classes or exclude t
he named classes, if the 1st
argument starts with '-'.
This action exports the current data from the database into colon
-separated-value files that are
placed in the nominated destination directory.
exporttables [[-]class[,class]] export_dir
Export the database to colon-separated-value files, ex
cluding the files below
$TRACKER_HOME/db/files/ (which can be archived separately). To in
clude the files, use the export
command.
filter classname propname=value ...
Find the nodes of the given class with a given property value. Mu
ltiple values can be specified
by separating them with commas. If property is a string, all
values must match. I.E. it's an
matches. I.E. an 'or' operation.
find classname propname=value ...
Find the nodes of the given class with a given link property value
.
genconfig <filename>
Generate a new tracker config file (ini style) with default values
in <filename>. Note that this
does not preserve any settings from the current tracker. Use updat
econfig for that.
get property designator[,designator]*
Get the given property of one or more designator(s).
Retrieves the property value of the nodes specified by the designa
tors.
history designator [skipquiet]
Lists the journal entries viewable by the user for the node i
dentified by the designator. If
skipquiet is the second argument, journal entries for quiet proper
ties are not shown.
import import_dir
Import a database from the directory containing CSV files, two per
class to import.
The imported nodes will have the same nodeid as defined in the imp
ort file, thus replacing any
existing content.
The new nodes are added to the existing database - if you want to
create a new database using the
imported data, then create a new database (or, tediously, retire a
ll the old data). See also
export.
importtables import_dir
Import a database from the directory containing CSV files, two per
class to import.
The imported nodes will have the same nodeid as defined in the
import file, thus replacing any
existing content.
This only imports database tables. It does not import files/messa
ge content. It is used to
import data exported by exporttables. See also exporttables.
initialise [adminpw]
Initialise a new Roundup tracker.
The administrator details will be set at this step.
install [template [backend [key=val[,key=val]]]]
Install a new roundup tracker.
The command will prompt for the tracker home directory (if not s
upplied through TRACKER_HOME or
the -i option). The template and backend may be specified on the
command-line as arguments, in
that order.
Command line arguments following the backend allows you to
pass initial values for config
options. For example, passing "web_http_auth=no,rdbms_user=dinsda
le" will override defaults for
options http_auth in section [web] and user in section [rdbms]
. Please be careful to not use
spaces in this argument! (Enclose whole argument in quotes if you
need spaces in option value).
The initialise command must be called after this command in order
to initialise the tracker's
database. You may edit the tracker's initial database contents
before running that command by
editing the tracker's dbinit.py module init() function.
See also initopts help.
list classname [property]
Lists all instances of the given class. If the property is not spe
cified, the "label" property
is used. The label property is tried in order: the key, "name", "
title" and then the first prop-
erty, alphabetically.
With -c, -S or -s print a list of item id's if no property specif
ied. If property specified,
print list of that property for every class instance.
migrate
Update a tracker's database to be compatible with the Roundup code
base.
You should run the "migrate" command for your tracker once you've
installed the latest codebase.
Do this before you use the web, command-line or mail interface
and before any users access the
tracker.
This command will respond with either "Tracker updated" (if you've
not previously run it on an
RDBMS backend) or "No migration action required" (if you have run
it, or have used another inter-
face to the tracker, or possibly because you are using anydbm).
It's safe to run this even if it's not required, so just get into
the habit.
pack period | date
Remove journal entries older than a period of time specified or be
fore a certain date.
reindex [classname|designator]*
This will re-generate the search indexes for a tracker.
restore designator[,designator]*
Restore the retired node specified by designator.
The given nodes will become available for users again.
retire designator[,designator]*
This action indicates that a particular node is not to be retrieve
d by the list or find commands,
and its key value may be re-used. See also restore.
rollback
Undo all changes that are pending commit to the database.
The changes made during an interactive session are not automati
cally written to the database -
they must be committed manually. This command undoes all those cha
nges, so a commit immediately
after would make no changes to the database.
security [Role name]
Display the Permissions available to one or all Roles.
set items property=value property=value ...
Set the given properties of one or more items(s).
The items are specified as a class or as a comma-separated list of
item designators (ie "designa-
tor[,designator,...]").
This command sets the properties to the values for all designators
given. If the value is missing
(ie. "property=") then the property is un-set. If the property
is a multilink, you specify the
linked ids for the multilink as comma-separated numbers (ie "1,2,3
").
specification classname
Show the properties for a classname.
table classname [property[,property]*]
Lists all instances of the given class. If the properties are not
specified, all properties are
displayed. By default, the column widths are the width of the larg
est value.
updateconfig <filename>
This is used when updating software. It merges the config.ini fro
m the tracker with new settings
from the new software. The merged/updated config file is written t
o <filename>.
Commands may be abbreviated as long as the abbreviation matches only one
command, e.g. l == li == lis ==
list.
FURTHER HELP FURTHER HELP
roundup-admin -h roundup-admin -h
roundup-admin help -- this help roundup-admin help -- this help
roundup-admin help <command> -- command-specific help roundup-admin help <command> -- command-specific help
roundup-admin help all -- all available help roundup-admin help all -- all available help
AUTHOR AUTHOR
This manpage was written by Bastian Kleineidam <calvin@debian.org> for the Debian distribution of This manpage was written by Bastian Kleineidam <calvin@debian.org> for the Debian distribution of
roundup. roundup.
 End of changes. 3 change blocks. 
2 lines changed or deleted 246 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)