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 DESCRIPTION
   7 The roundup mail gateway may be called in one of three ways:
   8 .IP \(bu
   9 with an instance home as the only argument,
  10 .IP \(bu
  11 with both an instance home and a mail spool file, or
  12 .IP \(bu
  13 with both an instance home and a pop server account.
  14 .PP
  15 \fBPIPE\fP
  16 .br
  17 In the first case, the mail gateway reads a single message from the
  18 standard input and submits the message to the roundup.mailgw module.
  19
  20 \fBUNIX mailbox\fP
  21 .br
  22 In the second case, the gateway reads all messages from the mail spool
  23 file and submits each in turn to the roundup.mailgw module. The file is
  24 emptied once all messages have been successfully handled. The file is
  25 specified as:
  26  \fImailbox /path/to/mailbox\fP
  27
  28 \fBPOP\fP
  29 .br
  30 In the third case, the gateway reads all messages from the POP server
  31 specified and submits each in turn to the roundup.mailgw module. The
  32 server is specified as:
  33  \fIpop username:password@server\fP
  34 .br
  35 The username and password may be omitted:
  36  \fIpop username@server\fP
  37  \fIpop server\fP
  38 .br
  39 are both valid. The username and/or password will be prompted for if
  40 not supplied on the command-line.
  41 .SH AUTHOR
  42 This manpage was written by Bastian Kleineidam
  43 <calvin@debian.org> for the Debian distribution of roundup.
  44
  45 The main author of roundup is Richard Jones
  46 <richard@users.sourceforge.net>.