Premiere version : mise en route du suivi.
[auf_roundup.git] / share / man / man1 / .svn / text-base / roundup-mailgw.1.svn-base
1 .TH ROUNDUP-MAILGW 1 "24 January 2003"
2 .SH NAME
3 roundup-mailgw \- mail gateway for roundup
4 .SH SYNOPSIS
5 \fBroundup-mailgw\fP \fI<instance home>\fP [\fImethod\fP]
6 .SH OPTIONS
7 .TP
8 \fB-C\fP \fIhyperdb class\fP
9 specify a tracker class - one of msg (the default), issue, file, user - to
10 manipulate with -S options
11 .TP
12 \fB-S\fP \fIproperty=value[;property=value] pairs\fP
13 specify the values to set on the class specified by -C using the same
14 format as the Subject line property manipulations
15 .SH DESCRIPTION
16 The roundup mail gateway may be called in one of three ways:
17 .IP \(bu
18 with an instance home as the only argument,
19 .IP \(bu
20 with both an instance home and a mail spool file, or
21 .IP \(bu
22 with both an instance home and a pop server account.
23 .PP
24 \fBPIPE\fP
25 .br
26 In the first case, the mail gateway reads a single message from the
27 standard input and submits the message to the roundup.mailgw module.
28
29 \fBUNIX mailbox\fP
30 .br
31 In the second case, the gateway reads all messages from the mail spool
32 file and submits each in turn to the roundup.mailgw module. The file is
33 emptied once all messages have been successfully handled. The file is
34 specified as:
35  \fImailbox /path/to/mailbox\fP
36
37 In all of the following the username and password can be stored in a
38 ~/.netrc file. In this case only the server name need be specified on
39 the command-line.
40
41 The username and/or password will be prompted for if not supplied on
42 the command-line or in ~/.netrc.
43
44 \fBPOP\fP
45 .br
46 In the third case, the gateway reads all messages from the POP server
47 specified and submits each in turn to the roundup.mailgw module. The
48 server is specified as:
49  \fIpop username:password@server\fP
50 .br
51 The username and password may be omitted:
52  \fIpop username@server\fP
53  \fIpop server\fP
54 .br
55 are both valid.
56
57 \fBAPOP\fP
58 Same as POP, but using Authenticated POP:
59  \fIapop username:password@server\fP
60 .SH AUTHOR
61 This manpage was written by Bastian Kleineidam
62 <calvin@debian.org> for the Debian distribution of roundup.
63
64 The main author of roundup is Richard Jones
65 <richard@users.sourceforge.net>.