1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/man/masqmail.8	Sat May 29 22:07:07 2010 +0200
     1.3 @@ -0,0 +1,293 @@
     1.4 +.TH masqmail 8 2010-05-07 masqmail-0.2.22 "Maintenance Commands"
     1.5 +
     1.6 +.SH NAME
     1.7 +masqmail \- An offline Mail Transfer Agent
     1.8 +
     1.9 +.SH SYNOPSIS
    1.10 +\fB/usr/sbin/masqmail \fR[\fB\-C \fIfile\fR] [\fB\-odq\fR] [\fB\-bd\fR] [\fB\-q\fIinterval\fR]
    1.11 +
    1.12 +\fB/usr/sbin/masqmail \fR[\fB\-odq\fR] [\fB\-bs\fR]
    1.13 +
    1.14 +\fB/usr/sbin/masqmail \fR[\fB\-bp\fR]
    1.15 +
    1.16 +\fB/usr/sbin/masqmail \fR[\fB\-q\fR]
    1.17 +
    1.18 +\fB/usr/sbin/masqmail \fR[\fB\-qo \fR[\fIname\fR]]
    1.19 +
    1.20 +\fB/usr/sbin/masqmail \fR[\fB\-odq\fR] [\fB\-g \fR[\fIname\fR]]
    1.21 +
    1.22 +\fB/usr/sbin/masqmail \fR[\fB\-odq\fR] [\fB\-go \fR[\fIname\fR]]
    1.23 +
    1.24 +\fB/usr/sbin/masqmail \fR[\fB\-t\fR] [\fB\-oi\fR] [\fB\-f \fIaddress\fR] [\fB\-\-\fR] \fIaddress...
    1.25 +
    1.26 +\fB/usr/sbin/mailq\fR
    1.27 +
    1.28 +
    1.29 +.SH DESCRIPTION
    1.30 +
    1.31 +Masqmail is a mail server designed for hosts that do not have a permanent internet connection
    1.32 +e.g. a home network or a single host at home.
    1.33 +It has special support for connections to different ISPs.
    1.34 +It replaces sendmail or other MTAs such as qmail or exim.
    1.35 +It can also act as a pop3 client.
    1.36 +
    1.37 +
    1.38 +.SH OPTIONS
    1.39 +
    1.40 +Since masqmail is intended to replace sendmail, it uses the same command line options,
    1.41 +but not all are implemented.
    1.42 +There are also two additional options, which are unique to masqmail
    1.43 +(\fB\-qo \fIconnection\fR and \fB\-g\fR)
    1.44 +
    1.45 +.TP
    1.46 +\fB\-\-\fR
    1.47 +
    1.48 +Not a `real' option, it means that all following arguments are to be understood
    1.49 +as arguments and not as options even if they begin with a leading dash `\-'.
    1.50 +Mutt is known to call sendmail with this option.
    1.51 +
    1.52 +.TP
    1.53 +\fB\-bd\fR
    1.54 +
    1.55 +Run as daemon, accepting connections, usually on port 25 if not configured differently.
    1.56 +This is usually used in the startup script at system boot and together with
    1.57 +the \fB\-q\fR option (see below).
    1.58 +
    1.59 +.TP
    1.60 +\fB\-bi\fR
    1.61 +
    1.62 +Old sendmail rebuilds its alias database when invoked with this option.
    1.63 +Masqmail ignores it.
    1.64 +Masqmail reads directly from the file given with `alias_file' in the config file.
    1.65 +
    1.66 +.TP
    1.67 +\fB\-bp\fR
    1.68 +
    1.69 +Show the messages in the queue. Same as calling masqmail as `mailq'.
    1.70 +
    1.71 +.TP
    1.72 +\fB\-bs\fR
    1.73 +
    1.74 +Accept SMTP commands from stdin.
    1.75 +Some mailers (e.g. pine) use this option as an interface.
    1.76 +It can also be used to call masqmail from inetd.
    1.77 +
    1.78 +.TP
    1.79 +\fB\-B \fIarg\fR
    1.80 +
    1.81 +\fIarg\fR is usually 8BITMIME.
    1.82 +Some mailers use this to indicate that the message contains characters > 127.
    1.83 +Masqmail is 8-bit clean and ignores this, so you do not have to recompile elm,
    1.84 +which is very painful ;-).
    1.85 +Note though that this violates some conventions:
    1.86 +masqmail does not convert 8 bit messages to any MIME format if it encounters
    1.87 +a mail server which does not advertise its 8BITMIME capability,
    1.88 +masqmail does not advertise this itself.
    1.89 +This is the same practice as that of exim (but different to sendmail).
    1.90 +
    1.91 +.TP
    1.92 +\fB\-bV \fR
    1.93 +
    1.94 +Show version information.
    1.95 +
    1.96 +.TP
    1.97 +\fB\-C \fIfilename\fR
    1.98 +
    1.99 +Use another configuration than \fI/etc/masqmail/masqmail.conf\fR.
   1.100 +Useful for debugging purposes.
   1.101 +If not invoked by a privileged user, masqmail will drop all privileges.
   1.102 +
   1.103 +.TP
   1.104 +\fB\-d \fInumber\fR
   1.105 +
   1.106 +Set the debug level.
   1.107 +This takes precedence before the value of `debug_level' in the configuration file.
   1.108 +Read the warning in the description of the latter.
   1.109 +
   1.110 +.TP
   1.111 +\fB\-f [\fIaddress\fB]\fR
   1.112 +
   1.113 +Set the return path address to \fIaddress\fR.
   1.114 +Only root, the user mail and anyone in group mail is allowed to do that.
   1.115 +
   1.116 +.TP
   1.117 +\fB\-F [\fIstring\fB]\fR
   1.118 +
   1.119 +Set the full sender name (in the From: header) to \fIstring\fR.
   1.120 +
   1.121 +.TP
   1.122 +\fB\-g [\fIname\fB]\fR
   1.123 +
   1.124 +Get mail (using pop3 or apop),
   1.125 +using the configurations given with get.\fIname\fR in the main configuration.
   1.126 +Without \fIname\fR, all get configurations will be used.
   1.127 +See also \fBmasqmail.get(5)\fR
   1.128 +
   1.129 +.TP
   1.130 +\fB\-go [\fIinterval\fB] [\fIname\fB]\fR
   1.131 +
   1.132 +Can be followed by a connection name.
   1.133 +Use this option in your script which starts as soon as a link to the internet
   1.134 +has been set up (usually ip-up).
   1.135 +When masqmail is called with this option, the specified get configuration(s)
   1.136 +is(are) read and mail will be retrieved from servers on the internet.
   1.137 +The \fIname\fR is defined in the configuration (see \fBonline_gets.\fIname\fR).
   1.138 +
   1.139 +If called with an interval option (recognized by a digit as the first characater),
   1.140 +masqmail starts as a daemon and tries to get mail in these intervals.
   1.141 +It checks for the online status first.
   1.142 +Example: `masqmail \-go 5m' will retrieve mail every five minutes.
   1.143 +
   1.144 +If called without \fIname\fR the online status is determined with the configured method
   1.145 +(see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR).
   1.146 +
   1.147 +.TP
   1.148 +\fB\-i\fR
   1.149 +
   1.150 +Same as \fB\-oi\fR, see below.
   1.151 +
   1.152 +.TP
   1.153 +\fB\-Mrm \fIlist\fR
   1.154 +
   1.155 +Remove given messages from the queue.
   1.156 +Only allowed for privileged users.
   1.157 +The identifiers of messages are listed in the output of
   1.158 +\fImasqmail -bp\fP (\fImailq\fR).
   1.159 +
   1.160 +.TP
   1.161 +\fB\-oem\fR
   1.162 +
   1.163 +If the \fB\-oi\fR ist not also given, always return with a non zero return code.
   1.164 +Maybe someone tells me what this is good for...
   1.165 +
   1.166 +.TP
   1.167 +\fB\-odb\fR
   1.168 +
   1.169 +Deliver in background.
   1.170 +Masqmail always does this, which makes this option pretty much useless.
   1.171 +
   1.172 +.TP
   1.173 +\fB\-odq\fR
   1.174 +
   1.175 +Do not attempt to deliver immediately.
   1.176 +Any messages will be queued until the next queue running process picks them up and delivers them.
   1.177 +You get the same effect by setting the do_queue option in /etc/masqmail/masqmail.conf.
   1.178 +
   1.179 +.TP
   1.180 +\fB\-oi\fR
   1.181 +
   1.182 +A dot as a single character in a line does not terminate the message.
   1.183 +
   1.184 +.TP
   1.185 +\fB\-q [\fIinterval\fB]\fR
   1.186 +
   1.187 +If not given with an argument, run a queue process, i.e. try to deliver all messages in the queue.
   1.188 +Masqmail sends only to those addresses that are on the local net, not to those that are outside.
   1.189 +Use \fB\-qo\fR for those.
   1.190 +
   1.191 +If you have configured inetd to start masqmail,
   1.192 +you can use this option in a cron job which starts in regular time intervals,
   1.193 +to mimic the same effect as starting masqmail with \fB\-bd \-q30m\fR.
   1.194 +
   1.195 +An argument may be a time interval i.e. a numerical value followed by one of the letters.
   1.196 +s,m,h,d,w which are interpreted as seconds, minutes, hours, days or weeks respectively.
   1.197 +Example: \fB\-q30m\fR.
   1.198 +Masqmail starts as a daemon and a queue runner process will be started automatically
   1.199 +once in this time interval.
   1.200 +This is usually used together with \fB\-bd\fR (see above).
   1.201 +
   1.202 +.TP
   1.203 +\fB\-qo [\fIname\fB]\fR
   1.204 +
   1.205 +Can be followed by a connection name.
   1.206 +Use this option in your script which starts as soon as a link to the internet
   1.207 +has been set up (usually ip-up).
   1.208 +When masqmail is called with this option, the specified route configuration
   1.209 +is read and the queued mail with destinations on the internet will be sent.
   1.210 +The \fIname\fR is defined in the configuration (see \fBonline_routes.\fIname\fR).
   1.211 +
   1.212 +If called without \fIname\fR the online status is determined with the configured
   1.213 +method (see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR)
   1.214 +
   1.215 +.TP
   1.216 +\fB\-t\fR
   1.217 +
   1.218 +Read recipients from headers.
   1.219 +Delete `Bcc:' headers.
   1.220 +If any arguments are given, these are interpreted as recipient addresses
   1.221 +and the message will not be sent to these.
   1.222 +
   1.223 +.TP
   1.224 +\fB\-v\fR
   1.225 +
   1.226 +Log also to stdout.
   1.227 +Currently, some log messages are marked as `write to stdout' and additionally,
   1.228 +all messages with priority `LOG_ALERT' and `LOG_WARNING' will be written to stdout
   1.229 +if this option is given. It is disabled in daemon mode.
   1.230 +
   1.231 +
   1.232 +.SH ENVIRONMENT FOR PIPES AND MDAS
   1.233 +
   1.234 +For security reasons, before any pipe command from an alias expansion or an mda is called,
   1.235 +the environment variables will be completely discarded and newly set up. These are:
   1.236 +
   1.237 +SENDER, RETURN_PATH \(en the return path.
   1.238 +
   1.239 +SENDER_DOMAIN \(en the domain part of the return path.
   1.240 +
   1.241 +SENDER_LOCAL \(en the local part of the return path.
   1.242 +
   1.243 +RECEIVED_HOST \(en the host the message was received from (unless local).
   1.244 +
   1.245 +LOCAL_PART, USER, LOGNAME \(en the local part of the (original) recipient.
   1.246 +
   1.247 +MESSAGE_ID \(en the unique message id.
   1.248 +This is not necessarily identical with the Message ID as given in the Message ID: header.
   1.249 +
   1.250 +QUALIFY_DOMAIN \(en the domain which will be appended to unqualified addresses.
   1.251 +
   1.252 +
   1.253 +.SH FILES
   1.254 +
   1.255 +\fI/etc/masqmail/masqmail.conf\fR is the main configuration for masqmail.
   1.256 +Depending on the settings in this file, you will also have other configuration
   1.257 +files in \fI/etc/masqmail/\fR.
   1.258 +
   1.259 +\fI/var/spool/masqmail/\fR is the spool directory where masqmail stores
   1.260 +its spooled messages and the uniq pop ids.
   1.261 +
   1.262 +\fI/var/spool/mail/\fR is the directory where locally delivered mail will be put,
   1.263 +if not configured differently in \fImasqmail.conf\fR.
   1.264 +
   1.265 +\fI/var/log/masqmail/\fR is the directory where masqmail stores its log mesages.
   1.266 +This can also be somewhere else if configured differently by your sysadmin or the package mantainer.
   1.267 +
   1.268 +
   1.269 +.SH CONFORMING TO
   1.270 +
   1.271 +RFC 821, 822, 1869, 1870, 2197, 2554 (SMTP)
   1.272 +
   1.273 +RFC 1725, 1939 (POP3)
   1.274 +
   1.275 +RFC 1321 (MD5)
   1.276 +
   1.277 +RFC 2195 (CRAM-MD5)
   1.278 +
   1.279 +
   1.280 +.SH AUTHOR
   1.281 +
   1.282 +Masqmail was written by Oliver Kurth.
   1.283 +It is now maintained by Markus Schnalke <meillo@marmaro.de>.
   1.284 +
   1.285 +You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\fR.
   1.286 +There is also a mailing list, you will find information about it at masqmail's main site.
   1.287 +
   1.288 +
   1.289 +.SH BUGS
   1.290 +
   1.291 +Please report them to the mailing list.
   1.292 +
   1.293 +
   1.294 +.SH SEE ALSO
   1.295 +
   1.296 +\fBmasqmail.conf(5)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.get(5)\fR, \fBmasqmail.aliases(5)\fR