1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/xml/masqmail.8.xml	Fri Sep 26 17:05:23 2008 +0200
     1.3 @@ -0,0 +1,302 @@
     1.4 +<?xml version="1.0" standalone='no'?>
     1.5 +<!DOCTYPE spec SYSTEM "man.dtd">
     1.6 +
     1.7 +<manpage name="masqmail" section="8" desc="An offline Mail Transfer Agent">
     1.8 +
     1.9 +<synopsis>
    1.10 +<cmd>/usr/sbin/masqmail [-C <arg>file</arg>] [-odq] [-bd] [-q<arg>interval</arg>]</cmd>
    1.11 +<cmd>/usr/sbin/masqmail [-odq] [-bs]</cmd>
    1.12 +<cmd>/usr/sbin/masqmail [-bp]</cmd>
    1.13 +<cmd>/usr/sbin/masqmail [-q]</cmd>
    1.14 +<cmd>/usr/sbin/masqmail [-qo [<arg>name</arg>]]</cmd>
    1.15 +<cmd>/usr/sbin/masqmail [-odq] [-g [<arg>name</arg>]]</cmd>
    1.16 +<cmd>/usr/sbin/masqmail [-odq] [-go [<arg>name</arg>]]</cmd>
    1.17 +<cmd>/usr/sbin/masqmail [-t] [-oi] [-f <arg>address</arg>] [--] <arg>address...</arg></cmd>
    1.18 +<cmd>/usr/sbin/mailq</cmd>
    1.19 +</synopsis>
    1.20 +
    1.21 +<description>
    1.22 +<p>MasqMail is a mail server designed for hosts that do
    1.23 +not have a permanent internet connection eg. a home network or a
    1.24 +single host at home. It has special support for connections to
    1.25 +different ISPs. It replaces sendmail or other MTAs such as qmail or
    1.26 +exim. It can also act as a pop3 client.</p>
    1.27 +</description>
    1.28 +
    1.29 +<options>
    1.30 +<p>Since masqmail is intended to replace sendmail, it uses the same
    1.31 +command line options, but not all are implemented. There are also two
    1.32 +additional options, which are unique to masqmail (-qo <arg>connection</arg> and -g)
    1.33 +</p>
    1.34 +
    1.35 +<option>
    1.36 +<p><opt>--</opt></p>
    1.37 +<optdesc><p>Not a 'real' option, it means that all following arguments are to
    1.38 +be understood as arguments and not as options even if they begin with a
    1.39 +leading dash '-'. Mutt is known to call sendmail with this option.</p></optdesc>
    1.40 +</option>
    1.41 +
    1.42 +<option>
    1.43 +<p><opt>-bd</opt></p>
    1.44 +<optdesc><p>Run as daemon, accepting connections, usually on port 25 if not
    1.45 +configured differently. This is usually used in the startup script at system boot and
    1.46 +together with the -q option (see below).</p></optdesc>
    1.47 +</option>
    1.48 +
    1.49 +<option>
    1.50 +<p><opt>-bi</opt></p>
    1.51 +<optdesc><p>Old sendmail rebuilds its alias database when invoked with this
    1.52 +option. Masqmail ignores it. Masqmail reads directly from the file
    1.53 +given with <b>alias_file</b> in the config file.</p></optdesc>
    1.54 +</option>
    1.55 +
    1.56 +<option>
    1.57 +<p><opt>-bp</opt></p>
    1.58 +<optdesc><p>Show the messages in the queue. Same as calling masqmail as
    1.59 +'mailq'.</p></optdesc>
    1.60 +</option>
    1.61 +
    1.62 +<option>
    1.63 +<p><opt>-bs</opt></p>
    1.64 +<optdesc><p>Accept SMTP commands from stdin. Some mailers (eg pine) use this
    1.65 +option as an interface. It can also be used to call masqmail from
    1.66 +inetd.</p></optdesc>
    1.67 +</option>
    1.68 +
    1.69 +<option>
    1.70 +<p><opt>-B <arg>arg</arg></opt></p>
    1.71 +<optdesc><p><arg>arg</arg> is usually 8BITMIME. Some mailers use this
    1.72 +to indicate that the message contains characters &gt; 127. Masqmail is
    1.73 +8-bit clean and ignores this, so you do not have to recompile elm,
    1.74 +which is very painful ;-). Note though that this violates some
    1.75 +conventions: masqmail <em>does not</em> convert 8 bit messages to any
    1.76 +MIME format if it encounters a mail server which does not advertise
    1.77 +its 8BITMIME capability, masqmail does not advertise this itself. This
    1.78 +is the same practice as that of exim (but different to
    1.79 +sendmail).</p></optdesc></option>
    1.80 +
    1.81 +<option>
    1.82 +<p><opt>-bV </opt></p>
    1.83 +<optdesc><p>Show version information.</p>
    1.84 +</optdesc>
    1.85 +</option>
    1.86 +
    1.87 +<option>
    1.88 +<p><opt>-C </opt><arg>filename</arg></p>
    1.89 +<optdesc><p>Use another configuration than <file>/etc/masqmail/masqmail.conf</file>. Useful for
    1.90 +debugging purposes. If not invoked by a privileged user, masqmail will drop all privileges.
    1.91 +</p></optdesc>
    1.92 +</option>
    1.93 +
    1.94 +<option>
    1.95 +<p><opt>-d <arg>number</arg></opt></p>
    1.96 +<optdesc>
    1.97 +<p>Set the debug level. This takes precedence before the value of
    1.98 +<b>debug_level</b> in the configuration file. Read the warning in the
    1.99 +description of the latter.
   1.100 +</p>
   1.101 +</optdesc>
   1.102 +</option>
   1.103 +
   1.104 +<option>
   1.105 +<p><opt>-f [<arg>address</arg>]</opt></p>
   1.106 +<optdesc>
   1.107 +<p>Set the return path address to <arg>address</arg>. Only root, the
   1.108 +user mail and anyoune in group trusted is allowed to do that.</p>
   1.109 +</optdesc>
   1.110 +</option>
   1.111 +
   1.112 +<option>
   1.113 +<p><opt>-F [<arg>string</arg>]</opt></p>
   1.114 +<optdesc>
   1.115 +<p>Set the full sender name (in the From: header)
   1.116 +to <arg>string</arg>.</p>
   1.117 +</optdesc>
   1.118 +</option>
   1.119 +
   1.120 +<option>
   1.121 +<p><opt>-g [<arg>name</arg>]</opt></p>
   1.122 +<optdesc>
   1.123 +<p>Get mail (using pop3 or apop), using the configurations given
   1.124 +with <b>get.<arg>name</arg></b> in the main configuration. Without <arg>name</arg>,
   1.125 +all get configurations will be used. See also <manref
   1.126 +name = "masqmail.get" section="5" href="masqmail.get.5.html"/></p>
   1.127 +</optdesc>
   1.128 +</option>
   1.129 +
   1.130 +<option>
   1.131 +<p><opt>-go [<arg>interval</arg>] [<arg>name</arg>]</opt></p>
   1.132 +<optdesc>
   1.133 +<p>Can be followed by a connection name. Use this option in your
   1.134 +script which starts as soon as a link to the internet has been set up
   1.135 +(usually ip-up). When masqmail is called with this option, the
   1.136 +specified get configuration(s) is(are) read and mail will be
   1.137 +retrieved from servers on the internet.
   1.138 +The <arg>name</arg> is defined
   1.139 +in the configuration (see <opt>online_gets.<arg>name</arg></opt>).
   1.140 +</p><p>
   1.141 +If called with an interval option (recognized by a digit
   1.142 +as the first characater), masqmail starts as a daemon and tries to
   1.143 +get mail in these intervals. It checks for the online status first.
   1.144 +Example: masqmail -go 5m will retrieve mail
   1.145 +all five minutes.
   1.146 +</p><p>
   1.147 +If called without <arg>name</arg> the online status is determined with
   1.148 +the configured method (see <opt>online_detect</opt> in <a
   1.149 +href="config.html">config.html</a>).
   1.150 +</p>
   1.151 +</optdesc>
   1.152 +</option>
   1.153 +
   1.154 +<option>
   1.155 +<p><opt>-i</opt></p>
   1.156 +<optdesc><p>Same as <b>-oi</b>, see below.</p></optdesc>
   1.157 +</option>
   1.158 +
   1.159 +<option>
   1.160 +<p><opt>-Mrm <arg>list</arg></opt></p>
   1.161 +<optdesc><p>Remove given messages from the queue. Only allowed for privileged users.</p></optdesc>
   1.162 +</option>
   1.163 +
   1.164 +<option>
   1.165 +<p><opt>-oem</opt></p>
   1.166 +<optdesc><p>If the <b>-oi</b> ist not also given, always return with a non zero
   1.167 +return code. Maybe someone tells me what this is good for...</p></optdesc>
   1.168 +</option>
   1.169 +
   1.170 +<option>
   1.171 +<p><opt>-odb</opt></p>
   1.172 +<optdesc><p>Deliver in background. Masqmail always does this, which
   1.173 +makes this option pretty much useless.</p></optdesc>
   1.174 +</option>
   1.175 +
   1.176 +<option>
   1.177 +<p><opt>-odq</opt></p>
   1.178 +<optdesc><p>Do not attempt to deliver immediately. Any messages will be queued
   1.179 +until the next queue running process picks them up and delivers
   1.180 +them. You get the same effect by setting the <i>do_queue</i> option in
   1.181 +/etc/masqmail/masqmail.conf.</p></optdesc>
   1.182 +</option>
   1.183 +
   1.184 +<option>
   1.185 +<p><opt>-oi</opt></p>
   1.186 +<optdesc><p>A dot as a single character in a line does <em>not</em> terminate
   1.187 +the message.</p></optdesc>
   1.188 +</option>
   1.189 +
   1.190 +<option>
   1.191 +<p><opt>-q [<arg>interval</arg>]</opt></p>
   1.192 +<optdesc><p>If not given with an argument, run a queue process, ie. try to
   1.193 +deliver all messages in the queue. Masqmail sends only to those
   1.194 +addresses that are on the <em>local</em> net, not to those that are
   1.195 +outside. Use -qo for those.</p>
   1.196 +<p>
   1.197 +If you have configured inetd to start masqmail, you can use this
   1.198 +option in a cron job which starts in regular time intervals, to mimic
   1.199 +the same effect as starting masqmail with -bd -q30m.
   1.200 +</p><p>
   1.201 +An argument may be a time interval ie. a numerical value followed
   1.202 +by one of the letters. s,m,h,d,w which are interpreted as seconds,
   1.203 +minutes, hours, days or weeks respectively. Example: -q30m. Masqmail
   1.204 +starts as a daemon and a queue runner process will be started
   1.205 +automatically once in this time interval. This is usually used
   1.206 +together with -bd (see above).
   1.207 +</p>
   1.208 +</optdesc>
   1.209 +</option>
   1.210 +
   1.211 +<option>
   1.212 +<p><opt>-qo [<arg>name</arg>]</opt></p>
   1.213 +<optdesc>
   1.214 +<p>Can be followed by a connection name. Use this option in your
   1.215 +script which starts as soon as a link to the internet has been set up
   1.216 +(usually ip-up). When masqmail is called with this option, the
   1.217 +specified route configuration is read and the queued mail with
   1.218 +destinations on the internet will be sent. The <arg>name</arg> is defined
   1.219 +in the configuration (see <opt>online_routes.<arg>name</arg></opt>).
   1.220 +</p><p>
   1.221 +If called without <arg>name</arg> the online status is determined with
   1.222 +the configured method (see <opt>online_detect</opt> in <a
   1.223 +href="config.html">config.html</a>)
   1.224 +</p>
   1.225 +</optdesc>
   1.226 +</option>
   1.227 +
   1.228 +<option>
   1.229 +<p><opt>-t</opt></p>
   1.230 +<optdesc><p>Read recipients from headers. Delete 'Bcc:' headers. If any
   1.231 +arguments are given, these are interpreted as recipient addresses and
   1.232 +the message will <em>not</em> be sent to these.</p></optdesc>
   1.233 +</option>
   1.234 +
   1.235 +<option>
   1.236 +<p><opt>-v</opt></p>
   1.237 +<optdesc><p>Log also to stdout. Currently, some log messages are
   1.238 +marked as 'write to stdout' and additionally, all messages with
   1.239 +priority 'LOG_ALERT' and 'LOG_WARNING' will be written to stdout
   1.240 +if this option is given. It is disabled in daemon mode.
   1.241 +</p></optdesc>
   1.242 +</option>
   1.243 +
   1.244 +</options>
   1.245 +
   1.246 +<section name = "Environment for pipes and mdas">
   1.247 +
   1.248 +<p>For security reasons, before any pipe command from an alias
   1.249 +expansion or an mda is called, the environment variables will be
   1.250 +completely discarded and newly set up. These are:</p>
   1.251 +<p>SENDER, RETURN_PATH - the return path.</p>
   1.252 +<p>SENDER_DOMAIN - the domain part of the return path.</p>
   1.253 +<p>SENDER_LOCAL - the local part of the return path.</p>
   1.254 +<p>RECEIVED_HOST - the host the message was received from (unless local).</p>
   1.255 +<p>LOCAL_PART, USER, LOGNAME - the local part of the (original) recipient.</p>
   1.256 +<p>MESSAGE_ID - the unique message id. This is not necessarily identical with the Message ID as given in the Message ID: header.</p>
   1.257 +<p>QUALIFY_DOMAIN - the domain which will be appended to unqualified addresses.</p>
   1.258 +
   1.259 +</section>
   1.260 +
   1.261 +<section name = "Files">
   1.262 +<p><file>/etc/masqmail/masqmail.conf</file> is the main configuration
   1.263 +for masqmail. Depending on the settings in this file, you will also
   1.264 +have other configuration files in <file>/etc/masqmail/</file>.</p>
   1.265 +<p><file>/etc/aliases</file> is the alias file, if not set differently
   1.266 +in <file>/etc/masqmail/masqmail.conf</file>.</p>
   1.267 +<p><file>/var/spool/masqmail/</file> is the spool directory where masqmail
   1.268 +stores its spooled messages and the uniq pop ids.</p>
   1.269 +<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>
   1.270 +<p><file>/var/log/masqmail/</file> is the directory where masqmail stores
   1.271 +its log mesages. This can also be somewhere else if configured
   1.272 +differently by your sysadmin or the package mantainer.</p>
   1.273 +</section>
   1.274 +
   1.275 +<section name="Conforming to">
   1.276 +<p><b>RFC 821, 822, 1869, 1870, 2197, 2554</b> (SMTP)</p>
   1.277 +<p><b>RFC 1725, 1939</b> (POP3)</p>
   1.278 +<p><b>RFC 1321</b> (MD5)</p>
   1.279 +<p><b>RFC 2195</b> (CRAM-MD5)</p>
   1.280 +</section>
   1.281 +
   1.282 +<section name = "Author">
   1.283 +<p>masqmail was written by Oliver Kurth
   1.284 +&lt;oku@masqmail.cx&gt;</p><p>You will find the newest version of
   1.285 +masqmail at <url href="http://masqmail.cx/masqmail/"/> or search for it
   1.286 +in freshmeat (<url href="http://www.freshmeat.net"/>). There is also a mailing list,
   1.287 +you will find information about it at masqmails main site.</p>
   1.288 +</section>
   1.289 +
   1.290 +<section name = "Bugs">
   1.291 +<p>You should report them to the mailing list.</p>
   1.292 +</section>
   1.293 +
   1.294 +<section name = "See also">
   1.295 +<p>
   1.296 +<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"/>
   1.297 +</p>
   1.298 +</section>
   1.299 +
   1.300 +<section name = "Comments">
   1.301 +<p>This man page was written using <manref name="xml2man" section="1"
   1.302 +href="http://masqmail.cx/xml2man/"/> by the same author.</p>
   1.303 +</section>
   1.304 +
   1.305 +</manpage>