masqmail-0.2

diff docs/old-manual/docs/masqmail.8.html @ 56:f6a6f55b7b9e

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