masqmail
view man/masqmail.8 @ 252:1b25fabdc3cb
improved man/masqmail.8 in various ways but mostly for -oem
The man page documents the changes in cmdline argument
processing, done just recently.
The problem of -oem is not solved yet but documented.
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Thu, 04 Nov 2010 13:43:44 -0300 |
| parents | 3c40f86d50e4 |
| children | 05fa719b7002 |
line source
1 .TH masqmail 8 2010-07-23 masqmail-0.3.0 "Maintenance Commands"
3 .SH NAME
4 masqmail \- An offline Mail Transfer Agent
6 .SH SYNOPSIS
7 \fB/usr/sbin/masqmail \fR[\fB\-C \fIfile\fR] [\fB\-odq\fR] [\fB\-bd\fR] [\fB\-q\fIinterval\fR]
9 \fB/usr/sbin/masqmail \fR[\fB\-odq\fR] [\fB\-bs\fR]
11 \fB/usr/sbin/masqmail \fR[\fB\-bp\fR]
13 \fB/usr/sbin/masqmail \fR[\fB\-q\fR]
15 \fB/usr/sbin/masqmail \fR[\fB\-qo \fR[\fIname\fR]]
17 \fB/usr/sbin/masqmail \fR[\fB\-t\fR] [\fB\-oi\fR] [\fB\-f \fIaddress\fR] [\fB\-\-\fR] \fIaddress...
19 \fB/usr/sbin/mailq\fR
22 .SH DESCRIPTION
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.
30 .SH OPTIONS
32 Since masqmail is intended to replace sendmail, it uses the same command line options,
33 but not all are implemented.
34 The \fB\-qo\fP option is additional, and unique to masqmail.
36 .TP
37 \fB\-\-\fR
39 Not a `real' option, it means that all following arguments are to be understood
40 as arguments and not as options even if they begin with a leading dash `\-'.
41 Mutt is known to call sendmail with this option.
43 .TP
44 \fB\-bd\fR
46 Run as daemon, accepting connections, usually on port 25 if not configured differently.
47 This is usually used in the startup script at system boot and together with
48 the \fB\-q\fR option (see below).
50 .TP
51 \fB\-bi\fR
53 Old sendmail rebuilds its alias database when invoked with this option.
54 Masqmail ignores it.
55 Masqmail reads directly from the file given with `alias_file' in the config file.
57 .TP
58 \fB\-bp\fR
60 Show the messages in the queue. Same as calling masqmail as `mailq'.
62 .TP
63 \fB\-bs\fR
65 Accept SMTP commands from stdin.
66 Some mailers (e.g. pine) use this option as an interface.
67 It can also be used to call masqmail from inetd.
69 .TP
70 \fB\-B \fIarg\fR
72 \fIarg\fR is usually 8BITMIME.
73 Some mailers use this to indicate that the message contains characters > 127.
74 Masqmail is 8-bit clean and ignores this, so you do not have to recompile elm,
75 which is very painful ;-).
76 Note though that this violates some conventions:
77 masqmail does not convert 8 bit messages to any MIME format if it encounters
78 a mail server which does not advertise its 8BITMIME capability,
79 masqmail does not advertise this itself.
80 This is the same practice as that of exim (but different to sendmail).
82 .TP
83 \fB\-bV \fR
85 Show version information.
87 .TP
88 \fB\-C \fIfilename\fR
90 Use another configuration than \fI/etc/masqmail/masqmail.conf\fR.
91 Useful for debugging purposes.
92 If not invoked by a privileged user, masqmail will drop all privileges.
94 .TP
95 \fB\-d \fInumber\fR
97 Set the debug level.
98 This takes precedence before the value of `debug_level' in the configuration file.
99 Read the warning in the description of the latter.
100 Only root may set the debug level.
102 .TP
103 \fB\-f [\fIaddress\fB]\fR
105 Set the return path address to \fIaddress\fR.
106 Only root, the user mail and anyone in group mail is allowed to do that.
108 .TP
109 \fB\-F [\fIstring\fB]\fR
111 Set the full sender name (in the From: header) to \fIstring\fR.
113 .TP
114 \fB\-i\fR
116 Same as \fB\-oi\fR, see below.
117 Kept for compatibility.
119 .TP
120 \fB\-Mrm \fImsgid...\fR
122 Remove given messages from the queue.
123 Privileged users may remove any message,
124 other users only their own.
125 The message identifiers are listed in the output of
126 \fImasqmail \-bp\fP (aka. \fImailq\fR).
128 .TP
129 \fB\-m\fR
131 Same as \fB\-om\fR, see below.
132 Kept for compatibility.
134 .TP
135 \fB\-oem\fR
137 Currently this option makes masqmail behave such:
139 If the \fB\-oi\fR ist not also given, always return with a non zero return code.
141 It seems as if this current behavior is not like it should be.
143 In exim this option makes it behave such:
145 .in +4
146 .ll -4
147 If an error is detected while a non-SMTP message is being received
148 (for example, a malformed address),
149 the error is reported to the sender in a mail message.
150 Exim exits with a non-zero return code then,
151 no matter if the error message was successful or not.
152 (In exim, -oee is similar but exim returns successful
153 if the error message had been sent successful.)
154 .ll
155 .in
157 The mutt wiki writes about ``sendmail -oi -oem'':
159 .in +4
160 .ll -4
161 The mail server (in this case sendmail) will receive the message in input,
162 and will parse it. In case of a malformed message, it will send an error
163 message to the user to whom belongs the MUA trasmitting the message
164 (e.g. user@localhost.localdomain), and it will exit with a non zero exit code:
165 the -oem flag forces the returning of a non zero exit code even in
166 the case the error message has been successfully sent to the local server.
167 .ll
168 .in
170 Masqmail's behavior is different in that:
171 First, it does not send such error messages.
172 Second, return non-zero whenever -oem is set (but -oi not).
173 Third, -oi overrules -oem, though as it seems the two options
174 should not affect each other.
175 (Their relationship is just that -oem does only affect non-SMTP
176 messages on stdin, which is the typical use of -oi.)
178 .TP
179 \fB\-odb\fR
181 ``Deliver in Background''
182 Masqmail always does this.
183 Hence masqmail ignores this switch.
185 .TP
186 \fB\-odq\fR
188 ``Do Queueing''
189 Do not attempt to deliver immediately.
190 Any messages will be queued until the next queue running process picks them up and delivers them.
191 You get the same effect by setting the do_queue option in /etc/masqmail/masqmail.conf.
193 .TP
194 \fB\-oi\fR
196 A dot as a single character in a line does not terminate the message.
198 .TP
199 \fB\-om\fR
201 ``Me too''
202 Masqmail never excludes the sender from any alias expansions,
203 like if this switch is always set.
204 Specifying this switch changes nothing.
206 .TP
207 \fB\-oXXX\fR
209 Any other switch starting with `-o' is ignored.
211 .TP
212 \fB\-q [\fIinterval\fB]\fR
214 If not given with an argument, run a queue process, i.e. try to deliver all messages in the queue.
215 Masqmail sends only to those addresses that are on the local net, not to those that are outside.
216 Use \fB\-qo\fR for those.
218 If you have configured inetd to start masqmail,
219 you can use this option in a cron job which starts in regular time intervals,
220 to mimic the same effect as starting masqmail with \fB\-bd \-q30m\fR.
222 An argument may be a time interval i.e. a numerical value followed by one of the letters.
223 s,m,h,d,w which are interpreted as seconds, minutes, hours, days or weeks respectively.
224 Example: \fB\-q30m\fR.
225 Masqmail starts as a daemon and a queue runner process will be started automatically
226 once in this time interval.
227 This is usually used together with \fB\-bd\fR (see above).
229 .TP
230 \fB\-qo [\fIname\fB]\fR
232 Can be followed by a connection name.
233 Use this option in your script which starts as soon as a link to the internet
234 has been set up (usually ip-up).
235 When masqmail is called with this option, the specified route configuration
236 is read and the queued mail with destinations on the internet will be sent.
237 The \fIname\fR is defined in the configuration (see \fBonline_routes.\fIname\fR).
239 If called without \fIname\fR the online status is determined with the configured
240 method (see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR)
242 .TP
243 \fB\-t\fR
245 Read recipients from headers.
246 If any arguments are given, these are interpreted as recipient addresses
247 and the message will not be sent to these,
248 although they might appear in To:, Cc:, or Bcc: headers.
249 I.e. the set of argument recipients is ``substracted'' from the set of header recipients.
251 This behavior is similar to exim's and smail's.
252 Postfix, in contrast, adds the arguments to the set of header recipients.
253 Sendmail seems to behave differently, depending on the version.
254 See exim(8) for further information.
256 .TP
257 \fB\-v\fR
259 ``Verbose''
260 Log also to stdout.
261 Currently, some log messages are marked as `write to stdout' and additionally,
262 all messages with priority `LOG_ALERT' and `LOG_WARNING' will be written to stdout
263 if this option is given. It is disabled in daemon mode.
266 .SH ENVIRONMENT FOR PIPES AND MDAS
268 For security reasons, before any pipe command from an alias expansion or an mda is called,
269 the environment variables will be completely discarded and newly set up. These are:
271 SENDER, RETURN_PATH \(en the return path.
273 SENDER_DOMAIN \(en the domain part of the return path.
275 SENDER_LOCAL \(en the local part of the return path.
277 RECEIVED_HOST \(en the host the message was received from (unless local).
279 LOCAL_PART, USER, LOGNAME \(en the local part of the (original) recipient.
281 MESSAGE_ID \(en the unique message id.
282 This is not necessarily identical with the Message ID as given in the Message ID: header.
284 QUALIFY_DOMAIN \(en the domain which will be appended to unqualified addresses.
287 .SH FILES
289 \fI/etc/masqmail/masqmail.conf\fR is the main configuration for masqmail.
290 Depending on the settings in this file, you will also have other configuration
291 files in \fI/etc/masqmail/\fR.
293 \fI/var/spool/masqmail/\fR is the spool directory where masqmail stores
294 its spooled messages.
296 \fI/var/spool/mail/\fR is the directory where locally delivered mail will be put,
297 if not configured differently in \fImasqmail.conf\fR.
299 \fI/var/log/masqmail/\fR is the directory where masqmail stores its log mesages.
300 This can also be somewhere else if configured differently by your sysadmin or the package mantainer.
303 .SH CONFORMING TO
305 RFC 821, 822, 1869, 1870, 2197, 2554 (SMTP)
307 RFC 1321 (MD5)
309 RFC 2195 (CRAM-MD5)
312 .SH AUTHOR
314 Masqmail was written by Oliver Kurth.
315 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
317 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
318 There is also a mailing list, you will find information about it at masqmail's main site.
321 .SH BUGS
323 Please report them to the mailing list.
326 .SH SEE ALSO
328 \fBmasqmail.conf(5)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.aliases(5)\fR