| rev |
line source |
|
meillo@228
|
1 .TH masqmail 8 2010-07-23 masqmail-0.3.0 "Maintenance Commands"
|
|
meillo@34
|
2
|
|
meillo@0
|
3 .SH NAME
|
|
meillo@0
|
4 masqmail \- An offline Mail Transfer Agent
|
|
meillo@34
|
5
|
|
meillo@0
|
6 .SH SYNOPSIS
|
|
meillo@34
|
7 \fB/usr/sbin/masqmail \fR[\fB\-C \fIfile\fR] [\fB\-odq\fR] [\fB\-bd\fR] [\fB\-q\fIinterval\fR]
|
|
meillo@0
|
8
|
|
meillo@34
|
9 \fB/usr/sbin/masqmail \fR[\fB\-odq\fR] [\fB\-bs\fR]
|
|
meillo@0
|
10
|
|
meillo@34
|
11 \fB/usr/sbin/masqmail \fR[\fB\-bp\fR]
|
|
meillo@0
|
12
|
|
meillo@34
|
13 \fB/usr/sbin/masqmail \fR[\fB\-q\fR]
|
|
meillo@0
|
14
|
|
meillo@34
|
15 \fB/usr/sbin/masqmail \fR[\fB\-qo \fR[\fIname\fR]]
|
|
meillo@0
|
16
|
|
meillo@34
|
17 \fB/usr/sbin/masqmail \fR[\fB\-t\fR] [\fB\-oi\fR] [\fB\-f \fIaddress\fR] [\fB\-\-\fR] \fIaddress...
|
|
meillo@0
|
18
|
|
meillo@34
|
19 \fB/usr/sbin/mailq\fR
|
|
meillo@0
|
20
|
|
meillo@34
|
21
|
|
meillo@0
|
22 .SH DESCRIPTION
|
|
meillo@0
|
23
|
|
meillo@34
|
24 Masqmail is a mail server designed for hosts that do not have a permanent internet connection
|
|
meillo@34
|
25 e.g. a home network or a single host at home.
|
|
meillo@34
|
26 It has special support for connections to different ISPs.
|
|
meillo@34
|
27 It replaces sendmail or other MTAs such as qmail or exim.
|
|
meillo@34
|
28
|
|
meillo@0
|
29
|
|
meillo@0
|
30 .SH OPTIONS
|
|
meillo@0
|
31
|
|
meillo@34
|
32 Since masqmail is intended to replace sendmail, it uses the same command line options,
|
|
meillo@34
|
33 but not all are implemented.
|
|
meillo@252
|
34 The \fB\-qo\fP option is additional, and unique to masqmail.
|
|
meillo@34
|
35
|
|
meillo@259
|
36 When no mode had been specified by either a command line option
|
|
meillo@259
|
37 (e.g. \fB\-bd\fP, \fB\-bs\fP) or by calling masqmail under a special name
|
|
meillo@259
|
38 (e.g. ``mailq''), then the default mode is used.
|
|
meillo@259
|
39 This is accepting messages on stdin if any address arguments are given,
|
|
meillo@259
|
40 and only printing its version (\fB\-bV\fP) otherwise.
|
|
meillo@259
|
41
|
|
meillo@0
|
42 .TP
|
|
meillo@34
|
43 \fB\-\-\fR
|
|
meillo@0
|
44
|
|
meillo@34
|
45 Not a `real' option, it means that all following arguments are to be understood
|
|
meillo@34
|
46 as arguments and not as options even if they begin with a leading dash `\-'.
|
|
meillo@34
|
47 Mutt is known to call sendmail with this option.
|
|
meillo@0
|
48
|
|
meillo@0
|
49 .TP
|
|
meillo@34
|
50 \fB\-bd\fR
|
|
meillo@0
|
51
|
|
meillo@34
|
52 Run as daemon, accepting connections, usually on port 25 if not configured differently.
|
|
meillo@34
|
53 This is usually used in the startup script at system boot and together with
|
|
meillo@34
|
54 the \fB\-q\fR option (see below).
|
|
meillo@0
|
55
|
|
meillo@0
|
56 .TP
|
|
meillo@34
|
57 \fB\-bi\fR
|
|
meillo@0
|
58
|
|
meillo@34
|
59 Old sendmail rebuilds its alias database when invoked with this option.
|
|
meillo@34
|
60 Masqmail ignores it.
|
|
meillo@34
|
61 Masqmail reads directly from the file given with `alias_file' in the config file.
|
|
meillo@0
|
62
|
|
meillo@0
|
63 .TP
|
|
meillo@34
|
64 \fB\-bp\fR
|
|
meillo@0
|
65
|
|
meillo@34
|
66 Show the messages in the queue. Same as calling masqmail as `mailq'.
|
|
meillo@0
|
67
|
|
meillo@0
|
68 .TP
|
|
meillo@34
|
69 \fB\-bs\fR
|
|
meillo@0
|
70
|
|
meillo@34
|
71 Accept SMTP commands from stdin.
|
|
meillo@34
|
72 Some mailers (e.g. pine) use this option as an interface.
|
|
meillo@34
|
73 It can also be used to call masqmail from inetd.
|
|
meillo@0
|
74
|
|
meillo@0
|
75 .TP
|
|
meillo@34
|
76 \fB\-B \fIarg\fR
|
|
meillo@0
|
77
|
|
meillo@34
|
78 \fIarg\fR is usually 8BITMIME.
|
|
meillo@34
|
79 Some mailers use this to indicate that the message contains characters > 127.
|
|
meillo@34
|
80 Masqmail is 8-bit clean and ignores this, so you do not have to recompile elm,
|
|
meillo@34
|
81 which is very painful ;-).
|
|
meillo@34
|
82 Note though that this violates some conventions:
|
|
meillo@34
|
83 masqmail does not convert 8 bit messages to any MIME format if it encounters
|
|
meillo@34
|
84 a mail server which does not advertise its 8BITMIME capability,
|
|
meillo@34
|
85 masqmail does not advertise this itself.
|
|
meillo@34
|
86 This is the same practice as that of exim (but different to sendmail).
|
|
meillo@0
|
87
|
|
meillo@0
|
88 .TP
|
|
meillo@34
|
89 \fB\-bV \fR
|
|
meillo@0
|
90
|
|
meillo@0
|
91 Show version information.
|
|
meillo@34
|
92
|
|
meillo@0
|
93 .TP
|
|
meillo@34
|
94 \fB\-C \fIfilename\fR
|
|
meillo@0
|
95
|
|
meillo@34
|
96 Use another configuration than \fI/etc/masqmail/masqmail.conf\fR.
|
|
meillo@34
|
97 Useful for debugging purposes.
|
|
meillo@34
|
98 If not invoked by a privileged user, masqmail will drop all privileges.
|
|
meillo@0
|
99
|
|
meillo@0
|
100 .TP
|
|
meillo@34
|
101 \fB\-d \fInumber\fR
|
|
meillo@0
|
102
|
|
meillo@34
|
103 Set the debug level.
|
|
meillo@34
|
104 This takes precedence before the value of `debug_level' in the configuration file.
|
|
meillo@34
|
105 Read the warning in the description of the latter.
|
|
meillo@252
|
106 Only root may set the debug level.
|
|
meillo@0
|
107
|
|
meillo@0
|
108 .TP
|
|
meillo@34
|
109 \fB\-f [\fIaddress\fB]\fR
|
|
meillo@0
|
110
|
|
meillo@34
|
111 Set the return path address to \fIaddress\fR.
|
|
meillo@34
|
112 Only root, the user mail and anyone in group mail is allowed to do that.
|
|
meillo@0
|
113
|
|
meillo@0
|
114 .TP
|
|
meillo@34
|
115 \fB\-F [\fIstring\fB]\fR
|
|
meillo@0
|
116
|
|
meillo@34
|
117 Set the full sender name (in the From: header) to \fIstring\fR.
|
|
meillo@0
|
118
|
|
meillo@0
|
119 .TP
|
|
meillo@34
|
120 \fB\-i\fR
|
|
meillo@0
|
121
|
|
meillo@34
|
122 Same as \fB\-oi\fR, see below.
|
|
meillo@252
|
123 Kept for compatibility.
|
|
meillo@0
|
124
|
|
meillo@0
|
125 .TP
|
|
meillo@252
|
126 \fB\-Mrm \fImsgid...\fR
|
|
meillo@0
|
127
|
|
meillo@34
|
128 Remove given messages from the queue.
|
|
meillo@252
|
129 Privileged users may remove any message,
|
|
meillo@252
|
130 other users only their own.
|
|
meillo@252
|
131 The message identifiers are listed in the output of
|
|
meillo@252
|
132 \fImasqmail \-bp\fP (aka. \fImailq\fR).
|
|
meillo@0
|
133
|
|
meillo@0
|
134 .TP
|
|
meillo@247
|
135 \fB\-m\fR
|
|
meillo@247
|
136
|
|
meillo@258
|
137 ``Me too''
|
|
meillo@258
|
138 This switch is ignored as,
|
|
meillo@258
|
139 masqmail never excludes the sender from any alias expansions.
|
|
meillo@258
|
140
|
|
meillo@258
|
141 \fB\-m\fP is an ancient alias for \fB\-om\fP.
|
|
meillo@252
|
142 Kept for compatibility.
|
|
meillo@247
|
143
|
|
meillo@247
|
144 .TP
|
|
meillo@34
|
145 \fB\-odb\fR
|
|
meillo@0
|
146
|
|
meillo@252
|
147 ``Deliver in Background''
|
|
meillo@252
|
148 Masqmail always does this.
|
|
meillo@252
|
149 Hence masqmail ignores this switch.
|
|
meillo@0
|
150
|
|
meillo@0
|
151 .TP
|
|
meillo@34
|
152 \fB\-odq\fR
|
|
meillo@0
|
153
|
|
meillo@252
|
154 ``Do Queueing''
|
|
meillo@34
|
155 Do not attempt to deliver immediately.
|
|
meillo@34
|
156 Any messages will be queued until the next queue running process picks them up and delivers them.
|
|
meillo@34
|
157 You get the same effect by setting the do_queue option in /etc/masqmail/masqmail.conf.
|
|
meillo@0
|
158
|
|
meillo@0
|
159 .TP
|
|
meillo@34
|
160 \fB\-oi\fR
|
|
meillo@0
|
161
|
|
meillo@0
|
162 A dot as a single character in a line does not terminate the message.
|
|
meillo@34
|
163
|
|
meillo@258
|
164 The same as \fB\-i\fP.
|
|
meillo@247
|
165
|
|
meillo@252
|
166 .TP
|
|
meillo@252
|
167 \fB\-oXXX\fR
|
|
meillo@252
|
168
|
|
meillo@258
|
169 Any other switch starting with `\-o' is ignored.
|
|
meillo@258
|
170 This especially affects \-om, \-oem, \-oee.
|
|
meillo@247
|
171
|
|
meillo@247
|
172 .TP
|
|
meillo@34
|
173 \fB\-q [\fIinterval\fB]\fR
|
|
meillo@0
|
174
|
|
meillo@34
|
175 If not given with an argument, run a queue process, i.e. try to deliver all messages in the queue.
|
|
meillo@34
|
176 Masqmail sends only to those addresses that are on the local net, not to those that are outside.
|
|
meillo@34
|
177 Use \fB\-qo\fR for those.
|
|
meillo@0
|
178
|
|
meillo@34
|
179 If you have configured inetd to start masqmail,
|
|
meillo@34
|
180 you can use this option in a cron job which starts in regular time intervals,
|
|
meillo@34
|
181 to mimic the same effect as starting masqmail with \fB\-bd \-q30m\fR.
|
|
meillo@0
|
182
|
|
meillo@34
|
183 An argument may be a time interval i.e. a numerical value followed by one of the letters.
|
|
meillo@34
|
184 s,m,h,d,w which are interpreted as seconds, minutes, hours, days or weeks respectively.
|
|
meillo@34
|
185 Example: \fB\-q30m\fR.
|
|
meillo@34
|
186 Masqmail starts as a daemon and a queue runner process will be started automatically
|
|
meillo@34
|
187 once in this time interval.
|
|
meillo@34
|
188 This is usually used together with \fB\-bd\fR (see above).
|
|
meillo@0
|
189
|
|
meillo@0
|
190 .TP
|
|
meillo@34
|
191 \fB\-qo [\fIname\fB]\fR
|
|
meillo@0
|
192
|
|
meillo@34
|
193 Can be followed by a connection name.
|
|
meillo@34
|
194 Use this option in your script which starts as soon as a link to the internet
|
|
meillo@34
|
195 has been set up (usually ip-up).
|
|
meillo@34
|
196 When masqmail is called with this option, the specified route configuration
|
|
meillo@34
|
197 is read and the queued mail with destinations on the internet will be sent.
|
|
meillo@34
|
198 The \fIname\fR is defined in the configuration (see \fBonline_routes.\fIname\fR).
|
|
meillo@0
|
199
|
|
meillo@34
|
200 If called without \fIname\fR the online status is determined with the configured
|
|
meillo@34
|
201 method (see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR)
|
|
meillo@0
|
202
|
|
meillo@0
|
203 .TP
|
|
meillo@34
|
204 \fB\-t\fR
|
|
meillo@0
|
205
|
|
meillo@276
|
206 Read recipients from mail headers and add them to the ones specified on the
|
|
meillo@276
|
207 command line.
|
|
meillo@276
|
208 (Only To:, Cc:, and Bcc: headers are regarded.)
|
|
meillo@103
|
209
|
|
meillo@276
|
210 .B WARNING: The behavior changed with version 0.3.1!
|
|
meillo@276
|
211
|
|
meillo@276
|
212 In earlier versions command line argument addresses were ``substracted''
|
|
meillo@276
|
213 from header addresses.
|
|
meillo@276
|
214
|
|
meillo@276
|
215 The old behavior was similar to exim's and smail's
|
|
meillo@276
|
216 (which are anchesters of masqmail).
|
|
meillo@276
|
217 The new behavior is similar to the one of current postfix versions,
|
|
meillo@276
|
218 which add the arguments to the set of header recipients.
|
|
meillo@276
|
219 (Earlier postfix failed in case of address arguments with \-t.)
|
|
meillo@103
|
220 Sendmail seems to behave differently, depending on the version.
|
|
meillo@103
|
221 See exim(8) for further information.
|
|
meillo@0
|
222
|
|
meillo@276
|
223 For masqmail the most simple approach had been taken.
|
|
meillo@276
|
224
|
|
meillo@276
|
225 As the behavior of \-t together with command line address arguments
|
|
meillo@276
|
226 differs among MTAs, one better not steps into this corner case.
|
|
meillo@276
|
227
|
|
meillo@0
|
228 .TP
|
|
meillo@34
|
229 \fB\-v\fR
|
|
meillo@0
|
230
|
|
meillo@252
|
231 ``Verbose''
|
|
meillo@34
|
232 Log also to stdout.
|
|
meillo@34
|
233 Currently, some log messages are marked as `write to stdout' and additionally,
|
|
meillo@34
|
234 all messages with priority `LOG_ALERT' and `LOG_WARNING' will be written to stdout
|
|
meillo@34
|
235 if this option is given. It is disabled in daemon mode.
|
|
meillo@0
|
236
|
|
meillo@34
|
237
|
|
meillo@0
|
238 .SH ENVIRONMENT FOR PIPES AND MDAS
|
|
meillo@0
|
239
|
|
meillo@34
|
240 For security reasons, before any pipe command from an alias expansion or an mda is called,
|
|
meillo@34
|
241 the environment variables will be completely discarded and newly set up. These are:
|
|
meillo@0
|
242
|
|
meillo@34
|
243 SENDER, RETURN_PATH \(en the return path.
|
|
meillo@0
|
244
|
|
meillo@34
|
245 SENDER_DOMAIN \(en the domain part of the return path.
|
|
meillo@0
|
246
|
|
meillo@34
|
247 SENDER_LOCAL \(en the local part of the return path.
|
|
meillo@0
|
248
|
|
meillo@34
|
249 RECEIVED_HOST \(en the host the message was received from (unless local).
|
|
meillo@0
|
250
|
|
meillo@34
|
251 LOCAL_PART, USER, LOGNAME \(en the local part of the (original) recipient.
|
|
meillo@0
|
252
|
|
meillo@34
|
253 MESSAGE_ID \(en the unique message id.
|
|
meillo@34
|
254 This is not necessarily identical with the Message ID as given in the Message ID: header.
|
|
meillo@0
|
255
|
|
meillo@34
|
256 QUALIFY_DOMAIN \(en the domain which will be appended to unqualified addresses.
|
|
meillo@34
|
257
|
|
meillo@0
|
258
|
|
meillo@0
|
259 .SH FILES
|
|
meillo@0
|
260
|
|
meillo@34
|
261 \fI/etc/masqmail/masqmail.conf\fR is the main configuration for masqmail.
|
|
meillo@34
|
262 Depending on the settings in this file, you will also have other configuration
|
|
meillo@34
|
263 files in \fI/etc/masqmail/\fR.
|
|
meillo@0
|
264
|
|
meillo@34
|
265 \fI/var/spool/masqmail/\fR is the spool directory where masqmail stores
|
|
meillo@192
|
266 its spooled messages.
|
|
meillo@0
|
267
|
|
meillo@34
|
268 \fI/var/spool/mail/\fR is the directory where locally delivered mail will be put,
|
|
meillo@34
|
269 if not configured differently in \fImasqmail.conf\fR.
|
|
meillo@0
|
270
|
|
meillo@34
|
271 \fI/var/log/masqmail/\fR is the directory where masqmail stores its log mesages.
|
|
meillo@34
|
272 This can also be somewhere else if configured differently by your sysadmin or the package mantainer.
|
|
meillo@34
|
273
|
|
meillo@0
|
274
|
|
meillo@0
|
275 .SH CONFORMING TO
|
|
meillo@0
|
276
|
|
meillo@0
|
277 RFC 821, 822, 1869, 1870, 2197, 2554 (SMTP)
|
|
meillo@0
|
278
|
|
meillo@0
|
279 RFC 1321 (MD5)
|
|
meillo@0
|
280
|
|
meillo@0
|
281 RFC 2195 (CRAM-MD5)
|
|
meillo@0
|
282
|
|
meillo@34
|
283
|
|
meillo@0
|
284 .SH AUTHOR
|
|
meillo@0
|
285
|
|
meillo@34
|
286 Masqmail was written by Oliver Kurth.
|
|
meillo@34
|
287 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
|
|
meillo@0
|
288
|
|
meillo@95
|
289 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
|
|
meillo@26
|
290 There is also a mailing list, you will find information about it at masqmail's main site.
|
|
meillo@0
|
291
|
|
meillo@34
|
292
|
|
meillo@0
|
293 .SH BUGS
|
|
meillo@0
|
294
|
|
meillo@34
|
295 Please report them to the mailing list.
|
|
meillo@34
|
296
|
|
meillo@0
|
297
|
|
meillo@0
|
298 .SH SEE ALSO
|
|
meillo@0
|
299
|
|
meillo@192
|
300 \fBmasqmail.conf(5)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.aliases(5)\fR
|
