| rev |
line source |
|
meillo@0
|
1 <?xml version="1.0" standalone='no'?>
|
|
meillo@0
|
2 <!DOCTYPE spec SYSTEM "man.dtd">
|
|
meillo@0
|
3
|
|
meillo@0
|
4 <manpage name="masqmail" section="8" desc="An offline Mail Transfer Agent">
|
|
meillo@0
|
5
|
|
meillo@0
|
6 <synopsis>
|
|
meillo@0
|
7 <cmd>/usr/sbin/masqmail [-C <arg>file</arg>] [-odq] [-bd] [-q<arg>interval</arg>]</cmd>
|
|
meillo@0
|
8 <cmd>/usr/sbin/masqmail [-odq] [-bs]</cmd>
|
|
meillo@0
|
9 <cmd>/usr/sbin/masqmail [-bp]</cmd>
|
|
meillo@0
|
10 <cmd>/usr/sbin/masqmail [-q]</cmd>
|
|
meillo@0
|
11 <cmd>/usr/sbin/masqmail [-qo [<arg>name</arg>]]</cmd>
|
|
meillo@0
|
12 <cmd>/usr/sbin/masqmail [-odq] [-g [<arg>name</arg>]]</cmd>
|
|
meillo@0
|
13 <cmd>/usr/sbin/masqmail [-odq] [-go [<arg>name</arg>]]</cmd>
|
|
meillo@0
|
14 <cmd>/usr/sbin/masqmail [-t] [-oi] [-f <arg>address</arg>] [--] <arg>address...</arg></cmd>
|
|
meillo@0
|
15 <cmd>/usr/sbin/mailq</cmd>
|
|
meillo@0
|
16 </synopsis>
|
|
meillo@0
|
17
|
|
meillo@0
|
18 <description>
|
|
meillo@0
|
19 <p>MasqMail is a mail server designed for hosts that do
|
|
meillo@0
|
20 not have a permanent internet connection eg. a home network or a
|
|
meillo@0
|
21 single host at home. It has special support for connections to
|
|
meillo@0
|
22 different ISPs. It replaces sendmail or other MTAs such as qmail or
|
|
meillo@0
|
23 exim. It can also act as a pop3 client.</p>
|
|
meillo@0
|
24 </description>
|
|
meillo@0
|
25
|
|
meillo@0
|
26 <options>
|
|
meillo@0
|
27 <p>Since masqmail is intended to replace sendmail, it uses the same
|
|
meillo@0
|
28 command line options, but not all are implemented. There are also two
|
|
meillo@0
|
29 additional options, which are unique to masqmail (-qo <arg>connection</arg> and -g)
|
|
meillo@0
|
30 </p>
|
|
meillo@0
|
31
|
|
meillo@0
|
32 <option>
|
|
meillo@0
|
33 <p><opt>--</opt></p>
|
|
meillo@0
|
34 <optdesc><p>Not a 'real' option, it means that all following arguments are to
|
|
meillo@0
|
35 be understood as arguments and not as options even if they begin with a
|
|
meillo@0
|
36 leading dash '-'. Mutt is known to call sendmail with this option.</p></optdesc>
|
|
meillo@0
|
37 </option>
|
|
meillo@0
|
38
|
|
meillo@0
|
39 <option>
|
|
meillo@0
|
40 <p><opt>-bd</opt></p>
|
|
meillo@0
|
41 <optdesc><p>Run as daemon, accepting connections, usually on port 25 if not
|
|
meillo@0
|
42 configured differently. This is usually used in the startup script at system boot and
|
|
meillo@0
|
43 together with the -q option (see below).</p></optdesc>
|
|
meillo@0
|
44 </option>
|
|
meillo@0
|
45
|
|
meillo@0
|
46 <option>
|
|
meillo@0
|
47 <p><opt>-bi</opt></p>
|
|
meillo@0
|
48 <optdesc><p>Old sendmail rebuilds its alias database when invoked with this
|
|
meillo@0
|
49 option. Masqmail ignores it. Masqmail reads directly from the file
|
|
meillo@0
|
50 given with <b>alias_file</b> in the config file.</p></optdesc>
|
|
meillo@0
|
51 </option>
|
|
meillo@0
|
52
|
|
meillo@0
|
53 <option>
|
|
meillo@0
|
54 <p><opt>-bp</opt></p>
|
|
meillo@0
|
55 <optdesc><p>Show the messages in the queue. Same as calling masqmail as
|
|
meillo@0
|
56 'mailq'.</p></optdesc>
|
|
meillo@0
|
57 </option>
|
|
meillo@0
|
58
|
|
meillo@0
|
59 <option>
|
|
meillo@0
|
60 <p><opt>-bs</opt></p>
|
|
meillo@0
|
61 <optdesc><p>Accept SMTP commands from stdin. Some mailers (eg pine) use this
|
|
meillo@0
|
62 option as an interface. It can also be used to call masqmail from
|
|
meillo@0
|
63 inetd.</p></optdesc>
|
|
meillo@0
|
64 </option>
|
|
meillo@0
|
65
|
|
meillo@0
|
66 <option>
|
|
meillo@0
|
67 <p><opt>-B <arg>arg</arg></opt></p>
|
|
meillo@0
|
68 <optdesc><p><arg>arg</arg> is usually 8BITMIME. Some mailers use this
|
|
meillo@0
|
69 to indicate that the message contains characters > 127. Masqmail is
|
|
meillo@0
|
70 8-bit clean and ignores this, so you do not have to recompile elm,
|
|
meillo@0
|
71 which is very painful ;-). Note though that this violates some
|
|
meillo@0
|
72 conventions: masqmail <em>does not</em> convert 8 bit messages to any
|
|
meillo@0
|
73 MIME format if it encounters a mail server which does not advertise
|
|
meillo@0
|
74 its 8BITMIME capability, masqmail does not advertise this itself. This
|
|
meillo@0
|
75 is the same practice as that of exim (but different to
|
|
meillo@0
|
76 sendmail).</p></optdesc></option>
|
|
meillo@0
|
77
|
|
meillo@0
|
78 <option>
|
|
meillo@0
|
79 <p><opt>-bV </opt></p>
|
|
meillo@0
|
80 <optdesc><p>Show version information.</p>
|
|
meillo@0
|
81 </optdesc>
|
|
meillo@0
|
82 </option>
|
|
meillo@0
|
83
|
|
meillo@0
|
84 <option>
|
|
meillo@0
|
85 <p><opt>-C </opt><arg>filename</arg></p>
|
|
meillo@0
|
86 <optdesc><p>Use another configuration than <file>/etc/masqmail/masqmail.conf</file>. Useful for
|
|
meillo@0
|
87 debugging purposes. If not invoked by a privileged user, masqmail will drop all privileges.
|
|
meillo@0
|
88 </p></optdesc>
|
|
meillo@0
|
89 </option>
|
|
meillo@0
|
90
|
|
meillo@0
|
91 <option>
|
|
meillo@0
|
92 <p><opt>-d <arg>number</arg></opt></p>
|
|
meillo@0
|
93 <optdesc>
|
|
meillo@0
|
94 <p>Set the debug level. This takes precedence before the value of
|
|
meillo@0
|
95 <b>debug_level</b> in the configuration file. Read the warning in the
|
|
meillo@0
|
96 description of the latter.
|
|
meillo@0
|
97 </p>
|
|
meillo@0
|
98 </optdesc>
|
|
meillo@0
|
99 </option>
|
|
meillo@0
|
100
|
|
meillo@0
|
101 <option>
|
|
meillo@0
|
102 <p><opt>-f [<arg>address</arg>]</opt></p>
|
|
meillo@0
|
103 <optdesc>
|
|
meillo@0
|
104 <p>Set the return path address to <arg>address</arg>. Only root, the
|
|
meillo@0
|
105 user mail and anyoune in group trusted is allowed to do that.</p>
|
|
meillo@0
|
106 </optdesc>
|
|
meillo@0
|
107 </option>
|
|
meillo@0
|
108
|
|
meillo@0
|
109 <option>
|
|
meillo@0
|
110 <p><opt>-F [<arg>string</arg>]</opt></p>
|
|
meillo@0
|
111 <optdesc>
|
|
meillo@0
|
112 <p>Set the full sender name (in the From: header)
|
|
meillo@0
|
113 to <arg>string</arg>.</p>
|
|
meillo@0
|
114 </optdesc>
|
|
meillo@0
|
115 </option>
|
|
meillo@0
|
116
|
|
meillo@0
|
117 <option>
|
|
meillo@0
|
118 <p><opt>-g [<arg>name</arg>]</opt></p>
|
|
meillo@0
|
119 <optdesc>
|
|
meillo@0
|
120 <p>Get mail (using pop3 or apop), using the configurations given
|
|
meillo@0
|
121 with <b>get.<arg>name</arg></b> in the main configuration. Without <arg>name</arg>,
|
|
meillo@0
|
122 all get configurations will be used. See also <manref
|
|
meillo@0
|
123 name = "masqmail.get" section="5" href="masqmail.get.5.html"/></p>
|
|
meillo@0
|
124 </optdesc>
|
|
meillo@0
|
125 </option>
|
|
meillo@0
|
126
|
|
meillo@0
|
127 <option>
|
|
meillo@0
|
128 <p><opt>-go [<arg>interval</arg>] [<arg>name</arg>]</opt></p>
|
|
meillo@0
|
129 <optdesc>
|
|
meillo@0
|
130 <p>Can be followed by a connection name. Use this option in your
|
|
meillo@0
|
131 script which starts as soon as a link to the internet has been set up
|
|
meillo@0
|
132 (usually ip-up). When masqmail is called with this option, the
|
|
meillo@0
|
133 specified get configuration(s) is(are) read and mail will be
|
|
meillo@0
|
134 retrieved from servers on the internet.
|
|
meillo@0
|
135 The <arg>name</arg> is defined
|
|
meillo@0
|
136 in the configuration (see <opt>online_gets.<arg>name</arg></opt>).
|
|
meillo@0
|
137 </p><p>
|
|
meillo@0
|
138 If called with an interval option (recognized by a digit
|
|
meillo@0
|
139 as the first characater), masqmail starts as a daemon and tries to
|
|
meillo@0
|
140 get mail in these intervals. It checks for the online status first.
|
|
meillo@0
|
141 Example: masqmail -go 5m will retrieve mail
|
|
meillo@0
|
142 all five minutes.
|
|
meillo@0
|
143 </p><p>
|
|
meillo@0
|
144 If called without <arg>name</arg> the online status is determined with
|
|
meillo@0
|
145 the configured method (see <opt>online_detect</opt> in <a
|
|
meillo@0
|
146 href="config.html">config.html</a>).
|
|
meillo@0
|
147 </p>
|
|
meillo@0
|
148 </optdesc>
|
|
meillo@0
|
149 </option>
|
|
meillo@0
|
150
|
|
meillo@0
|
151 <option>
|
|
meillo@0
|
152 <p><opt>-i</opt></p>
|
|
meillo@0
|
153 <optdesc><p>Same as <b>-oi</b>, see below.</p></optdesc>
|
|
meillo@0
|
154 </option>
|
|
meillo@0
|
155
|
|
meillo@0
|
156 <option>
|
|
meillo@0
|
157 <p><opt>-Mrm <arg>list</arg></opt></p>
|
|
meillo@0
|
158 <optdesc><p>Remove given messages from the queue. Only allowed for privileged users.</p></optdesc>
|
|
meillo@0
|
159 </option>
|
|
meillo@0
|
160
|
|
meillo@0
|
161 <option>
|
|
meillo@0
|
162 <p><opt>-oem</opt></p>
|
|
meillo@0
|
163 <optdesc><p>If the <b>-oi</b> ist not also given, always return with a non zero
|
|
meillo@0
|
164 return code. Maybe someone tells me what this is good for...</p></optdesc>
|
|
meillo@0
|
165 </option>
|
|
meillo@0
|
166
|
|
meillo@0
|
167 <option>
|
|
meillo@0
|
168 <p><opt>-odb</opt></p>
|
|
meillo@0
|
169 <optdesc><p>Deliver in background. Masqmail always does this, which
|
|
meillo@0
|
170 makes this option pretty much useless.</p></optdesc>
|
|
meillo@0
|
171 </option>
|
|
meillo@0
|
172
|
|
meillo@0
|
173 <option>
|
|
meillo@0
|
174 <p><opt>-odq</opt></p>
|
|
meillo@0
|
175 <optdesc><p>Do not attempt to deliver immediately. Any messages will be queued
|
|
meillo@0
|
176 until the next queue running process picks them up and delivers
|
|
meillo@0
|
177 them. You get the same effect by setting the <i>do_queue</i> option in
|
|
meillo@0
|
178 /etc/masqmail/masqmail.conf.</p></optdesc>
|
|
meillo@0
|
179 </option>
|
|
meillo@0
|
180
|
|
meillo@0
|
181 <option>
|
|
meillo@0
|
182 <p><opt>-oi</opt></p>
|
|
meillo@0
|
183 <optdesc><p>A dot as a single character in a line does <em>not</em> terminate
|
|
meillo@0
|
184 the message.</p></optdesc>
|
|
meillo@0
|
185 </option>
|
|
meillo@0
|
186
|
|
meillo@0
|
187 <option>
|
|
meillo@0
|
188 <p><opt>-q [<arg>interval</arg>]</opt></p>
|
|
meillo@0
|
189 <optdesc><p>If not given with an argument, run a queue process, ie. try to
|
|
meillo@0
|
190 deliver all messages in the queue. Masqmail sends only to those
|
|
meillo@0
|
191 addresses that are on the <em>local</em> net, not to those that are
|
|
meillo@0
|
192 outside. Use -qo for those.</p>
|
|
meillo@0
|
193 <p>
|
|
meillo@0
|
194 If you have configured inetd to start masqmail, you can use this
|
|
meillo@0
|
195 option in a cron job which starts in regular time intervals, to mimic
|
|
meillo@0
|
196 the same effect as starting masqmail with -bd -q30m.
|
|
meillo@0
|
197 </p><p>
|
|
meillo@0
|
198 An argument may be a time interval ie. a numerical value followed
|
|
meillo@0
|
199 by one of the letters. s,m,h,d,w which are interpreted as seconds,
|
|
meillo@0
|
200 minutes, hours, days or weeks respectively. Example: -q30m. Masqmail
|
|
meillo@0
|
201 starts as a daemon and a queue runner process will be started
|
|
meillo@0
|
202 automatically once in this time interval. This is usually used
|
|
meillo@0
|
203 together with -bd (see above).
|
|
meillo@0
|
204 </p>
|
|
meillo@0
|
205 </optdesc>
|
|
meillo@0
|
206 </option>
|
|
meillo@0
|
207
|
|
meillo@0
|
208 <option>
|
|
meillo@0
|
209 <p><opt>-qo [<arg>name</arg>]</opt></p>
|
|
meillo@0
|
210 <optdesc>
|
|
meillo@0
|
211 <p>Can be followed by a connection name. Use this option in your
|
|
meillo@0
|
212 script which starts as soon as a link to the internet has been set up
|
|
meillo@0
|
213 (usually ip-up). When masqmail is called with this option, the
|
|
meillo@0
|
214 specified route configuration is read and the queued mail with
|
|
meillo@0
|
215 destinations on the internet will be sent. The <arg>name</arg> is defined
|
|
meillo@0
|
216 in the configuration (see <opt>online_routes.<arg>name</arg></opt>).
|
|
meillo@0
|
217 </p><p>
|
|
meillo@0
|
218 If called without <arg>name</arg> the online status is determined with
|
|
meillo@0
|
219 the configured method (see <opt>online_detect</opt> in <a
|
|
meillo@0
|
220 href="config.html">config.html</a>)
|
|
meillo@0
|
221 </p>
|
|
meillo@0
|
222 </optdesc>
|
|
meillo@0
|
223 </option>
|
|
meillo@0
|
224
|
|
meillo@0
|
225 <option>
|
|
meillo@0
|
226 <p><opt>-t</opt></p>
|
|
meillo@0
|
227 <optdesc><p>Read recipients from headers. Delete 'Bcc:' headers. If any
|
|
meillo@0
|
228 arguments are given, these are interpreted as recipient addresses and
|
|
meillo@0
|
229 the message will <em>not</em> be sent to these.</p></optdesc>
|
|
meillo@0
|
230 </option>
|
|
meillo@0
|
231
|
|
meillo@0
|
232 <option>
|
|
meillo@0
|
233 <p><opt>-v</opt></p>
|
|
meillo@0
|
234 <optdesc><p>Log also to stdout. Currently, some log messages are
|
|
meillo@0
|
235 marked as 'write to stdout' and additionally, all messages with
|
|
meillo@0
|
236 priority 'LOG_ALERT' and 'LOG_WARNING' will be written to stdout
|
|
meillo@0
|
237 if this option is given. It is disabled in daemon mode.
|
|
meillo@0
|
238 </p></optdesc>
|
|
meillo@0
|
239 </option>
|
|
meillo@0
|
240
|
|
meillo@0
|
241 </options>
|
|
meillo@0
|
242
|
|
meillo@0
|
243 <section name = "Environment for pipes and mdas">
|
|
meillo@0
|
244
|
|
meillo@0
|
245 <p>For security reasons, before any pipe command from an alias
|
|
meillo@0
|
246 expansion or an mda is called, the environment variables will be
|
|
meillo@0
|
247 completely discarded and newly set up. These are:</p>
|
|
meillo@0
|
248 <p>SENDER, RETURN_PATH - the return path.</p>
|
|
meillo@0
|
249 <p>SENDER_DOMAIN - the domain part of the return path.</p>
|
|
meillo@0
|
250 <p>SENDER_LOCAL - the local part of the return path.</p>
|
|
meillo@0
|
251 <p>RECEIVED_HOST - the host the message was received from (unless local).</p>
|
|
meillo@0
|
252 <p>LOCAL_PART, USER, LOGNAME - the local part of the (original) recipient.</p>
|
|
meillo@0
|
253 <p>MESSAGE_ID - the unique message id. This is not necessarily identical with the Message ID as given in the Message ID: header.</p>
|
|
meillo@0
|
254 <p>QUALIFY_DOMAIN - the domain which will be appended to unqualified addresses.</p>
|
|
meillo@0
|
255
|
|
meillo@0
|
256 </section>
|
|
meillo@0
|
257
|
|
meillo@0
|
258 <section name = "Files">
|
|
meillo@0
|
259 <p><file>/etc/masqmail/masqmail.conf</file> is the main configuration
|
|
meillo@0
|
260 for masqmail. Depending on the settings in this file, you will also
|
|
meillo@0
|
261 have other configuration files in <file>/etc/masqmail/</file>.</p>
|
|
meillo@0
|
262 <p><file>/etc/aliases</file> is the alias file, if not set differently
|
|
meillo@0
|
263 in <file>/etc/masqmail/masqmail.conf</file>.</p>
|
|
meillo@0
|
264 <p><file>/var/spool/masqmail/</file> is the spool directory where masqmail
|
|
meillo@0
|
265 stores its spooled messages and the uniq pop ids.</p>
|
|
meillo@0
|
266 <p><file>/var/spool/mail/</file> is the directory where locally delivered mail will be put, if not configured differently in <file>masqmail.conf</file>.</p>
|
|
meillo@0
|
267 <p><file>/var/log/masqmail/</file> is the directory where masqmail stores
|
|
meillo@0
|
268 its log mesages. This can also be somewhere else if configured
|
|
meillo@0
|
269 differently by your sysadmin or the package mantainer.</p>
|
|
meillo@0
|
270 </section>
|
|
meillo@0
|
271
|
|
meillo@0
|
272 <section name="Conforming to">
|
|
meillo@0
|
273 <p><b>RFC 821, 822, 1869, 1870, 2197, 2554</b> (SMTP)</p>
|
|
meillo@0
|
274 <p><b>RFC 1725, 1939</b> (POP3)</p>
|
|
meillo@0
|
275 <p><b>RFC 1321</b> (MD5)</p>
|
|
meillo@0
|
276 <p><b>RFC 2195</b> (CRAM-MD5)</p>
|
|
meillo@0
|
277 </section>
|
|
meillo@0
|
278
|
|
meillo@0
|
279 <section name = "Author">
|
|
meillo@0
|
280 <p>masqmail was written by Oliver Kurth
|
|
meillo@0
|
281 <oku@masqmail.cx></p><p>You will find the newest version of
|
|
meillo@0
|
282 masqmail at <url href="http://masqmail.cx/masqmail/"/> or search for it
|
|
meillo@0
|
283 in freshmeat (<url href="http://www.freshmeat.net"/>). There is also a mailing list,
|
|
meillo@0
|
284 you will find information about it at masqmails main site.</p>
|
|
meillo@0
|
285 </section>
|
|
meillo@0
|
286
|
|
meillo@0
|
287 <section name = "Bugs">
|
|
meillo@0
|
288 <p>You should report them to the mailing list.</p>
|
|
meillo@0
|
289 </section>
|
|
meillo@0
|
290
|
|
meillo@0
|
291 <section name = "See also">
|
|
meillo@0
|
292 <p>
|
|
meillo@0
|
293 <manref name="masqmail.conf" section="5" href="masqmail.conf.5.html"/>, <manref name="masqmail.route" section="5" href="masqmail.route.5.html"/>, <manref name="masqmail.get" section="5" href="masqmail.get.5.html"/>, <manref name="masqmail.aliases" section="5" href="masqmail.aliases.5.html"/>
|
|
meillo@0
|
294 </p>
|
|
meillo@0
|
295 </section>
|
|
meillo@0
|
296
|
|
meillo@0
|
297 <section name = "Comments">
|
|
meillo@0
|
298 <p>This man page was written using <manref name="xml2man" section="1"
|
|
meillo@0
|
299 href="http://masqmail.cx/xml2man/"/> by the same author.</p>
|
|
meillo@0
|
300 </section>
|
|
meillo@0
|
301
|
|
meillo@0
|
302 </manpage>
|
