Mercurial > p > roundup > code

annotate doc/user_guide.txt @ 6768:15238a434368

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
formatting fixes.
author John Rouillard <rouilj@ieee.org>
date Sun, 10 Jul 2022 22:53:05 -0400
parents 2eec7a500333
children e7b4ad2c57ac
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6586
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6469
diff changeset
1 .. meta::
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6469
diff changeset
2 :description language=en:
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6469
diff changeset
3 Describes how to interact with and use a tracker with the
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6469
diff changeset
4 Roundup Issue Tracker.
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6469
diff changeset
5
688
b38f4f95bffd More doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents: 686
diff changeset
6 ==========
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 User Guide
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 ==========
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
686
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
10 .. contents::
4890
609edf9de0a5 docs: Remove one nesting level from ToC on subpages
anatoly techtonik <techtonik@gmail.com>
parents: 4792
diff changeset
11 :local:
686
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
12
2409
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
13 .. hint::
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
14 This document will refer to *issues* as the primary store of
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
15 information in the tracker. This is the default of the classic template,
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
16 but may vary in any given installation.
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
17
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
18
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
19 Your Tracker in a Nutshell
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
20 ==========================
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
21
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
22 Your tracker holds information about issues in bundles we call *items*.
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
23 An item may be an *issue* (a bug or feature request) or a *user*. The
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
24 issue-ness or user-ness is called the item's *class*. So, for bug
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
25 reports and features, the class is "issue", and for users the class is
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
26 "user".
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
27
3754
9f4dd27ae843 documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents: 3696
diff changeset
28 Each item in the tracker has an ID number that identifies it along with
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
29 its item class. To identify a particular issue or user, we combine the
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
30 class with the number to create a unique label, so that user 1 (who,
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
31 incidentally, is *always* the "admin" user) is referred to as "user1".
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
32 Issue number 315 is referred to as "issue315". We call that label the
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
33 item's *designator*.
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
34
1844
67e530e2a0ae *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1661
diff changeset
35 Items in the database are never deleted, they're just "retired". You
67e530e2a0ae *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1661
diff changeset
36 can still refer to them by ID - hence removing an item won't break
67e530e2a0ae *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1661
diff changeset
37 references to the item. It's just that the item won't appear in any
67e530e2a0ae *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1661
diff changeset
38 listings.
67e530e2a0ae *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1661
diff changeset
39
1615
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
40
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
41 Accessing the Tracker
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
42 ---------------------
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
43
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
44 You may access your tracker through one of three ways:
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
45
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
46 1. through the `web interface`_,
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
47 2. through the `e-mail gateway`_, or
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
48 3. using the `command line tool`_.
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
49
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
50 The last is usually only used by administrators. Most users will use the
3529
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
51 web and e-mail interfaces. All three are explained below.
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
52
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
53
1615
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
54 Issue life cycles in Roundup
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
55 ----------------------------
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
56
3529
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
57 New issues may be submitted via the web or e-mail.
1615
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
58
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
59 By default, the issue will have the status "unread". If another message
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
60 is received for the issue, its status will change to "chatting".
1615
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
61
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
62 The "home" page for a tracker will generally display all issues which
3529
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
63 are not "resolved".
1615
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
64
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
65 If an issue is closed, and a new message is received then it'll be
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
66 reopened to the state of "chatting".
1615
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
67
5827
c263187e82d1 Fix typos.
John Rouillard <rouilj@ieee.org>
parents: 5610
diff changeset
68 The full set of **priority** and **status** values are:
3650
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
69
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
70 =========== =====================================
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
71 Priority Description
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
72 =========== =====================================
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
73 "critical" panic: work is stopped!
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
74 "urgent" important, but not deadly
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
75 "bug" lost work or incorrect results
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
76 "feature" want missing functionality
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
77 "wish" avoidable bugs, missing conveniences
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
78 =========== =====================================
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
79
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
80 ============= =====================================
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
81 Status Description
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
82 ============= =====================================
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
83 "unread" submitted but no action yet
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
84 "deferred" intentionally set aside
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
85 "chatting" under review or seeking clarification
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
86 "need-eg" need a reproducible example of a bug
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
87 "in-progress" understood; development in progress
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
88 "testing" we think it's done; others, please test
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
89 "done-cbb" okay for now, but could be better
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
90 "resolved" fix has been released
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
91 ============= =====================================
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3529
diff changeset
92
1615
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
93
4929
57a482110a24 doc: Link XMLRPC `filter` doc to User Guide chapter about querying
anatoly techtonik <techtonik@gmail.com>
parents: 4890
diff changeset
94 .. _query-tracker:
57a482110a24 doc: Link XMLRPC `filter` doc to User Guide chapter about querying
anatoly techtonik <techtonik@gmail.com>
parents: 4890
diff changeset
95
1588
1ac46e7e4150 more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 1575
diff changeset
96 Entering values in your Tracker
1ac46e7e4150 more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 1575
diff changeset
97 -------------------------------
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
98
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
99 All interfaces to your tracker use the same format for entering values.
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
100 This means the web interface for entering a new issue, the web interface
3529
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
101 for searching issues, the e-mail interface and even the command-line
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
102 administration tool.
1588
1ac46e7e4150 more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 1575
diff changeset
103
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
104
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
105 String and Numeric properties
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
106 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
107
1588
1ac46e7e4150 more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 1575
diff changeset
108 These fields just take a simple text value, like ``It's broken``.
1ac46e7e4150 more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 1575
diff changeset
109
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
110
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
111 Boolean properties
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
112 ~~~~~~~~~~~~~~~~~~
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
113
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
114 These fields take a value which indicates "yes"/"no", "true"/"false",
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
115 "1"/"0" or "on"/"off".
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
116
1588
1ac46e7e4150 more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 1575
diff changeset
117
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
118 Constrained (link and multilink) properties
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
119 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
120
3904
91008ec8f9a0 retire "topic" usage
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3756
diff changeset
121 Fields like "Assigned To" and "Keywords" hold references to items in other
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
122 classes ("user" and "keyword" in those two cases.)
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
123
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
124 Sometimes, the selection is done through a menu, like in the "Assigned
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
125 To" field.
1588
1ac46e7e4150 more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 1575
diff changeset
126
1ac46e7e4150 more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 1575
diff changeset
127 Where the input is not a simple menu selection, we use a comma-separated
1ac46e7e4150 more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 1575
diff changeset
128 list of values to indicated which values of "user" or "keyword" are
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
129 interesting. The values may be either numeric ids or the names of items.
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
130 The special value "-1" may be used to match items where the property is
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
131 not set. For example, the following searches on the issues:
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
132
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
133 ``assignedto=richard,george``
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
134 match issues which are assigned to richard or george.
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
135 ``assignedto=-1``
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
136 match issues that are not assigned to a user.
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
137 ``assignedto=2,3,40``
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
138 match issues that are assigned to users 2, 3 or 40.
3904
91008ec8f9a0 retire "topic" usage
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3756
diff changeset
139 ``keyword=user interface``
91008ec8f9a0 retire "topic" usage
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3756
diff changeset
140 match issues with the keyword "user interface" in their keyword list
91008ec8f9a0 retire "topic" usage
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3756
diff changeset
141 ``keyword=web interface,e-mail interface``
3529
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
142 match issues with the keyword "web interface" or "e-mail interface" in
3904
91008ec8f9a0 retire "topic" usage
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3756
diff changeset
143 their keyword list
91008ec8f9a0 retire "topic" usage
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3756
diff changeset
144 ``keyword=-1``
91008ec8f9a0 retire "topic" usage
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3756
diff changeset
145 match issues with no keywords set
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
146
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
147
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
148 Date properties
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
149 ~~~~~~~~~~~~~~~
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
150
2750
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
151 Date-and-time stamps are specified with the date in
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
152 international standard format (``yyyy-mm-dd``) joined to the time
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
153 (``hh:mm:ss``) by a period ``.``. Dates in this form can be easily
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
154 compared and are fairly readable when printed. An example of a valid
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
155 stamp is ``2000-06-24.13:03:59``. We'll call this the "full date
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
156 format". When Timestamp objects are printed as strings, they appear in
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
157 the full date format.
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
158
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
159 For user input, some partial forms are also permitted: the whole time or
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
160 just the seconds may be omitted; and the whole date may be omitted or
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
161 just the year may be omitted. If the time is given, the time is
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
162 interpreted in the user's local time zone. The Date constructor takes
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
163 care of these conversions. In the following examples, suppose that
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
164 ``yyyy`` is the current year, ``mm`` is the current month, and ``dd`` is
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
165 the current day of the month.
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
166
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
167 - "2000-04-17" means <Date 2000-04-17.00:00:00>
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
168 - "01-25" means <Date yyyy-01-25.00:00:00>
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
169 - "2000-04-17.03:45" means <Date 2000-04-17.08:45:00>
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
170 - "08-13.22:13" means <Date yyyy-08-14.03:13:00>
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
171 - "11-07.09:32:43" means <Date yyyy-11-07.14:32:43>
4650
0485b47a39a8 issue2550766: Minor formatting issues in the docs for date properties, thanks John Kristensen.
Bernhard Reiter <bernhard@intevation.de>
parents: 4402
diff changeset
172 - "14:25" means <Date yyyy-mm-dd.19:25:00>
0485b47a39a8 issue2550766: Minor formatting issues in the docs for date properties, thanks John Kristensen.
Bernhard Reiter <bernhard@intevation.de>
parents: 4402
diff changeset
173 - "8:47:11" means <Date yyyy-mm-dd.13:47:11>
2750
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
174 - the special date "." means "right now"
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
175
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
176
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
177 When searching, a plain date entered as a search field will match that date
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
178 exactly in the database. We may also accept ranges of dates. You can
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
179 specify range of dates in one of two formats:
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
180
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
181 1. English syntax::
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
182
1599
cc96bf971b33 extended date syntax to make range searches even more useful
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1596
diff changeset
183 [From <value>][To <value>]
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
184
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
185 Keywords "From" and "To" are case insensitive. Keyword "From" is
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
186 optional.
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
187
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
188 2. "Geek" syntax::
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
189
1599
cc96bf971b33 extended date syntax to make range searches even more useful
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1596
diff changeset
190 [<value>];[<value>]
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
191
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
192 Either first or second ``<value>`` can be omitted in both syntaxes.
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
193
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
194 For example, if you enter string "from 9:00" to "Creation date" field,
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
195 roundup will find all issues, that were created today since 9 AM.
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
196
2750
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
197 The ``<value>`` may also be an interval, as described in the next section.
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
198 Searching of "-2m; -1m" on activity field gives you issues which were
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
199 active between period of time since 2 months up-till month ago.
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
200
2910
5c0e5abcb5e3 doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2750
diff changeset
201 Other possible examples (consider local time is 2003-03-08.22:07:48):
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
202
2750
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
203 - "from 2-12 to 4-2" means
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
204 <Range from 2003-02-12.00:00:00 to 2003-04-02.00:00:00>
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
205 - "FROM 18:00 TO +2m" means
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
206 <Range from 2003-03-08.18:00:00 to 2003-05-08.20:07:48>
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
207 - "12:00;" means
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
208 <Range from 2003-03-08.12:00:00 to None>
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
209 - "tO +3d" means
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
210 <Range from None to 2003-03-11.20:07:48>
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
211 - "2002-11-10; 2002-12-12" means
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
212 <Range from 2002-11-10.00:00:00 to 2002-12-12.00:00:00>
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
213 - "; 20:00 +1d" means
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
214 <Range from None to 2003-03-09.20:00:00>
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
215 - "2003" means
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
216 <Range from 2003-01-01.00:00:00 to 2003-12-31.23:59:59>
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
217 - "2003-04" means
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
218 <Range from 2003-04-01.00:00:00 to 2003-04-30.23:59:59>
1599
cc96bf971b33 extended date syntax to make range searches even more useful
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1596
diff changeset
219
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
220
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
221 Interval properties
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
222 ~~~~~~~~~~~~~~~~~~~
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
223
2750
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
224 Date intervals are specified using the suffixes "y", "m", and "d". The
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
225 suffix "w" (for "week") means 7 days. Time intervals are specified in
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
226 hh:mm:ss format (the seconds may be omitted, but the hours and minutes
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
227 may not).
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
228
2750
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
229 - "3y" means three years
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
230 - "2y 1m" means two years and one month
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
231 - "1m 25d" means one month and 25 days
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
232 - "2w 3d" means two weeks and three days
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
233 - "1d 2:50" means one day, two hours, and 50 minutes
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
234 - "14:00" means 14 hours
a97bbd72a643 copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
235 - "0:04:33" means four minutes and 33 seconds
1596
33a0d94c7658 searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1588
diff changeset
236
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
237
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents: 2136
diff changeset
238 Simple support for collision detection
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents: 2136
diff changeset
239 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents: 2136
diff changeset
240
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents: 2136
diff changeset
241 Item edit pages remember when the item was last edited. When a form is
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents: 2136
diff changeset
242 submitted, the user will be informed if someone else has edited the item
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents: 2136
diff changeset
243 at the same time they tried to.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents: 2136
diff changeset
244
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents: 2136
diff changeset
245
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
246 Web Interface
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
247 =============
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
248
2409
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
249 .. note::
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
250 This document contains screenshots of the default look and feel.
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
251 Your site may have a slightly (or very) different look, but the
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
252 functionality will be very similar, and the concepts still hold.
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
253
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
254 The web interface is broken up into the following parts:
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
255
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
256 1. `lists of items`_,
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
257 2. `display, edit or entry of an item`_, and
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
258 3. `searching page`_.
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
259
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
260
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
261 Lists of Items
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
262 --------------
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
263
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
264 The first thing you'll see when you log into Roundup will be a list of
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
265 open (ie. not resolved) issues. This list has been generated by a bunch
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
266 of controls `under the covers`_ but for now, you can see something like:
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
267
3756
068b3d7d4279 images for user guide
Richard Jones <richard@users.sourceforge.net>
parents: 3754
diff changeset
268 .. image:: images/index_logged_out.png
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
269
3756
068b3d7d4279 images for user guide
Richard Jones <richard@users.sourceforge.net>
parents: 3754
diff changeset
270 The screen is divided up into three sections. There's a title which tells
068b3d7d4279 images for user guide
Richard Jones <richard@users.sourceforge.net>
parents: 3754
diff changeset
271 you where you are, a sidebar which contains useful navigation tools and a
068b3d7d4279 images for user guide
Richard Jones <richard@users.sourceforge.net>
parents: 3754
diff changeset
272 body which usually displays either a list of items or a single item from
068b3d7d4279 images for user guide
Richard Jones <richard@users.sourceforge.net>
parents: 3754
diff changeset
273 the tracker.
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
274
6257
f9c059921ccc Document password reset mechanism in web interface.
John Rouillard <rouilj@ieee.org>
parents: 6174
diff changeset
275 You may register, reset your password or log in. Registration takes
f9c059921ccc Document password reset mechanism in web interface.
John Rouillard <rouilj@ieee.org>
parents: 6174
diff changeset
276 you to:
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
277
3756
068b3d7d4279 images for user guide
Richard Jones <richard@users.sourceforge.net>
parents: 3754
diff changeset
278 .. image:: images/registration.png
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
279
6257
f9c059921ccc Document password reset mechanism in web interface.
John Rouillard <rouilj@ieee.org>
parents: 6174
diff changeset
280 Clicking on the "Lost your login?" link allows you to reset your
f9c059921ccc Document password reset mechanism in web interface.
John Rouillard <rouilj@ieee.org>
parents: 6174
diff changeset
281 password. Resetting your password takes you to:
f9c059921ccc Document password reset mechanism in web interface.
John Rouillard <rouilj@ieee.org>
parents: 6174
diff changeset
282
f9c059921ccc Document password reset mechanism in web interface.
John Rouillard <rouilj@ieee.org>
parents: 6174
diff changeset
283 .. image:: images/reset.png
f9c059921ccc Document password reset mechanism in web interface.
John Rouillard <rouilj@ieee.org>
parents: 6174
diff changeset
284
f9c059921ccc Document password reset mechanism in web interface.
John Rouillard <rouilj@ieee.org>
parents: 6174
diff changeset
285 You can enter your username to get a reset email sent to your primary
f9c059921ccc Document password reset mechanism in web interface.
John Rouillard <rouilj@ieee.org>
parents: 6174
diff changeset
286 E-mail address. Otherwise you can enter your primary E-mail address or
f9c059921ccc Document password reset mechanism in web interface.
John Rouillard <rouilj@ieee.org>
parents: 6174
diff changeset
287 an Alternate E-mail address to get a reset email sent to that address.
f9c059921ccc Document password reset mechanism in web interface.
John Rouillard <rouilj@ieee.org>
parents: 6174
diff changeset
288 The reset email includes a verification link that can be used to
f9c059921ccc Document password reset mechanism in web interface.
John Rouillard <rouilj@ieee.org>
parents: 6174
diff changeset
289 complete the password reset.
f9c059921ccc Document password reset mechanism in web interface.
John Rouillard <rouilj@ieee.org>
parents: 6174
diff changeset
290
3756
068b3d7d4279 images for user guide
Richard Jones <richard@users.sourceforge.net>
parents: 3754
diff changeset
291 Once you're logged in, the sidebar changes to:
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
292
3756
068b3d7d4279 images for user guide
Richard Jones <richard@users.sourceforge.net>
parents: 3754
diff changeset
293 .. image:: images/index_logged_in.png
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
294
3756
068b3d7d4279 images for user guide
Richard Jones <richard@users.sourceforge.net>
parents: 3754
diff changeset
295 You can now get to your "My Details" page:
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
296
3756
068b3d7d4279 images for user guide
Richard Jones <richard@users.sourceforge.net>
parents: 3754
diff changeset
297 .. image:: images/my_details.png
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
298
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1199
diff changeset
299
Richard Jones <richard@users.sourceforge.net>
parents: 1199
diff changeset
300 Display, edit or entry of an item
Richard Jones <richard@users.sourceforge.net>
parents: 1199
diff changeset
301 ---------------------------------
Richard Jones <richard@users.sourceforge.net>
parents: 1199
diff changeset
302
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
303 Create a new issue with "create new" under the issue subheading. This
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
304 will take you to:
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
305
3756
068b3d7d4279 images for user guide
Richard Jones <richard@users.sourceforge.net>
parents: 3754
diff changeset
306 .. image:: images/new_issue.png
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
307
3756
068b3d7d4279 images for user guide
Richard Jones <richard@users.sourceforge.net>
parents: 3754
diff changeset
308 Editing an issue uses the same form, though now you'll see attached files
068b3d7d4279 images for user guide
Richard Jones <richard@users.sourceforge.net>
parents: 3754
diff changeset
309 and messages, and the issue history at the bottom of the page:
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
310
3756
068b3d7d4279 images for user guide
Richard Jones <richard@users.sourceforge.net>
parents: 3754
diff changeset
311 .. image:: images/edit_issue.png
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
312
6469
98082155ffea Document "Make a copy" link
John Rouillard <rouilj@ieee.org>
parents: 6408
diff changeset
313 The "Make a copy" link duplicate the current issue copying most of the
98082155ffea Document "Make a copy" link
John Rouillard <rouilj@ieee.org>
parents: 6408
diff changeset
314 properties to a new issue. This is useful for splitting am issue into
98082155ffea Document "Make a copy" link
John Rouillard <rouilj@ieee.org>
parents: 6408
diff changeset
315 sub-issues that can be assigned to different people.
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
316
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1199
diff changeset
317 Searching Page
Richard Jones <richard@users.sourceforge.net>
parents: 1199
diff changeset
318 --------------
Richard Jones <richard@users.sourceforge.net>
parents: 1199
diff changeset
319
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
320 See `entering values in your tracker`_ for an explanation of what you
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
321 may type into the search form.
1588
1ac46e7e4150 more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 1575
diff changeset
322
1ac46e7e4150 more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 1575
diff changeset
323
2136
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
324 Saving queries
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
325 ~~~~~~~~~~~~~~
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
326
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
327 You may save queries in the tracker by giving the query a name. Each user
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
328 may only have one query with a given name - if a subsequent search is
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
329 performed with the same query name supplied, then it will edit the
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
330 existing query of the same name.
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
331
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
332 Queries may be marked as "private". These queries are only visible to the
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
333 user that created them. If they're not marked "private" then all other
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
334 users may include the query in their list of "Your Queries". Marking it as
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
335 private at a later date does not affect users already using the query, nor
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
336 does deleting the query.
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
337
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
338 If a user subsequently creates or edits a public query, a new personal
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
339 version of that query is made, with the same editing rules as described
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
340 above.
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2028
diff changeset
341
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
342
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
343 Under the covers
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
344 ~~~~~~~~~~~~~~~~
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
345
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
346 The searching page converts your selections into the following
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
347 arguments:
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
348
3036
8fa6b5747a53 updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
349 ============ =============================================================
8fa6b5747a53 updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
350 Argument Description
8fa6b5747a53 updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
351 ============ =============================================================
5827
c263187e82d1 Fix typos.
John Rouillard <rouilj@ieee.org>
parents: 5610
diff changeset
352 @sort sort by prop name, optionally preceded with '-' to give
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3650
diff changeset
353 descending or nothing for ascending sorting. The sort
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3650
diff changeset
354 argument can have several props separated with comma.
5827
c263187e82d1 Fix typos.
John Rouillard <rouilj@ieee.org>
parents: 5610
diff changeset
355 @group group by prop name, optionally preceded with '-' or to sort
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3650
diff changeset
356 in descending or nothing for ascending order. The group
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3650
diff changeset
357 argument can have several props separated with comma.
3036
8fa6b5747a53 updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
358 @columns selects the columns that should be displayed. Default is
8fa6b5747a53 updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
359 all.
8fa6b5747a53 updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
360 @filter indicates which properties are being used in filtering.
8fa6b5747a53 updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
361 Default is none.
8fa6b5747a53 updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
362 propname selects the values the item properties given by propname must
8fa6b5747a53 updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
363 have (very basic search/filter).
8fa6b5747a53 updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
364 @search_text performs a full-text search (message bodies, issue titles,
8fa6b5747a53 updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
365 etc)
8fa6b5747a53 updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
366 ============ =============================================================
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
367
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
368 You may manually write URLS that contain these arguments, like so
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
369 (whitespace has been added for clarity)::
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
370
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
371 /issue?status=unread,in-progress,resolved&
3904
91008ec8f9a0 retire "topic" usage
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3756
diff changeset
372 keyword=security,ui&
3696
790363e96852 Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3650
diff changeset
373 @group=priority,-status&
3036
8fa6b5747a53 updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
374 @sort=-activity&
3904
91008ec8f9a0 retire "topic" usage
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3756
diff changeset
375 @filters=status,keyword&
3036
8fa6b5747a53 updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
376 @columns=title,status,fixer
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
377
6592
828e2eaee7cd Document full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
378 Full text search using the xapian, whoosh and native indexers treats
828e2eaee7cd Document full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
379 the search query as a series of space separated words. Any word less
6613
2eec7a500333 Doc updates for indexers.
John Rouillard <rouilj@ieee.org>
parents: 6592
diff changeset
380 than 2 characters or more than 50 characters is discarded. Also a
6592
828e2eaee7cd Document full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
381 stoplist is used to remove common words like "with", "and"
828e2eaee7cd Document full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
382 etc. Additional stoplist words can be added in the tracker's
828e2eaee7cd Document full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
383 config.ini file. Once filtering of the word list is done, each indexed
828e2eaee7cd Document full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
384 item (e.g. title, file or message content ...) is searched and if all
828e2eaee7cd Document full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
385 the terms are found in the item the item is returned. Then the items
828e2eaee7cd Document full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
386 are mapped to an issue and the list of matching issues is generated.
828e2eaee7cd Document full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
387
828e2eaee7cd Document full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
388 Other searching backends such as native-fts can be used in which case
828e2eaee7cd Document full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
389 the filtering above is not used. The search query can support
828e2eaee7cd Document full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
390 structure such as quoted phrases, matching one term or another rather
828e2eaee7cd Document full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
391 than both (or search), prefixes etc. In this case you should look at
6613
2eec7a500333 Doc updates for indexers.
John Rouillard <rouilj@ieee.org>
parents: 6592
diff changeset
392 the `documentation for configuring the native-fts`_ backend to find
2eec7a500333 Doc updates for indexers.
John Rouillard <rouilj@ieee.org>
parents: 6592
diff changeset
393 the supported format and features.
2eec7a500333 Doc updates for indexers.
John Rouillard <rouilj@ieee.org>
parents: 6592
diff changeset
394
2eec7a500333 Doc updates for indexers.
John Rouillard <rouilj@ieee.org>
parents: 6592
diff changeset
395 .. _`documentation for configuring the native-fts`: admin_guide.html#configuring-native-fts-full-text-search
1575
f5d53a939b67 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1570
diff changeset
396
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
397 Access Controls
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
398 ---------------
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
399
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
400 User access is controlled through Permissions. These are are grouped
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
401 into Roles, and users have a comma-separated list of Roles assigned to
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
402 them.
1317
28ae91aae74f clarifications
Richard Jones <richard@users.sourceforge.net>
parents: 1282
diff changeset
403
28ae91aae74f clarifications
Richard Jones <richard@users.sourceforge.net>
parents: 1282
diff changeset
404 Permissions divide access controls up into answering questions like:
28ae91aae74f clarifications
Richard Jones <richard@users.sourceforge.net>
parents: 1282
diff changeset
405
28ae91aae74f clarifications
Richard Jones <richard@users.sourceforge.net>
parents: 1282
diff changeset
406 - may the user edit issues ("Edit", "issue")
28ae91aae74f clarifications
Richard Jones <richard@users.sourceforge.net>
parents: 1282
diff changeset
407 - is the user allowed to use the web interface ("Web Access")
28ae91aae74f clarifications
Richard Jones <richard@users.sourceforge.net>
parents: 1282
diff changeset
408 - may the user edit other user's Roles through the web ("Web Roles")
28ae91aae74f clarifications
Richard Jones <richard@users.sourceforge.net>
parents: 1282
diff changeset
409
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
410 Any number of new Permissions and Roles may be created as described in
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
411 the customisation documentation. Examples of new access controls are:
1317
28ae91aae74f clarifications
Richard Jones <richard@users.sourceforge.net>
parents: 1282
diff changeset
412
28ae91aae74f clarifications
Richard Jones <richard@users.sourceforge.net>
parents: 1282
diff changeset
413 - only managers may sign off issues as complete
3529
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
414 - don't give users who register through e-mail web access
1317
28ae91aae74f clarifications
Richard Jones <richard@users.sourceforge.net>
parents: 1282
diff changeset
415 - let some users edit the details of all users
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
416
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
417
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
418 E-Mail Gateway
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
419 ==============
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
420
3529
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
421 Roundup trackers may be used to facilitate e-mail conversations around
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
422 issues. The "nosy" list attached to each issue indicates the users who
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
423 should receive e-mail when messages are added to the issue.
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
424
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
425 When e-mail comes into a tracker that identifies an issue in the subject
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
426 line, the content of the e-mail is attached to the issue.
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
427
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
428 You may even create new issues from e-mail messages.
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
429
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
430 E-mail sent to a tracker is examined for several pieces of information:
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
431
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
432 1. `subject-line information`_ identifying the purpose of the e-mail
1615
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
433 2. `sender identification`_ using the sender of the message
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
434 3. `e-mail message content`_ which is to be extracted
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
435 4. e-mail attachments which should be associated with the message
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
436
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
437
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
438 Subject-line information
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
439 ------------------------
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
440
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
441 The subject line of the incoming message is examined to find one of:
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
442
5827
c263187e82d1 Fix typos.
John Rouillard <rouilj@ieee.org>
parents: 5610
diff changeset
443 1. a case insensitive ``help``,
5056
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
444 2. a match for ``-- key <OneTimeKey>``,
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
445 3. the item that the message is responding to,
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
446 4. the type of item the message should create, or
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
447 5. we default the item class and try some trickiness.
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
448
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
449 If the subject is ``help`` (case insensitive), the gateway responds
5827
c263187e82d1 Fix typos.
John Rouillard <rouilj@ieee.org>
parents: 5610
diff changeset
450 with an explanation of the interface.
5056
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
451
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
452 If a one-time key is found, we're processing an in-progress
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
453 registration confirmation.
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
454
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
455 If the subject line contains a prefix in ``[square brackets]`` then
5056
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
456 we're looking at case 3 or 4 above. Any "re:" or "fwd:" prefixes are
2409
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
457 stripped off the subject line before we start looking for real
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
458 information.
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
459
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
460 If an item designator (class name and id number, for example
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
461 ``issue123``) is found there, a new "msg" item is added to the
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
462 "messages" property for that item, and any new "file" items are added to
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
463 the "files" property for the item.
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
464
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
465 If just an item class name is found there, we attempt to create a new
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
466 item of that class with its "messages" property initialized to contain
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
467 the new "msg" item and its "files" property initialized to contain any
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
468 new "file" items.
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
469
5056
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
470 The fifth case above - where no ``[information]`` is provided, the
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
471 tracker's ``MAIL_DEFAULT_CLASS`` configuration variable defines what
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
472 class of item the message relates to. We try to match the subject line
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
473 to an existing item of the default class, and if there's a match, the
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
474 message is related to that matched item. If not, then a new item of the
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
475 default class is created.
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
476
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
477
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
478 Setting Properties
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
479 ~~~~~~~~~~~~~~~~~~
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
480
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
481 The e-mail interface also provides a simple way to set properties on
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
482 items. At the end of the subject line, propname=value pairs can be
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
483 specified in square brackets, using the same conventions as for the
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
484 roundup set shell command.
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
485
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
486 For example,
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
487
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
488 - setting the priority of an issue::
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
489
4298
f6468c5e1493 Fix typo in email section of user guide, fixes issue2550607
Richard Jones <richard@users.sourceforge.net>
parents: 4036
diff changeset
490 Subject: Re: [issue2] the coffee machine is broken! [priority=urgent]
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
491
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
492 - adding yourself to a nosy list::
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
493
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
494 Subject: Re: [issue2] we're out of widgets [nosy=+richard]
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
495
1282
2feb3e0a9955 included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents: 1267
diff changeset
496 - setting the nosy list to just you and cliff::
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
497
1282
2feb3e0a9955 included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents: 1267
diff changeset
498 Subject: Re: [issue2] we're out of widgets [nosy=richard,cliff]
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
499
1282
2feb3e0a9955 included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents: 1267
diff changeset
500 - removing yourself from a nosy list and setting the priority::
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
501
1282
2feb3e0a9955 included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents: 1267
diff changeset
502 Subject: Re: [issue2] we're out of widgets [nosy=-richard;priority=bug]
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
503
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
504 In all cases, the message relates to issue 2. The ``Re:`` prefix is
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
505 stripped off.
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
506
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
507
1267
a28dfdb6c9a5 doc refinement
Richard Jones <richard@users.sourceforge.net>
parents: 1228
diff changeset
508 Automatic Properties
a28dfdb6c9a5 doc refinement
Richard Jones <richard@users.sourceforge.net>
parents: 1228
diff changeset
509 ~~~~~~~~~~~~~~~~~~~~
a28dfdb6c9a5 doc refinement
Richard Jones <richard@users.sourceforge.net>
parents: 1228
diff changeset
510
a28dfdb6c9a5 doc refinement
Richard Jones <richard@users.sourceforge.net>
parents: 1228
diff changeset
511 **status of new issues**
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
512 When a new message is received that is not identified as being related
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
513 to an existing issue, it creates a new issue. The status of the new
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
514 issue is defaulted to "unread".
1267
a28dfdb6c9a5 doc refinement
Richard Jones <richard@users.sourceforge.net>
parents: 1228
diff changeset
515
a28dfdb6c9a5 doc refinement
Richard Jones <richard@users.sourceforge.net>
parents: 1228
diff changeset
516 **reopening of resolved issues**
a28dfdb6c9a5 doc refinement
Richard Jones <richard@users.sourceforge.net>
parents: 1228
diff changeset
517 When a message is is received for a resolved issue, the issue status is
a28dfdb6c9a5 doc refinement
Richard Jones <richard@users.sourceforge.net>
parents: 1228
diff changeset
518 automatically reset to "chatting" to indicate new information has been
a28dfdb6c9a5 doc refinement
Richard Jones <richard@users.sourceforge.net>
parents: 1228
diff changeset
519 received.
a28dfdb6c9a5 doc refinement
Richard Jones <richard@users.sourceforge.net>
parents: 1228
diff changeset
520
a28dfdb6c9a5 doc refinement
Richard Jones <richard@users.sourceforge.net>
parents: 1228
diff changeset
521
1615
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
522 Sender identification
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
523 ---------------------
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
524
3529
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
525 If the sender of an e-mail is unknown to Roundup (looking up both user
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
526 primary e-mail addresses and their alternate addresses) then a new user
4018
17bdd79a3ae1 clarify default permission change
Richard Jones <richard@users.sourceforge.net>
parents: 3904
diff changeset
527 may be created, depending on tracker configuration (see the `Admin
17bdd79a3ae1 clarify default permission change
Richard Jones <richard@users.sourceforge.net>
parents: 3904
diff changeset
528 Guide`_ section "Users and Security" for configuration details.)
17bdd79a3ae1 clarify default permission change
Richard Jones <richard@users.sourceforge.net>
parents: 3904
diff changeset
529
17bdd79a3ae1 clarify default permission change
Richard Jones <richard@users.sourceforge.net>
parents: 3904
diff changeset
530 .. _`Admin Guide`: admin_guide.html
17bdd79a3ae1 clarify default permission change
Richard Jones <richard@users.sourceforge.net>
parents: 3904
diff changeset
531
17bdd79a3ae1 clarify default permission change
Richard Jones <richard@users.sourceforge.net>
parents: 3904
diff changeset
532 The new user will have their username set to the "user" part of
17bdd79a3ae1 clarify default permission change
Richard Jones <richard@users.sourceforge.net>
parents: 3904
diff changeset
533 "user@domain" in their e-mail address. Their password will be
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
534 completely randomised, and they'll have to visit the web interface to
2409
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
535 have it changed. Some sites don't allow web access by users who register
3529
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
536 via e-mail like this.
1615
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
537
7b680b906417 more user docco
Richard Jones <richard@users.sourceforge.net>
parents: 1599
diff changeset
538
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
539 E-Mail Message Content
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
540 ----------------------
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
541
6408
ef7bc1fac35a Update user_guide to include support for html messages.
John Rouillard <rouilj@ieee.org>
parents: 6257
diff changeset
542 By default Roundup only associates plain text (MIME type
ef7bc1fac35a Update user_guide to include support for html messages.
John Rouillard <rouilj@ieee.org>
parents: 6257
diff changeset
543 ``text/plain``) as messages for items. Any other parts of a message
ef7bc1fac35a Update user_guide to include support for html messages.
John Rouillard <rouilj@ieee.org>
parents: 6257
diff changeset
544 are associated as downloadable files. If no plain text part is found,
ef7bc1fac35a Update user_guide to include support for html messages.
John Rouillard <rouilj@ieee.org>
parents: 6257
diff changeset
545 the message is rejected. The tracker can be configured to enable
ef7bc1fac35a Update user_guide to include support for html messages.
John Rouillard <rouilj@ieee.org>
parents: 6257
diff changeset
546 ``convert_htmltotext``. If this is enabled, an email with an HTML
ef7bc1fac35a Update user_guide to include support for html messages.
John Rouillard <rouilj@ieee.org>
parents: 6257
diff changeset
547 message (MIME type ``text/html``) and no ``text/plain`` part will be
ef7bc1fac35a Update user_guide to include support for html messages.
John Rouillard <rouilj@ieee.org>
parents: 6257
diff changeset
548 accepted. The first HTML part will be converted to text and used as
ef7bc1fac35a Update user_guide to include support for html messages.
John Rouillard <rouilj@ieee.org>
parents: 6257
diff changeset
549 the message for the item. Subsequent parts will be treated as
ef7bc1fac35a Update user_guide to include support for html messages.
John Rouillard <rouilj@ieee.org>
parents: 6257
diff changeset
550 attachments.
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
551
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
552 To do this, incoming messages are examined for multiple parts:
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
553
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
554 * In a multipart/mixed message or part, each subpart is extracted and
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
555 examined. The text/plain subparts are assembled to form the textual
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
556 body of the message, to be stored in the file associated with a "msg"
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
557 class item. Any parts of other types are each stored in separate files
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
558 and given "file" class items that are linked to the "msg" item.
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
559 * In a multipart/alternative message or part, we look for a text/plain
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
560 subpart and ignore the other parts.
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
561
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
562 If the message is a response to a previous message, and contains quoted
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
563 sections, then these will be stripped out of the message if the
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
564 ``EMAIL_KEEP_QUOTED_TEXT`` configuration variable is set to ``'no'``.
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
565
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
566 Message summary
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
567 ~~~~~~~~~~~~~~~
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
568
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
569 The "summary" property on message items is taken from the first
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
570 non-quoting section in the message body. The message body is divided
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
571 into sections by blank lines. Sections where the second and all
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
572 subsequent lines begin with a ">" or "|" character are considered
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
573 "quoting sections". The first line of the first non-quoting section
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
574 becomes the summary of the message.
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
575
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
576
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
577 Address handling
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
578 ----------------
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
579
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
580 All of the addresses in the ``To:`` and ``Cc:`` headers of the incoming
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
581 message are looked up among the tracker users, and the corresponding
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
582 users are placed in the "recipients" property on the new "msg" item. The
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
583 address in the ``From:`` header similarly determines the "author"
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
584 property of the new "msg" item. The default handling for addresses that
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
585 don't have corresponding users is to create new users with no passwords
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
586 and a username equal to the address.
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
587
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
588 The addresses mentioned in the ``To:``, ``From:`` and ``Cc:`` headers of
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
589 the message may be added to the `nosy list`_ depending on:
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
590
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
591 ``ADD_AUTHOR_TO_NOSY``
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
592 Does the author of a message get placed on the nosy list automatically?
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
593 If 'new' is used, then the author will only be added when a message
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
594 creates a new issue. If 'yes', then the author will be added on
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
595 followups too. If 'no', they're never added to the nosy.
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
596
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
597 ``ADD_RECIPIENTS_TO_NOSY``
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
598 Do the recipients (To:, Cc:) of a message get placed on the nosy list?
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
599 If 'new' is used, then the recipients will only be added when a message
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
600 creates a new issue. If 'yes', then the recipients will be added on
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
601 followups too. If 'no', they're never added to the nosy.
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
602
5045
a46d5d0fd5f8 Fix issue1615201: Added a new configuration option EMAIL_KEEP_REAL_FROM
Peter Funk <pf@artcom-gmbh.de>
parents: 4929
diff changeset
603 Some organisations might prefer to have someone moderate emails before
a46d5d0fd5f8 Fix issue1615201: Added a new configuration option EMAIL_KEEP_REAL_FROM
Peter Funk <pf@artcom-gmbh.de>
parents: 4929
diff changeset
604 they are delivered into Roundup. Those might want to set the
a46d5d0fd5f8 Fix issue1615201: Added a new configuration option EMAIL_KEEP_REAL_FROM
Peter Funk <pf@artcom-gmbh.de>
parents: 4929
diff changeset
605 configuration option ``EMAIL_KEEP_REAL_FROM`` to ``'yes'`` to avoid
a46d5d0fd5f8 Fix issue1615201: Added a new configuration option EMAIL_KEEP_REAL_FROM
Peter Funk <pf@artcom-gmbh.de>
parents: 4929
diff changeset
606 having the moderators address appearing as the creator of issues.
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
607
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
608 Nosy List
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
609 ~~~~~~~~~
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
610
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1199
diff changeset
611 Roundup watches for additions to the "messages" property of items.
Richard Jones <richard@users.sourceforge.net>
parents: 1199
diff changeset
612
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
613 When a new message is added, it is sent to all the users on the "nosy"
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
614 list for the item that are not already on the "recipients" list of the
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
615 message. Those users are then appended to the "recipients" property on
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
616 the message, so multiple copies of a message are never sent to the same
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
617 user. The journal recorded by the hyperdatabase on the "recipients"
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
618 property then provides a log of when the message was sent to whom.
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
619
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
620 If the author of the message is also in the nosy list for the item that
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
621 the message is attached to, then the config var ``MESSAGES_TO_AUTHOR``
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
622 is queried to determine if they get a nosy list copy of the message too.
881
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
623
85cc6e6a94b8 better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
624
1359
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
625 Mail gateway script command line
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
626 --------------------------------
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
627
1844
67e530e2a0ae *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1661
diff changeset
628 Usage::
67e530e2a0ae *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1661
diff changeset
629
67e530e2a0ae *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1661
diff changeset
630 roundup-mailgw [[-C class] -S field=value]* <instance home> [method]
67e530e2a0ae *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1661
diff changeset
631
1359
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
632 The roundup mail gateway may be called in one of three ways:
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
633
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
634 - with an instance home as the only argument,
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
635 - with both an instance home and a mail spool file, or
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
636 - with both an instance home and a pop server account.
1359
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
637
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
638 It also supports optional -C and -S arguments that allows you to set a
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
639 fields for a class created by the roundup-mailgw. The default class if
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
640 not specified is msg, but the other classes: issue, file, user can also
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
641 be used. The -S or --set options uses the same
1359
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
642 property=value[;property=value] notation accepted by the command line
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
643 roundup command or the commands that can be given on the Subject line of
3529
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
644 an e-mail message.
1359
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
645
3529
4fd84dcfed33 more explanation
Richard Jones <richard@users.sourceforge.net>
parents: 3036
diff changeset
646 It can let you set the type of the message on a per e-mail address basis.
1359
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
647
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
648 PIPE:
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
649 In the first case, the mail gateway reads a single message from the
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
650 standard input and submits the message to the roundup.mailgw module.
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
651
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
652 UNIX mailbox:
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
653 In the second case, the gateway reads all messages from the mail spool
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
654 file and submits each in turn to the roundup.mailgw module. The file is
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
655 emptied once all messages have been successfully handled. The file is
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
656 specified as::
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
657
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
658 mailbox /path/to/mailbox
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
659
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
660 POP:
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
661 In the third case, the gateway reads all messages from the POP server
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
662 specified and submits each in turn to the roundup.mailgw module. The
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
663 server is specified as::
1560
3f2e516b8de3 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1499
diff changeset
664
1359
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
665 pop username:password@server
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
666
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
667 The username and password may be omitted::
1560
3f2e516b8de3 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1499
diff changeset
668
1359
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
669 pop username@server
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
670 pop server
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
671
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
672 are both valid. The username and/or password will be prompted for if
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
673 not supplied on the command-line.
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
674
4402
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
675 POPS:
5526
df3f553fa414 Update documentation for Python 3 support (issue 2550968, issue 2550980).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5056
diff changeset
676 Connect to a POP server over ssl.
4402
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
677 This supports the same notation as POP::
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
678
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
679 pops username:password@server
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
680
1560
3f2e516b8de3 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1499
diff changeset
681 APOP:
3f2e516b8de3 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1499
diff changeset
682 Same as POP, but using Authenticated POP::
3f2e516b8de3 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1499
diff changeset
683
3f2e516b8de3 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1499
diff changeset
684 apop username:password@server
3f2e516b8de3 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1499
diff changeset
685
4402
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
686 IMAP:
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
687 Connect to an IMAP server. This supports the same notation as that of
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
688 POP mail::
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
689
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
690 imap username:password@server
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
691
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
692 It also allows you to specify a specific mailbox other than INBOX using
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
693 this format::
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
694
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
695 imap username:password@server mailbox
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
696
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
697 IMAPS:
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
698 Connect to an IMAP server over ssl.
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
699 This supports the same notation as IMAP::
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
700
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
701 imaps username:password@server [mailbox]
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
702
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
703 IMAPS_CRAM:
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
704 Connect to an IMAP server over ssl using CRAM-MD5 authentication.
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
705 This supports the same notation as IMAP::
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
706
abb7dbbf27ba update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents: 4298
diff changeset
707 imaps_cram username:password@server [mailbox]
1359
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1317
diff changeset
708
6174
5522c950a2e4 Add indexing for roundup-admin references.
John Rouillard <rouilj@ieee.org>
parents: 5827
diff changeset
709 .. index:: ! roundup-admin
5522c950a2e4 Add indexing for roundup-admin references.
John Rouillard <rouilj@ieee.org>
parents: 5827
diff changeset
710 single: roundup-admin; usage
5522c950a2e4 Add indexing for roundup-admin references.
John Rouillard <rouilj@ieee.org>
parents: 5827
diff changeset
711 single: roundup-admin; data formats
5522c950a2e4 Add indexing for roundup-admin references.
John Rouillard <rouilj@ieee.org>
parents: 5827
diff changeset
712 pair: roundup-admin; designator
5522c950a2e4 Add indexing for roundup-admin references.
John Rouillard <rouilj@ieee.org>
parents: 5827
diff changeset
713
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
714 Command Line Tool
1199
cd58a8603424 half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents: 1098
diff changeset
715 =================
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
716
1098
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
717 The basic usage is::
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
718
1566
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
719 Usage: roundup-admin [options] [<command> <arguments>]
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
720
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
721 Options:
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
722 -i instance home -- specify the issue tracker "home directory" to administer
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
723 -u -- the user[:password] to use for commands
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
724 -d -- print full designators not just class id numbers
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
725 -c -- when outputting lists of data, comma-separate them.
1599
cc96bf971b33 extended date syntax to make range searches even more useful
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1596
diff changeset
726 Same as '-S ","'.
1566
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
727 -S <string> -- when outputting lists of data, string-separate them
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
728 -s -- when outputting lists of data, space-separate them.
1599
cc96bf971b33 extended date syntax to make range searches even more useful
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1596
diff changeset
729 Same as '-S " "'.
1566
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
730
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
731 Only one of -s, -c or -S can be specified.
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
732
1098
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
733 Help:
1566
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
734 roundup-admin -h
1098
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
735 roundup-admin help -- this help
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
736 roundup-admin help <command> -- command-specific help
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
737 roundup-admin help all -- all available help
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
738
1566
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
739 Commands:
1098
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
740 commit
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
741 create classname property=value ...
1566
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
742 display designator[,designator]*
1098
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
743 export [class[,class]] export_dir
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
744 find classname propname=value ...
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
745 get property designator[,designator]*
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
746 help topic
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
747 history designator
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
748 import import_dir
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
749 initialise [adminpw]
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
750 install [template [backend [admin password]]]
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
751 list classname [property]
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
752 pack period | date
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
753 reindex
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
754 retire designator[,designator]*
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
755 rollback
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
756 security [Role name]
1570
93e0a565cee5 fix the "set" command usage statement
Richard Jones <richard@users.sourceforge.net>
parents: 1566
diff changeset
757 set items property=value property=value ...
1098
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
758 specification classname
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
759 table classname [property[,property]*]
1566
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
760 Commands may be abbreviated as long as the abbreviation matches only one
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
761 command, e.g. l == li == lis == list.
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
762
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
763
1098
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
764 All commands (except help) require a tracker specifier. This is just the
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
765 path to the roundup tracker you're working with. A roundup tracker is
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
766 where roundup keeps the database and configuration file that defines an
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
767 issue tracker. It may be thought of as the issue tracker's "home
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
768 directory". It may be specified in the environment variable
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
769 ``TRACKER_HOME`` or on the command line as "``-i tracker``".
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
770
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
771 A designator is a classname and an itemid concatenated, eg. bug1,
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
772 user10, ... Property values are represented as strings in command
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
773 arguments and in the printed results:
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
774
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
775 - Strings are, well, strings.
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
776 - Password values will display as their encoded value.
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
777 - Date values are printed in the full date format in the local time
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
778 zone, and accepted in the full format or any of the partial formats
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
779 explained below.::
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
780
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
781 Input of... Means...
2028
1883dfd4fd77 Times in 'Date Value' examples were all out by 5 hours.
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1844
diff changeset
782 "2000-04-17.03:45" 2000-04-17.03:45:00
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
783 "2000-04-17" 2000-04-17.00:00:00
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
784 "01-25" yyyy-01-25.00:00:00
2028
1883dfd4fd77 Times in 'Date Value' examples were all out by 5 hours.
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1844
diff changeset
785 "08-13.22:13" yyyy-08-13.22:13:00
1883dfd4fd77 Times in 'Date Value' examples were all out by 5 hours.
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1844
diff changeset
786 "11-07.09:32:43" yyyy-11-07.09:32:43
1883dfd4fd77 Times in 'Date Value' examples were all out by 5 hours.
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1844
diff changeset
787 "14:25" yyyy-mm-dd.14:25:00
1883dfd4fd77 Times in 'Date Value' examples were all out by 5 hours.
Cameron Blackwood <drkorg@users.sourceforge.net>
parents: 1844
diff changeset
788 "8:47:11" yyyy-mm-dd.08:47:11
1599
cc96bf971b33 extended date syntax to make range searches even more useful
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1596
diff changeset
789 "2003" 2003-01-01.00:00:00
cc96bf971b33 extended date syntax to make range searches even more useful
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1596
diff changeset
790 "2003-04" 2003-04-01.00:00:00
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
791 "." "right now"
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
792
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
793 - Link values are printed as item designators. When given as an
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
794 argument, item designators and key strings are both accepted.
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 881
diff changeset
795 - Multilink values are printed as lists of item designators joined by
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
796 commas. When given as an argument, item designators and key strings
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
797 are both accepted; an empty string, a single item, or a list of items
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
798 joined by commas is accepted.
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
799
1098
c5819344714c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
800 When multiple items are specified to the roundup get or roundup set
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
801 commands, the specified properties are retrieved or set on all the
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
802 listed items. When multiple results are returned by the roundup get or
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
803 roundup find commands, they are printed one per line (default) or joined
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
804 by commas (with the "``-c``" option).
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
805
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
806 Where the command changes data, a login name/password is required. The
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
807 login may be specified as either "``name``" or "``name:password``".
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
808
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
809 - ``ROUNDUP_LOGIN`` environment variable
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
810 - the "``-u``" command-line option
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
811
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
812 If either the name or password is not supplied, they are obtained from
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
813 the command-line.
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
814
4792
1a0cf0345465 issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents: 4650
diff changeset
815 When you initialise a new tracker instance you are prompted for the
1a0cf0345465 issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents: 4650
diff changeset
816 admin password. If you want to initialise a tracker non-interactively
5827
c263187e82d1 Fix typos.
John Rouillard <rouilj@ieee.org>
parents: 5610
diff changeset
817 you can put the initialise command and password on the command
4792
1a0cf0345465 issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents: 4650
diff changeset
818 line. But this allows others on the host to see the password (using
1a0cf0345465 issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents: 4650
diff changeset
819 the ps command). To initialise a tracker non-interactively without
1a0cf0345465 issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents: 4650
diff changeset
820 exposing the password, create a file (e.g init_tracker) set to mode
1a0cf0345465 issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents: 4650
diff changeset
821 600 (so only the owner can read it) with the contents:
1a0cf0345465 issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents: 4650
diff changeset
822
1a0cf0345465 issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents: 4650
diff changeset
823 initialise admin_password
1a0cf0345465 issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents: 4650
diff changeset
824
1a0cf0345465 issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents: 4650
diff changeset
825 and feed it to roundup-admin on standard input. E.G.
1a0cf0345465 issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents: 4650
diff changeset
826
1a0cf0345465 issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents: 4650
diff changeset
827 cat init_tracker | roundup-admin -i tracker_dir
1a0cf0345465 issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents: 4650
diff changeset
828
5610
0df5f9eeefd4 Changed references to http://issues.roundup-tracker.org to https now
John Rouillard <rouilj@ieee.org>
parents: 5526
diff changeset
829 (for more details see https://issues.roundup-tracker.org/issue2550789.)
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
830
6174
5522c950a2e4 Add indexing for roundup-admin references.
John Rouillard <rouilj@ieee.org>
parents: 5827
diff changeset
831 .. index:: ! roundup-admin; usage in scripts
5522c950a2e4 Add indexing for roundup-admin references.
John Rouillard <rouilj@ieee.org>
parents: 5827
diff changeset
832
1566
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
833 Using with the shell
1588
1ac46e7e4150 more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 1575
diff changeset
834 --------------------
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
835
3754
9f4dd27ae843 documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents: 3696
diff changeset
836 With version 0.6.0 or newer of roundup (which introduced support for
9f4dd27ae843 documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents: 3696
diff changeset
837 multiple designators to display and the -d, -S and -s flags):
1566
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
838
1661
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
839 To find all messages regarding chatting issues that contain the word
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
840 "spam", for example, you could execute the following command from the
b9c1226cb600 Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1615
diff changeset
841 directory where the database dumps its files::
1566
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
842
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
843 shell% for issue in `roundup-admin -ds find issue status=chatting`; do
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
844 > grep -l spam `roundup-admin -ds ' ' get messages $issue`
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
845 > done
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
846 msg23
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
847 msg49
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
848 msg50
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
849 msg61
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
850 shell%
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
851
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
852 Or, using the -dc option, this can be written as a single command::
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
853
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
854 shell% grep -l spam `roundup get messages \
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
855 \`roundup -dc find issue status=chatting\``
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
856 msg23
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
857 msg49
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
858 msg50
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
859 msg61
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
860 shell%
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
861
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
862 You can also display issue contents::
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
863
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
864 shell% roundup-admin display `roundup-admin -dc get messages \
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
865 issue3,issue1`
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
866 files: []
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
867 inreplyto: None
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
868 recipients: []
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
869 author: 1
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
870 date: 2003-02-16.21:23:03
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
871 messageid: None
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
872 summary: jkdskldjf
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
873 files: []
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
874 inreplyto: None
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
875 recipients: []
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
876 author: 1
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
877 date: 2003-02-15.01:59:11
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
878 messageid: None
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
879 summary: jlkfjadsf
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
880
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
881 or status::
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
882
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
883 shell% roundup-admin get name `/tools/roundup/bin/roundup-admin \
1599
cc96bf971b33 extended date syntax to make range searches even more useful
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1596
diff changeset
884 -dc -i /var/roundup/sysadmin get status issue3,issue1`
1566
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
885 unread
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
886 deferred
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
887
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
888 or status on a single line::
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
889
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
890 shell% echo `roundup-admin get name \`/tools/roundup/bin/roundup-admin \
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
891 -dc -i /var/roundup/sysadmin get status issue3,issue1\``
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
892 unread deferred
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
893
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
894 which is the same as::
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
895
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
896 shell% roundup-admin -s get name `/tools/roundup/bin/roundup-admin \
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
897 -dc -i /var/roundup/sysadmin get status issue3,issue1`
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
898 unread deferred
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
899
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
900 Also the tautological::
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
901
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
902 shell% roundup-admin get name \
1599
cc96bf971b33 extended date syntax to make range searches even more useful
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1596
diff changeset
903 `roundup-admin -dc get status \`roundup-admin -dc find issue \
1566
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
904 status=chatting\``
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
905 chatting
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
906 chatting
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
907
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
908 Remember the roundup commands that accept multiple designators accept
053065585406 added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
909 them ',' separated so using '-dc' is almost always required.
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
910
Roundup Issue Tracker: http://roundup-tracker.org/