doc/roundup-mailgw.1

   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 \fBPOP\fP
  38 .br
  39 In the third case, the gateway reads all messages from the POP server
  40 specified and submits each in turn to the roundup.mailgw module. The
  41 server is specified as:
  42  \fIpop username:password@server\fP
  43 .br
  44 The username and password may be omitted:
  45  \fIpop username@server\fP
  46  \fIpop server\fP
  47 .br
  48 are both valid. The username and/or password will be prompted for if
  49 not supplied on the command-line.
  50
  51 \fBAPOP\fP
  52 Same as POP, but using Authenticated POP:
  53  \fIapop username:password@server\fP
  54 .SH AUTHOR
  55 This manpage was written by Bastian Kleineidam
  56 <calvin@debian.org> for the Debian distribution of roundup.
  57
  58 The main author of roundup is Richard Jones
  59 <richard@users.sourceforge.net>.