Mercurial > masqmail

comparison man/masqmail.8 @ 285:bdcc2b42eb0f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Heavily reworked man/masqmail.8 I hope the new version is clearer.
author markus schnalke <meillo@marmaro.de>
date Tue, 07 Dec 2010 17:10:07 -0300
parents 853b85616c98
children e2f6eefbd573
comparison
equal deleted inserted replaced
284:4869321aa7bf 285:bdcc2b42eb0f
2 2
3 .SH NAME 3 .SH NAME
4 masqmail \- An offline Mail Transfer Agent 4 masqmail \- An offline Mail Transfer Agent
5 5
6 .SH SYNOPSIS 6 .SH SYNOPSIS
7 \fB/usr/sbin/masqmail \fR[\fB\-C \fIfile\fR] [\fB\-odq\fR] [\fB\-bd\fR] [\fB\-q\fIinterval\fR] 7
8 8 .BR masqmail\ [ \-t ] \ [ \-oi ] \ [ \-f\ \fIADDRESS ] \ \fIRECIPIENT...
9 \fB/usr/sbin/masqmail \fR[\fB\-odq\fR] [\fB\-bs\fR] 9
10 10 .B mailq
11 \fB/usr/sbin/masqmail \fR[\fB\-bp\fR] 11 .br
12 12 .B masqmail \-bp
13 \fB/usr/sbin/masqmail \fR[\fB\-q\fR] 13
14 14 .B runq
15 \fB/usr/sbin/masqmail \fR[\fB\-qo \fR[\fIname\fR]] 15 .br
16 16 .B masqmail \-q
17 \fB/usr/sbin/masqmail \fR[\fB\-t\fR] [\fB\-oi\fR] [\fB\-f \fIaddress\fR] [\fB\-\-\fR] \fIaddress... 17
18 18 .BR masqmail\ \-qo\ [ \fINAME ]
19 \fB/usr/sbin/mailq\fR 19
20 .BI mailrm\ MSGID...
21 .br
22 .BI masqmail\ -Mrm\ MSGID...
23
24 .BR masqmail\ [ \-C\ \fIFILE ] \ [ \-odq ]\ \-bs
25
26 .BR masqmail\ [ \-C\ \fIFILE ] \ [ \-odq ]\ \-bd\ \-q\fIINTERVAL
27
28 (This list is a selection.)
20 29
21 30
22 .SH DESCRIPTION 31 .SH DESCRIPTION
23 32
24 Masqmail is a mail server designed for hosts that do not have a permanent internet connection 33 Masqmail is a mail server designed for hosts that do not have a permanent internet connection
30 .SH OPERATION MODES 39 .SH OPERATION MODES
31 40
32 Masqmail operates in one of several exclusive modes. 41 Masqmail operates in one of several exclusive modes.
33 42
34 The daemon mode has two flavors that may be, 43 The daemon mode has two flavors that may be,
35 and usually are, combined: 44 and usually are, used in combination:
36 .TP 45 .TP
46 .B Daemon (listen)
37 .B \-bd 47 .B \-bd
38 listen daemon; listens for incoming SMTP connections. 48 or invoked as
39 .TP 49 .B smtpd
40 .B \-q\fRINTERVAL 50
41 queue daemon; processes the queue in a regular interval. 51 Run as daemon.
52 Act as SMTP server and accept SMTP connections,
53 on port 25 if not configured differently.
54
55 This is normally used in the startup script at system boot
56 and together with \fB\-q\fIINTERVAL\fR (see below).
57
58 Alternatively masqmail can be run with the \fB\-bs\fR option
59 from inetd.
60
61 .TP
62 .B Daemon (queue)
63 .B \-q\fIINTERVAL
64
65 Run as daemon.
66 Do regular queue runs at the specified time interval.
67 This is normally used together with \fB\-bd\fR (see above).
68
69 An argument may be a time interval i.e. a numerical value followed by one
70 of the letters s,m,h,d,w which are interpreted as
71 seconds, minutes, hours, days or weeks respectively.
72 Example: \fB\-q30m\fR.
73 Combinations like \fB\-q1h30m\fR, which sendmail accepts, are not possible.
74
75 Alternatively single queue runs (\fB\-q\fR) can be started from cron.
42 76
43 .P 77 .P
44 The queue processing mode has two flavors that may be combined: 78 The queue processing mode has two flavors that may be
45 .TP 79 used in combination:
46 .BR \-q 80
81 .TP
82 .B Single queue run (normal)
83 .B \-q
47 (without argument) 84 (without argument)
48 do a single queue run. 85 or invoked as
49 .TP 86 .B runq
87
88 Do a single queue run.
89 Try to deliver all messages in the queue.
90 Masqmail sends to addresses on the local host, on the local net,
91 and if it detects an online connection to remote ones too.
92 That means, masqmail sends all queued mail it can.
93 .B \-q
94 includes
50 .B \-qo 95 .B \-qo
51 do a single queue run and deliver only using a specific online route. 96 (without argument).
97
98 .TP
99 .B Single queue run (online)
100 .B \-qo \fR[\fB\fINAME\fR]
101
102 Do a single queue run and deliver only using one specific online route.
103
104 If a connection name is given, then this one will be used.
105
106 If no connection name is given, it will be determined with the configured
107 method (see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR) and,
108 if none is available no mail will be delivered.
109
110 The specified route configuration is read and queued mail to matching
111 remote recipients will be sent.
112 The \fINAME\fR is defined in the configuration
113 (see \fBonline_routes.\fINAME\fR).
114
115 You may want to use this option in scripts that run as soon as a link
116 to the internet has been set up (e.g. ip-up).
52 117
53 .P 118 .P
54 The other modes are simple ones: 119 The other modes are simple ones:
55 .TP 120
121 .TP
122 .B Rebuild alias database
56 .B \-bi 123 .B \-bi
57 a no-op for masqmail, just exit. 124 or invoked as
58 .TP 125 .B newaliases
59 .B \-bm 126
60 accept messages on stdin. (The default) 127 A no-op for masqmail, just exit.
61 .TP 128 Old sendmail rebuilds its alias database when invoked with this option.
129 Masqmail reads directly from its alias file
130 (see config option `alias_file'),
131 thus no database needs to be updated.
132
133 .TP
134 .B Accept messages
135 .BR \-bm ,
136 also the default mode
137
138 Accept a text message on stdin.
139 This is the default mode of operation.
140 One will hardly use this switch as it is the default.
141
142 The command line options
143 .BR \-f , \-F , \-i / \-oi , \-t
144 are only used in this mode.
145
146 .TP
147 .B Print queue
62 .B \-bp 148 .B \-bp
63 print the contents of the queue. 149 or invoked as
64 .TP 150 .B mailq
151
152 Show the messages in the queue.
153
154 .TP
155 .B Stand-alone SMTP server
65 .B \-bs 156 .B \-bs
66 accept messages by speaking SMTP on stdin. 157
67 .TP 158 Act as SMTP server by reading commands from stdin
159 and writing to stdout.
160 Some mailers (e.g. pine) use this option as an interface.
161 It can also be used to call masqmail from inetd.
162
163 .TP
164 .B Print version
68 .B \-bV 165 .B \-bV
69 print version information. 166 or if called without arguments
70 .TP 167
168 Print version information, then exit.
169
170 .TP
171 .B Queue manipulation mode
71 .B \-Mrm 172 .B \-Mrm
72 remove messages from the queue. 173 or invoked as
174 .B mailrm
175
176 Remove given messages from the queue.
177 Privileged users may remove any message, other users only their own.
178 The message identifiers are listed when printing the queue
179 (see \fB\-bp\fR).
180
73 .P 181 .P
74 Some of the modes are also available by calling masqmail 182 The default mode:
75 under a special name. 183 .P
76
77 When no mode had been specified by either one of the above command line 184 When no mode had been specified by either one of the above command line
78 options or by calling masqmail under a special name, 185 options or by calling masqmail under a special name,
79 then the default mode \fB\-bm\fR 186 then the default mode \fB\-bm\fR
80 (i.e. accept messages on stdin) is entered. 187 (i.e. accept messages on stdin) is entered.
81 However, if neither address arguments are specified nor 188 However, if neither address arguments are specified nor
82 \fB\-t\fR is given, then no recipients are available and thus mail can not 189 \fB\-t\fR is given, then mail can not be sent,
83 be sent, hence something more useful is done: \fB\-bV\fP is assumed. 190 hence something more useful is done: \fB\-bV\fP is assumed.
84 191
85 192
86 .SH OPTIONS 193 .SH OPTIONS
87 194
88 Since masqmail is intended to replace sendmail, 195 Since masqmail is intended to replace sendmail,
98 Mutt is known to call sendmail with this option. 205 Mutt is known to call sendmail with this option.
99 206
100 .TP 207 .TP
101 \fB\-bd\fR 208 \fB\-bd\fR
102 209
103 Run as daemon, accepting connections, 210 ``Daemon (listen)'' mode. See above.
104 usually on port 25 if not configured differently.
105 This is usually used in the startup script at system boot and together with
106 the \fB\-q\fR option (see below).
107 211
108 .TP 212 .TP
109 \fB\-bi\fR 213 \fB\-bi\fR
110 214
111 Old sendmail rebuilds its alias database when invoked with this option. 215 ``Rebuild alias database'' mode. See above.
112 Masqmail reads directly from the file given with `alias_file' in the config file.
113 Hence masqmail simply exits in this mode.
114 216
115 .TP 217 .TP
116 .B \-bm 218 .B \-bm
117 219
118 Accept a text message on stdin. 220 ``Accept message'' mode. See above.
119 This is the default mode of operation.
120 One will hardly use this switch as it is the default.
121 221
122 .TP 222 .TP
123 \fB\-bp\fR 223 \fB\-bp\fR
124 224
125 Show the messages in the queue. 225 ``Print queue'' mode. See above.
126 Same as calling masqmail as `mailq'.
127 226
128 .TP 227 .TP
129 \fB\-bs\fR 228 \fB\-bs\fR
130 229
131 Accept SMTP commands from stdin. 230 ``Stand-alone SMTP server'' mode. See above.
132 Some mailers (e.g. pine) use this option as an interface.
133 It can also be used to call masqmail from inetd.
134 231
135 .TP 232 .TP
136 \fB\-bV \fR 233 \fB\-bV \fR
137 234
138 Show version information, then exit. 235 ``Print version'' mode. See above.
139 236
140 .TP 237 .TP
141 \fB\-B \fIarg\fR 238 \fB\-B \fIarg\fR
142 239
143 \fIarg\fR is usually 8BITMIME. 240 \fIarg\fR is usually 8BITMIME.
183 Kept for compatibility. 280 Kept for compatibility.
184 281
185 .TP 282 .TP
186 \fB\-Mrm \fImsgid...\fR 283 \fB\-Mrm \fImsgid...\fR
187 284
188 ``Queue manipulation mode'' 285 ``Queue manipulation'' mode. See above.
189
190 Remove given messages from the queue.
191 Privileged users may remove any message, other users only their own.
192 The message identifiers are listed in the output of
193 \fImasqmail \-bp\fP (aka. \fImailq\fR).
194 286
195 .TP 287 .TP
196 \fB\-m\fR 288 \fB\-m\fR
197 289
198 ``Me too'' 290 ``Me too''
231 323
232 Any other switch starting with `\-o' is ignored. 324 Any other switch starting with `\-o' is ignored.
233 This especially affects \-om, \-oem, \-oee. 325 This especially affects \-om, \-oem, \-oee.
234 326
235 .TP 327 .TP
236 \fB\-q [\fIinterval\fB]\fR 328 \fB\-q
237 329
238 Without argument: 330 ``Single queue run (normal)'' mode. See above.
239 Do a single queue run, i.e. try to deliver all messages in the queue. 331
240 Masqmail sends to addresses on the local host, on the local net, 332 .TP
241 and if it detects an online connection, to remote ones too. 333 \fB\-q\fIINTERVAL
242 That means, that masqmail sends any queued mail it can. 334
243 .B \-q 335 ``Daemon (queue)'' mode. See above.
244 includes
245 .B \-qo
246 (without argument).
247
248 With an argument:
249 Start as a daemon and do a queue run automatically once in the specified
250 time interval.
251 This is usually used together with \fB\-bd\fR (see above).
252
253 An argument may be a time interval i.e. a numerical value followed by one
254 of the letters s,m,h,d,w which are interpreted as
255 seconds, minutes, hours, days or weeks respectively.
256 Example: \fB\-q30m\fR.
257
258 Running masqmail from inetd and starting single queue runs from cron
259 mimics the same effect as starting masqmail with something like
260 \fB\-bd \-q30m\fR.
261 336
262 .TP 337 .TP
263 \fB\-qo [\fIname\fB]\fR 338 \fB\-qo [\fIname\fB]\fR
264 339
265 Online queue runs. 340 ``Single queue run (online)'' mode. See above.
266
267 Without a connection name:
268 Determine the online status with the configured method
269 (see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR)
270 and, if a connection is available, send remote mail over it.
271
272 With a connection name:
273 Send remote mail over the specified connection,
274 no online detection is made.
275
276 The specified route configuration is read and queued mail to remote
277 recipients will be sent.
278 The \fIname\fR is defined in the configuration (see \fBonline_routes.\fIname\fR).
279
280 Use this option in your script which starts as soon as a link to the internet
281 has been set up (usually ip-up).
282 341
283 .TP 342 .TP
284 \fB\-t\fR 343 \fB\-t\fR
285 344
286 Read recipients from mail headers and add them to the ones specified on the 345 Read recipients from mail headers and add them to the ones specified on the