Mercurial > p > roundup > code
annotate doc/user_guide.txt @ 1597:4d55f90d4af1
granularity based ranges
| author | Andrey Lebedev <kedder@users.sourceforge.net> |
|---|---|
| date | Mon, 21 Apr 2003 14:29:40 +0000 |
| parents | 33a0d94c7658 |
| children | cc96bf971b33 |
| 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 |
|
1596
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1588
diff
changeset
|
5 :Version: $Revision: 1.20 $ |
|
686
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
6 |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
7 .. contents:: |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
8 |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
9 Note: this document will refer to *issues* as the primary store of information |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
10 in the tracker. This is the default of the classic template, bubt may vary in |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
11 any given installation. |
|
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 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
16 Your tracker holds information about issues in bundles we call *items*. An |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
17 item may be an *issue* (a bug or feature request) or a *user*. The issue-ness or |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
18 user-ness is called the item's *class*. So, for bug reports and features, the |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
19 class is "issue", and for users the class is "user". |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
20 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
21 Each item in the tracker has an id number that identifies it along with its |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
22 item class. To identify a particular issue or user, we combine the class with |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
23 the number to create a unique label, so that user 1 (who, incidentally, is |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
24 *always* the "admin" user) is referred to as "user1". Issue number 315 is |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
25 referred to as "issue315". We call that label the item's *designator*. |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
26 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
27 Accessing the Tracker |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
28 --------------------- |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
29 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
30 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
|
31 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
32 1. through the `web interface`_, |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
33 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
|
34 3. using the `command line tool`_. |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
35 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
36 The last is usually only used by administrators. Most users will use the web |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
37 and email interfaces. All three are explained below. |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
38 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
39 |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
40 Entering values in your Tracker |
|
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
41 ------------------------------- |
| 1575 | 42 |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
43 All interfaces to your tracker use the same format for entering values. This |
|
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
44 means the web interface for entering a new issue, the web interface for |
|
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
45 searching issues, the email interface and even the command-line administration |
|
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
46 tool. |
|
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
47 |
| 1575 | 48 |
| 49 String and Numeric properties | |
| 50 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 51 | |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
52 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
|
53 |
| 1575 | 54 |
| 55 Boolean properties | |
| 56 ~~~~~~~~~~~~~~~~~~ | |
| 57 | |
| 58 These fields take a value which indicates "yes"/"no", "true"/"false", | |
| 59 "1"/"0" or "on"/"off". | |
| 60 | |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
61 |
| 1575 | 62 Constrained (link and multilink) properties |
| 63 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 64 | |
| 65 Fields like "Assigned To" and "Topics" hold references to items in other | |
| 66 classes ("user" and "keyword" in those two cases.) | |
| 67 | |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
68 Sometimes, the selection is done through a menu, like in the "Assigned To" |
|
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
69 field. |
|
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
70 |
|
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
71 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
|
72 list of values to indicated which values of "user" or "keyword" are |
|
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
73 interesting. The values may be either numeric ids or the |
| 1575 | 74 names of items. The special value "-1" may be used to match items where the |
| 75 property is not set. For example, the following searches on the issues: | |
| 76 | |
| 77 ``assignedto=richard,george`` | |
| 78 match issues which are assigned to richard or george. | |
| 79 ``assignedto=-1`` | |
| 80 match issues that are not assigned to a user. | |
| 81 ``assignedto=2,3,40`` | |
| 82 match issues that are assigned to users 2, 3 or 40. | |
| 83 ``topic=user interface`` | |
| 84 match issues with the keyword "user interface" in their topic list | |
| 85 ``topic=web interface,email interface`` | |
| 86 match issues with the keyword "web interface" or "email interface" in | |
| 87 their topic list | |
| 88 ``topic=-1`` | |
| 89 match issues with no topics set | |
| 90 | |
| 91 | |
| 92 Date properties | |
| 93 ~~~~~~~~~~~~~~~ | |
| 94 | |
| 95 Some fields in the search page (e.g. "Activity" or "Creation date") hold | |
| 96 dates. A plain date entered as a search field will match that date exactly | |
| 97 in the database. We may also accept ranges of dates. You can specify range | |
| 98 of dates in one of two formats: | |
| 99 | |
| 100 1. English syntax:: | |
| 101 | |
| 102 [[From] <value>][ To <value>] | |
| 103 | |
| 104 Keywords "From" and "To" are case insensitive. Keyword "From" is optional. | |
| 105 | |
| 106 2. "Geek" syntax:: | |
| 107 | |
| 108 [<value>][; <value>] | |
| 109 | |
| 110 Either first or second ``<value>`` can be omitted in both syntaxes. | |
| 111 | |
| 112 For example, if you enter string "from 9:00" to "Creation date" field, | |
| 113 roundup will find all issues, that were created today since 9 AM. | |
| 114 | |
| 115 Searching of "-2m; -1m" on activity field gives you issues which were | |
| 116 active between period of time since 2 months up-till month ago. | |
| 117 | |
| 118 Other possible examples (consider local time is Sat Mar 8 22:07:48 2003):: | |
| 119 | |
| 120 >>> Range("from 2-12 to 4-2") | |
| 121 <Range from 2003-02-12.00:00:00 to 2003-04-02.00:00:00> | |
| 122 | |
| 123 >>> Range("18:00 TO +2m") | |
| 124 <Range from 2003-03-08.18:00:00 to 2003-05-08.20:07:48> | |
| 125 | |
| 126 >>> Range("12:00") | |
| 127 <Range from 2003-03-08.12:00:00 to None> | |
| 128 | |
| 129 >>> Range("tO +3d") | |
| 130 <Range from None to 2003-03-11.20:07:48> | |
| 131 | |
| 132 >>> Range("2002-11-10; 2002-12-12") | |
| 133 <Range from 2002-11-10.00:00:00 to 2002-12-12.00:00:00> | |
| 134 | |
| 135 >>> Range("; 20:00 +1d") | |
| 136 <Range from None to 2003-03-09.20:00:00> | |
| 137 | |
| 138 | |
| 139 Interval properties | |
| 140 ~~~~~~~~~~~~~~~~~~~ | |
| 141 | |
| 142 XXX explain... | |
| 143 | |
|
1596
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1588
diff
changeset
|
144 When searching on interval properties use the same syntax as for dates. |
|
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1588
diff
changeset
|
145 |
| 1575 | 146 |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
147 Web Interface |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
148 ============= |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
149 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
150 Note: this document contains screenshots of the default look and feel. Your |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
151 site may have a slightly (or very) different look, but the functionality will |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
152 be very similar, and the concepts still hold. |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
153 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
154 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
|
155 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
156 1. `lists of items`_, |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
157 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
|
158 3. `searching page`_. |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
159 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
160 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
161 Lists of Items |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
162 -------------- |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
163 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
164 The first thing you'll see when you log into Roundup will be a list of open |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
165 (ie. not resolved) issues. This list has been generated by a bunch of controls |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
166 `under the covers`_ but for now, you can see something like: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
167 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
168 .. img: images/index_logged_out.png |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
169 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
170 The screen is divided up into three sections: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
171 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
172 .. img: images/page_layout.png |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
173 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
174 you may either register or log in. Registration takes you to: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
175 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
176 .. img: images/registration.png |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
177 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
178 Once you're logged in, the screen changes slightly to: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
179 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
180 .. img: images/index_logged_in.png |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
181 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
182 Note that the sidebar menu has changed slightly, so you can now get to your |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
183 "My Details" page: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
184 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
185 .. img: images/my_details.png |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
186 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
187 Note the new information on this page - the history. |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
188 |
| 1228 | 189 |
| 190 Display, edit or entry of an item | |
| 191 --------------------------------- | |
| 192 | |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
193 Create a new issue with "create new" under the issue subheading. This will |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
194 take you to: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
195 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
196 .. img: images/new_issue.png |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
197 |
| 1228 | 198 The `nosy list`_ is explained below. |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
199 Enter some information and click "submit new entry" and you'll be rewarded |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
200 with: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
201 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
202 .. img: images/new_issue_created.png |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
203 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
204 or, if you don't enter all the required information (or some other error |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
205 occurs) you'll get something like: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
206 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
207 .. img: images/new_issue_error.png |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
208 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
209 |
| 1228 | 210 Searching Page |
| 211 -------------- | |
| 212 | |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
213 See `entering values in your tracker`_ for an explanation of what you may |
|
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
214 type into the search form. |
|
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
215 |
|
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
216 |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
217 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
218 Under the covers |
| 1575 | 219 ~~~~~~~~~~~~~~~~ |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
220 |
| 1575 | 221 The searching page converts your selections into the following arguments: |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
222 |
| 1098 | 223 ========== ============================================================= |
| 224 Argument Description | |
| 225 ========== ============================================================= | |
| 226 :sort sort by prop name, optionally preceeded with '-' | |
| 227 to give descending or nothing for ascending sorting. | |
| 228 :group group by prop name, optionally preceeded with '-' or | |
| 229 to sort in descending or nothing for ascending order. | |
| 230 :filter selects which props should be displayed in the filter | |
| 231 section. Default is all. | |
| 232 :columns selects the columns that should be displayed. | |
| 233 Default is all. | |
| 234 propname selects the values the item properties given by propname | |
| 235 must have (very basic search/filter). | |
| 236 ========== ============================================================= | |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
237 |
| 1575 | 238 You may manually write URLS that contain these arguments, like so (whitespace |
| 239 has been added for clarity):: | |
| 240 | |
| 241 /issue?status=unread,in-progress,resolved& | |
| 242 topic=security,ui& | |
| 243 :group=priority& | |
| 244 :sort=-activity& | |
| 245 :filters=status,topic& | |
| 246 :columns=title,status,fixer | |
| 247 | |
| 248 | |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
249 Access Controls |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
250 --------------- |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
251 |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
252 User access is controlled through Permissions. These are are grouped into |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
253 Roles, and users have a comma-separated list of Roles assigned to them. |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
254 |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
255 Permissions divide access controls up into answering questions like: |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
256 |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
257 - may the user edit issues ("Edit", "issue") |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
258 - is the user allowed to use the web interface ("Web Access") |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
259 - 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
|
260 |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
261 Any number of new Permissions and Roles may be created as described in the |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
262 customisation documentation. Examples of new access controls are: |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
263 |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
264 - only managers may sign off issues as complete |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
265 - don't give users who register through email web access |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
266 - 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
|
267 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
268 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
269 E-Mail Gateway |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
270 ============== |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
271 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
272 E-mail sent to Roundup is examined for several pieces of information: |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
273 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
274 1. `subject-line information`_ identifying the purpose of the e-mail |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
275 2. `e-mail message content`_ which is to be extracted |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
276 3. e-mail attachments which should be associated with the message |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
277 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
278 Subject-line information |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
279 ------------------------ |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
280 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
281 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
|
282 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
283 1. the item that the message is responding to, |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
284 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
|
285 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
|
286 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
287 If the subject line contains a prefix in ``[square brackets]`` then we're |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
288 looking at case 1 or 2 above. Note that any "re:" or "fwd:" prefixes are |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
289 stripped off the subject line before we start looking for real information. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
290 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
291 If an item designator (class name and id number, for example ``issue123``) |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
292 is found there, a new "msg" item is added to the "messages" property for |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
293 that item, and any new "file" items are added to the "files" property for |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
294 the item. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
295 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
296 If just an item class name is found there, we attempt to create a new item of |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
297 that class with its "messages" property initialized to contain the new "msg" |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
298 item and its "files" property initialized to contain any new "file" items. |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
299 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
300 The third case above - where no ``[information]`` is provided, the tracker's |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
301 ``MAIL_DEFAULT_CLASS`` configuration variable defines what class of item |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
302 the message relates to. We try to match the subject line to an existing |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
303 item of the default class, and if there's a match, the message is related to |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
304 that matched item. If not, then a new item of the default class is created. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
305 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
306 Setting Properties |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
307 ~~~~~~~~~~~~~~~~~~ |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
308 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
309 The e-mail interface also provides a simple way to set properties on items. At |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
310 the end of the subject line, propname=value pairs can be specified in square |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
311 brackets, using the same conventions as for the roundup set shell command. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
312 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
313 For example, |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
314 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
315 - setting the priority of an issue:: |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
316 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
317 Subject: Re: [issue1] the coffee machine is broken! [priority=urgent] |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
318 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
319 - adding yourself to a nosy list:: |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
320 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
321 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
|
322 |
|
1282
2feb3e0a9955
included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents:
1267
diff
changeset
|
323 - 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
|
324 |
|
1282
2feb3e0a9955
included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents:
1267
diff
changeset
|
325 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
|
326 |
|
1282
2feb3e0a9955
included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents:
1267
diff
changeset
|
327 - 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
|
328 |
|
1282
2feb3e0a9955
included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents:
1267
diff
changeset
|
329 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
|
330 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
331 In all cases, the message relates to issue 2. The ``Re:`` prefix is stripped |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
332 off. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
333 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
334 |
|
1267
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
335 Automatic Properties |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
336 ~~~~~~~~~~~~~~~~~~~~ |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
337 |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
338 **status of new issues** |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
339 When a new message is received that is not identified as being related to an |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
340 existing issue, it creates a new issue. The status of the new issue is |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
341 defaulted to "unread". |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
342 |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
343 **reopening of resolved issues** |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
344 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
|
345 automatically reset to "chatting" to indicate new information has been |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
346 received. |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
347 |
|
a28dfdb6c9a5
doc refinement
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
348 |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
349 E-Mail Message Content |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
350 ---------------------- |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
351 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
352 Roundup only associates plain text (MIME type ``text/plain``) as messages for |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
353 items. Any other parts of a message are associated as downloadable files. If |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
354 no plain text part is found, the message is rejected. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
355 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
356 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
|
357 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
358 * In a multipart/mixed message or part, each subpart is extracted and |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
359 examined. The text/plain subparts are assembled to form the textual body |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
360 of the message, to be stored in the file associated with a "msg" class |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
361 item. Any parts of other types are each stored in separate files and |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
362 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
|
363 * 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
|
364 subpart and ignore the other parts. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
365 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
366 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
|
367 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
|
368 ``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
|
369 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
370 Message summary |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
371 ~~~~~~~~~~~~~~~ |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
372 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
373 The "summary" property on message items is taken from the first non-quoting |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
374 section in the message body. The message body is divided into sections by blank |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
375 lines. Sections where the second and all subsequent lines begin with a ">" or |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
376 "|" character are considered "quoting sections". The first line of the first |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
377 non-quoting section becomes the summary of the message. |
|
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 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
380 Address handling |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
381 ---------------- |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
382 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
383 All of the addresses in the ``To:`` and ``Cc:`` headers of the incoming |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
384 message are |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
385 looked up among the tracker users, and the corresponding users are placed |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
386 in the |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
387 "recipients" property on the new "msg" item. The address in the ``From:`` header |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
388 similarly determines the "author" property of the new "msg" item. The default |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
389 handling for addresses that don't have corresponding users is to create new |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
390 users with no passwords and a username equal to the address. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
391 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
392 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
|
393 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
|
394 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
395 ``ADD_AUTHOR_TO_NOSY`` |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
396 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
|
397 If 'new' is used, then the author will only be added when a message |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
398 creates a new issue. If 'yes', then the author will be added on followups |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
399 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
|
400 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
401 ``ADD_RECIPIENTS_TO_NOSY`` |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
402 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
|
403 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
|
404 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
|
405 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
|
406 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
407 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
408 Nosy List |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
409 ~~~~~~~~~ |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
410 |
| 1228 | 411 Roundup watches for additions to the "messages" property of items. |
| 412 | |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
413 When a new message is added, it is sent to all the users |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
414 on the "nosy" list for the item that are not already on the "recipients" list |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
415 of the message. Those users are then appended to the "recipients" property on |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
416 the message, so multiple copies of a message are never sent to the same user. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
417 The journal recorded by the hyperdatabase on the "recipients" property then |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
418 provides a log of when the message was sent to whom. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
419 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
420 If the author of the message is also in the nosy list for the item that the |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
421 message is attached to, then the config var ``MESSAGES_TO_AUTHOR`` is queried |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
422 to determine if they get a nosy list copy of the message too. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
423 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
424 |
|
1359
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
425 Mail gateway script command line |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
426 -------------------------------- |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
427 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
428 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
|
429 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
430 . with an instance home as the only argument, |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
431 . with both an instance home and a mail spool file, or |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
432 . with both an instance home and a pop server account. |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
433 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
434 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
|
435 fields for a class created by the roundup-mailgw. The default class if |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
436 not specified is msg, but the other classes: issue, file, user can |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
437 also be used. The -S or --set options uses the same |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
438 property=value[;property=value] notation accepted by the command line |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
439 roundup command or the commands that can be given on the Subject line |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
440 of an email message. |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
441 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
442 It can let you set the type of the message on a per email address basis. |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
443 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
444 PIPE: |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
445 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
|
446 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
|
447 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
448 UNIX mailbox: |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
449 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
|
450 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
|
451 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
|
452 specified as:: |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
453 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
454 mailbox /path/to/mailbox |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
455 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
456 POP: |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
457 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
|
458 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
|
459 server is specified as:: |
| 1560 | 460 |
|
1359
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
461 pop username:password@server |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
462 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
463 The username and password may be omitted:: |
| 1560 | 464 |
|
1359
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
465 pop username@server |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
466 pop server |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
467 |
|
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
468 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
|
469 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
|
470 |
| 1560 | 471 APOP: |
| 472 Same as POP, but using Authenticated POP:: | |
| 473 | |
| 474 apop username:password@server | |
| 475 | |
|
1359
ebfd8dd1cce7
missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents:
1317
diff
changeset
|
476 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
477 Command Line Tool |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
478 ================= |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
479 |
| 1098 | 480 The basic usage is:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
481 |
|
1566
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
482 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
|
483 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
484 Options: |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
485 -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
|
486 -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
|
487 -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
|
488 -c -- when outputting lists of data, comma-separate them. |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
489 Same as '-S ","'. |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
490 -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
|
491 -s -- when outputting lists of data, space-separate them. |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
492 Same as '-S " "'. |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
493 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
494 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
|
495 |
| 1098 | 496 Help: |
|
1566
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
497 roundup-admin -h |
| 1098 | 498 roundup-admin help -- this help |
| 499 roundup-admin help <command> -- command-specific help | |
| 500 roundup-admin help all -- all available help | |
| 501 | |
|
1566
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
502 Commands: |
| 1098 | 503 commit |
| 504 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
|
505 display designator[,designator]* |
| 1098 | 506 export [class[,class]] export_dir |
| 507 find classname propname=value ... | |
| 508 get property designator[,designator]* | |
| 509 help topic | |
| 510 history designator | |
| 511 import import_dir | |
| 512 initialise [adminpw] | |
| 513 install [template [backend [admin password]]] | |
| 514 list classname [property] | |
| 515 pack period | date | |
| 516 reindex | |
| 517 retire designator[,designator]* | |
| 518 rollback | |
| 519 security [Role name] | |
|
1570
93e0a565cee5
fix the "set" command usage statement
Richard Jones <richard@users.sourceforge.net>
parents:
1566
diff
changeset
|
520 set items property=value property=value ... |
| 1098 | 521 specification classname |
| 522 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
|
523 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
|
524 command, e.g. l == li == lis == list. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
525 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
526 |
| 1098 | 527 All commands (except help) require a tracker specifier. This is just the |
| 528 path to the roundup tracker you're working with. A roundup tracker is where | |
| 529 roundup keeps the database and configuration file that defines an issue | |
| 530 tracker. It may be thought of as the issue tracker's "home directory". | |
| 531 It may be specified in the environment variable ``TRACKER_HOME`` or on | |
| 532 the command line as "``-i tracker``". | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
533 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
534 A designator is a classname and an itemid concatenated, eg. bug1, user10, ... |
|
1566
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
535 Property values are represented as strings in command arguments and in the |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
536 printed results: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
537 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
538 - Strings are, well, strings. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
539 - Password values will display as their encoded value. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
540 - Date values are printed in the full date format in the local time zone, |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
541 and accepted in the full format or any of the partial formats explained |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
542 below.:: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
543 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
544 Input of... Means... |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
545 "2000-04-17.03:45" 2000-04-17.08:45:00 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
546 "2000-04-17" 2000-04-17.00:00:00 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
547 "01-25" yyyy-01-25.00:00:00 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
548 "08-13.22:13" yyyy-08-14.03:13:00 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
549 "11-07.09:32:43" yyyy-11-07.14:32:43 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
550 "14:25" yyyy-mm-dd.19:25:00 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
551 "8:47:11" yyyy-mm-dd.13:47:11 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
552 "." "right now" |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
553 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
554 - Link values are printed as item designators. When given as an argument, |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
555 item designators and key strings are both accepted. |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
556 - Multilink values are printed as lists of item designators joined by |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
557 commas. When given as an argument, item designators and key strings are |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
558 both accepted; an empty string, a single item, or a list of items joined |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
559 by commas is accepted. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
560 |
| 1098 | 561 When multiple items are specified to the roundup get or roundup set |
| 562 commands, the specified properties are retrieved or set on all the listed | |
| 563 items. When multiple results are returned by the roundup get or roundup | |
| 564 find commands, they are printed one per line (default) or joined by commas | |
| 565 (with the "``-c``" option). | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
566 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
567 Where the command changes data, a login name/password is required. The login may |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
568 be specified as either "``name``" or "``name:password``". |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
569 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
570 - ``ROUNDUP_LOGIN`` environment variable |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
571 - the "``-u``" command-line option |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
572 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
573 If either the name or password is not supplied, they are obtained from the |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
574 command-line. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
575 |
|
1566
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
576 Using with the shell |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1575
diff
changeset
|
577 -------------------- |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
578 |
|
1566
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
579 With version 0.6.0 or newer of roundup which supports: multiple |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
580 designators to display and the -d, -S and -s flags. |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
581 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
582 To find all messages regarding chatting issues that |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
583 contain the word "spam", for example, you could execute the |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
584 following command from the directory where the database |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
585 dumps its files:: |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
586 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
587 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
|
588 > 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
|
589 > done |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
590 msg23 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
591 msg49 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
592 msg50 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
593 msg61 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
594 shell% |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
595 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
596 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
|
597 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
598 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
|
599 \`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
|
600 msg23 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
601 msg49 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
602 msg50 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
603 msg61 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
604 shell% |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
605 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
606 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
|
607 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
608 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
|
609 issue3,issue1` |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
610 files: [] |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
611 inreplyto: None |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
612 recipients: [] |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
613 author: 1 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
614 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
|
615 messageid: None |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
616 summary: jkdskldjf |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
617 files: [] |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
618 inreplyto: None |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
619 recipients: [] |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
620 author: 1 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
621 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
|
622 messageid: None |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
623 summary: jlkfjadsf |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
624 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
625 or status:: |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
626 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
627 shell% 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
|
628 -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
|
629 unread |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
630 deferred |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
631 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
632 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
|
633 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
634 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
|
635 -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
|
636 unread deferred |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
637 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
638 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
|
639 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
640 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
|
641 -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
|
642 unread deferred |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
643 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
644 Also the tautological:: |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
645 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
646 shell% roundup-admin get name \ |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
647 `roundup-admin -dc get status \`roundup-admin -dc find issue \ |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
648 status=chatting\`` |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
649 chatting |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
650 chatting |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
651 |
|
053065585406
added command-line functionality for roundup-adming (feature [SF#687664])
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
652 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
|
653 them ',' separated so using '-dc' is almost always required. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
654 |
|
686
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
655 ----------------- |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
656 |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
657 Back to `Table of Contents`_ |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
658 |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
659 .. _`Table of Contents`: index.html |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
660 .. _`customisation documentation`: customizing.html |