"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "doc/user_guide.txt" 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).

user_guide.txt  (roundup-1.6.1):user_guide.txt  (roundup-2.0.0)
skipping to change at line 60 skipping to change at line 60
By default, the issue will have the status "unread". If another message By default, the issue will have the status "unread". If another message
is received for the issue, its status will change to "chatting". is received for the issue, its status will change to "chatting".
The "home" page for a tracker will generally display all issues which The "home" page for a tracker will generally display all issues which
are not "resolved". are not "resolved".
If an issue is closed, and a new message is received then it'll be If an issue is closed, and a new message is received then it'll be
reopened to the state of "chatting". reopened to the state of "chatting".
The full set of **prority** and **status** values are: The full set of **priority** and **status** values are:
=========== ===================================== =========== =====================================
Priority Description Priority Description
=========== ===================================== =========== =====================================
"critical" panic: work is stopped! "critical" panic: work is stopped!
"urgent" important, but not deadly "urgent" important, but not deadly
"bug" lost work or incorrect results "bug" lost work or incorrect results
"feature" want missing functionality "feature" want missing functionality
"wish" avoidable bugs, missing conveniences "wish" avoidable bugs, missing conveniences
=========== ===================================== =========== =====================================
skipping to change at line 315 skipping to change at line 315
Under the covers Under the covers
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
The searching page converts your selections into the following The searching page converts your selections into the following
arguments: arguments:
============ ============================================================= ============ =============================================================
Argument Description Argument Description
============ ============================================================= ============ =============================================================
@sort sort by prop name, optionally preceeded with '-' to give @sort sort by prop name, optionally preceded with '-' to give
descending or nothing for ascending sorting. The sort descending or nothing for ascending sorting. The sort
argument can have several props separated with comma. argument can have several props separated with comma.
@group group by prop name, optionally preceeded with '-' or to sort @group group by prop name, optionally preceded with '-' or to sort
in descending or nothing for ascending order. The group in descending or nothing for ascending order. The group
argument can have several props separated with comma. argument can have several props separated with comma.
@columns selects the columns that should be displayed. Default is @columns selects the columns that should be displayed. Default is
all. all.
@filter indicates which properties are being used in filtering. @filter indicates which properties are being used in filtering.
Default is none. Default is none.
propname selects the values the item properties given by propname must propname selects the values the item properties given by propname must
have (very basic search/filter). have (very basic search/filter).
@search_text performs a full-text search (message bodies, issue titles, @search_text performs a full-text search (message bodies, issue titles,
etc) etc)
skipping to change at line 385 skipping to change at line 385
1. `subject-line information`_ identifying the purpose of the e-mail 1. `subject-line information`_ identifying the purpose of the e-mail
2. `sender identification`_ using the sender of the message 2. `sender identification`_ using the sender of the message
3. `e-mail message content`_ which is to be extracted 3. `e-mail message content`_ which is to be extracted
4. e-mail attachments which should be associated with the message 4. e-mail attachments which should be associated with the message
Subject-line information Subject-line information
------------------------ ------------------------
The subject line of the incoming message is examined to find one of: The subject line of the incoming message is examined to find one of:
1. a case insentive ``help``, 1. a case insensitive ``help``,
2. a match for ``-- key <OneTimeKey>``, 2. a match for ``-- key <OneTimeKey>``,
3. the item that the message is responding to, 3. the item that the message is responding to,
4. the type of item the message should create, or 4. the type of item the message should create, or
5. we default the item class and try some trickiness. 5. we default the item class and try some trickiness.
If the subject is ``help`` (case insensitive), the gateway responds If the subject is ``help`` (case insensitive), the gateway responds
with an explaination of the interface. with an explanation of the interface.
If a one-time key is found, we're processing an in-progress If a one-time key is found, we're processing an in-progress
registration confirmation. registration confirmation.
If the subject line contains a prefix in ``[square brackets]`` then If the subject line contains a prefix in ``[square brackets]`` then
we're looking at case 3 or 4 above. Any "re:" or "fwd:" prefixes are we're looking at case 3 or 4 above. Any "re:" or "fwd:" prefixes are
stripped off the subject line before we start looking for real stripped off the subject line before we start looking for real
information. information.
If an item designator (class name and id number, for example If an item designator (class name and id number, for example
skipping to change at line 607 skipping to change at line 607
The username and password may be omitted:: The username and password may be omitted::
pop username@server pop username@server
pop server pop server
are both valid. The username and/or password will be prompted for if are both valid. The username and/or password will be prompted for if
not supplied on the command-line. not supplied on the command-line.
POPS: POPS:
Connect to a POP server over ssl. This requires python 2.4 or later. Connect to a POP server over ssl.
This supports the same notation as POP:: This supports the same notation as POP::
pops username:password@server pops username:password@server
APOP: APOP:
Same as POP, but using Authenticated POP:: Same as POP, but using Authenticated POP::
apop username:password@server apop username:password@server
IMAP: IMAP:
skipping to change at line 640 skipping to change at line 640
This supports the same notation as IMAP:: This supports the same notation as IMAP::
imaps username:password@server [mailbox] imaps username:password@server [mailbox]
IMAPS_CRAM: IMAPS_CRAM:
Connect to an IMAP server over ssl using CRAM-MD5 authentication. Connect to an IMAP server over ssl using CRAM-MD5 authentication.
This supports the same notation as IMAP:: This supports the same notation as IMAP::
imaps_cram username:password@server [mailbox] imaps_cram username:password@server [mailbox]
.. index:: ! roundup-admin
single: roundup-admin; usage
single: roundup-admin; data formats
pair: roundup-admin; designator
Command Line Tool Command Line Tool
================= =================
The basic usage is:: The basic usage is::
Usage: roundup-admin [options] [<command> <arguments>] Usage: roundup-admin [options] [<command> <arguments>]
Options: Options:
-i instance home -- specify the issue tracker "home directory" to administer -i instance home -- specify the issue tracker "home directory" to administer
-u -- the user[:password] to use for commands -u -- the user[:password] to use for commands
skipping to change at line 742 skipping to change at line 747
login may be specified as either "``name``" or "``name:password``". login may be specified as either "``name``" or "``name:password``".
- ``ROUNDUP_LOGIN`` environment variable - ``ROUNDUP_LOGIN`` environment variable
- the "``-u``" command-line option - the "``-u``" command-line option
If either the name or password is not supplied, they are obtained from If either the name or password is not supplied, they are obtained from
the command-line. the command-line.
When you initialise a new tracker instance you are prompted for the When you initialise a new tracker instance you are prompted for the
admin password. If you want to initialise a tracker non-interactively admin password. If you want to initialise a tracker non-interactively
you can put the initialise command and password on the commnd you can put the initialise command and password on the command
line. But this allows others on the host to see the password (using line. But this allows others on the host to see the password (using
the ps command). To initialise a tracker non-interactively without the ps command). To initialise a tracker non-interactively without
exposing the password, create a file (e.g init_tracker) set to mode exposing the password, create a file (e.g init_tracker) set to mode
600 (so only the owner can read it) with the contents: 600 (so only the owner can read it) with the contents:
initialise admin_password initialise admin_password
and feed it to roundup-admin on standard input. E.G. and feed it to roundup-admin on standard input. E.G.
cat init_tracker | roundup-admin -i tracker_dir cat init_tracker | roundup-admin -i tracker_dir
(for more details see https://issues.roundup-tracker.org/issue2550789.) (for more details see https://issues.roundup-tracker.org/issue2550789.)
.. index:: ! roundup-admin; usage in scripts
Using with the shell Using with the shell
-------------------- --------------------
With version 0.6.0 or newer of roundup (which introduced support for With version 0.6.0 or newer of roundup (which introduced support for
multiple designators to display and the -d, -S and -s flags): multiple designators to display and the -d, -S and -s flags):
To find all messages regarding chatting issues that contain the word To find all messages regarding chatting issues that contain the word
"spam", for example, you could execute the following command from the "spam", for example, you could execute the following command from the
directory where the database dumps its files:: directory where the database dumps its files::
 End of changes. 9 change blocks. 
7 lines changed or deleted 14 lines changed or added

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