meillo@34: .TH masqmail 8 2010-05-07 masqmail-0.2.21 "Maintenance Commands"
meillo@34: 
meillo@0: .SH NAME
meillo@0: masqmail \- An offline Mail Transfer Agent
meillo@34: 
meillo@0: .SH SYNOPSIS
meillo@34: \fB/usr/sbin/masqmail \fR[\fB\-C \fIfile\fR] [\fB\-odq\fR] [\fB\-bd\fR] [\fB\-q\fIinterval\fR]
meillo@0: 
meillo@34: \fB/usr/sbin/masqmail \fR[\fB\-odq\fR] [\fB\-bs\fR]
meillo@0: 
meillo@34: \fB/usr/sbin/masqmail \fR[\fB\-bp\fR]
meillo@0: 
meillo@34: \fB/usr/sbin/masqmail \fR[\fB\-q\fR]
meillo@0: 
meillo@34: \fB/usr/sbin/masqmail \fR[\fB\-qo \fR[\fIname\fR]]
meillo@0: 
meillo@34: \fB/usr/sbin/masqmail \fR[\fB\-odq\fR] [\fB\-g \fR[\fIname\fR]]
meillo@0: 
meillo@34: \fB/usr/sbin/masqmail \fR[\fB\-odq\fR] [\fB\-go \fR[\fIname\fR]]
meillo@0: 
meillo@34: \fB/usr/sbin/masqmail \fR[\fB\-t\fR] [\fB\-oi\fR] [\fB\-f \fIaddress\fR] [\fB\-\-\fR] \fIaddress...
meillo@0: 
meillo@34: \fB/usr/sbin/mailq\fR
meillo@0: 
meillo@34: 
meillo@0: .SH DESCRIPTION
meillo@0: 
meillo@34: Masqmail is a mail server designed for hosts that do not have a permanent internet connection
meillo@34: e.g. a home network or a single host at home.
meillo@34: It has special support for connections to different ISPs.
meillo@34: It replaces sendmail or other MTAs such as qmail or exim.
meillo@34: It can also act as a pop3 client.
meillo@34: 
meillo@0: 
meillo@0: .SH OPTIONS
meillo@0: 
meillo@34: Since masqmail is intended to replace sendmail, it uses the same command line options,
meillo@34: but not all are implemented.
meillo@34: There are also two additional options, which are unique to masqmail
meillo@34: (\fB\-qo \fIconnection\fR and \fB\-g\fR)
meillo@34: 
meillo@0: .TP
meillo@34: \fB\-\-\fR
meillo@0: 
meillo@34: Not a `real' option, it means that all following arguments are to be understood
meillo@34: as arguments and not as options even if they begin with a leading dash `\-'.
meillo@34: Mutt is known to call sendmail with this option.
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-bd\fR
meillo@0: 
meillo@34: Run as daemon, accepting connections, usually on port 25 if not configured differently.
meillo@34: This is usually used in the startup script at system boot and together with
meillo@34: the \fB\-q\fR option (see below).
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-bi\fR
meillo@0: 
meillo@34: Old sendmail rebuilds its alias database when invoked with this option.
meillo@34: Masqmail ignores it.
meillo@34: Masqmail reads directly from the file given with `alias_file' in the config file.
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-bp\fR
meillo@0: 
meillo@34: Show the messages in the queue. Same as calling masqmail as `mailq'.
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-bs\fR
meillo@0: 
meillo@34: Accept SMTP commands from stdin.
meillo@34: Some mailers (e.g. pine) use this option as an interface.
meillo@34: It can also be used to call masqmail from inetd.
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-B \fIarg\fR
meillo@0: 
meillo@34: \fIarg\fR is usually 8BITMIME.
meillo@34: Some mailers use this to indicate that the message contains characters > 127.
meillo@34: Masqmail is 8-bit clean and ignores this, so you do not have to recompile elm,
meillo@34: which is very painful ;-).
meillo@34: Note though that this violates some conventions:
meillo@34: masqmail does not convert 8 bit messages to any MIME format if it encounters
meillo@34: a mail server which does not advertise its 8BITMIME capability,
meillo@34: masqmail does not advertise this itself.
meillo@34: This is the same practice as that of exim (but different to sendmail).
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-bV \fR
meillo@0: 
meillo@0: Show version information.
meillo@34: 
meillo@0: .TP
meillo@34: \fB\-C \fIfilename\fR
meillo@0: 
meillo@34: Use another configuration than \fI/etc/masqmail/masqmail.conf\fR.
meillo@34: Useful for debugging purposes.
meillo@34: If not invoked by a privileged user, masqmail will drop all privileges.
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-d \fInumber\fR
meillo@0: 
meillo@34: Set the debug level.
meillo@34: This takes precedence before the value of `debug_level' in the configuration file.
meillo@34: Read the warning in the description of the latter.
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-f [\fIaddress\fB]\fR
meillo@0: 
meillo@34: Set the return path address to \fIaddress\fR.
meillo@34: Only root, the user mail and anyone in group mail is allowed to do that.
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-F [\fIstring\fB]\fR
meillo@0: 
meillo@34: Set the full sender name (in the From: header) to \fIstring\fR.
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-g [\fIname\fB]\fR
meillo@0: 
meillo@34: Get mail (using pop3 or apop),
meillo@34: using the configurations given with get.\fIname\fR in the main configuration.
meillo@34: Without \fIname\fR, all get configurations will be used.
meillo@34: See also \fBmasqmail.get(5)\fR
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-go [\fIinterval\fB] [\fIname\fB]\fR
meillo@0: 
meillo@34: Can be followed by a connection name.
meillo@34: Use this option in your script which starts as soon as a link to the internet
meillo@34: has been set up (usually ip-up).
meillo@34: When masqmail is called with this option, the specified get configuration(s)
meillo@34: is(are) read and mail will be retrieved from servers on the internet.
meillo@34: The \fIname\fR is defined in the configuration (see \fBonline_gets.\fIname\fR).
meillo@0: 
meillo@34: If called with an interval option (recognized by a digit as the first characater),
meillo@34: masqmail starts as a daemon and tries to get mail in these intervals.
meillo@34: It checks for the online status first.
meillo@34: Example: `masqmail \-go 5m' will retrieve mail every five minutes.
meillo@0: 
meillo@34: If called without \fIname\fR the online status is determined with the configured method
meillo@34: (see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR).
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-i\fR
meillo@0: 
meillo@34: Same as \fB\-oi\fR, see below.
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-Mrm \fIlist\fR
meillo@0: 
meillo@34: Remove given messages from the queue.
meillo@34: Only allowed for privileged users.
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-oem\fR
meillo@0: 
meillo@34: If the \fB\-oi\fR ist not also given, always return with a non zero return code.
meillo@34: Maybe someone tells me what this is good for...
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-odb\fR
meillo@0: 
meillo@34: Deliver in background.
meillo@34: Masqmail always does this, which makes this option pretty much useless.
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-odq\fR
meillo@0: 
meillo@34: Do not attempt to deliver immediately.
meillo@34: Any messages will be queued until the next queue running process picks them up and delivers them.
meillo@34: You get the same effect by setting the do_queue option in /etc/masqmail/masqmail.conf.
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-oi\fR
meillo@0: 
meillo@0: A dot as a single character in a line does not terminate the message.
meillo@34: 
meillo@0: .TP
meillo@34: \fB\-q [\fIinterval\fB]\fR
meillo@0: 
meillo@34: If not given with an argument, run a queue process, i.e. try to deliver all messages in the queue.
meillo@34: Masqmail sends only to those addresses that are on the local net, not to those that are outside.
meillo@34: Use \fB\-qo\fR for those.
meillo@0: 
meillo@34: If you have configured inetd to start masqmail,
meillo@34: you can use this option in a cron job which starts in regular time intervals,
meillo@34: to mimic the same effect as starting masqmail with \fB\-bd \-q30m\fR.
meillo@0: 
meillo@34: An argument may be a time interval i.e. a numerical value followed by one of the letters.
meillo@34: s,m,h,d,w which are interpreted as seconds, minutes, hours, days or weeks respectively.
meillo@34: Example: \fB\-q30m\fR.
meillo@34: Masqmail starts as a daemon and a queue runner process will be started automatically
meillo@34: once in this time interval.
meillo@34: This is usually used together with \fB\-bd\fR (see above).
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-qo [\fIname\fB]\fR
meillo@0: 
meillo@34: Can be followed by a connection name.
meillo@34: Use this option in your script which starts as soon as a link to the internet
meillo@34: has been set up (usually ip-up).
meillo@34: When masqmail is called with this option, the specified route configuration
meillo@34: is read and the queued mail with destinations on the internet will be sent.
meillo@34: The \fIname\fR is defined in the configuration (see \fBonline_routes.\fIname\fR).
meillo@0: 
meillo@34: If called without \fIname\fR the online status is determined with the configured
meillo@34: method (see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR)
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-t\fR
meillo@0: 
meillo@34: Read recipients from headers.
meillo@34: Delete `Bcc:' headers.
meillo@34: If any arguments are given, these are interpreted as recipient addresses
meillo@34: and the message will not be sent to these.
meillo@0: 
meillo@0: .TP
meillo@34: \fB\-v\fR
meillo@0: 
meillo@34: Log also to stdout.
meillo@34: Currently, some log messages are marked as `write to stdout' and additionally,
meillo@34: all messages with priority `LOG_ALERT' and `LOG_WARNING' will be written to stdout
meillo@34: if this option is given. It is disabled in daemon mode.
meillo@0: 
meillo@34: 
meillo@0: .SH ENVIRONMENT FOR PIPES AND MDAS
meillo@0: 
meillo@34: For security reasons, before any pipe command from an alias expansion or an mda is called,
meillo@34: the environment variables will be completely discarded and newly set up. These are:
meillo@0: 
meillo@34: SENDER, RETURN_PATH \(en the return path.
meillo@0: 
meillo@34: SENDER_DOMAIN \(en the domain part of the return path.
meillo@0: 
meillo@34: SENDER_LOCAL \(en the local part of the return path.
meillo@0: 
meillo@34: RECEIVED_HOST \(en the host the message was received from (unless local).
meillo@0: 
meillo@34: LOCAL_PART, USER, LOGNAME \(en the local part of the (original) recipient.
meillo@0: 
meillo@34: MESSAGE_ID \(en the unique message id.
meillo@34: This is not necessarily identical with the Message ID as given in the Message ID: header.
meillo@0: 
meillo@34: QUALIFY_DOMAIN \(en the domain which will be appended to unqualified addresses.
meillo@34: 
meillo@0: 
meillo@0: .SH FILES
meillo@0: 
meillo@34: \fI/etc/masqmail/masqmail.conf\fR is the main configuration for masqmail.
meillo@34: Depending on the settings in this file, you will also have other configuration
meillo@34: files in \fI/etc/masqmail/\fR.
meillo@0: 
meillo@34: \fI/var/spool/masqmail/\fR is the spool directory where masqmail stores
meillo@34: its spooled messages and the uniq pop ids.
meillo@0: 
meillo@34: \fI/var/spool/mail/\fR is the directory where locally delivered mail will be put,
meillo@34: if not configured differently in \fImasqmail.conf\fR.
meillo@0: 
meillo@34: \fI/var/log/masqmail/\fR is the directory where masqmail stores its log mesages.
meillo@34: This can also be somewhere else if configured differently by your sysadmin or the package mantainer.
meillo@34: 
meillo@0: 
meillo@0: .SH CONFORMING TO
meillo@0: 
meillo@0: RFC 821, 822, 1869, 1870, 2197, 2554 (SMTP)
meillo@0: 
meillo@0: RFC 1725, 1939 (POP3)
meillo@0: 
meillo@0: RFC 1321 (MD5)
meillo@0: 
meillo@0: RFC 2195 (CRAM-MD5)
meillo@0: 
meillo@34: 
meillo@0: .SH AUTHOR
meillo@0: 
meillo@34: Masqmail was written by Oliver Kurth.
meillo@34: It is now maintained by Markus Schnalke <meillo@marmaro.de>.
meillo@0: 
meillo@34: You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\fR.
meillo@26: There is also a mailing list, you will find information about it at masqmail's main site.
meillo@0: 
meillo@34: 
meillo@0: .SH BUGS
meillo@0: 
meillo@34: Please report them to the mailing list.
meillo@34: 
meillo@0: 
meillo@0: .SH SEE ALSO
meillo@0: 
meillo@34: \fBmasqmail.conf(5)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.get(5)\fR, \fBmasqmail.aliases(5)\fR