Mercurial > p > roundup > code
annotate doc/roundup-mailgw.1 @ 3682:193f316dbbe9
More transitive-property support.
- Implemented transitive properties in sort and group specs. Sort/group
specs can now be lists of specs.
- All regression tests except for one metakit backend test related to
metakit having no representation of NULL pass
- Fixed more PEP 8 whitespace peeves (and probably introduced some new
ones :-)
- Moved Proptree from support.py to hyperdb.py due to circular import
- Moved some proptree-specific methods from Class to Proptree
- Added a test for sorting by ids -> should be numeric sort (which now
really works for all backends)
- Added "required" attribute to all property classes in hyperdb (e.g.,
String, Link,...), see Feature Requests [SF#539081]
-> factored common stuff to _Type. Note that I also converted to a
new-style class when I was at it. Bad: The repr changes for new-style
classes which made some SQL backends break (!) because the repr of
Multilink is used in the schema storage. Fixed the repr to be
independent of the class type.
- Added get_required_props to Class. Todo: should also automagically
make the key property required...
- Add a sort_repr method to property classes. This defines the
sort-order. Individual backends may use diffent routines if the
outcome is the same. This one has a special case for id properties to
make the sorting numeric. Using these methods isn't mandatory in
backends as long as the sort-order is correct.
- Multilink sorting takes orderprop into account. It used to sort by
ids. You can restore the old behaviour by specifying id as the
orderprop of the Multilink if you really need that.
- If somebody specified a Link or Multilink as orderprop, we sort by
labelprop of that class -- not transitively by orderprop. I've
resited the tempation to implement recursive orderprop here: There
could even be loops if several classes specify a Link or Multilink as
the orderprop...
- Fixed a bug in Metakit-Backend: When sorting by Links, the backend
would do a natural join to the Link class. It would rename the "id"
attribute before joining but *not* all the other attributes of the
joined class. So in one test-case we had a name-clash with
priority.name and status.name when sorting *and* grouping by these
attributes. Depending on the order of joining this would produce a
name-clash with broken sort-results (and broken display if the
original class has an attribute that clashes). I'm now doing the
sorting of Links in the generic filter method for the metakit backend.
I've left the dead code in the metakit-backend since correctly
implementing this in the backend will probably be more efficient.
- updated doc/design.html with the new docstring of filter.
| author | Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net> |
|---|---|
| date | Mon, 21 Aug 2006 12:19:48 +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>. |
