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