masqmail
view man/masqmail.8 @ 283:853b85616c98
improved man/masqmail.8 heavily
In respect to the modes, -bm, -q, and -qo.
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Tue, 07 Dec 2010 14:19:04 -0300 |
| parents | 1abc1faeb45d |
| children | bdcc2b42eb0f |
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 OPERATION MODES
32 Masqmail operates in one of several exclusive modes.
34 The daemon mode has two flavors that may be,
35 and usually are, combined:
36 .TP
37 .B \-bd
38 listen daemon; listens for incoming SMTP connections.
39 .TP
40 .B \-q\fRINTERVAL
41 queue daemon; processes the queue in a regular interval.
43 .P
44 The queue processing mode has two flavors that may be combined:
45 .TP
46 .BR \-q
47 (without argument)
48 do a single queue run.
49 .TP
50 .B \-qo
51 do a single queue run and deliver only using a specific online route.
53 .P
54 The other modes are simple ones:
55 .TP
56 .B \-bi
57 a no-op for masqmail, just exit.
58 .TP
59 .B \-bm
60 accept messages on stdin. (The default)
61 .TP
62 .B \-bp
63 print the contents of the queue.
64 .TP
65 .B \-bs
66 accept messages by speaking SMTP on stdin.
67 .TP
68 .B \-bV
69 print version information.
70 .TP
71 .B \-Mrm
72 remove messages from the queue.
73 .P
74 Some of the modes are also available by calling masqmail
75 under a special name.
77 When no mode had been specified by either one of the above command line
78 options or by calling masqmail under a special name,
79 then the default mode \fB\-bm\fR
80 (i.e. accept messages on stdin) is entered.
81 However, if neither address arguments are specified nor
82 \fB\-t\fR is given, then no recipients are available and thus mail can not
83 be sent, hence something more useful is done: \fB\-bV\fP is assumed.
86 .SH OPTIONS
88 Since masqmail is intended to replace sendmail,
89 it uses the same command line options,
90 but not all are implemented.
91 The \fB\-qo\fP option is additional, and unique to masqmail.
93 .TP
94 \fB\-\-\fR
96 Not a `real' option, it means that all following arguments are to be understood
97 as arguments and not as options even if they begin with a leading dash `\-'.
98 Mutt is known to call sendmail with this option.
100 .TP
101 \fB\-bd\fR
103 Run as daemon, accepting connections,
104 usually on port 25 if not configured differently.
105 This is usually used in the startup script at system boot and together with
106 the \fB\-q\fR option (see below).
108 .TP
109 \fB\-bi\fR
111 Old sendmail rebuilds its alias database when invoked with this option.
112 Masqmail reads directly from the file given with `alias_file' in the config file.
113 Hence masqmail simply exits in this mode.
115 .TP
116 .B \-bm
118 Accept a text message on stdin.
119 This is the default mode of operation.
120 One will hardly use this switch as it is the default.
122 .TP
123 \fB\-bp\fR
125 Show the messages in the queue.
126 Same as calling masqmail as `mailq'.
128 .TP
129 \fB\-bs\fR
131 Accept SMTP commands from stdin.
132 Some mailers (e.g. pine) use this option as an interface.
133 It can also be used to call masqmail from inetd.
135 .TP
136 \fB\-bV \fR
138 Show version information, then exit.
140 .TP
141 \fB\-B \fIarg\fR
143 \fIarg\fR is usually 8BITMIME.
144 Some mailers use this to indicate that the message contains characters > 127.
145 Masqmail is 8-bit clean and ignores this, so you do not have to recompile elm,
146 which is very painful ;-).
147 Note though that this violates some conventions:
148 masqmail does not convert 8 bit messages to any MIME format if it encounters
149 a mail server which does not advertise its 8BITMIME capability,
150 masqmail does not advertise this itself.
151 This is the same practice as that of exim (but different to sendmail).
153 .TP
154 \fB\-C \fIfilename\fR
156 Use another configuration than \fI/etc/masqmail/masqmail.conf\fR.
157 Useful for debugging purposes.
158 If not invoked by a privileged user, masqmail will drop all privileges.
160 .TP
161 \fB\-d \fInumber\fR
163 Set the debug level.
164 This takes precedence before the value of `debug_level' in the configuration file.
165 Read the warning in the description of the latter.
166 Only root may set the debug level.
168 .TP
169 \fB\-f [\fIaddress\fB]\fR
171 Set the return path address to \fIaddress\fR.
172 Only root, the user mail and anyone in group mail is allowed to do that.
174 .TP
175 \fB\-F [\fIstring\fB]\fR
177 Set the full sender name (in the From: header) to \fIstring\fR.
179 .TP
180 \fB\-i\fR
182 Same as \fB\-oi\fR, see below.
183 Kept for compatibility.
185 .TP
186 \fB\-Mrm \fImsgid...\fR
188 ``Queue manipulation mode''
190 Remove given messages from the queue.
191 Privileged users may remove any message, other users only their own.
192 The message identifiers are listed in the output of
193 \fImasqmail \-bp\fP (aka. \fImailq\fR).
195 .TP
196 \fB\-m\fR
198 ``Me too''
199 This switch is ignored as,
200 masqmail never excludes the sender from any alias expansions.
202 \fB\-m\fP is an ancient alias for \fB\-om\fP.
203 Kept for compatibility.
205 .TP
206 \fB\-odb\fR
208 ``Deliver in Background''
209 Masqmail always does this.
210 Hence masqmail ignores this switch.
212 .TP
213 \fB\-odq\fR
215 ``Do Queueing''
216 Do not attempt to deliver immediately.
217 Any messages will be queued until the next queue running process picks them
218 up and delivers them.
219 You get the same effect by setting the do_queue option in
220 /etc/masqmail/masqmail.conf.
222 .TP
223 \fB\-oi\fR
225 A dot as a single character in a line does not terminate the message.
227 The same as \fB\-i\fP.
229 .TP
230 \fB\-oXXX\fR
232 Any other switch starting with `\-o' is ignored.
233 This especially affects \-om, \-oem, \-oee.
235 .TP
236 \fB\-q [\fIinterval\fB]\fR
238 Without argument:
239 Do a single queue run, i.e. try to deliver all messages in the queue.
240 Masqmail sends to addresses on the local host, on the local net,
241 and if it detects an online connection, to remote ones too.
242 That means, that masqmail sends any queued mail it can.
243 .B \-q
244 includes
245 .B \-qo
246 (without argument).
248 With an argument:
249 Start as a daemon and do a queue run automatically once in the specified
250 time interval.
251 This is usually used together with \fB\-bd\fR (see above).
253 An argument may be a time interval i.e. a numerical value followed by one
254 of the letters s,m,h,d,w which are interpreted as
255 seconds, minutes, hours, days or weeks respectively.
256 Example: \fB\-q30m\fR.
258 Running masqmail from inetd and starting single queue runs from cron
259 mimics the same effect as starting masqmail with something like
260 \fB\-bd \-q30m\fR.
262 .TP
263 \fB\-qo [\fIname\fB]\fR
265 Online queue runs.
267 Without a connection name:
268 Determine the online status with the configured method
269 (see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR)
270 and, if a connection is available, send remote mail over it.
272 With a connection name:
273 Send remote mail over the specified connection,
274 no online detection is made.
276 The specified route configuration is read and queued mail to remote
277 recipients will be sent.
278 The \fIname\fR is defined in the configuration (see \fBonline_routes.\fIname\fR).
280 Use this option in your script which starts as soon as a link to the internet
281 has been set up (usually ip-up).
283 .TP
284 \fB\-t\fR
286 Read recipients from mail headers and add them to the ones specified on the
287 command line.
288 (Only To:, Cc:, and Bcc: headers are regarded.)
290 .B WARNING: The behavior changed with version 0.3.1!
292 In earlier versions command line argument addresses were ``substracted''
293 from header addresses.
295 The old behavior was similar to exim's and smail's
296 (which are anchesters of masqmail).
297 The new behavior is similar to the one of current postfix versions,
298 which add the arguments to the set of header recipients.
299 (Earlier postfix failed in case of address arguments with \-t.)
300 Sendmail seems to behave differently, depending on the version.
301 See exim(8) for further information.
303 For masqmail the most simple approach had been taken.
305 As the behavior of \-t together with command line address arguments
306 differs among MTAs, one better not steps into this corner case.
308 .TP
309 \fB\-v\fR
311 ``Verbose''
312 Log also to stdout.
313 Currently, some log messages are marked as `write to stdout' and additionally,
314 all messages with priority `LOG_ALERT' and `LOG_WARNING' will be written to stdout
315 if this option is given. It is disabled in daemon mode.
318 .SH ENVIRONMENT FOR PIPES AND MDAS
320 For security reasons, before any pipe command from an alias expansion or an mda is called,
321 the environment variables will be completely discarded and newly set up. These are:
323 SENDER, RETURN_PATH \(en the return path.
325 SENDER_DOMAIN \(en the domain part of the return path.
327 SENDER_LOCAL \(en the local part of the return path.
329 RECEIVED_HOST \(en the host the message was received from (unless local).
331 LOCAL_PART, USER, LOGNAME \(en the local part of the (original) recipient.
333 MESSAGE_ID \(en the unique message id.
334 This is not necessarily identical with the Message ID as given in the Message ID: header.
336 QUALIFY_DOMAIN \(en the domain which will be appended to unqualified addresses.
339 .SH FILES
341 \fI/etc/masqmail/masqmail.conf\fR is the main configuration for masqmail.
342 Depending on the settings in this file, you will also have other configuration
343 files in \fI/etc/masqmail/\fR.
345 \fI/var/spool/masqmail/\fR is the spool directory where masqmail stores
346 its spooled messages.
348 \fI/var/spool/mail/\fR is the directory where locally delivered mail will be put,
349 if not configured differently in \fImasqmail.conf\fR.
351 \fI/var/log/masqmail/\fR is the directory where masqmail stores its log mesages.
352 This can also be somewhere else if configured differently by your sysadmin or the package mantainer.
355 .SH CONFORMING TO
357 RFC 821, 822, 1869, 1870, 2197, 2554 (SMTP)
359 RFC 1321 (MD5)
361 RFC 2195 (CRAM-MD5)
364 .SH AUTHOR
366 Masqmail was written by Oliver Kurth.
367 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
369 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
370 There is also a mailing list, you will find information about it at masqmail's main site.
373 .SH BUGS
375 Please report them to the mailing list.
378 .SH SEE ALSO
380 \fBmasqmail.conf(5)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.aliases(5)\fR