Mercurial > masqmail

comparison docs/xml/masqmail.8.xml @ 0:08114f7dcc23 0.2.21

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