masqmail

annotate man/masqmail.8 @ 179:3190e6864452

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