masqmail

annotate man/masqmail.8 @ 248:018cfd163f5c

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