masqmail

annotate docs/masqmail.8 @ 34:8ea86ac25658

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