masqmail
view man/masqmail.8 @ 227:cab46cefa4ce
renamed contrib/ to admin/
because the contents are for system admins
and possibly for advanced users too
| author | meillo@marmaro.de |
|---|---|
| date | Fri, 23 Jul 2010 11:49:44 +0200 |
| parents | dbe3dadd1afe |
| children | 9397d10fd771 |
line source
1 .TH masqmail 8 2010-07-06 masqmail-0.2.25 "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 There are also two additional options, which are unique to masqmail
35 (\fB\-qo \fIconnection\fR and \fB\-g\fR)
37 .TP
38 \fB\-\-\fR
40 Not a `real' option, it means that all following arguments are to be understood
41 as arguments and not as options even if they begin with a leading dash `\-'.
42 Mutt is known to call sendmail with this option.
44 .TP
45 \fB\-bd\fR
47 Run as daemon, accepting connections, usually on port 25 if not configured differently.
48 This is usually used in the startup script at system boot and together with
49 the \fB\-q\fR option (see below).
51 .TP
52 \fB\-bi\fR
54 Old sendmail rebuilds its alias database when invoked with this option.
55 Masqmail ignores it.
56 Masqmail reads directly from the file given with `alias_file' in the config file.
58 .TP
59 \fB\-bp\fR
61 Show the messages in the queue. Same as calling masqmail as `mailq'.
63 .TP
64 \fB\-bs\fR
66 Accept SMTP commands from stdin.
67 Some mailers (e.g. pine) use this option as an interface.
68 It can also be used to call masqmail from inetd.
70 .TP
71 \fB\-B \fIarg\fR
73 \fIarg\fR is usually 8BITMIME.
74 Some mailers use this to indicate that the message contains characters > 127.
75 Masqmail is 8-bit clean and ignores this, so you do not have to recompile elm,
76 which is very painful ;-).
77 Note though that this violates some conventions:
78 masqmail does not convert 8 bit messages to any MIME format if it encounters
79 a mail server which does not advertise its 8BITMIME capability,
80 masqmail does not advertise this itself.
81 This is the same practice as that of exim (but different to sendmail).
83 .TP
84 \fB\-bV \fR
86 Show version information.
88 .TP
89 \fB\-C \fIfilename\fR
91 Use another configuration than \fI/etc/masqmail/masqmail.conf\fR.
92 Useful for debugging purposes.
93 If not invoked by a privileged user, masqmail will drop all privileges.
95 .TP
96 \fB\-d \fInumber\fR
98 Set the debug level.
99 This takes precedence before the value of `debug_level' in the configuration file.
100 Read the warning in the description of the latter.
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.
118 .TP
119 \fB\-Mrm \fIlist\fR
121 Remove given messages from the queue.
122 Only allowed for privileged users.
123 The identifiers of messages are listed in the output of
124 \fImasqmail \-bp\fP (\fImailq\fR).
126 .TP
127 \fB\-oem\fR
129 If the \fB\-oi\fR ist not also given, always return with a non zero return code.
130 Maybe someone tells me what this is good for...
132 .TP
133 \fB\-odb\fR
135 Deliver in background.
136 Masqmail always does this, which makes this option pretty much useless.
138 .TP
139 \fB\-odq\fR
141 Do not attempt to deliver immediately.
142 Any messages will be queued until the next queue running process picks them up and delivers them.
143 You get the same effect by setting the do_queue option in /etc/masqmail/masqmail.conf.
145 .TP
146 \fB\-oi\fR
148 A dot as a single character in a line does not terminate the message.
150 .TP
151 \fB\-q [\fIinterval\fB]\fR
153 If not given with an argument, run a queue process, i.e. try to deliver all messages in the queue.
154 Masqmail sends only to those addresses that are on the local net, not to those that are outside.
155 Use \fB\-qo\fR for those.
157 If you have configured inetd to start masqmail,
158 you can use this option in a cron job which starts in regular time intervals,
159 to mimic the same effect as starting masqmail with \fB\-bd \-q30m\fR.
161 An argument may be a time interval i.e. a numerical value followed by one of the letters.
162 s,m,h,d,w which are interpreted as seconds, minutes, hours, days or weeks respectively.
163 Example: \fB\-q30m\fR.
164 Masqmail starts as a daemon and a queue runner process will be started automatically
165 once in this time interval.
166 This is usually used together with \fB\-bd\fR (see above).
168 .TP
169 \fB\-qo [\fIname\fB]\fR
171 Can be followed by a connection name.
172 Use this option in your script which starts as soon as a link to the internet
173 has been set up (usually ip-up).
174 When masqmail is called with this option, the specified route configuration
175 is read and the queued mail with destinations on the internet will be sent.
176 The \fIname\fR is defined in the configuration (see \fBonline_routes.\fIname\fR).
178 If called without \fIname\fR the online status is determined with the configured
179 method (see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR)
181 .TP
182 \fB\-t\fR
184 Read recipients from headers.
185 Delete `Bcc:' headers.
186 (Since 0.2.25, masqmail deletes Bcc: headers in all cases.)
187 If any arguments are given, these are interpreted as recipient addresses
188 and the message will not be sent to these,
189 although they might appear in To:, Cc:, or Bcc: headers.
190 I.e. the set of argument recipients is ``substracted'' from the set of header recipients.
192 This behavior is similar to exim's and smail's.
193 Postfix, in contrast, adds the arguments to the set of header recipients.
194 Sendmail seems to behave differently, depending on the version.
195 See exim(8) for further information.
197 .TP
198 \fB\-v\fR
200 Log also to stdout.
201 Currently, some log messages are marked as `write to stdout' and additionally,
202 all messages with priority `LOG_ALERT' and `LOG_WARNING' will be written to stdout
203 if this option is given. It is disabled in daemon mode.
206 .SH ENVIRONMENT FOR PIPES AND MDAS
208 For security reasons, before any pipe command from an alias expansion or an mda is called,
209 the environment variables will be completely discarded and newly set up. These are:
211 SENDER, RETURN_PATH \(en the return path.
213 SENDER_DOMAIN \(en the domain part of the return path.
215 SENDER_LOCAL \(en the local part of the return path.
217 RECEIVED_HOST \(en the host the message was received from (unless local).
219 LOCAL_PART, USER, LOGNAME \(en the local part of the (original) recipient.
221 MESSAGE_ID \(en the unique message id.
222 This is not necessarily identical with the Message ID as given in the Message ID: header.
224 QUALIFY_DOMAIN \(en the domain which will be appended to unqualified addresses.
227 .SH FILES
229 \fI/etc/masqmail/masqmail.conf\fR is the main configuration for masqmail.
230 Depending on the settings in this file, you will also have other configuration
231 files in \fI/etc/masqmail/\fR.
233 \fI/var/spool/masqmail/\fR is the spool directory where masqmail stores
234 its spooled messages.
236 \fI/var/spool/mail/\fR is the directory where locally delivered mail will be put,
237 if not configured differently in \fImasqmail.conf\fR.
239 \fI/var/log/masqmail/\fR is the directory where masqmail stores its log mesages.
240 This can also be somewhere else if configured differently by your sysadmin or the package mantainer.
243 .SH CONFORMING TO
245 RFC 821, 822, 1869, 1870, 2197, 2554 (SMTP)
247 RFC 1321 (MD5)
249 RFC 2195 (CRAM-MD5)
252 .SH AUTHOR
254 Masqmail was written by Oliver Kurth.
255 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
257 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
258 There is also a mailing list, you will find information about it at masqmail's main site.
261 .SH BUGS
263 Please report them to the mailing list.
266 .SH SEE ALSO
268 \fBmasqmail.conf(5)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.aliases(5)\fR