masqmail
view man/masqmail.8 @ 271:899175e8dff0
heavy refactoring in the small of parse.c
I really hope I didn't change any behavior.
This reminds me that we really need a test framework.
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Fri, 03 Dec 2010 13:05:59 -0300 |
| parents | 05fa719b7002 |
| children | 1abc1faeb45d |
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 When no mode had been specified by either a command line option
37 (e.g. \fB\-bd\fP, \fB\-bs\fP) or by calling masqmail under a special name
38 (e.g. ``mailq''), then the default mode is used.
39 This is accepting messages on stdin if any address arguments are given,
40 and only printing its version (\fB\-bV\fP) otherwise.
42 .TP
43 \fB\-\-\fR
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.
49 .TP
50 \fB\-bd\fR
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).
56 .TP
57 \fB\-bi\fR
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.
63 .TP
64 \fB\-bp\fR
66 Show the messages in the queue. Same as calling masqmail as `mailq'.
68 .TP
69 \fB\-bs\fR
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.
75 .TP
76 \fB\-B \fIarg\fR
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).
88 .TP
89 \fB\-bV \fR
91 Show version information.
93 .TP
94 \fB\-C \fIfilename\fR
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.
100 .TP
101 \fB\-d \fInumber\fR
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.
106 Only root may set the debug level.
108 .TP
109 \fB\-f [\fIaddress\fB]\fR
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.
114 .TP
115 \fB\-F [\fIstring\fB]\fR
117 Set the full sender name (in the From: header) to \fIstring\fR.
119 .TP
120 \fB\-i\fR
122 Same as \fB\-oi\fR, see below.
123 Kept for compatibility.
125 .TP
126 \fB\-Mrm \fImsgid...\fR
128 Remove given messages from the queue.
129 Privileged users may remove any message,
130 other users only their own.
131 The message identifiers are listed in the output of
132 \fImasqmail \-bp\fP (aka. \fImailq\fR).
134 .TP
135 \fB\-m\fR
137 ``Me too''
138 This switch is ignored as,
139 masqmail never excludes the sender from any alias expansions.
141 \fB\-m\fP is an ancient alias for \fB\-om\fP.
142 Kept for compatibility.
144 .TP
145 \fB\-odb\fR
147 ``Deliver in Background''
148 Masqmail always does this.
149 Hence masqmail ignores this switch.
151 .TP
152 \fB\-odq\fR
154 ``Do Queueing''
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.
159 .TP
160 \fB\-oi\fR
162 A dot as a single character in a line does not terminate the message.
164 The same as \fB\-i\fP.
166 .TP
167 \fB\-oXXX\fR
169 Any other switch starting with `\-o' is ignored.
170 This especially affects \-om, \-oem, \-oee.
172 .TP
173 \fB\-q [\fIinterval\fB]\fR
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.
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.
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).
190 .TP
191 \fB\-qo [\fIname\fB]\fR
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).
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)
203 .TP
204 \fB\-t\fR
206 Read recipients from headers.
207 If any arguments are given, these are interpreted as recipient addresses
208 and the message will not be sent to these,
209 although they might appear in To:, Cc:, or Bcc: headers.
210 I.e. the set of argument recipients is ``substracted'' from the set of header recipients.
212 This behavior is similar to exim's and smail's.
213 Postfix, in contrast, adds the arguments to the set of header recipients.
214 Sendmail seems to behave differently, depending on the version.
215 See exim(8) for further information.
217 .TP
218 \fB\-v\fR
220 ``Verbose''
221 Log also to stdout.
222 Currently, some log messages are marked as `write to stdout' and additionally,
223 all messages with priority `LOG_ALERT' and `LOG_WARNING' will be written to stdout
224 if this option is given. It is disabled in daemon mode.
227 .SH ENVIRONMENT FOR PIPES AND MDAS
229 For security reasons, before any pipe command from an alias expansion or an mda is called,
230 the environment variables will be completely discarded and newly set up. These are:
232 SENDER, RETURN_PATH \(en the return path.
234 SENDER_DOMAIN \(en the domain part of the return path.
236 SENDER_LOCAL \(en the local part of the return path.
238 RECEIVED_HOST \(en the host the message was received from (unless local).
240 LOCAL_PART, USER, LOGNAME \(en the local part of the (original) recipient.
242 MESSAGE_ID \(en the unique message id.
243 This is not necessarily identical with the Message ID as given in the Message ID: header.
245 QUALIFY_DOMAIN \(en the domain which will be appended to unqualified addresses.
248 .SH FILES
250 \fI/etc/masqmail/masqmail.conf\fR is the main configuration for masqmail.
251 Depending on the settings in this file, you will also have other configuration
252 files in \fI/etc/masqmail/\fR.
254 \fI/var/spool/masqmail/\fR is the spool directory where masqmail stores
255 its spooled messages.
257 \fI/var/spool/mail/\fR is the directory where locally delivered mail will be put,
258 if not configured differently in \fImasqmail.conf\fR.
260 \fI/var/log/masqmail/\fR is the directory where masqmail stores its log mesages.
261 This can also be somewhere else if configured differently by your sysadmin or the package mantainer.
264 .SH CONFORMING TO
266 RFC 821, 822, 1869, 1870, 2197, 2554 (SMTP)
268 RFC 1321 (MD5)
270 RFC 2195 (CRAM-MD5)
273 .SH AUTHOR
275 Masqmail was written by Oliver Kurth.
276 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
278 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
279 There is also a mailing list, you will find information about it at masqmail's main site.
282 .SH BUGS
284 Please report them to the mailing list.
287 .SH SEE ALSO
289 \fBmasqmail.conf(5)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.aliases(5)\fR