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