Mercurial > masqmail

comparison man/masqmail.8 @ 283:853b85616c98

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
improved man/masqmail.8 heavily In respect to the modes, -bm, -q, and -qo.
author markus schnalke <meillo@marmaro.de>
date Tue, 07 Dec 2010 14:19:04 -0300
parents 1abc1faeb45d
children bdcc2b42eb0f
comparison
equal deleted inserted replaced
282:ba53e648906f 283:853b85616c98
25 e.g. a home network or a single host at home. 25 e.g. a home network or a single host at home.
26 It has special support for connections to different ISPs. 26 It has special support for connections to different ISPs.
27 It replaces sendmail or other MTAs such as qmail or exim. 27 It replaces sendmail or other MTAs such as qmail or exim.
28 28
29 29
30 .SH OPERATION MODES
31
32 Masqmail operates in one of several exclusive modes.
33
34 The daemon mode has two flavors that may be,
35 and usually are, combined:
36 .TP
37 .B \-bd
38 listen daemon; listens for incoming SMTP connections.
39 .TP
40 .B \-q\fRINTERVAL
41 queue daemon; processes the queue in a regular interval.
42
43 .P
44 The queue processing mode has two flavors that may be combined:
45 .TP
46 .BR \-q
47 (without argument)
48 do a single queue run.
49 .TP
50 .B \-qo
51 do a single queue run and deliver only using a specific online route.
52
53 .P
54 The other modes are simple ones:
55 .TP
56 .B \-bi
57 a no-op for masqmail, just exit.
58 .TP
59 .B \-bm
60 accept messages on stdin. (The default)
61 .TP
62 .B \-bp
63 print the contents of the queue.
64 .TP
65 .B \-bs
66 accept messages by speaking SMTP on stdin.
67 .TP
68 .B \-bV
69 print version information.
70 .TP
71 .B \-Mrm
72 remove messages from the queue.
73 .P
74 Some of the modes are also available by calling masqmail
75 under a special name.
76
77 When no mode had been specified by either one of the above command line
78 options or by calling masqmail under a special name,
79 then the default mode \fB\-bm\fR
80 (i.e. accept messages on stdin) is entered.
81 However, if neither address arguments are specified nor
82 \fB\-t\fR is given, then no recipients are available and thus mail can not
83 be sent, hence something more useful is done: \fB\-bV\fP is assumed.
84
85
30 .SH OPTIONS 86 .SH OPTIONS
31 87
32 Since masqmail is intended to replace sendmail, it uses the same command line options, 88 Since masqmail is intended to replace sendmail,
89 it uses the same command line options,
33 but not all are implemented. 90 but not all are implemented.
34 The \fB\-qo\fP option is additional, and unique to masqmail. 91 The \fB\-qo\fP option is additional, and unique to masqmail.
35
36 When no mode had been specified by either a command line option
37 (e.g. \fB\-bd\fP, \fB\-bs\fP) or by calling masqmail under a special name
38 (e.g. ``mailq''), then the default mode is used.
39 This is accepting messages on stdin if any address arguments are given,
40 and only printing its version (\fB\-bV\fP) otherwise.
41 92
42 .TP 93 .TP
43 \fB\-\-\fR 94 \fB\-\-\fR
44 95
45 Not a `real' option, it means that all following arguments are to be understood 96 Not a `real' option, it means that all following arguments are to be understood
47 Mutt is known to call sendmail with this option. 98 Mutt is known to call sendmail with this option.
48 99
49 .TP 100 .TP
50 \fB\-bd\fR 101 \fB\-bd\fR
51 102
52 Run as daemon, accepting connections, usually on port 25 if not configured differently. 103 Run as daemon, accepting connections,
104 usually on port 25 if not configured differently.
53 This is usually used in the startup script at system boot and together with 105 This is usually used in the startup script at system boot and together with
54 the \fB\-q\fR option (see below). 106 the \fB\-q\fR option (see below).
55 107
56 .TP 108 .TP
57 \fB\-bi\fR 109 \fB\-bi\fR
58 110
59 Old sendmail rebuilds its alias database when invoked with this option. 111 Old sendmail rebuilds its alias database when invoked with this option.
60 Masqmail ignores it.
61 Masqmail reads directly from the file given with `alias_file' in the config file. 112 Masqmail reads directly from the file given with `alias_file' in the config file.
113 Hence masqmail simply exits in this mode.
114
115 .TP
116 .B \-bm
117
118 Accept a text message on stdin.
119 This is the default mode of operation.
120 One will hardly use this switch as it is the default.
62 121
63 .TP 122 .TP
64 \fB\-bp\fR 123 \fB\-bp\fR
65 124
66 Show the messages in the queue. Same as calling masqmail as `mailq'. 125 Show the messages in the queue.
126 Same as calling masqmail as `mailq'.
67 127
68 .TP 128 .TP
69 \fB\-bs\fR 129 \fB\-bs\fR
70 130
71 Accept SMTP commands from stdin. 131 Accept SMTP commands from stdin.
72 Some mailers (e.g. pine) use this option as an interface. 132 Some mailers (e.g. pine) use this option as an interface.
73 It can also be used to call masqmail from inetd. 133 It can also be used to call masqmail from inetd.
134
135 .TP
136 \fB\-bV \fR
137
138 Show version information, then exit.
74 139
75 .TP 140 .TP
76 \fB\-B \fIarg\fR 141 \fB\-B \fIarg\fR
77 142
78 \fIarg\fR is usually 8BITMIME. 143 \fIarg\fR is usually 8BITMIME.
84 a mail server which does not advertise its 8BITMIME capability, 149 a mail server which does not advertise its 8BITMIME capability,
85 masqmail does not advertise this itself. 150 masqmail does not advertise this itself.
86 This is the same practice as that of exim (but different to sendmail). 151 This is the same practice as that of exim (but different to sendmail).
87 152
88 .TP 153 .TP
89 \fB\-bV \fR
90
91 Show version information.
92
93 .TP
94 \fB\-C \fIfilename\fR 154 \fB\-C \fIfilename\fR
95 155
96 Use another configuration than \fI/etc/masqmail/masqmail.conf\fR. 156 Use another configuration than \fI/etc/masqmail/masqmail.conf\fR.
97 Useful for debugging purposes. 157 Useful for debugging purposes.
98 If not invoked by a privileged user, masqmail will drop all privileges. 158 If not invoked by a privileged user, masqmail will drop all privileges.
123 Kept for compatibility. 183 Kept for compatibility.
124 184
125 .TP 185 .TP
126 \fB\-Mrm \fImsgid...\fR 186 \fB\-Mrm \fImsgid...\fR
127 187
188 ``Queue manipulation mode''
189
128 Remove given messages from the queue. 190 Remove given messages from the queue.
129 Privileged users may remove any message, 191 Privileged users may remove any message, other users only their own.
130 other users only their own.
131 The message identifiers are listed in the output of 192 The message identifiers are listed in the output of
132 \fImasqmail \-bp\fP (aka. \fImailq\fR). 193 \fImasqmail \-bp\fP (aka. \fImailq\fR).
133 194
134 .TP 195 .TP
135 \fB\-m\fR 196 \fB\-m\fR
151 .TP 212 .TP
152 \fB\-odq\fR 213 \fB\-odq\fR
153 214
154 ``Do Queueing'' 215 ``Do Queueing''
155 Do not attempt to deliver immediately. 216 Do not attempt to deliver immediately.
156 Any messages will be queued until the next queue running process picks them up and delivers them. 217 Any messages will be queued until the next queue running process picks them
157 You get the same effect by setting the do_queue option in /etc/masqmail/masqmail.conf. 218 up and delivers them.
219 You get the same effect by setting the do_queue option in
220 /etc/masqmail/masqmail.conf.
158 221
159 .TP 222 .TP
160 \fB\-oi\fR 223 \fB\-oi\fR
161 224
162 A dot as a single character in a line does not terminate the message. 225 A dot as a single character in a line does not terminate the message.
170 This especially affects \-om, \-oem, \-oee. 233 This especially affects \-om, \-oem, \-oee.
171 234
172 .TP 235 .TP
173 \fB\-q [\fIinterval\fB]\fR 236 \fB\-q [\fIinterval\fB]\fR
174 237
175 If not given with an argument, run a queue process, i.e. try to deliver all messages in the queue. 238 Without argument:
176 Masqmail sends only to those addresses that are on the local net, not to those that are outside. 239 Do a single queue run, i.e. try to deliver all messages in the queue.
177 Use \fB\-qo\fR for those. 240 Masqmail sends to addresses on the local host, on the local net,
178 241 and if it detects an online connection, to remote ones too.
179 If you have configured inetd to start masqmail, 242 That means, that masqmail sends any queued mail it can.
180 you can use this option in a cron job which starts in regular time intervals, 243 .B \-q
181 to mimic the same effect as starting masqmail with \fB\-bd \-q30m\fR. 244 includes
182 245 .B \-qo
183 An argument may be a time interval i.e. a numerical value followed by one of the letters. 246 (without argument).
184 s,m,h,d,w which are interpreted as seconds, minutes, hours, days or weeks respectively. 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.
185 Example: \fB\-q30m\fR. 256 Example: \fB\-q30m\fR.
186 Masqmail starts as a daemon and a queue runner process will be started automatically 257
187 once in this time interval. 258 Running masqmail from inetd and starting single queue runs from cron
188 This is usually used together with \fB\-bd\fR (see above). 259 mimics the same effect as starting masqmail with something like
260 \fB\-bd \-q30m\fR.
189 261
190 .TP 262 .TP
191 \fB\-qo [\fIname\fB]\fR 263 \fB\-qo [\fIname\fB]\fR
192 264
193 Can be followed by a connection name. 265 Online queue runs.
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
194 Use this option in your script which starts as soon as a link to the internet 280 Use this option in your script which starts as soon as a link to the internet
195 has been set up (usually ip-up). 281 has been set up (usually ip-up).
196 When masqmail is called with this option, the specified route configuration
197 is read and the queued mail with destinations on the internet will be sent.
198 The \fIname\fR is defined in the configuration (see \fBonline_routes.\fIname\fR).
199
200 If called without \fIname\fR the online status is determined with the configured
201 method (see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR)
202 282
203 .TP 283 .TP
204 \fB\-t\fR 284 \fB\-t\fR
205 285
206 Read recipients from mail headers and add them to the ones specified on the 286 Read recipients from mail headers and add them to the ones specified on the