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