Mercurial > p > roundup > code
annotate doc/user_guide.txt @ 4550:b59ba4dda623
remove old website HT file support; alter repository mentioned in developers doc
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Fri, 21 Oct 2011 15:15:06 +1100 |
| parents | abb7dbbf27ba |
| children | 0485b47a39a8 |
| rev | line source |
|---|---|
|
688
b38f4f95bffd
More doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
686
diff
changeset
|
1 ========== |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
2 User Guide |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
3 ========== |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
4 |
|
686
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
5 .. contents:: |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
6 |
| 2409 | 7 .. hint:: |
| 8 This document will refer to *issues* as the primary store of | |
| 9 information in the tracker. This is the default of the classic template, | |
| 10 but may vary in any given installation. | |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
11 |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
12 |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
13 Your Tracker in a Nutshell |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
14 ========================== |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
15 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
16 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
|
17 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
|
18 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
|
19 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
|
20 "user". |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
21 |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3696
diff
changeset
|
22 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
|
23 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
|
24 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
|
25 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
|
26 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
|
27 item's *designator*. |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
28 |
|
1844
67e530e2a0ae
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1661
diff
changeset
|
29 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
|
30 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
|
31 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
|
32 listings. |
|
67e530e2a0ae
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1661
diff
changeset
|
33 |
|
1615
7b680b906417
more user docco
Richard Jones <richard@users.sourceforge.net>
parents:
1599
diff
changeset
|
34 |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
35 Accessing the Tracker |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
36 --------------------- |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
37 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
38 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
|
39 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
40 1. through the `web interface`_, |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
41 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
|
42 3. using the `command line tool`_. |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
43 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
44 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
|
45 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
|
46 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
47 |
|
1615
7b680b906417
more user docco
Richard Jones <richard@users.sourceforge.net>
parents:
1599
diff
changeset
|
48 Issue life cycles in Roundup |
|
7b680b906417
more user docco
Richard Jones <richard@users.sourceforge.net>
parents:
1599
diff
changeset
|
49 ---------------------------- |
|
7b680b906417
more user docco
Richard Jones <richard@users.sourceforge.net>
parents:
1599
diff
changeset
|
50 |
|
3529
4fd84dcfed33
more explanation
Richard Jones <richard@users.sourceforge.net>
parents:
3036
diff
changeset
|
51 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
|
52 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
53 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
|
54 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
|
55 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
56 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
|
57 are not "resolved". |
|
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 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
|
60 reopened to the state of "chatting". |
|
1615
7b680b906417
more user docco
Richard Jones <richard@users.sourceforge.net>
parents:
1599
diff
changeset
|
61 |
|
3650
77e067e64035
copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
3529
diff
changeset
|
62 The full set of **prority** and **status** values are: |
|
77e067e64035
copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
3529
diff
changeset
|
63 |
|
77e067e64035
copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
3529
diff
changeset
|
64 =========== ===================================== |
|
77e067e64035
copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
3529
diff
changeset
|
65 Priority Description |
|
77e067e64035
copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
3529
diff
changeset
|
66 =========== ===================================== |
|
77e067e64035
copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
3529
diff
changeset
|
67 "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
|
68 "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
|
69 "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
|
70 "feature" want missing functionality |
|
77e067e64035
copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
3529
diff
changeset
|
71 "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
|
72 =========== ===================================== |
|
77e067e64035
copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
3529
diff
changeset
|
73 |
|
77e067e64035
copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
3529
diff
changeset
|
74 ============= ===================================== |
|
77e067e64035
copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
3529
diff
changeset
|
75 Status Description |
|
77e067e64035
copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
3529
diff
changeset
|
76 ============= ===================================== |
|
77e067e64035
copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
3529
diff
changeset
|
77 "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
|
78 "deferred" intentionally set aside |
|
77e067e64035
copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
3529
diff
changeset
|
79 "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
|
80 "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
|
81 "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
|
82 "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
|
83 "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
|
84 "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
|
85 ============= ===================================== |
|
77e067e64035
copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
3529
diff
changeset
|
86 |
|
1615
7b680b906417
more user docco
Richard Jones <richard@users.sourceforge.net>
parents:
1599
diff
changeset
|
87 |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
88 Entering values in your Tracker |
|
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
89 ------------------------------- |
| 1575 | 90 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
91 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
|
92 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
|
93 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
|
94 administration tool. |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
95 |
| 1575 | 96 |
| 97 String and Numeric properties | |
| 98 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 99 | |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
100 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
|
101 |
| 1575 | 102 |
| 103 Boolean properties | |
| 104 ~~~~~~~~~~~~~~~~~~ | |
| 105 | |
| 106 These fields take a value which indicates "yes"/"no", "true"/"false", | |
| 107 "1"/"0" or "on"/"off". | |
| 108 | |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
109 |
| 1575 | 110 Constrained (link and multilink) properties |
| 111 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 112 | |
|
3904
91008ec8f9a0
retire "topic" usage
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3756
diff
changeset
|
113 Fields like "Assigned To" and "Keywords" hold references to items in other |
| 1575 | 114 classes ("user" and "keyword" in those two cases.) |
| 115 | |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
116 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
|
117 To" field. |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
118 |
|
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
119 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
|
120 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
|
121 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
|
122 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
|
123 not set. For example, the following searches on the issues: |
| 1575 | 124 |
| 125 ``assignedto=richard,george`` | |
| 126 match issues which are assigned to richard or george. | |
| 127 ``assignedto=-1`` | |
| 128 match issues that are not assigned to a user. | |
| 129 ``assignedto=2,3,40`` | |
| 130 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
|
131 ``keyword=user interface`` |
|
91008ec8f9a0
retire "topic" usage
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3756
diff
changeset
|
132 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
|
133 ``keyword=web interface,e-mail interface`` |
|
3529
4fd84dcfed33
more explanation
Richard Jones <richard@users.sourceforge.net>
parents:
3036
diff
changeset
|
134 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
|
135 their keyword list |
|
91008ec8f9a0
retire "topic" usage
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3756
diff
changeset
|
136 ``keyword=-1`` |
|
91008ec8f9a0
retire "topic" usage
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3756
diff
changeset
|
137 match issues with no keywords set |
| 1575 | 138 |
| 139 | |
| 140 Date properties | |
| 141 ~~~~~~~~~~~~~~~ | |
| 142 | |
|
2750
a97bbd72a643
copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
143 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
|
144 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
|
145 (``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
|
146 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
|
147 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
|
148 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
|
149 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
|
150 |
|
a97bbd72a643
copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
151 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
|
152 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
|
153 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
|
154 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
|
155 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
|
156 ``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
|
157 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
|
158 |
|
a97bbd72a643
copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
159 - "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
|
160 - "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
|
161 - "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
|
162 - "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
|
163 - "11-07.09:32:43" means <Date yyyy-11-07.14:32:43> |
|
a97bbd72a643
copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
164 - "14:25" means |
|
a97bbd72a643
copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
165 - <Date yyyy-mm-dd.19:25:00> |
|
a97bbd72a643
copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
166 - "8:47:11" means |
|
a97bbd72a643
copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
167 - <Date yyyy-mm-dd.13:47:11> |
|
a97bbd72a643
copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
168 - 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
|
169 |
|
a97bbd72a643
copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
170 |
|
a97bbd72a643
copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
171 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
|
172 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
|
173 specify range of dates in one of two formats: |
| 1575 | 174 |
| 175 1. English syntax:: | |
| 176 | |
|
1599
cc96bf971b33
extended date syntax to make range searches even more useful
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1596
diff
changeset
|
177 [From <value>][To <value>] |
| 1575 | 178 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
179 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
|
180 optional. |
| 1575 | 181 |
| 182 2. "Geek" syntax:: | |
| 183 | |
|
1599
cc96bf971b33
extended date syntax to make range searches even more useful
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1596
diff
changeset
|
184 [<value>];[<value>] |
| 1575 | 185 |
| 186 Either first or second ``<value>`` can be omitted in both syntaxes. | |
| 187 | |
| 188 For example, if you enter string "from 9:00" to "Creation date" field, | |
| 189 roundup will find all issues, that were created today since 9 AM. | |
| 190 | |
|
2750
a97bbd72a643
copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
191 The ``<value>`` may also be an interval, as described in the next section. |
| 1575 | 192 Searching of "-2m; -1m" on activity field gives you issues which were |
| 193 active between period of time since 2 months up-till month ago. | |
| 194 | |
| 2910 | 195 Other possible examples (consider local time is 2003-03-08.22:07:48): |
| 1575 | 196 |
|
2750
a97bbd72a643
copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
197 - "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
|
198 <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
|
199 - "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
|
200 <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
|
201 - "12:00;" means |
|
a97bbd72a643
copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
202 <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
|
203 - "tO +3d" 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 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
|
205 - "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
|
206 <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
|
207 - "; 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
|
208 <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
|
209 - "2003" 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 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
|
211 - "2003-04" 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 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
|
213 |
| 1575 | 214 |
| 215 Interval properties | |
| 216 ~~~~~~~~~~~~~~~~~~~ | |
| 217 | |
|
2750
a97bbd72a643
copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
218 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
|
219 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
|
220 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
|
221 may not). |
| 1575 | 222 |
|
2750
a97bbd72a643
copy date/interval formatting from design spec to user guide
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
223 - "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
|
224 - "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
|
225 - "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
|
226 - "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
|
227 - "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
|
228 - "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
|
229 - "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
|
230 |
| 1575 | 231 |
|
2138
f76d1642014a
doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
2136
diff
changeset
|
232 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
|
233 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
f76d1642014a
doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
2136
diff
changeset
|
234 |
|
f76d1642014a
doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
2136
diff
changeset
|
235 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
|
236 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
|
237 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
|
238 |
|
f76d1642014a
doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
2136
diff
changeset
|
239 |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
240 Web Interface |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
241 ============= |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
242 |
| 2409 | 243 .. note:: |
| 244 This document contains screenshots of the default look and feel. | |
| 245 Your site may have a slightly (or very) different look, but the | |
| 246 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
|
247 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
248 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
|
249 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
250 1. `lists of items`_, |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
251 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
|
252 3. `searching page`_. |
|
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 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
255 Lists of Items |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
256 -------------- |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
257 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
258 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
|
259 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
|
260 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
|
261 |
|
3756
068b3d7d4279
images for user guide
Richard Jones <richard@users.sourceforge.net>
parents:
3754
diff
changeset
|
262 .. 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
|
263 |
|
3756
068b3d7d4279
images for user guide
Richard Jones <richard@users.sourceforge.net>
parents:
3754
diff
changeset
|
264 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
|
265 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
|
266 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
|
267 the tracker. |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
268 |
|
3756
068b3d7d4279
images for user guide
Richard Jones <richard@users.sourceforge.net>
parents:
3754
diff
changeset
|
269 You may either register or log in. Registration takes you to: |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
270 |
|
3756
068b3d7d4279
images for user guide
Richard Jones <richard@users.sourceforge.net>
parents:
3754
diff
changeset
|
271 .. image:: images/registration.png |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
272 |
|
3756
068b3d7d4279
images for user guide
Richard Jones <richard@users.sourceforge.net>
parents:
3754
diff
changeset
|
273 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
|
274 |
|
3756
068b3d7d4279
images for user guide
Richard Jones <richard@users.sourceforge.net>
parents:
3754
diff
changeset
|
275 .. 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
|
276 |
|
3756
068b3d7d4279
images for user guide
Richard Jones <richard@users.sourceforge.net>
parents:
3754
diff
changeset
|
277 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
|
278 |
|
3756
068b3d7d4279
images for user guide
Richard Jones <richard@users.sourceforge.net>
parents:
3754
diff
changeset
|
279 .. image:: images/my_details.png |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
280 |
| 1228 | 281 |
| 282 Display, edit or entry of an item | |
| 283 --------------------------------- | |
| 284 | |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
285 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
|
286 will take you to: |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
287 |
|
3756
068b3d7d4279
images for user guide
Richard Jones <richard@users.sourceforge.net>
parents:
3754
diff
changeset
|
288 .. image:: images/new_issue.png |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
289 |
|
3756
068b3d7d4279
images for user guide
Richard Jones <richard@users.sourceforge.net>
parents:
3754
diff
changeset
|
290 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
|
291 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
|
292 |
|
3756
068b3d7d4279
images for user guide
Richard Jones <richard@users.sourceforge.net>
parents:
3754
diff
changeset
|
293 .. image:: images/edit_issue.png |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
294 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
295 |
| 1228 | 296 Searching Page |
| 297 -------------- | |
| 298 | |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
299 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
|
300 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
|
301 |
|
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
302 |
|
2136
ee3cf6a44f29
queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents:
2028
diff
changeset
|
303 Saving queries |
|
ee3cf6a44f29
queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents:
2028
diff
changeset
|
304 ~~~~~~~~~~~~~~ |
|
ee3cf6a44f29
queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents:
2028
diff
changeset
|
305 |
|
ee3cf6a44f29
queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents:
2028
diff
changeset
|
306 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
|
307 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
|
308 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
|
309 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
|
310 |
|
ee3cf6a44f29
queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents:
2028
diff
changeset
|
311 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
|
312 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
|
313 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
|
314 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
|
315 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
|
316 |
|
ee3cf6a44f29
queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents:
2028
diff
changeset
|
317 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
|
318 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
|
319 above. |
|
ee3cf6a44f29
queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents:
2028
diff
changeset
|
320 |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
321 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
322 Under the covers |
| 1575 | 323 ~~~~~~~~~~~~~~~~ |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
324 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
325 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
|
326 arguments: |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
327 |
|
3036
8fa6b5747a53
updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents:
2910
diff
changeset
|
328 ============ ============================================================= |
|
8fa6b5747a53
updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents:
2910
diff
changeset
|
329 Argument Description |
|
8fa6b5747a53
updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents:
2910
diff
changeset
|
330 ============ ============================================================= |
|
8fa6b5747a53
updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents:
2910
diff
changeset
|
331 @sort sort by prop name, optionally preceeded with '-' to give |
|
3696
790363e96852
Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
3650
diff
changeset
|
332 descending or nothing for ascending sorting. The sort |
|
790363e96852
Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
3650
diff
changeset
|
333 argument can have several props separated with comma. |
|
3036
8fa6b5747a53
updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents:
2910
diff
changeset
|
334 @group group by prop name, optionally preceeded with '-' or to sort |
|
3696
790363e96852
Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
3650
diff
changeset
|
335 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
|
336 argument can have several props separated with comma. |
|
3036
8fa6b5747a53
updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents:
2910
diff
changeset
|
337 @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
|
338 all. |
|
8fa6b5747a53
updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents:
2910
diff
changeset
|
339 @filter indicates which properties are being used in filtering. |
|
8fa6b5747a53
updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents:
2910
diff
changeset
|
340 Default is none. |
|
8fa6b5747a53
updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents:
2910
diff
changeset
|
341 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
|
342 have (very basic search/filter). |
|
8fa6b5747a53
updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents:
2910
diff
changeset
|
343 @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
|
344 etc) |
|
8fa6b5747a53
updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents:
2910
diff
changeset
|
345 ============ ============================================================= |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
346 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
347 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
|
348 (whitespace has been added for clarity):: |
| 1575 | 349 |
| 350 /issue?status=unread,in-progress,resolved& | |
|
3904
91008ec8f9a0
retire "topic" usage
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3756
diff
changeset
|
351 keyword=security,ui& |
|
3696
790363e96852
Sorting/grouping by multiple properties.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
3650
diff
changeset
|
352 @group=priority,-status& |
|
3036
8fa6b5747a53
updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents:
2910
diff
changeset
|
353 @sort=-activity& |
|
3904
91008ec8f9a0
retire "topic" usage
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3756
diff
changeset
|
354 @filters=status,keyword& |
|
3036
8fa6b5747a53
updated searching / indexing docs
Richard Jones <richard@users.sourceforge.net>
parents:
2910
diff
changeset
|
355 @columns=title,status,fixer |
| 1575 | 356 |
| 357 | |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
358 Access Controls |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
359 --------------- |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
360 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
361 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
|
362 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
|
363 them. |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
364 |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
365 Permissions divide access controls up into answering questions like: |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
366 |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
367 - may the user edit issues ("Edit", "issue") |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
368 - is the user allowed to use the web interface ("Web Access") |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
369 - 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
|
370 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
371 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
|
372 the customisation documentation. Examples of new access controls are: |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
373 |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
374 - only managers may sign off issues as complete |
|
3529
4fd84dcfed33
more explanation
Richard Jones <richard@users.sourceforge.net>
parents:
3036
diff
changeset
|
375 - don't give users who register through e-mail web access |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
376 - 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
|
377 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
378 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
379 E-Mail Gateway |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
380 ============== |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
381 |
|
3529
4fd84dcfed33
more explanation
Richard Jones <richard@users.sourceforge.net>
parents:
3036
diff
changeset
|
382 Roundup trackers may be used to facilitate e-mail conversations around |
|
4fd84dcfed33
more explanation
Richard Jones <richard@users.sourceforge.net>
parents:
3036
diff
changeset
|
383 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
|
384 should receive e-mail when messages are added to the issue. |
|
4fd84dcfed33
more explanation
Richard Jones <richard@users.sourceforge.net>
parents:
3036
diff
changeset
|
385 |
|
4fd84dcfed33
more explanation
Richard Jones <richard@users.sourceforge.net>
parents:
3036
diff
changeset
|
386 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
|
387 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
|
388 |
|
4fd84dcfed33
more explanation
Richard Jones <richard@users.sourceforge.net>
parents:
3036
diff
changeset
|
389 You may even create new issues from e-mail messages. |
|
4fd84dcfed33
more explanation
Richard Jones <richard@users.sourceforge.net>
parents:
3036
diff
changeset
|
390 |
|
4fd84dcfed33
more explanation
Richard Jones <richard@users.sourceforge.net>
parents:
3036
diff
changeset
|
391 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
|
392 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
393 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
|
394 2. `sender identification`_ using the sender of the message |
|
7b680b906417
more user docco
Richard Jones <richard@users.sourceforge.net>
parents:
1599
diff
changeset
|
395 3. `e-mail message content`_ which is to be extracted |
|
7b680b906417
more user docco
Richard Jones <richard@users.sourceforge.net>
parents:
1599
diff
changeset
|
396 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
|
397 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
398 |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
399 Subject-line information |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
400 ------------------------ |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
401 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
402 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
|
403 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
404 1. the item that the message is responding to, |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
405 2. the type of item the message should create, or |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
406 3. we default the item class and try some trickiness |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
407 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
408 If the subject line contains a prefix in ``[square brackets]`` then |
| 2409 | 409 we're looking at case 1 or 2 above. Any "re:" or "fwd:" prefixes are |
| 410 stripped off the subject line before we start looking for real | |
| 411 information. | |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
412 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
413 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
|
414 ``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
|
415 "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
|
416 the "files" property for the item. |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
417 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
418 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
|
419 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
|
420 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
|
421 new "file" items. |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
422 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
423 The third case above - where no ``[information]`` is provided, the |
|
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
424 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
|
425 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
|
426 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
|
427 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
|
428 default class is created. |
|
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
429 |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
430 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
431 Setting Properties |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
432 ~~~~~~~~~~~~~~~~~~ |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
433 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
434 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
|
435 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
|
436 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
|
437 roundup set shell command. |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
438 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
439 For example, |
|
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 - setting the priority of an issue:: |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
442 |
|
4298
f6468c5e1493
Fix typo in email section of user guide, fixes issue2550607
Richard Jones <richard@users.sourceforge.net>
parents:
4036
diff
changeset
|
443 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
|
444 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
445 - adding yourself to a nosy list:: |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
446 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
447 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
|
448 |
|
1282
2feb3e0a9955
included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents:
1267
diff
changeset
|
449 - 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
|
450 |
|
1282
2feb3e0a9955
included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents:
1267
diff
changeset
|
451 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
|
452 |
|
1282
2feb3e0a9955
included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents:
1267
diff
changeset
|
453 - 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
|
454 |
|
1282
2feb3e0a9955
included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents:
1267
diff
changeset
|
455 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
|
456 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
457 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
|
458 stripped off. |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
459 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
460 |
|
1267
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
461 Automatic Properties |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
462 ~~~~~~~~~~~~~~~~~~~~ |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
463 |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
464 **status of new issues** |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
465 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
|
466 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
|
467 issue is defaulted to "unread". |
|
1267
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
468 |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
469 **reopening of resolved issues** |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
470 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
|
471 automatically reset to "chatting" to indicate new information has been |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
472 received. |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
473 |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
474 |
|
1615
7b680b906417
more user docco
Richard Jones <richard@users.sourceforge.net>
parents:
1599
diff
changeset
|
475 Sender identification |
|
7b680b906417
more user docco
Richard Jones <richard@users.sourceforge.net>
parents:
1599
diff
changeset
|
476 --------------------- |
|
7b680b906417
more user docco
Richard Jones <richard@users.sourceforge.net>
parents:
1599
diff
changeset
|
477 |
|
3529
4fd84dcfed33
more explanation
Richard Jones <richard@users.sourceforge.net>
parents:
3036
diff
changeset
|
478 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
|
479 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
|
480 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
|
481 Guide`_ section "Users and Security" for configuration details.) |
|
17bdd79a3ae1
clarify default permission change
Richard Jones <richard@users.sourceforge.net>
parents:
3904
diff
changeset
|
482 |
|
17bdd79a3ae1
clarify default permission change
Richard Jones <richard@users.sourceforge.net>
parents:
3904
diff
changeset
|
483 .. _`Admin Guide`: admin_guide.html |
|
17bdd79a3ae1
clarify default permission change
Richard Jones <richard@users.sourceforge.net>
parents:
3904
diff
changeset
|
484 |
|
17bdd79a3ae1
clarify default permission change
Richard Jones <richard@users.sourceforge.net>
parents:
3904
diff
changeset
|
485 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
|
486 "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
|
487 completely randomised, and they'll have to visit the web interface to |
| 2409 | 488 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
|
489 via e-mail like this. |
|
1615
7b680b906417
more user docco
Richard Jones <richard@users.sourceforge.net>
parents:
1599
diff
changeset
|
490 |
|
7b680b906417
more user docco
Richard Jones <richard@users.sourceforge.net>
parents:
1599
diff
changeset
|
491 |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
492 E-Mail Message Content |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
493 ---------------------- |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
494 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
495 Roundup only associates plain text (MIME type ``text/plain``) as |
|
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
496 messages for items. Any other parts of a message are associated as |
|
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
497 downloadable files. If no plain text part is found, the message is |
|
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
498 rejected. |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
499 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
500 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
|
501 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
502 * 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
|
503 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
|
504 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
|
505 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
|
506 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
|
507 * 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
|
508 subpart and ignore the other parts. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
509 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
510 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
|
511 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
|
512 ``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
|
513 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
514 Message summary |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
515 ~~~~~~~~~~~~~~~ |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
516 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
517 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
|
518 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
|
519 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
|
520 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
|
521 "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
|
522 becomes the summary of the message. |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
523 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
524 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
525 Address handling |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
526 ---------------- |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
527 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
528 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
|
529 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
|
530 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
|
531 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
|
532 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
|
533 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
|
534 and a username equal to the address. |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
535 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
536 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
|
537 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
|
538 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
539 ``ADD_AUTHOR_TO_NOSY`` |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
540 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
|
541 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
|
542 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
|
543 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
|
544 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
545 ``ADD_RECIPIENTS_TO_NOSY`` |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
546 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
|
547 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
|
548 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
|
549 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
|
550 |
|
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 Nosy List |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
553 ~~~~~~~~~ |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
554 |
| 1228 | 555 Roundup watches for additions to the "messages" property of items. |
| 556 | |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
557 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
|
558 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
|
559 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
|
560 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
|
561 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
|
562 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
|
563 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
564 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
|
565 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
|
566 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
|
567 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
568 |
|
1359
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
569 Mail gateway script command line |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
570 -------------------------------- |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
571 |
|
1844
67e530e2a0ae
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1661
diff
changeset
|
572 Usage:: |
|
67e530e2a0ae
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1661
diff
changeset
|
573 |
|
67e530e2a0ae
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1661
diff
changeset
|
574 roundup-mailgw [[-C class] -S field=value]* <instance home> [method] |
|
67e530e2a0ae
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1661
diff
changeset
|
575 |
|
1359
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
576 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
|
577 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
578 - with an instance home as the only argument, |
|
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
579 - 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
|
580 - 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
|
581 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
582 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
|
583 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
|
584 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
|
585 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
|
586 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
|
587 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
|
588 an e-mail message. |
|
1359
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
589 |
|
3529
4fd84dcfed33
more explanation
Richard Jones <richard@users.sourceforge.net>
parents:
3036
diff
changeset
|
590 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
|
591 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
592 PIPE: |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
593 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
|
594 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
|
595 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
596 UNIX mailbox: |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
597 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
|
598 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
|
599 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
|
600 specified as:: |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
601 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
602 mailbox /path/to/mailbox |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
603 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
604 POP: |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
605 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
|
606 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
|
607 server is specified as:: |
| 1560 | 608 |
|
1359
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
609 pop username:password@server |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
610 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
611 The username and password may be omitted:: |
| 1560 | 612 |
|
1359
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
613 pop username@server |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
614 pop server |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
615 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
616 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
|
617 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
|
618 |
|
4402
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
619 POPS: |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
620 Connect to a POP server over ssl. This requires python 2.4 or later. |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
621 This supports the same notation as POP:: |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
622 |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
623 pops username:password@server |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
624 |
| 1560 | 625 APOP: |
| 626 Same as POP, but using Authenticated POP:: | |
| 627 | |
| 628 apop username:password@server | |
| 629 | |
|
4402
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
630 IMAP: |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
631 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
|
632 POP mail:: |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
633 |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
634 imap username:password@server |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
635 |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
636 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
|
637 this format:: |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
638 |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
639 imap username:password@server mailbox |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
640 |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
641 IMAPS: |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
642 Connect to an IMAP server over ssl. |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
643 This supports the same notation as IMAP:: |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
644 |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
645 imaps username:password@server [mailbox] |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
646 |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
647 IMAPS_CRAM: |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
648 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
|
649 This supports the same notation as IMAP:: |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
650 |
|
abb7dbbf27ba
update mailgw docs
Richard Jones <richard@users.sourceforge.net>
parents:
4298
diff
changeset
|
651 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
|
652 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
653 Command Line Tool |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
654 ================= |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
655 |
| 1098 | 656 The basic usage is:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
657 |
|
1566
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
658 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
|
659 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
660 Options: |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
661 -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
|
662 -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
|
663 -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
|
664 -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
|
665 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
|
666 -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
|
667 -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
|
668 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
|
669 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
670 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
|
671 |
| 1098 | 672 Help: |
|
1566
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
673 roundup-admin -h |
| 1098 | 674 roundup-admin help -- this help |
| 675 roundup-admin help <command> -- command-specific help | |
| 676 roundup-admin help all -- all available help | |
| 677 | |
|
1566
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
678 Commands: |
| 1098 | 679 commit |
| 680 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
|
681 display designator[,designator]* |
| 1098 | 682 export [class[,class]] export_dir |
| 683 find classname propname=value ... | |
| 684 get property designator[,designator]* | |
| 685 help topic | |
| 686 history designator | |
| 687 import import_dir | |
| 688 initialise [adminpw] | |
| 689 install [template [backend [admin password]]] | |
| 690 list classname [property] | |
| 691 pack period | date | |
| 692 reindex | |
| 693 retire designator[,designator]* | |
| 694 rollback | |
| 695 security [Role name] | |
|
1570
93e0a565cee5
fix the "set" command usage statement
Richard Jones <richard@users.sourceforge.net>
parents:
1566
diff
changeset
|
696 set items property=value property=value ... |
| 1098 | 697 specification classname |
| 698 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
|
699 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
|
700 command, e.g. l == li == lis == list. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
701 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
702 |
| 1098 | 703 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
|
704 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
|
705 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
|
706 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
|
707 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
|
708 ``TRACKER_HOME`` or on the command line as "``-i tracker``". |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
709 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
710 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
|
711 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
|
712 arguments and in the printed results: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
713 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
714 - Strings are, well, strings. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
715 - 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
|
716 - 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
|
717 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
|
718 explained below.:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
719 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
720 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
|
721 "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
|
722 "2000-04-17" 2000-04-17.00:00:00 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
723 "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
|
724 "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
|
725 "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
|
726 "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
|
727 "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
|
728 "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
|
729 "2003-04" 2003-04-01.00:00:00 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
730 "." "right now" |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
731 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
732 - 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
|
733 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
|
734 - 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
|
735 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
|
736 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
|
737 joined by commas is accepted. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
738 |
| 1098 | 739 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
|
740 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
|
741 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
|
742 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
|
743 by commas (with the "``-c``" option). |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
744 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
745 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
|
746 login may be specified as either "``name``" or "``name:password``". |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
747 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
748 - ``ROUNDUP_LOGIN`` environment variable |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
749 - the "``-u``" command-line option |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
750 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
751 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
|
752 the command-line. |
|
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
753 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
754 |
|
1566
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
755 Using with the shell |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
756 -------------------- |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
757 |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3696
diff
changeset
|
758 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
|
759 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
|
760 |
|
1661
b9c1226cb600
Reflowed text to 72 cols...
Jean Jordaan <neaj@users.sourceforge.net>
parents:
1615
diff
changeset
|
761 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
|
762 "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
|
763 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
|
764 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
765 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
|
766 > 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
|
767 > done |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
768 msg23 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
769 msg49 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
770 msg50 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
771 msg61 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
772 shell% |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
773 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
774 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
|
775 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
776 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
|
777 \`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
|
778 msg23 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
779 msg49 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
780 msg50 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
781 msg61 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
782 shell% |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
783 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
784 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
|
785 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
786 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
|
787 issue3,issue1` |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
788 files: [] |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
789 inreplyto: None |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
790 recipients: [] |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
791 author: 1 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
792 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
|
793 messageid: None |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
794 summary: jkdskldjf |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
795 files: [] |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
796 inreplyto: None |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
797 recipients: [] |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
798 author: 1 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
799 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
|
800 messageid: None |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
801 summary: jlkfjadsf |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
802 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
803 or status:: |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
804 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
805 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
|
806 -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
|
807 unread |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
808 deferred |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
809 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
810 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
|
811 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
812 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
|
813 -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
|
814 unread deferred |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
815 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
816 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
|
817 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
818 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
|
819 -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
|
820 unread deferred |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
821 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
822 Also the tautological:: |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
823 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
824 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
|
825 `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
|
826 status=chatting\`` |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
827 chatting |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
828 chatting |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
829 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
830 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
|
831 them ',' separated so using '-dc' is almost always required. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
832 |