Mercurial > p > roundup > code
annotate doc/roundup-mailgw.1 @ 3696:790363e96852
Sorting/grouping by multiple properties.
- Implement sorting/grouping by multiple properties for the web
interface. I'm now using @sort0/@sortdir0,@sort1/@sortdir1,... and
@group0/@groupdir0,... when generating URLs from a search template.
These are converted to a list internally. When saving URLs (e.g. when
storing queries) I'm using @sort=prop1,prop2,... and @group=... with
optional '-' prepended to individual props.
This means saved URLs are backward compatible with existing trackers
(and yes, this was a design goal).
I need the clumsy version with @sort0,@sort1 etc, because I'm
currently using several selectors and checkboxes (as the classic
template does, too). I don't think there is a way around that in HTML?
- Updated (hopefully all) documentation to reflect the new URL format
and the consequences in the web-interface.
- I've set the number of sort/group properties in the classic template
to two -- this can easily be reverted by changing n_sort to 1.
Richard, would you look over these changes? I've set a tag before and
(will set) after commit, so that it would be easy to merge out.
Don't be too scared about the size of the change, most is documentation,
the guts are in cgi/templating.py and small changes in the classic
template.
| author | Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net> |
|---|---|
| date | Wed, 30 Aug 2006 20:28:26 +0000 |
| parents | 3f2e516b8de3 |
| children | 39af38d6f77d |
| rev | line source |
|---|---|
|
1419
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1 .TH ROUNDUP-MAILGW 1 "24 January 2003" |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
2 .SH NAME |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
3 roundup-mailgw \- mail gateway for roundup |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
4 .SH SYNOPSIS |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
5 \fBroundup-mailgw\fP \fI<instance home>\fP [\fImethod\fP] |
|
1536
3408d091da5b
fixed roundup-mailgw man page for 0.6
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
6 .SH OPTIONS |
|
3408d091da5b
fixed roundup-mailgw man page for 0.6
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
7 .TP |
|
3408d091da5b
fixed roundup-mailgw man page for 0.6
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
8 \fB-C\fP \fIhyperdb class\fP |
|
3408d091da5b
fixed roundup-mailgw man page for 0.6
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
9 specify a tracker class - one of msg (the default), issue, file, user - to |
|
3408d091da5b
fixed roundup-mailgw man page for 0.6
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
10 manipulate with -S options |
|
3408d091da5b
fixed roundup-mailgw man page for 0.6
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
11 .TP |
|
3408d091da5b
fixed roundup-mailgw man page for 0.6
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
12 \fB-S\fP \fIproperty=value[;property=value] pairs\fP |
|
3408d091da5b
fixed roundup-mailgw man page for 0.6
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
13 specify the values to set on the class specified by -C using the same |
|
3408d091da5b
fixed roundup-mailgw man page for 0.6
Richard Jones <richard@users.sourceforge.net>
parents:
1419
diff
changeset
|
14 format as the Subject line property manipulations |
|
1419
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
15 .SH DESCRIPTION |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
16 The roundup mail gateway may be called in one of three ways: |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
17 .IP \(bu |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
18 with an instance home as the only argument, |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
19 .IP \(bu |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
20 with both an instance home and a mail spool file, or |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
21 .IP \(bu |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
22 with both an instance home and a pop server account. |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
23 .PP |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
24 \fBPIPE\fP |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
25 .br |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
26 In the first case, the mail gateway reads a single message from the |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
27 standard input and submits the message to the roundup.mailgw module. |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
28 |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
29 \fBUNIX mailbox\fP |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
30 .br |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
31 In the second case, the gateway reads all messages from the mail spool |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
32 file and submits each in turn to the roundup.mailgw module. The file is |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
33 emptied once all messages have been successfully handled. The file is |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
34 specified as: |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
35 \fImailbox /path/to/mailbox\fP |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
36 |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
37 \fBPOP\fP |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
38 .br |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
39 In the third case, the gateway reads all messages from the POP server |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
40 specified and submits each in turn to the roundup.mailgw module. The |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
41 server is specified as: |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
42 \fIpop username:password@server\fP |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
43 .br |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
44 The username and password may be omitted: |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
45 \fIpop username@server\fP |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
46 \fIpop server\fP |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
47 .br |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
48 are both valid. The username and/or password will be prompted for if |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
49 not supplied on the command-line. |
| 1560 | 50 |
| 51 \fBAPOP\fP | |
| 52 Same as POP, but using Authenticated POP: | |
| 53 \fIapop username:password@server\fP | |
|
1419
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
54 .SH AUTHOR |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
55 This manpage was written by Bastian Kleineidam |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
56 <calvin@debian.org> for the Debian distribution of roundup. |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
57 |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
58 The main author of roundup is Richard Jones |
|
c717b8d63a7e
included UN*X manual pages from Bastian Kleineidam
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
59 <richard@users.sourceforge.net>. |
