emailrelay/doc/emailrelay.1

.\" Copyright (C) 2001-2007 Graeme Walker <graeme_walker@users.sourceforge.net>
.\" 
.\" This program is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation, either version 3 of the License, or 
.\" (at your option) any later version.
.\" 
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\" 
.\" You should have received a copy of the GNU General Public License
.\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
.TH EMAILRELAY 1 local
.SH NAME
emailrelay \- e-mail transfer agent and proxy
.SH SYNOPSIS
.B emailrelay
[OPTIONS]
.LP
.B emailrelay 
--as-server
.LP
.B emailrelay
--as-client 
.I server-address
.LP
.B emailrelay
--as-proxy 
.I server-address
.SH DESCRIPTION
.I emailrelay
is a simple SMTP proxy and store-and-forward message transfer agent.
It does store-and-forward mail relay to a fixed next-hop server, without 
any routing. 
.LP
It runs in two main modes: a storage daemon 
.RI ( --as-server ) 
and a forwarding 
agent 
.RI ( --as-client ). 
The storage daemon is an SMTP server which stores e-mail 
messages in a local spool directory. The forwarding agent acts as an
SMTP client sending the spooled e-mail messages on to the next
SMTP server in the chain.
.LP
It can also run in a third mode, as a proxy server
.RI ( --as-proxy ). 
In this mode all messages are forwarded immediately to the next-hop
server. Messages are only fully accepted from the sender once they
have been successfully delivered to the next-hop server.
.SH OPTIONS
.TP
.B \-a, --admin \fI<admin-port>\fR
Enables the administration interface and specifies its listening port number.
.TP
.B \-Q, --admin-terminate 
Enables the terminate command on the admin interface.
.TP
.B \-A, --anonymous 
Disables the smtp vrfy command and sends less verbose smtp responses.
.TP
.B \-q, --as-client \fI<host:port>\fR
Runs as a client, forwarding spooled mail to <host>: equivalent to \fI--log\fR \fI--no-syslog\fR \fI--no-daemon\fR \fI--dont-serve\fR \fI--forward\fR \fI--forward-to\fR.
.TP
.B \-y, --as-proxy \fI<host:port>\fR
Runs as a proxy: equivalent to \fI--log\fR \fI--close-stderr\fR \fI--immediate\fR \fI--forward-to\fR.
.TP
.B \-d, --as-server 
Runs as a server: equivalent to \fI--log\fR \fI--close-stderr\fR.
.TP
.B \-C, --client-auth \fI<file>\fR
Enables smtp authentication with remote server, using the given secrets file.
.TP
.B \-Y, --client-filter \fI<program>\fR
Specifies an external program to process messages when they are forwarded.
.TP
.B \-e, --close-stderr 
Closes the standard error stream after start-up.
.TP
.B \-U, --connection-timeout \fI<time>\fR
Sets the timeout (in seconds) when connecting to a remote server (default is 40).
.TP
.B \-g, --debug 
Generates debug-level logging if compiled-in.
.TP
.B \-D, --domain \fI<fqdn>\fR
Sets an override for the host's fully qualified domain name.
.TP
.B \-x, --dont-serve 
Disables acting as a server on any port (part of \fI--as-client\fR and usually used with \fI--forward\fR).
.TP
.B \-z, --filter \fI<program>\fR
Specifies an external program to process messages as they are stored.
.TP
.B \-W, --filter-timeout \fI<time>\fR
Sets the timeout (in seconds) for running the \fI--filter\fR processor.
.TP
.B \-f, --forward 
Forwards stored mail on startup (requires \fI--forward-to\fR).
.TP
.B \-o, --forward-to \fI<host:port>\fR
Specifies the remote smtp server (required by \fI--forward\fR, \fI--poll\fR, \fI--immediate\fR and \fI--admin\fR).
.TP
.B \-h, --help 
Displays help text and exits.
.TP
.B \-m, --immediate 
Enables immediate forwarding of messages as soon as they are received (requires \fI--forward-to\fR).
.TP
.B \-I, --interface \fI<ip-address>\fR
Defines the listening interface for new connections.
.TP
.B \-l, --log 
Writes log information on standard error and syslog.
.TP
.B \-L, --log-time 
Adds a timestamp to the logging output.
.TP
.B \-t, --no-daemon 
Does not detach from the terminal.
.TP
.B \-X, --no-smtp 
Disables listening for smtp connections (usually used with \fI--admin\fR or \fI--pop\fR).
.TP
.B \-n, --no-syslog 
Disables syslog output (always overridden by \fI--syslog\fR).
.TP
.B \-i, --pid-file \fI<pid-file>\fR
Defines a file for storing the daemon process-id.
.TP
.B \-O, --poll \fI<period>\fR
Enables polling of the spool directory for messages to be forwarded with the specified period (requires \fI--forward-to\fR).
.TP
.B \-B, --pop 
Enables the pop server if compiled-in.
.TP
.B \-F, --pop-auth \fI<file>\fR
Defines the pop server secrets file (default is \fI/etc/emailrelay.auth\fR).
.TP
.B \-J, --pop-by-name 
Modifies the pop spool directory according to the user name (requires \fI--pop\fR).
.TP
.B \-G, --pop-no-delete 
Disables message deletion via pop (requires \fI--pop\fR).
.TP
.B \-E, --pop-port \fI<port>\fR
Specifies the pop listening port number (requires \fI--pop\fR).
.TP
.B \-p, --port \fI<port>\fR
Specifies the smtp listening port number.
.TP
.B \-w, --prompt-timeout \fI<time>\fR
Sets the timeout (in seconds) for getting an initial prompt from the server.
.TP
.B \-r, --remote-clients 
Allows remote clients to connect.
.TP
.B \-T, --response-timeout \fI<time>\fR
Sets the response timeout (in seconds) when talking to a remote server (default is 1800).
.TP
.B \-S, --server-auth \fI<file>\fR
Enables authentication of remote clients, using the given secrets file.
.TP
.B \-s, --spool-dir \fI<dir>\fR
Specifies the spool directory (default is \fI/var/spool/emailrelay\fR).
.TP
.B \-k, --syslog 
Force syslog output if logging is enabled (overrides \fI--no-syslog\fR).
.TP
.B \-u, --user \fI<username>\fR
Names the effective user to switch to if started as root (default is \fIdaemon\fR).
.TP
.B \-v, --verbose 
Generates more verbose output (works with \fI--help\fR and \fI--log\fR).
.TP
.B \-Z, --verifier \fI<program>\fR
Specifies an external program for address verification.
.TP
.B \-V, --version 
Displays version information and exits.
.SH FILES
GNU style...
.br
/usr/local/etc/emailrelay.conf
.br
/usr/local/etc/emailrelay.conf.template
.br
/usr/local/libexec/emailrelay/emailrelay-filter-copy
.br
/usr/local/libexec/emailrelay/emailrelay-poke
.br
/usr/local/libexec/emailrelay/examples/*
.br
/usr/local/libexec/emailrelay/init/emailrelay
.br
/usr/local/man/man1/emailrelay*.1.gz
.br
/usr/local/sbin/emailrelay
.br
/usr/local/sbin/emailrelay-passwd
.br
/usr/local/sbin/emailrelay-submit
.br
/usr/local/share/emailrelay/doc/*
.br
/usr/local/share/emailrelay/doc/index.html
.br
/usr/local/share/emailrelay/doc/README
.br
/usr/local/var/spool/emailrelay/emailrelay.*.content
.br
/usr/local/var/spool/emailrelay/emailrelay.*.envelope
.LP
FHS style...
.br
/etc/emailrelay.conf
.br
/etc/emailrelay.conf.template
.br
/etc/init.d/emailrelay
.br
/usr/lib/emailrelay/emailrelay-filter-copy
.br
/usr/lib/emailrelay/emailrelay-poke
.br
/usr/lib/emailrelay/examples/*
.br
/usr/sbin/emailrelay
.br
/usr/sbin/emailrelay-passwd
.br
/usr/sbin/emailrelay-submit
.br
/usr/share/doc/emailrelay/*
.br
/usr/share/doc/emailrelay/index.html
.br
/usr/share/doc/emailrelay/README
.br
/usr/share/man/man1/emailrelay*.1.gz
.br
/var/spool/emailrelay/emailrelay.*.content
.br
/var/spool/emailrelay/emailrelay.*.envelope
.SH SEE ALSO
E-MailRelay user guide, http://emailrelay.sourceforge.net/userguide.html .
.br
E-MailRelay reference, http://emailrelay.sourceforge.net/reference.html .
.br
.BR emailrelay-submit (1),
.BR emailrelay-passwd (1),
.SH AUTHOR
Graeme Walker, mailto:graeme_walker@users.sourceforge.net