masqmail
view man/masqmail.8 @ 258:05fa719b7002
fixed -oem by removing it ;-)
The implemenation of -oem had been very weird.
docs/oem-option explains the situation and the fix.
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Wed, 01 Dec 2010 18:27:46 -0300 |
| parents | 1b25fabdc3cb |
| children | f4117fd5a163 |
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 ``Me too''
132 This switch is ignored as,
133 masqmail never excludes the sender from any alias expansions.
135 \fB\-m\fP is an ancient alias for \fB\-om\fP.
136 Kept for compatibility.
138 .TP
139 \fB\-odb\fR
141 ``Deliver in Background''
142 Masqmail always does this.
143 Hence masqmail ignores this switch.
145 .TP
146 \fB\-odq\fR
148 ``Do Queueing''
149 Do not attempt to deliver immediately.
150 Any messages will be queued until the next queue running process picks them up and delivers them.
151 You get the same effect by setting the do_queue option in /etc/masqmail/masqmail.conf.
153 .TP
154 \fB\-oi\fR
156 A dot as a single character in a line does not terminate the message.
158 The same as \fB\-i\fP.
160 .TP
161 \fB\-oXXX\fR
163 Any other switch starting with `\-o' is ignored.
164 This especially affects \-om, \-oem, \-oee.
166 .TP
167 \fB\-q [\fIinterval\fB]\fR
169 If not given with an argument, run a queue process, i.e. try to deliver all messages in the queue.
170 Masqmail sends only to those addresses that are on the local net, not to those that are outside.
171 Use \fB\-qo\fR for those.
173 If you have configured inetd to start masqmail,
174 you can use this option in a cron job which starts in regular time intervals,
175 to mimic the same effect as starting masqmail with \fB\-bd \-q30m\fR.
177 An argument may be a time interval i.e. a numerical value followed by one of the letters.
178 s,m,h,d,w which are interpreted as seconds, minutes, hours, days or weeks respectively.
179 Example: \fB\-q30m\fR.
180 Masqmail starts as a daemon and a queue runner process will be started automatically
181 once in this time interval.
182 This is usually used together with \fB\-bd\fR (see above).
184 .TP
185 \fB\-qo [\fIname\fB]\fR
187 Can be followed by a connection name.
188 Use this option in your script which starts as soon as a link to the internet
189 has been set up (usually ip-up).
190 When masqmail is called with this option, the specified route configuration
191 is read and the queued mail with destinations on the internet will be sent.
192 The \fIname\fR is defined in the configuration (see \fBonline_routes.\fIname\fR).
194 If called without \fIname\fR the online status is determined with the configured
195 method (see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR)
197 .TP
198 \fB\-t\fR
200 Read recipients from headers.
201 If any arguments are given, these are interpreted as recipient addresses
202 and the message will not be sent to these,
203 although they might appear in To:, Cc:, or Bcc: headers.
204 I.e. the set of argument recipients is ``substracted'' from the set of header recipients.
206 This behavior is similar to exim's and smail's.
207 Postfix, in contrast, adds the arguments to the set of header recipients.
208 Sendmail seems to behave differently, depending on the version.
209 See exim(8) for further information.
211 .TP
212 \fB\-v\fR
214 ``Verbose''
215 Log also to stdout.
216 Currently, some log messages are marked as `write to stdout' and additionally,
217 all messages with priority `LOG_ALERT' and `LOG_WARNING' will be written to stdout
218 if this option is given. It is disabled in daemon mode.
221 .SH ENVIRONMENT FOR PIPES AND MDAS
223 For security reasons, before any pipe command from an alias expansion or an mda is called,
224 the environment variables will be completely discarded and newly set up. These are:
226 SENDER, RETURN_PATH \(en the return path.
228 SENDER_DOMAIN \(en the domain part of the return path.
230 SENDER_LOCAL \(en the local part of the return path.
232 RECEIVED_HOST \(en the host the message was received from (unless local).
234 LOCAL_PART, USER, LOGNAME \(en the local part of the (original) recipient.
236 MESSAGE_ID \(en the unique message id.
237 This is not necessarily identical with the Message ID as given in the Message ID: header.
239 QUALIFY_DOMAIN \(en the domain which will be appended to unqualified addresses.
242 .SH FILES
244 \fI/etc/masqmail/masqmail.conf\fR is the main configuration for masqmail.
245 Depending on the settings in this file, you will also have other configuration
246 files in \fI/etc/masqmail/\fR.
248 \fI/var/spool/masqmail/\fR is the spool directory where masqmail stores
249 its spooled messages.
251 \fI/var/spool/mail/\fR is the directory where locally delivered mail will be put,
252 if not configured differently in \fImasqmail.conf\fR.
254 \fI/var/log/masqmail/\fR is the directory where masqmail stores its log mesages.
255 This can also be somewhere else if configured differently by your sysadmin or the package mantainer.
258 .SH CONFORMING TO
260 RFC 821, 822, 1869, 1870, 2197, 2554 (SMTP)
262 RFC 1321 (MD5)
264 RFC 2195 (CRAM-MD5)
267 .SH AUTHOR
269 Masqmail was written by Oliver Kurth.
270 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
272 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
273 There is also a mailing list, you will find information about it at masqmail's main site.
276 .SH BUGS
278 Please report them to the mailing list.
281 .SH SEE ALSO
283 \fBmasqmail.conf(5)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.aliases(5)\fR