masqmail

annotate docs/masqmail.8 @ 10:26e34ae9a3e3

find changesets by author, revision, files, or words in the commit message
changed indention and line wrapping to a more consistent style
author meillo@marmaro.de
date Mon, 27 Oct 2008 16:23:10 +0100
parents 08114f7dcc23
children 163aa299bedb
rev   line source
meillo@0 1 .TH masqmail 8 User Manuals
meillo@0 2 .SH NAME
meillo@0 3 masqmail \- An offline Mail Transfer Agent
meillo@0 4 .SH SYNOPSIS
meillo@0 5 \fB/usr/sbin/masqmail [-C \fIfile\f1\fB] [-odq] [-bd] [-q\fIinterval\f1\fB]
meillo@0 6
meillo@0 7 \fB/usr/sbin/masqmail [-odq] [-bs]
meillo@0 8
meillo@0 9 \fB/usr/sbin/masqmail [-bp]
meillo@0 10
meillo@0 11 \fB/usr/sbin/masqmail [-q]
meillo@0 12
meillo@0 13 \fB/usr/sbin/masqmail [-qo [\fIname\f1\fB]]
meillo@0 14
meillo@0 15 \fB/usr/sbin/masqmail [-odq] [-g [\fIname\f1\fB]]
meillo@0 16
meillo@0 17 \fB/usr/sbin/masqmail [-odq] [-go [\fIname\f1\fB]]
meillo@0 18
meillo@0 19 \fB/usr/sbin/masqmail [-t] [-oi] [-f \fIaddress\f1\fB] [--] \fIaddress...\f1\fB
meillo@0 20
meillo@0 21 \fB/usr/sbin/mailq
meillo@0 22
meillo@0 23 \fB
meillo@0 24 .SH DESCRIPTION
meillo@0 25
meillo@0 26 MasqMail is a mail server designed for hosts that do not have a permanent internet connection eg. a home network or a single host at home. It has special support for connections to different ISPs. It replaces sendmail or other MTAs such as qmail or exim. It can also act as a pop3 client.
meillo@0 27
meillo@0 28 .SH OPTIONS
meillo@0 29
meillo@0 30 Since masqmail is intended to replace sendmail, it uses the same command line options, but not all are implemented. There are also two additional options, which are unique to masqmail (-qo \fIconnection\f1 and -g)
meillo@0 31 .TP
meillo@0 32
meillo@0 33 \fB--\f1
meillo@0 34
meillo@0 35 Not a 'real' option, it means that all following arguments are to be understood as arguments and not as options even if they begin with a leading dash '-'. Mutt is known to call sendmail with this option.
meillo@0 36 .TP
meillo@0 37
meillo@0 38 \fB-bd\f1
meillo@0 39
meillo@0 40 Run as daemon, accepting connections, usually on port 25 if not configured differently. This is usually used in the startup script at system boot and together with the -q option (see below).
meillo@0 41 .TP
meillo@0 42
meillo@0 43 \fB-bi\f1
meillo@0 44
meillo@0 45 Old sendmail rebuilds its alias database when invoked with this option. Masqmail ignores it. Masqmail reads directly from the file given with alias_file in the config file.
meillo@0 46 .TP
meillo@0 47
meillo@0 48 \fB-bp\f1
meillo@0 49
meillo@0 50 Show the messages in the queue. Same as calling masqmail as 'mailq'.
meillo@0 51 .TP
meillo@0 52
meillo@0 53 \fB-bs\f1
meillo@0 54
meillo@0 55 Accept SMTP commands from stdin. Some mailers (eg pine) use this option as an interface. It can also be used to call masqmail from inetd.
meillo@0 56 .TP
meillo@0 57
meillo@0 58 \fB-B \fIarg\f1\fB\f1
meillo@0 59
meillo@0 60 \fIarg\f1 is usually 8BITMIME. Some mailers use this to indicate that the message contains characters > 127. Masqmail is 8-bit clean and ignores this, so you do not have to recompile elm, which is very painful ;-). Note though that this violates some conventions: masqmail does not convert 8 bit messages to any MIME format if it encounters a mail server which does not advertise its 8BITMIME capability, masqmail does not advertise this itself. This is the same practice as that of exim (but different to sendmail).
meillo@0 61 .TP
meillo@0 62
meillo@0 63 \fB-bV \f1
meillo@0 64
meillo@0 65 Show version information.
meillo@0 66 .TP
meillo@0 67
meillo@0 68 \fB-C \f1\fIfilename\f1
meillo@0 69
meillo@0 70 Use another configuration than \fI/etc/masqmail/masqmail.conf\f1. Useful for debugging purposes. If not invoked by a privileged user, masqmail will drop all privileges.
meillo@0 71 .TP
meillo@0 72
meillo@0 73 \fB-d \fInumber\f1\fB\f1
meillo@0 74
meillo@0 75 Set the debug level. This takes precedence before the value ofdebug_level in the configuration file. Read the warning in the description of the latter.
meillo@0 76 .TP
meillo@0 77
meillo@0 78 \fB-f [\fIaddress\f1\fB]\f1
meillo@0 79
meillo@0 80 Set the return path address to \fIaddress\f1. Only root, the user mail and anyoune in group trusted is allowed to do that.
meillo@0 81 .TP
meillo@0 82
meillo@0 83 \fB-F [\fIstring\f1\fB]\f1
meillo@0 84
meillo@0 85 Set the full sender name (in the From: header) to \fIstring\f1.
meillo@0 86 .TP
meillo@0 87
meillo@0 88 \fB-g [\fIname\f1\fB]\f1
meillo@0 89
meillo@0 90 Get mail (using pop3 or apop), using the configurations given with get.\fIname\f1 in the main configuration. Without \fIname\f1, all get configurations will be used. See also \fBmasqmail.get (5)\f1
meillo@0 91 .TP
meillo@0 92
meillo@0 93 \fB-go [\fIinterval\f1\fB] [\fIname\f1\fB]\f1
meillo@0 94
meillo@0 95 Can be followed by a connection name. Use this option in your script which starts as soon as a link to the internet has been set up (usually ip-up). When masqmail is called with this option, the specified get configuration(s) is(are) read and mail will be retrieved from servers on the internet. The \fIname\f1 is defined in the configuration (see \fBonline_gets.\fIname\f1\fB\f1).
meillo@0 96
meillo@0 97 If called with an interval option (recognized by a digit as the first characater), masqmail starts as a daemon and tries to get mail in these intervals. It checks for the online status first. Example: masqmail -go 5m will retrieve mail all five minutes.
meillo@0 98
meillo@0 99 If called without \fIname\f1 the online status is determined with the configured method (see \fBonline_detect\f1 in config.html).
meillo@0 100 .TP
meillo@0 101
meillo@0 102 \fB-i\f1
meillo@0 103
meillo@0 104 Same as -oi, see below.
meillo@0 105 .TP
meillo@0 106
meillo@0 107 \fB-Mrm \fIlist\f1\fB\f1
meillo@0 108
meillo@0 109 Remove given messages from the queue. Only allowed for privileged users.
meillo@0 110 .TP
meillo@0 111
meillo@0 112 \fB-oem\f1
meillo@0 113
meillo@0 114 If the -oi ist not also given, always return with a non zero return code. Maybe someone tells me what this is good for...
meillo@0 115 .TP
meillo@0 116
meillo@0 117 \fB-odb\f1
meillo@0 118
meillo@0 119 Deliver in background. Masqmail always does this, which makes this option pretty much useless.
meillo@0 120 .TP
meillo@0 121
meillo@0 122 \fB-odq\f1
meillo@0 123
meillo@0 124 Do not attempt to deliver immediately. Any messages will be queued until the next queue running process picks them up and delivers them. You get the same effect by setting the do_queue option in /etc/masqmail/masqmail.conf.
meillo@0 125 .TP
meillo@0 126
meillo@0 127 \fB-oi\f1
meillo@0 128
meillo@0 129 A dot as a single character in a line does not terminate the message.
meillo@0 130 .TP
meillo@0 131
meillo@0 132 \fB-q [\fIinterval\f1\fB]\f1
meillo@0 133
meillo@0 134 If not given with an argument, run a queue process, ie. try to deliver all messages in the queue. Masqmail sends only to those addresses that are on the local net, not to those that are outside. Use -qo for those.
meillo@0 135
meillo@0 136 If you have configured inetd to start masqmail, you can use this option in a cron job which starts in regular time intervals, to mimic the same effect as starting masqmail with -bd -q30m.
meillo@0 137
meillo@0 138 An argument may be a time interval ie. a numerical value followed by one of the letters. s,m,h,d,w which are interpreted as seconds, minutes, hours, days or weeks respectively. Example: -q30m. Masqmail starts as a daemon and a queue runner process will be started automatically once in this time interval. This is usually used together with -bd (see above).
meillo@0 139 .TP
meillo@0 140
meillo@0 141 \fB-qo [\fIname\f1\fB]\f1
meillo@0 142
meillo@0 143 Can be followed by a connection name. Use this option in your script which starts as soon as a link to the internet has been set up (usually ip-up). When masqmail is called with this option, the specified route configuration is read and the queued mail with destinations on the internet will be sent. The \fIname\f1 is defined in the configuration (see \fBonline_routes.\fIname\f1\fB\f1).
meillo@0 144
meillo@0 145 If called without \fIname\f1 the online status is determined with the configured method (see \fBonline_detect\f1 in config.html)
meillo@0 146 .TP
meillo@0 147
meillo@0 148 \fB-t\f1
meillo@0 149
meillo@0 150 Read recipients from headers. Delete 'Bcc:' headers. If any arguments are given, these are interpreted as recipient addresses and the message will not be sent to these.
meillo@0 151 .TP
meillo@0 152
meillo@0 153 \fB-v\f1
meillo@0 154
meillo@0 155 Log also to stdout. Currently, some log messages are marked as 'write to stdout' and additionally, all messages with priority 'LOG_ALERT' and 'LOG_WARNING' will be written to stdout if this option is given. It is disabled in daemon mode.
meillo@0 156 .SH ENVIRONMENT FOR PIPES AND MDAS
meillo@0 157
meillo@0 158 For security reasons, before any pipe command from an alias expansion or an mda is called, the environment variables will be completely discarded and newly set up. These are:
meillo@0 159
meillo@0 160 SENDER, RETURN_PATH - the return path.
meillo@0 161
meillo@0 162 SENDER_DOMAIN - the domain part of the return path.
meillo@0 163
meillo@0 164 SENDER_LOCAL - the local part of the return path.
meillo@0 165
meillo@0 166 RECEIVED_HOST - the host the message was received from (unless local).
meillo@0 167
meillo@0 168 LOCAL_PART, USER, LOGNAME - the local part of the (original) recipient.
meillo@0 169
meillo@0 170 MESSAGE_ID - the unique message id. This is not necessarily identical with the Message ID as given in the Message ID: header.
meillo@0 171
meillo@0 172 QUALIFY_DOMAIN - the domain which will be appended to unqualified addresses.
meillo@0 173
meillo@0 174 .SH FILES
meillo@0 175
meillo@0 176 \fI/etc/masqmail/masqmail.conf\f1 is the main configuration for masqmail. Depending on the settings in this file, you will also have other configuration files in \fI/etc/masqmail/\f1.
meillo@0 177
meillo@0 178 \fI/etc/aliases\f1 is the alias file, if not set differently in \fI/etc/masqmail/masqmail.conf\f1.
meillo@0 179
meillo@0 180 \fI/var/spool/masqmail/\f1 is the spool directory where masqmail stores its spooled messages and the uniq pop ids.
meillo@0 181
meillo@0 182 \fI/var/spool/mail/\f1 is the directory where locally delivered mail will be put, if not configured differently in \fImasqmail.conf\f1.
meillo@0 183
meillo@0 184 \fI/var/log/masqmail/\f1 is the directory where masqmail stores its log mesages. This can also be somewhere else if configured differently by your sysadmin or the package mantainer.
meillo@0 185
meillo@0 186 .SH CONFORMING TO
meillo@0 187
meillo@0 188 RFC 821, 822, 1869, 1870, 2197, 2554 (SMTP)
meillo@0 189
meillo@0 190 RFC 1725, 1939 (POP3)
meillo@0 191
meillo@0 192 RFC 1321 (MD5)
meillo@0 193
meillo@0 194 RFC 2195 (CRAM-MD5)
meillo@0 195
meillo@0 196 .SH AUTHOR
meillo@0 197
meillo@0 198 masqmail was written by Oliver Kurth <oku@masqmail.cx>
meillo@0 199
meillo@0 200 You will find the newest version of masqmail at \fBhttp://masqmail.cx/masqmail/\f1 or search for it in freshmeat (\fBhttp://www.freshmeat.net\f1). There is also a mailing list, you will find information about it at masqmails main site.
meillo@0 201
meillo@0 202 .SH BUGS
meillo@0 203
meillo@0 204 You should report them to the mailing list.
meillo@0 205
meillo@0 206 .SH SEE ALSO
meillo@0 207
meillo@0 208 \fBmasqmail.conf (5)\f1, \fBmasqmail.route (5)\f1, \fBmasqmail.get (5)\f1, \fBmasqmail.aliases (5)\f1
meillo@0 209
meillo@0 210 .SH COMMENTS
meillo@0 211
meillo@0 212 This man page was written using \fBxml2man (1)\f1 by the same author.
meillo@0 213