masqmail

annotate man/masqmail.8 @ 235:92063f90f9be

find changesets by author, revision, files, or words in the commit message
removed additional new lines at the end of debug messages the strings printed to the end of the line contain a new line already
author markus schnalke <meillo@marmaro.de>
date Fri, 22 Oct 2010 11:09:57 -0300
parents 89f951be358f
children 3c40f86d50e4
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@34 127 \fB\-oem\fR
meillo@0 128
meillo@34 129 If the \fB\-oi\fR ist not also given, always return with a non zero return code.
meillo@34 130 Maybe someone tells me what this is good for...
meillo@0 131
meillo@0 132 .TP
meillo@34 133 \fB\-odb\fR
meillo@0 134
meillo@34 135 Deliver in background.
meillo@34 136 Masqmail always does this, which makes this option pretty much useless.
meillo@0 137
meillo@0 138 .TP
meillo@34 139 \fB\-odq\fR
meillo@0 140
meillo@34 141 Do not attempt to deliver immediately.
meillo@34 142 Any messages will be queued until the next queue running process picks them up and delivers them.
meillo@34 143 You get the same effect by setting the do_queue option in /etc/masqmail/masqmail.conf.
meillo@0 144
meillo@0 145 .TP
meillo@34 146 \fB\-oi\fR
meillo@0 147
meillo@0 148 A dot as a single character in a line does not terminate the message.
meillo@34 149
meillo@0 150 .TP
meillo@34 151 \fB\-q [\fIinterval\fB]\fR
meillo@0 152
meillo@34 153 If not given with an argument, run a queue process, i.e. try to deliver all messages in the queue.
meillo@34 154 Masqmail sends only to those addresses that are on the local net, not to those that are outside.
meillo@34 155 Use \fB\-qo\fR for those.
meillo@0 156
meillo@34 157 If you have configured inetd to start masqmail,
meillo@34 158 you can use this option in a cron job which starts in regular time intervals,
meillo@34 159 to mimic the same effect as starting masqmail with \fB\-bd \-q30m\fR.
meillo@0 160
meillo@34 161 An argument may be a time interval i.e. a numerical value followed by one of the letters.
meillo@34 162 s,m,h,d,w which are interpreted as seconds, minutes, hours, days or weeks respectively.
meillo@34 163 Example: \fB\-q30m\fR.
meillo@34 164 Masqmail starts as a daemon and a queue runner process will be started automatically
meillo@34 165 once in this time interval.
meillo@34 166 This is usually used together with \fB\-bd\fR (see above).
meillo@0 167
meillo@0 168 .TP
meillo@34 169 \fB\-qo [\fIname\fB]\fR
meillo@0 170
meillo@34 171 Can be followed by a connection name.
meillo@34 172 Use this option in your script which starts as soon as a link to the internet
meillo@34 173 has been set up (usually ip-up).
meillo@34 174 When masqmail is called with this option, the specified route configuration
meillo@34 175 is read and the queued mail with destinations on the internet will be sent.
meillo@34 176 The \fIname\fR is defined in the configuration (see \fBonline_routes.\fIname\fR).
meillo@0 177
meillo@34 178 If called without \fIname\fR the online status is determined with the configured
meillo@34 179 method (see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR)
meillo@0 180
meillo@0 181 .TP
meillo@34 182 \fB\-t\fR
meillo@0 183
meillo@34 184 Read recipients from headers.
meillo@34 185 Delete `Bcc:' headers.
meillo@106 186 (Since 0.2.25, masqmail deletes Bcc: headers in all cases.)
meillo@34 187 If any arguments are given, these are interpreted as recipient addresses
meillo@103 188 and the message will not be sent to these,
meillo@103 189 although they might appear in To:, Cc:, or Bcc: headers.
meillo@103 190 I.e. the set of argument recipients is ``substracted'' from the set of header recipients.
meillo@103 191
meillo@103 192 This behavior is similar to exim's and smail's.
meillo@103 193 Postfix, in contrast, adds the arguments to the set of header recipients.
meillo@103 194 Sendmail seems to behave differently, depending on the version.
meillo@103 195 See exim(8) for further information.
meillo@0 196
meillo@0 197 .TP
meillo@34 198 \fB\-v\fR
meillo@0 199
meillo@34 200 Log also to stdout.
meillo@34 201 Currently, some log messages are marked as `write to stdout' and additionally,
meillo@34 202 all messages with priority `LOG_ALERT' and `LOG_WARNING' will be written to stdout
meillo@34 203 if this option is given. It is disabled in daemon mode.
meillo@0 204
meillo@34 205
meillo@0 206 .SH ENVIRONMENT FOR PIPES AND MDAS
meillo@0 207
meillo@34 208 For security reasons, before any pipe command from an alias expansion or an mda is called,
meillo@34 209 the environment variables will be completely discarded and newly set up. These are:
meillo@0 210
meillo@34 211 SENDER, RETURN_PATH \(en the return path.
meillo@0 212
meillo@34 213 SENDER_DOMAIN \(en the domain part of the return path.
meillo@0 214
meillo@34 215 SENDER_LOCAL \(en the local part of the return path.
meillo@0 216
meillo@34 217 RECEIVED_HOST \(en the host the message was received from (unless local).
meillo@0 218
meillo@34 219 LOCAL_PART, USER, LOGNAME \(en the local part of the (original) recipient.
meillo@0 220
meillo@34 221 MESSAGE_ID \(en the unique message id.
meillo@34 222 This is not necessarily identical with the Message ID as given in the Message ID: header.
meillo@0 223
meillo@34 224 QUALIFY_DOMAIN \(en the domain which will be appended to unqualified addresses.
meillo@34 225
meillo@0 226
meillo@0 227 .SH FILES
meillo@0 228
meillo@34 229 \fI/etc/masqmail/masqmail.conf\fR is the main configuration for masqmail.
meillo@34 230 Depending on the settings in this file, you will also have other configuration
meillo@34 231 files in \fI/etc/masqmail/\fR.
meillo@0 232
meillo@34 233 \fI/var/spool/masqmail/\fR is the spool directory where masqmail stores
meillo@192 234 its spooled messages.
meillo@0 235
meillo@34 236 \fI/var/spool/mail/\fR is the directory where locally delivered mail will be put,
meillo@34 237 if not configured differently in \fImasqmail.conf\fR.
meillo@0 238
meillo@34 239 \fI/var/log/masqmail/\fR is the directory where masqmail stores its log mesages.
meillo@34 240 This can also be somewhere else if configured differently by your sysadmin or the package mantainer.
meillo@34 241
meillo@0 242
meillo@0 243 .SH CONFORMING TO
meillo@0 244
meillo@0 245 RFC 821, 822, 1869, 1870, 2197, 2554 (SMTP)
meillo@0 246
meillo@0 247 RFC 1321 (MD5)
meillo@0 248
meillo@0 249 RFC 2195 (CRAM-MD5)
meillo@0 250
meillo@34 251
meillo@0 252 .SH AUTHOR
meillo@0 253
meillo@34 254 Masqmail was written by Oliver Kurth.
meillo@34 255 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
meillo@0 256
meillo@95 257 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
meillo@26 258 There is also a mailing list, you will find information about it at masqmail's main site.
meillo@0 259
meillo@34 260
meillo@0 261 .SH BUGS
meillo@0 262
meillo@34 263 Please report them to the mailing list.
meillo@34 264
meillo@0 265
meillo@0 266 .SH SEE ALSO
meillo@0 267
meillo@192 268 \fBmasqmail.conf(5)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.aliases(5)\fR