1.1 --- a/docs/README	Thu May 06 13:31:57 2010 +0200
     1.2 +++ b/docs/README	Fri May 07 13:50:23 2010 +0200
     1.3 @@ -1,2 +1,2 @@
     1.4 -Since masqmail-0.3, documentation is maintained in troff (man page) format.
     1.5 +Since masqmail-0.3, documentation is maintained in troff (man page) format directly.
     1.6  The old XML sources are no longer used.

     2.1 --- a/docs/masqmail.8	Thu May 06 13:31:57 2010 +0200
     2.2 +++ b/docs/masqmail.8	Fri May 07 13:50:23 2010 +0200
     2.3 @@ -1,185 +1,265 @@
     2.4 -.TH masqmail 8 User Manuals
     2.5 +.TH masqmail 8 2010-05-07 masqmail-0.2.21 "Maintenance Commands"
     2.6 +
     2.7  .SH NAME
     2.8  masqmail \- An offline Mail Transfer Agent
     2.9 +
    2.10  .SH SYNOPSIS
    2.11 -\fB/usr/sbin/masqmail [\-C \fIfile\f1\fB] [\-odq] [\-bd] [\-q\fIinterval\f1\fB]
    2.12 +\fB/usr/sbin/masqmail \fR[\fB\-C \fIfile\fR] [\fB\-odq\fR] [\fB\-bd\fR] [\fB\-q\fIinterval\fR]
    2.13  
    2.14 -\fB/usr/sbin/masqmail [\-odq] [\-bs]
    2.15 +\fB/usr/sbin/masqmail \fR[\fB\-odq\fR] [\fB\-bs\fR]
    2.16  
    2.17 -\fB/usr/sbin/masqmail [\-bp]
    2.18 +\fB/usr/sbin/masqmail \fR[\fB\-bp\fR]
    2.19  
    2.20 -\fB/usr/sbin/masqmail [\-q]
    2.21 +\fB/usr/sbin/masqmail \fR[\fB\-q\fR]
    2.22  
    2.23 -\fB/usr/sbin/masqmail [\-qo [\fIname\f1\fB]]
    2.24 +\fB/usr/sbin/masqmail \fR[\fB\-qo \fR[\fIname\fR]]
    2.25  
    2.26 -\fB/usr/sbin/masqmail [\-odq] [\-g [\fIname\f1\fB]]
    2.27 +\fB/usr/sbin/masqmail \fR[\fB\-odq\fR] [\fB\-g \fR[\fIname\fR]]
    2.28  
    2.29 -\fB/usr/sbin/masqmail [\-odq] [\-go [\fIname\f1\fB]]
    2.30 +\fB/usr/sbin/masqmail \fR[\fB\-odq\fR] [\fB\-go \fR[\fIname\fR]]
    2.31  
    2.32 -\fB/usr/sbin/masqmail [\-t] [\-oi] [\-f \fIaddress\f1\fB] [\-\-] \fIaddress...\f1\fB
    2.33 +\fB/usr/sbin/masqmail \fR[\fB\-t\fR] [\fB\-oi\fR] [\fB\-f \fIaddress\fR] [\fB\-\-\fR] \fIaddress...
    2.34  
    2.35 -\fB/usr/sbin/mailq
    2.36 +\fB/usr/sbin/mailq\fR
    2.37  
    2.38 -\fB
    2.39 +
    2.40  .SH DESCRIPTION
    2.41  
    2.42 -MasqMail is a mail server designed for hosts that do not have a permanent internet connection eg. a home network or a single host at home. It has special support for connections to different ISPs. It replaces sendmail or other MTAs such as qmail or exim. It can also act as a pop3 client.
    2.43 +Masqmail is a mail server designed for hosts that do not have a permanent internet connection
    2.44 +e.g. a home network or a single host at home.
    2.45 +It has special support for connections to different ISPs.
    2.46 +It replaces sendmail or other MTAs such as qmail or exim.
    2.47 +It can also act as a pop3 client.
    2.48 +
    2.49  
    2.50  .SH OPTIONS
    2.51  
    2.52 -Since masqmail is intended to replace sendmail, it uses the same command line options, but not all are implemented. There are also two additional options, which are unique to masqmail (\-qo \fIconnection\f1 and \-g)
    2.53 +Since masqmail is intended to replace sendmail, it uses the same command line options,
    2.54 +but not all are implemented.
    2.55 +There are also two additional options, which are unique to masqmail
    2.56 +(\fB\-qo \fIconnection\fR and \fB\-g\fR)
    2.57 +
    2.58  .TP
    2.59 +\fB\-\-\fR
    2.60  
    2.61 -\fB\-\-\f1
    2.62 +Not a `real' option, it means that all following arguments are to be understood
    2.63 +as arguments and not as options even if they begin with a leading dash `\-'.
    2.64 +Mutt is known to call sendmail with this option.
    2.65  
    2.66 -Not a 'real' option, it means that all following arguments are to be understood as arguments and not as options even if they begin with a leading dash '\-'. Mutt is known to call sendmail with this option.
    2.67  .TP
    2.68 +\fB\-bd\fR
    2.69  
    2.70 -\fB\-bd\f1
    2.71 +Run as daemon, accepting connections, usually on port 25 if not configured differently.
    2.72 +This is usually used in the startup script at system boot and together with
    2.73 +the \fB\-q\fR option (see below).
    2.74  
    2.75 -Run as daemon, accepting connections, usually on port 25 if not configured differently. This is usually used in the startup script at system boot and together with the \-q option (see below).
    2.76  .TP
    2.77 +\fB\-bi\fR
    2.78  
    2.79 -\fB\-bi\f1
    2.80 +Old sendmail rebuilds its alias database when invoked with this option.
    2.81 +Masqmail ignores it.
    2.82 +Masqmail reads directly from the file given with `alias_file' in the config file.
    2.83  
    2.84 -Old sendmail rebuilds its alias database when invoked with this option. Masqmail ignores it. Masqmail reads directly from the file given with alias_file in the config file.
    2.85  .TP
    2.86 +\fB\-bp\fR
    2.87  
    2.88 -\fB\-bp\f1
    2.89 +Show the messages in the queue. Same as calling masqmail as `mailq'.
    2.90  
    2.91 -Show the messages in the queue. Same as calling masqmail as 'mailq'.
    2.92  .TP
    2.93 +\fB\-bs\fR
    2.94  
    2.95 -\fB\-bs\f1
    2.96 +Accept SMTP commands from stdin.
    2.97 +Some mailers (e.g. pine) use this option as an interface.
    2.98 +It can also be used to call masqmail from inetd.
    2.99  
   2.100 -Accept SMTP commands from stdin. Some mailers (eg pine) use this option as an interface. It can also be used to call masqmail from inetd.
   2.101  .TP
   2.102 +\fB\-B \fIarg\fR
   2.103  
   2.104 -\fB\-B \fIarg\f1\fB\f1
   2.105 +\fIarg\fR is usually 8BITMIME.
   2.106 +Some mailers use this to indicate that the message contains characters > 127.
   2.107 +Masqmail is 8-bit clean and ignores this, so you do not have to recompile elm,
   2.108 +which is very painful ;-).
   2.109 +Note though that this violates some conventions:
   2.110 +masqmail does not convert 8 bit messages to any MIME format if it encounters
   2.111 +a mail server which does not advertise its 8BITMIME capability,
   2.112 +masqmail does not advertise this itself.
   2.113 +This is the same practice as that of exim (but different to sendmail).
   2.114  
   2.115 -\fIarg\f1 is usually 8BITMIME. Some mailers use this to indicate that the message contains characters > 127. Masqmail is 8-bit clean and ignores this, so you do not have to recompile elm, which is very painful ;-). Note though that this violates some conventions: masqmail does not convert 8 bit messages to any MIME format if it encounters a mail server which does not advertise its 8BITMIME capability, masqmail does not advertise this itself. This is the same practice as that of exim (but different to sendmail).
   2.116  .TP
   2.117 -
   2.118 -\fB\-bV \f1
   2.119 +\fB\-bV \fR
   2.120  
   2.121  Show version information.
   2.122 +
   2.123  .TP
   2.124 +\fB\-C \fIfilename\fR
   2.125  
   2.126 -\fB\-C \f1\fIfilename\f1
   2.127 +Use another configuration than \fI/etc/masqmail/masqmail.conf\fR.
   2.128 +Useful for debugging purposes.
   2.129 +If not invoked by a privileged user, masqmail will drop all privileges.
   2.130  
   2.131 -Use another configuration than \fI/etc/masqmail/masqmail.conf\f1. Useful for debugging purposes. If not invoked by a privileged user, masqmail will drop all privileges.
   2.132  .TP
   2.133 +\fB\-d \fInumber\fR
   2.134  
   2.135 -\fB\-d \fInumber\f1\fB\f1
   2.136 +Set the debug level.
   2.137 +This takes precedence before the value of `debug_level' in the configuration file.
   2.138 +Read the warning in the description of the latter.
   2.139  
   2.140 -Set the debug level. This takes precedence before the value ofdebug_level in the configuration file. Read the warning in the description of the latter.
   2.141  .TP
   2.142 +\fB\-f [\fIaddress\fB]\fR
   2.143  
   2.144 -\fB\-f [\fIaddress\f1\fB]\f1
   2.145 +Set the return path address to \fIaddress\fR.
   2.146 +Only root, the user mail and anyone in group mail is allowed to do that.
   2.147  
   2.148 -Set the return path address to \fIaddress\f1. Only root, the user mail and anyone in group mail is allowed to do that.
   2.149  .TP
   2.150 +\fB\-F [\fIstring\fB]\fR
   2.151  
   2.152 -\fB\-F [\fIstring\f1\fB]\f1
   2.153 +Set the full sender name (in the From: header) to \fIstring\fR.
   2.154  
   2.155 -Set the full sender name (in the From: header) to \fIstring\f1.
   2.156  .TP
   2.157 +\fB\-g [\fIname\fB]\fR
   2.158  
   2.159 -\fB\-g [\fIname\f1\fB]\f1
   2.160 +Get mail (using pop3 or apop),
   2.161 +using the configurations given with get.\fIname\fR in the main configuration.
   2.162 +Without \fIname\fR, all get configurations will be used.
   2.163 +See also \fBmasqmail.get(5)\fR
   2.164  
   2.165 -Get mail (using pop3 or apop), using the configurations given with get.\fIname\f1 in the main configuration. Without \fIname\f1, all get configurations will be used. See also \fBmasqmail.get (5)\f1
   2.166  .TP
   2.167 +\fB\-go [\fIinterval\fB] [\fIname\fB]\fR
   2.168  
   2.169 -\fB\-go [\fIinterval\f1\fB] [\fIname\f1\fB]\f1
   2.170 +Can be followed by a connection name.
   2.171 +Use this option in your script which starts as soon as a link to the internet
   2.172 +has been set up (usually ip-up).
   2.173 +When masqmail is called with this option, the specified get configuration(s)
   2.174 +is(are) read and mail will be retrieved from servers on the internet.
   2.175 +The \fIname\fR is defined in the configuration (see \fBonline_gets.\fIname\fR).
   2.176  
   2.177 -Can be followed by a connection name. Use this option in your script which starts as soon as a link to the internet has been set up (usually ip-up). When masqmail is called with this option, the specified get configuration(s) is(are) read and mail will be retrieved from servers on the internet. The \fIname\f1 is defined in the configuration (see \fBonline_gets.\fIname\f1\fB\f1).
   2.178 +If called with an interval option (recognized by a digit as the first characater),
   2.179 +masqmail starts as a daemon and tries to get mail in these intervals.
   2.180 +It checks for the online status first.
   2.181 +Example: `masqmail \-go 5m' will retrieve mail every five minutes.
   2.182  
   2.183 -If called with an interval option (recognized by a digit as the first characater), masqmail starts as a daemon and tries to get mail in these intervals. It checks for the online status first. Example: masqmail \-go 5m will retrieve mail every five minutes.
   2.184 +If called without \fIname\fR the online status is determined with the configured method
   2.185 +(see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR).
   2.186  
   2.187 -If called without \fIname\f1 the online status is determined with the configured method (see \fBonline_detect\f1 in \fBmasqmail.conf (5)\f1).
   2.188  .TP
   2.189 +\fB\-i\fR
   2.190  
   2.191 -\fB\-i\f1
   2.192 +Same as \fB\-oi\fR, see below.
   2.193  
   2.194 -Same as \-oi, see below.
   2.195  .TP
   2.196 +\fB\-Mrm \fIlist\fR
   2.197  
   2.198 -\fB\-Mrm \fIlist\f1\fB\f1
   2.199 +Remove given messages from the queue.
   2.200 +Only allowed for privileged users.
   2.201  
   2.202 -Remove given messages from the queue. Only allowed for privileged users.
   2.203  .TP
   2.204 +\fB\-oem\fR
   2.205  
   2.206 -\fB\-oem\f1
   2.207 +If the \fB\-oi\fR ist not also given, always return with a non zero return code.
   2.208 +Maybe someone tells me what this is good for...
   2.209  
   2.210 -If the \-oi ist not also given, always return with a non zero return code. Maybe someone tells me what this is good for...
   2.211  .TP
   2.212 +\fB\-odb\fR
   2.213  
   2.214 -\fB\-odb\f1
   2.215 +Deliver in background.
   2.216 +Masqmail always does this, which makes this option pretty much useless.
   2.217  
   2.218 -Deliver in background. Masqmail always does this, which makes this option pretty much useless.
   2.219  .TP
   2.220 +\fB\-odq\fR
   2.221  
   2.222 -\fB\-odq\f1
   2.223 +Do not attempt to deliver immediately.
   2.224 +Any messages will be queued until the next queue running process picks them up and delivers them.
   2.225 +You get the same effect by setting the do_queue option in /etc/masqmail/masqmail.conf.
   2.226  
   2.227 -Do not attempt to deliver immediately. Any messages will be queued until the next queue running process picks them up and delivers them. You get the same effect by setting the do_queue option in /etc/masqmail/masqmail.conf.
   2.228  .TP
   2.229 -
   2.230 -\fB\-oi\f1
   2.231 +\fB\-oi\fR
   2.232  
   2.233  A dot as a single character in a line does not terminate the message.
   2.234 +
   2.235  .TP
   2.236 +\fB\-q [\fIinterval\fB]\fR
   2.237  
   2.238 -\fB\-q [\fIinterval\f1\fB]\f1
   2.239 +If not given with an argument, run a queue process, i.e. try to deliver all messages in the queue.
   2.240 +Masqmail sends only to those addresses that are on the local net, not to those that are outside.
   2.241 +Use \fB\-qo\fR for those.
   2.242  
   2.243 -If not given with an argument, run a queue process, ie. try to deliver all messages in the queue. Masqmail sends only to those addresses that are on the local net, not to those that are outside. Use \-qo for those.
   2.244 +If you have configured inetd to start masqmail,
   2.245 +you can use this option in a cron job which starts in regular time intervals,
   2.246 +to mimic the same effect as starting masqmail with \fB\-bd \-q30m\fR.
   2.247  
   2.248 -If you have configured inetd to start masqmail, you can use this option in a cron job which starts in regular time intervals, to mimic the same effect as starting masqmail with \-bd \-q30m.
   2.249 +An argument may be a time interval i.e. a numerical value followed by one of the letters.
   2.250 +s,m,h,d,w which are interpreted as seconds, minutes, hours, days or weeks respectively.
   2.251 +Example: \fB\-q30m\fR.
   2.252 +Masqmail starts as a daemon and a queue runner process will be started automatically
   2.253 +once in this time interval.
   2.254 +This is usually used together with \fB\-bd\fR (see above).
   2.255  
   2.256 -An argument may be a time interval ie. a numerical value followed by one of the letters. s,m,h,d,w which are interpreted as seconds, minutes, hours, days or weeks respectively. Example: \-q30m. Masqmail starts as a daemon and a queue runner process will be started automatically once in this time interval. This is usually used together with \-bd (see above).
   2.257  .TP
   2.258 +\fB\-qo [\fIname\fB]\fR
   2.259  
   2.260 -\fB\-qo [\fIname\f1\fB]\f1
   2.261 +Can be followed by a connection name.
   2.262 +Use this option in your script which starts as soon as a link to the internet
   2.263 +has been set up (usually ip-up).
   2.264 +When masqmail is called with this option, the specified route configuration
   2.265 +is read and the queued mail with destinations on the internet will be sent.
   2.266 +The \fIname\fR is defined in the configuration (see \fBonline_routes.\fIname\fR).
   2.267  
   2.268 -Can be followed by a connection name. Use this option in your script which starts as soon as a link to the internet has been set up (usually ip-up). When masqmail is called with this option, the specified route configuration is read and the queued mail with destinations on the internet will be sent. The \fIname\f1 is defined in the configuration (see \fBonline_routes.\fIname\f1\fB\f1).
   2.269 +If called without \fIname\fR the online status is determined with the configured
   2.270 +method (see \fBonline_detect\fR in \fBmasqmail.conf(5)\fR)
   2.271  
   2.272 -If called without \fIname\f1 the online status is determined with the configured method (see \fBonline_detect\f1 in \fBmasqmail.conf (5)\f1)
   2.273  .TP
   2.274 +\fB\-t\fR
   2.275  
   2.276 -\fB\-t\f1
   2.277 +Read recipients from headers.
   2.278 +Delete `Bcc:' headers.
   2.279 +If any arguments are given, these are interpreted as recipient addresses
   2.280 +and the message will not be sent to these.
   2.281  
   2.282 -Read recipients from headers. Delete 'Bcc:' headers. If any arguments are given, these are interpreted as recipient addresses and the message will not be sent to these.
   2.283  .TP
   2.284 +\fB\-v\fR
   2.285  
   2.286 -\fB\-v\f1
   2.287 +Log also to stdout.
   2.288 +Currently, some log messages are marked as `write to stdout' and additionally,
   2.289 +all messages with priority `LOG_ALERT' and `LOG_WARNING' will be written to stdout
   2.290 +if this option is given. It is disabled in daemon mode.
   2.291  
   2.292 -Log also to stdout. Currently, some log messages are marked as 'write to stdout' and additionally, all messages with priority 'LOG_ALERT' and 'LOG_WARNING' will be written to stdout if this option is given. It is disabled in daemon mode.
   2.293 +
   2.294  .SH ENVIRONMENT FOR PIPES AND MDAS
   2.295  
   2.296 -For security reasons, before any pipe command from an alias expansion or an mda is called, the environment variables will be completely discarded and newly set up. These are:
   2.297 +For security reasons, before any pipe command from an alias expansion or an mda is called,
   2.298 +the environment variables will be completely discarded and newly set up. These are:
   2.299  
   2.300 -SENDER, RETURN_PATH - the return path.
   2.301 +SENDER, RETURN_PATH \(en the return path.
   2.302  
   2.303 -SENDER_DOMAIN - the domain part of the return path.
   2.304 +SENDER_DOMAIN \(en the domain part of the return path.
   2.305  
   2.306 -SENDER_LOCAL - the local part of the return path.
   2.307 +SENDER_LOCAL \(en the local part of the return path.
   2.308  
   2.309 -RECEIVED_HOST - the host the message was received from (unless local).
   2.310 +RECEIVED_HOST \(en the host the message was received from (unless local).
   2.311  
   2.312 -LOCAL_PART, USER, LOGNAME - the local part of the (original) recipient.
   2.313 +LOCAL_PART, USER, LOGNAME \(en the local part of the (original) recipient.
   2.314  
   2.315 -MESSAGE_ID - the unique message id. This is not necessarily identical with the Message ID as given in the Message ID: header.
   2.316 +MESSAGE_ID \(en the unique message id.
   2.317 +This is not necessarily identical with the Message ID as given in the Message ID: header.
   2.318  
   2.319 -QUALIFY_DOMAIN - the domain which will be appended to unqualified addresses.
   2.320 +QUALIFY_DOMAIN \(en the domain which will be appended to unqualified addresses.
   2.321 +
   2.322  
   2.323  .SH FILES
   2.324  
   2.325 -\fI/etc/masqmail/masqmail.conf\f1 is the main configuration for masqmail. Depending on the settings in this file, you will also have other configuration files in \fI/etc/masqmail/\f1.
   2.326 +\fI/etc/masqmail/masqmail.conf\fR is the main configuration for masqmail.
   2.327 +Depending on the settings in this file, you will also have other configuration
   2.328 +files in \fI/etc/masqmail/\fR.
   2.329  
   2.330 -\fI/var/spool/masqmail/\f1 is the spool directory where masqmail stores its spooled messages and the uniq pop ids.
   2.331 +\fI/var/spool/masqmail/\fR is the spool directory where masqmail stores
   2.332 +its spooled messages and the uniq pop ids.
   2.333  
   2.334 -\fI/var/spool/mail/\f1 is the directory where locally delivered mail will be put, if not configured differently in \fImasqmail.conf\f1.
   2.335 +\fI/var/spool/mail/\fR is the directory where locally delivered mail will be put,
   2.336 +if not configured differently in \fImasqmail.conf\fR.
   2.337  
   2.338 -\fI/var/log/masqmail/\f1 is the directory where masqmail stores its log mesages. This can also be somewhere else if configured differently by your sysadmin or the package mantainer.
   2.339 +\fI/var/log/masqmail/\fR is the directory where masqmail stores its log mesages.
   2.340 +This can also be somewhere else if configured differently by your sysadmin or the package mantainer.
   2.341 +
   2.342  
   2.343  .SH CONFORMING TO
   2.344  
   2.345 @@ -191,22 +271,21 @@
   2.346  
   2.347  RFC 2195 (CRAM-MD5)
   2.348  
   2.349 +
   2.350  .SH AUTHOR
   2.351  
   2.352 -masqmail was written by Oliver Kurth. It is now maintained by Markus Schnalke <meillo@marmaro.de>.
   2.353 +Masqmail was written by Oliver Kurth.
   2.354 +It is now maintained by Markus Schnalke <meillo@marmaro.de>.
   2.355  
   2.356 -You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\f1.
   2.357 +You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\fR.
   2.358  There is also a mailing list, you will find information about it at masqmail's main site.
   2.359  
   2.360 +
   2.361  .SH BUGS
   2.362  
   2.363 -You should report them to the mailing list.
   2.364 +Please report them to the mailing list.
   2.365 +
   2.366  
   2.367  .SH SEE ALSO
   2.368  
   2.369 -\fBmasqmail.conf (5)\f1, \fBmasqmail.route (5)\f1, \fBmasqmail.get (5)\f1, \fBmasqmail.aliases (5)\f1
   2.370 -
   2.371 -.SH COMMENTS
   2.372 -
   2.373 -This man page was written using \fBxml2man (1)\f1 by the same author.
   2.374 -
   2.375 +\fBmasqmail.conf(5)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.get(5)\fR, \fBmasqmail.aliases(5)\fR

     3.1 --- a/docs/masqmail.aliases.5	Thu May 06 13:31:57 2010 +0200
     3.2 +++ b/docs/masqmail.aliases.5	Fri May 07 13:50:23 2010 +0200
     3.3 @@ -1,42 +1,54 @@
     3.4 -.TH masqmail.aliases 5 User Manuals
     3.5 +.TH masqmail.aliases 5 2010-05-07 masqmail-0.2.21 "File Formats"
     3.6 +
     3.7  .SH NAME
     3.8  masqmail.aliases \- masqmail alias file format
     3.9 +
    3.10 +
    3.11  .SH DESCRIPTION
    3.12  
    3.13 -This man page describes the format of the masqmail alias file. Its usual location is \fI/etc/aliases\f1.
    3.14 +This man page describes the format of the masqmail alias file.
    3.15 +Its usual location is \fI/etc/aliases\fR.
    3.16 +
    3.17  
    3.18  .SH FILE FORMAT
    3.19  
    3.20  The alias file consists of lines of the form:
    3.21  local_part: item1, item2, ...
    3.22 -Items can be surrounded by quotes '"'. If within the quotes other quotes are needed for an address they can be escaped with a leading backslash '\'.
    3.23 +Items can be surrounded by double quotes `"'.
    3.24 +If within the quotes other quotes are needed for an address they can be
    3.25 +escaped with a leading backslash `\\'.
    3.26  
    3.27 -A leading '\' indicates that this address shall not be further expanded.
    3.28 +A leading backslash `\\' indicates that this address shall not be further expanded.
    3.29  
    3.30 -A leading pipe symbol '|' indicates that the item shall be treated as a pipe command. The content of the message will then be sent to the standard input of a command. The command will run under the user id and group id masqmail is running as. If quotes are needed, the pipe symbol must appear within the quotes.
    3.31 +A leading pipe symbol `|' indicates that the item shall be treated as a pipe command.
    3.32 +The content of the message will then be sent to the standard input of a command.
    3.33 +The command will run under the user id and group id masqmail is running as.
    3.34 +If quotes are needed, the pipe symbol must appear within the quotes.
    3.35  
    3.36  Loops will be detected, the offending address will be ignored.
    3.37  
    3.38 -Aliases will be expanded at delivery time. This means that if there is a message still in the queue and you change any alias which matches one of the recipient addresses, the change will have effect next time a delivery is attemped.
    3.39 +Aliases will be expanded at delivery time.
    3.40 +This means that if there is a message still in the queue and you change
    3.41 +any alias which matches one of the recipient addresses,
    3.42 +the change will have effect next time a delivery is attemped.
    3.43  
    3.44  There is no need to restart masqmail or run any command when the alias file has been changed.
    3.45  
    3.46 +
    3.47  .SH AUTHOR
    3.48  
    3.49 -masqmail was written by Oliver Kurth. It is now maintained by Markus Schnalke <meillo@marmaro.de>.
    3.50 +Masqmail was written by Oliver Kurth.
    3.51 +It is now maintained by Markus Schnalke <meillo@marmaro.de>.
    3.52  
    3.53 -You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\f1.
    3.54 +You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\fR.
    3.55  There is also a mailing list, you will find information about it at masqmail's main site.
    3.56  
    3.57 +
    3.58  .SH BUGS
    3.59  
    3.60 -You should report them to the mailing list.
    3.61 +Please report bugs to the mailing list.
    3.62 +
    3.63  
    3.64  .SH SEE ALSO
    3.65  
    3.66 -\fBmasqmail.conf (5)\f1, \fBmasqmail (8)\f1, 
    3.67 -
    3.68 -.SH COMMENTS
    3.69 -
    3.70 -This man page was written using \fBxml2man (1)\f1 by the same author.
    3.71 -
    3.72 +\fBmasqmail.conf(5)\fR, \fBmasqmail(8)\fR, 

     4.1 --- a/docs/masqmail.conf.5	Thu May 06 13:31:57 2010 +0200
     4.2 +++ b/docs/masqmail.conf.5	Fri May 07 13:50:23 2010 +0200
     4.3 @@ -1,200 +1,290 @@
     4.4 -.TH masqmail.conf 5 User Manuals
     4.5 +.TH masqmail.conf 5 2010-05-07 masqmail-0.2.21 "File Formats"
     4.6 +
     4.7  .SH NAME
     4.8  masqmail.conf \- masqmail configuration file
     4.9 +
    4.10 +
    4.11  .SH DESCRIPTION
    4.12  
    4.13 -This man page describes the syntax of the main configuration file of masqmail. Its usual location is \fI/etc/masqmail/masqmail.conf\f1
    4.14 +This man page describes the syntax of the main configuration file of masqmail.
    4.15 +Its usual location is \fI/etc/masqmail/masqmail.conf\fR
    4.16  
    4.17  The configuration consists of lines of the form
    4.18  
    4.19 -\fBval\f1 = \fIexpression\f1
    4.20 +\fBval\fR = \fIexpression\fR
    4.21  
    4.22 -Where \fBval\f1 is a variable name and \fIexpression\f1 a string, which can be quoted with '"'. If the expression is on multiple lines or contains characters other than letters, digits or the characters '.', '-', '_', '/', it must be quoted. You can use quotes inside quotes by escaping them with a backslash.
    4.23 +Where \fBval\fR is a variable name and \fIexpression\fR a string,
    4.24 +which can be quoted with double quotes `"'.
    4.25 +If the expression is on multiple lines or contains characters other than letters,
    4.26 +digits or the characters `.', `-', `_', `/', it must be quoted.
    4.27 +You can use quotes inside quotes by escaping them with a backslash.
    4.28  
    4.29 -Each val has a type, which can be boolean, numeric, string or list. A boolean variable can be set with one of the values 'on', 'yes', and 'true' or 'off', 'no' and 'false'. List items are separated with ';'. For some values patterns (like '*','?') can be used. The spaces before and after the '=' are optional.
    4.30 +Each val has a type, which can be boolean, numeric, string or list.
    4.31 +A boolean variable can be set with one of the values `on', `yes', and `true' or `off', `no' and `false'.
    4.32 +List items are separated with semicolons `;'.
    4.33 +For some values patterns (like `*',`?') can be used.
    4.34 +The spaces before and after the equal sign `=' are optional.
    4.35  
    4.36 -Most lists (exceptions: \fBlocal_hosts\f1,\fBlocal_nets\f1, \fBlisten_addresses\f1, \fBonline_routes\f1 and \fBonline_gets\f1) accept files. These will be recognized by a leading slash '/'. The contents of these files will be included at the position of the file name, there can be items or other files before and after the file entry. The format of the files is different though, within these files each entry is on another line. (And not separated by semicolons). This makes it easy to include large lists which are common in different configuration files, so they do not have to appear in every configuration file.
    4.37 +Most lists (exceptions: \fBlocal_hosts\fR, \fBlocal_nets\fR, \fBlisten_addresses\fR,
    4.38 +\fBonline_routes\fR, and \fBonline_gets\fR) accept files.
    4.39 +These will be recognized by a leading slash `/'.
    4.40 +The contents of these files will be included at the position of the file name,
    4.41 +there can be items or other files before and after the file entry.
    4.42 +The format of the files is different though, within these files each entry is on another line.
    4.43 +(And not separated by semicolons).
    4.44 +This makes it easy to include large lists which are common in different configuration files,
    4.45 +so they do not have to appear in every configuration file.
    4.46  
    4.47 -Blank lines and lines starting with '#' are ignored.
    4.48 +Blank lines and lines starting with a hash `#' are ignored.
    4.49 +
    4.50  
    4.51  .SH OPTIONS
    4.52 +
    4.53  .TP
    4.54 +\fBrun_as_user = \fIboolean\fR
    4.55  
    4.56 -\fBrun_as_user = \fIboolean\f1\fB\f1
    4.57 +If this is set, masqmail runs with the user id of the user who invoked it and never changes it.
    4.58 +This is for debugging purposes only.
    4.59 +If the user is not root, masqmail will not be able to listen on a port < 1024
    4.60 +and will not be able to deliver local mail to others than the user.
    4.61  
    4.62 -If this is set, masqmail runs with the user id of the user who invoked it and never changes it. This is for debugging purposes only. If the user is not root, masqmail will not be able to listen on a port < 1024 and will not be able to deliver local mail to others than the user.
    4.63  .TP
    4.64 +\fBuse_syslog = \fIboolean\fR
    4.65  
    4.66 -\fBuse_syslog = \fIboolean\f1\fB\f1
    4.67 +If this is set, masqmail uses syslogd for logging.
    4.68 +It uses facility MAIL.
    4.69 +You still have to set \fBlog_dir\fR for debug files.
    4.70  
    4.71 -If this is set, masqmail uses syslogd for logging. It uses facility MAIL. You still have to set \fBlog_dir\f1 for debug files.
    4.72  .TP
    4.73 +\fBdebug_level = \fIn\fR
    4.74  
    4.75 -\fBdebug_level = \fIn\f1\fB\f1
    4.76 +Set the debug level.
    4.77 +Valid values are 0 to 6, increasing it further makes no difference.
    4.78 +Be careful if you set this as high as 5 or higher, the logs may very soon fill your hard drive.
    4.79  
    4.80 -Set the debug level. Valid values are 0 to 6, increasing it further makes no difference. Be careful if you set this as high as 5 or higher, the logs may very soon fill your hard drive.
    4.81  .TP
    4.82 +\fBmail_dir = \fIfile\fR
    4.83  
    4.84 -\fBmail_dir = \fIfile\f1\fB\f1
    4.85 +The directory where local mail is stored, usually \fI/var/spool/mail\fR or \fI/var/mail\fR.
    4.86  
    4.87 -The directory where local mail is stored, usually \fI/var/spool/mail\f1 or \fI/var/mail\f1.
    4.88  .TP
    4.89 +\fBspool_dir = \fIfile\fR
    4.90  
    4.91 -\fBspool_dir = \fIfile\f1\fB\f1
    4.92 +The directory where masqmail stores its spool files (and later also other stuff).
    4.93 +It must have a subdirectory \fIinput\fR.
    4.94 +Masqmail needs read and write permissions for this directory.
    4.95 +I suggest to use \fI/var/spool/masqmail\fR.
    4.96  
    4.97 -The directory where masqmail stores its spool files (and later also other stuff). It must have a subdirectory \fIinput\f1. Masqmail needs read and write permissions for this directory. I suggest to use \fI/var/spool/masqmail\f1.
    4.98  .TP
    4.99 +\fBhost_name = \fIstring\fR
   4.100  
   4.101 -\fBhost_name = \fIstring\f1\fB\f1
   4.102 +This is used in different places: Masqmail identifies itself in the greeting banner
   4.103 +on incoming connections and in the HELO/EHLO command for outgoing connections with this name,
   4.104 +it is used in the Received: header and to qualify the sender of a locally originating message.
   4.105  
   4.106 -This is used in different places: Masqmail identifies itself in the greeting banner on incoming connections and in the HELO/EHLO command for outgoing connections with this name, it is used in the Received: header and to qualify the sender of a locally originating message.
   4.107 +If the string begins with a slash `/', it it assumed that it is a filename,
   4.108 +and the first line of this file will be used.
   4.109 +Usually this will be `/etc/mailname' to make masqmail conform to Debian policies.
   4.110  
   4.111 -If the string begins with a slash '/', it it assumed that it is a filename, and the first line of this file will be used. Usually this will be '/etc/mailname' to make masqmail conform to Debian policies.
   4.112 +It is not used to find whether an address is local. Use \fBlocal_hosts\fR for that.
   4.113  
   4.114 -It is not used to find whether an address is local. Use \fBlocal_hosts\f1 for that.
   4.115  .TP
   4.116 -
   4.117 -\fBremote_port = \fIn\f1\fB\f1
   4.118 +\fBremote_port = \fIn\fR
   4.119  
   4.120  The remote port number to be used. This defaults to port 25.
   4.121  
   4.122 -This option is deprecated. Use \fBhost_name\f1 in the route configuration instead. See \fBmasqmail.route (5)\f1.
   4.123 +This option is deprecated.
   4.124 +Use \fBhost_name\fR in the route configuration instead.
   4.125 +See \fBmasqmail.route(5)\fR.
   4.126 +
   4.127  .TP
   4.128 +\fBlocal_hosts = \fIlist\fR
   4.129  
   4.130 -\fBlocal_hosts = \fIlist\f1\fB\f1
   4.131 +A semicolon `;' separated list of hostnames which are considered local.
   4.132 +Normally you set it to "localhost;foo;foo.bar.com" if your host has the
   4.133 +fully qualified domain name `foo.bar.com'.
   4.134  
   4.135 -A semicolon ';' separated list of hostnames which are considered local. Normally you set it to "localhost;foo;foo.bar.com" if your host has the fully qualified domain name 'foo.bar.com'.
   4.136  .TP
   4.137 +\fBlocal_nets = \fIlist\fR
   4.138  
   4.139 -\fBlocal_nets = \fIlist\f1\fB\f1
   4.140 +A semicolon `;' separated list of hostnames which are on the `local' net.
   4.141 +Delivery to these hosts is attempted immediately.
   4.142 +You can use patterns with `*', e.g. "*.bar.com".
   4.143  
   4.144 -A semicolon ';' separated list of hostnames which are on the 'local' net. Delivery to these hosts is attempted immediately. You can use patterns with '*', eg. "*.bar.com".
   4.145  .TP
   4.146 +\fBlocal_addresses = \fIlist\fR
   4.147  
   4.148 -\fBlocal_addresses = \fIlist\f1\fB\f1
   4.149 +A semicolon `;' separated list of fully qualified email-addresses which are
   4.150 +considered local although their domain name part is not in the list of \fBlocal_hosts\fR. 
   4.151  
   4.152 -A semicolon ';' separated list of fully qualified email-addresses which are considered local although their domain name part is not in the list of \fBlocal_hosts\f1. 
   4.153 -
   4.154 -For example: There are two people working at your LAN: person1@yourdomain and person2@yourdomain. But there are other persons @yourdomain which are NOT local. So you can not put yourdomain to the list of local_hosts. If person1 now wants to write to person2@yourdomain and this mail should not leave the LAN then you can put
   4.155 +For example: There are two people working at your LAN: person1@yourdomain and person2@yourdomain.
   4.156 +But there are other persons @yourdomain which are NOT local.
   4.157 +So you can not put yourdomain to the list of local_hosts.
   4.158 +If person1 now wants to write to person2@yourdomain and this mail should not leave the LAN then you can put
   4.159  
   4.160  local_addresses = "person1@yourdomain;person2@yourdomain"
   4.161  
   4.162  to your masqmail.conf.
   4.163 +
   4.164  .TP
   4.165 +\fBnot_local_addresses = \fIlist\fR
   4.166  
   4.167 -\fBnot_local_addresses = \fIlist\f1\fB\f1
   4.168 +A semicolon `;' separated list of fully qualified email-addresses which are
   4.169 +considered not local although their domain name part is in the list of \fBlocal_hosts\fR. 
   4.170  
   4.171 -A semicolon ';' separated list of fully qualified email-addresses which are considered not local although their domain name part is in the list of \fBlocal_hosts\f1. 
   4.172 -
   4.173 -This is the opposite of the previous case. The majority of addresses of a specific domain are local. But some users are not. With this option you can easily exclude these users.
   4.174 +This is the opposite of the previous case.
   4.175 +The majority of addresses of a specific domain are local.
   4.176 +But some users are not.
   4.177 +With this option you can easily exclude these users.
   4.178  
   4.179  Example:
   4.180  
   4.181  local_hosts = "localhost;myhost;mydomain.net"
   4.182  
   4.183  not_local_addresses = "eric@mydomain.net"
   4.184 +
   4.185  .TP
   4.186 +\fBlisten_addresses = \fIlist\fR
   4.187  
   4.188 -\fBlisten_addresses = \fIlist\f1\fB\f1
   4.189 +A semicolon `;' separated list of interfaces on which connections will be accepted.
   4.190 +An interface ist defined by a hostname, optionally followed by a colon `:' and a number for the port.
   4.191 +If this is left out, port 25 will be used.
   4.192  
   4.193 -A semicolon ';' separated list of interfaces on which connections will be accepted. An interface ist defined by a hostname, optionally followed by a colon ':' and a number for the port. If this is left out, port 25 will be used.
   4.194 +You can set this to "localhost:25;foo:25" if your hostname is `foo'.
   4.195  
   4.196 -You can set this to "localhost:25;foo:25" if your hostname is 'foo'.
   4.197 +Note that the names are resolved to IP addreses.
   4.198 +If your host has different names which resolve to the same IP,
   4.199 +use only one of them, otherwise you will get an error message.
   4.200  
   4.201 -Note that the names are resolved to IP addreses. If your host has different names which resolve to the same IP, use only one of them, otherwise you will get an error message.
   4.202  .TP
   4.203 +\fBdo_save_envelope_to = \fIboolean\fR
   4.204  
   4.205 -\fBdo_save_envelope_to = \fIboolean\f1\fB\f1
   4.206 +If this is set to true, a possibly existing Envelope-to: header in an incoming mail
   4.207 +which is received via either pop3 or smtp will be saved as an X-Orig-Envelope-to: header.
   4.208  
   4.209 -If this is set to true, a possibly existing Envelope-to: header in an incoming mail which is received via either pop3 or smtp will be saved as an X-Orig-Envelope-to: header.
   4.210 -
   4.211 -This is useful if you retrieve mail from a pop3 server with either masqmail or fetchmail, and the server supports Envelope-to: headers, and you want to make use of those with a mail filtering tool, eg. procmail. It cannot be preserved because masqmail sets such a header by itself.
   4.212 +This is useful if you retrieve mail from a pop3 server with either masqmail or fetchmail,
   4.213 +and the server supports Envelope-to: headers,
   4.214 +and you want to make use of those with a mail filtering tool, e.g. procmail.
   4.215 +It cannot be preserved because masqmail sets such a header by itself.
   4.216  
   4.217  Default is false.
   4.218 +
   4.219  .TP
   4.220 +\fBdo_relay = \fIboolean\fR
   4.221  
   4.222 -\fBdo_relay = \fIboolean\f1\fB\f1
   4.223 +If this is set to false, mail with a return path that is not local and a destination
   4.224 +that is also not local will not be accepted via smtp and a 550 reply will be given.
   4.225 +Default is true.
   4.226  
   4.227 -If this is set to false, mail with a return path that is not local and a destination that is also not local will not be accepted via smtp and a 550 reply will be given. Default is true.
   4.228 +Note that this will not protect you from spammers using open relays,
   4.229 +but from users unable to set their address in their mail clients.
   4.230  
   4.231 -Note that this will not protect you from spammers using open relays, but from users unable to set their address in their mail clients.
   4.232  .TP
   4.233 +\fBdo_queue = \fIboolean\fR
   4.234  
   4.235 -\fBdo_queue = \fIboolean\f1\fB\f1
   4.236 +If this is set, mail will not be delivered immediately when accepted.
   4.237 +Same as calling masqmail with the \fB\-odq\fR option.
   4.238  
   4.239 -If this is set, mail will not be delivered immediately when accepted. Same as calling masqmail with the \fB\-odq\f1 option.
   4.240  .TP
   4.241 +\fBonline_routes.\fIname\fR = \fIlist\fR
   4.242  
   4.243 -\fBonline_routes.\fIname\f1\fB = \fIlist\f1\fB\f1
   4.244 +Replace \fIname\fR with a name to identify a connection.
   4.245 +Set this to a filename (or a list of filenames) for the special route configuration for that connection.
   4.246 +You will use that name to call masqmail with the \fB\-qo\fR option every time a
   4.247 +connection to your ISP is set up.
   4.248  
   4.249 -Replace \fIname\f1 with a name to identify a connection. Set this to a filename (or a list of filenames) for the special route configuration for that connection. You will use that name to call masqmail with the \fB\-qo\f1 option every time a connection to your ISP is set up.
   4.250 +Example: Your ISP has the name FastNet.
   4.251 +Then you write the following line in the main configuration:
   4.252  
   4.253 -Example: Your ISP has the name FastNet. Then you write the following line in the main configuration:
   4.254 +\fBonline_routes.FastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
   4.255  
   4.256 -\fBonline_routes.FastNet\f1 = \fI"/etc/masqmail/fastnet.route"\f1
   4.257 +\fI/etc/masqmail/fastnet.route\fR is the route configuration file, see \fBmasqmail.route(5)\fR.
   4.258 +As soon as a link to FastNet has been set up, you call masqmail \fB\-qo \fIFastNet\fR.
   4.259 +Masqmail will then read the specified file and send the mails.
   4.260  
   4.261 -\fI/etc/masqmail/fastnet.route\f1 is the route configuration file, see \fBmasqmail.route (5)\f1. As soon as a link to FastNet has been set up, you call masqmail \fB\-qo\f1 \fIFastNet\f1. Masqmail will then read the specified file and send the mails.
   4.262  .TP
   4.263 +\fBconnect_route.\fIname\fR = \fIlist\fR
   4.264  
   4.265 -\fBconnect_route.\fIname\f1\fB = \fIlist\f1\fB\f1
   4.266 +Old name for \fBonline_routes\fR.
   4.267  
   4.268 -Old name for \fBonline_routes\f1.
   4.269  .TP
   4.270 +\fBlocal_net_route = \fIfile\fR
   4.271  
   4.272 -\fBlocal_net_route = \fIfile\f1\fB\f1
   4.273 +This is similar to \fBonline_routes.\fIname\fR but for the local net.
   4.274 +Recipient addresses that are in local_nets will be routed using this route configuration.
   4.275 +Main purpose is to define a mail server with mail_host in your local network.
   4.276 +In simple environments this can be left unset.
   4.277 +If unset, a default route configuration will be used.
   4.278  
   4.279 -This is similar to \fBonline_routes.\fIname\f1\fB\f1 but for the local net. Recipient addresses that are in local_nets will be routed using this route configuration. Main purpose is to define a mail server with mail_host in your local network. In simple environments this can be left unset. If unset, a default route configuration will be used.
   4.280  .TP
   4.281 +\fBalias_file = \fIfile\fR
   4.282  
   4.283 -\fBalias_file = \fIfile\f1\fB\f1
   4.284 +Set this to the location of your alias file.
   4.285 +If unset, no aliasing will be done.
   4.286  
   4.287 -Set this to the location of your alias file. If unset, no aliasing will be done.
   4.288  .TP
   4.289 -
   4.290 -\fBalias_local_caseless = \fIboolean\f1\fB\f1
   4.291 +\fBalias_local_caseless = \fIboolean\fR
   4.292  
   4.293  If this is set, local parts in the alias file will be matched disregarding upper/lower case.
   4.294 +
   4.295  .TP
   4.296 +\fBpipe_fromline = \fIboolean\fR
   4.297  
   4.298 -\fBpipe_fromline = \fIboolean\f1\fB\f1
   4.299 +If this is set, a from line will be prepended to the output stream whenever
   4.300 +a pipe command is called after an alias expansion.
   4.301 +Default is false.
   4.302  
   4.303 -If this is set, a from line will be prepended to the output stream whenever a pipe command is called after an alias expansion. Default is false.
   4.304  .TP
   4.305 +\fBpipe_fromhack = \fIboolean\fR
   4.306  
   4.307 -\fBpipe_fromhack = \fIboolean\f1\fB\f1
   4.308 +If this is set, each line beginning with `From ' is replaced with `>From '
   4.309 +whenever a pipe command is called after an alias expansion.
   4.310 +You probably want this if you have set \fBpipe_fromline\fR above.
   4.311 +Default is false.
   4.312  
   4.313 -If this is set, each line beginning with 'From ' is replaced with '>From ' whenever a pipe command is called after an alias expansion. You probably want this if you have set \fBpipe_fromline\f1 above. Default is false.
   4.314  .TP
   4.315 +\fBmbox_default = \fIstring\fR
   4.316  
   4.317 -\fBmbox_default = \fIstring\f1\fB\f1
   4.318 +The default local delivery method.
   4.319 +Can be one of mbox, mda or maildir (the latter only if maildir support is enabled at compile time).
   4.320 +Default is mbox.
   4.321 +You can override this for each user by using the \fBmbox_users\fR, \fBmda_users\fR,
   4.322 +or \fBmaildir_users\fR options (see below).
   4.323  
   4.324 -The default local delivery method. Can be one of mbox, mda or maildir (the latter only if maildir support is enabled at compile time). Default is mbox. You can override this for each user by using the \fBmbox_users\f1, \fBmda_users\f1 or \fBmaildir_users\f1 options (see below).
   4.325  .TP
   4.326 -
   4.327 -\fBmbox_users = \fIlist\f1\fB\f1
   4.328 +\fBmbox_users = \fIlist\fR
   4.329  
   4.330  A list of users which wish delivery to an mbox style mail folder.
   4.331 +
   4.332  .TP
   4.333 +\fBmda_users = \fIlist\fR
   4.334  
   4.335 -\fBmda_users = \fIlist\f1\fB\f1
   4.336 +A list of users which wish local delivery to an mda.
   4.337 +You have to set \fBmda\fR (see below) as well.
   4.338  
   4.339 -A list of users which wish local delivery to an mda. You have to set \fBmda\f1 (see below) as well.
   4.340  .TP
   4.341 +\fBmaildir_users = \fIlist\fR
   4.342  
   4.343 -\fBmaildir_users = \fIlist\f1\fB\f1
   4.344 +A list of users which wish delivery to a qmail style maildir.
   4.345 +The path to maildir is ~/Maildir/.
   4.346 +The maildir will be created if it does not exist.
   4.347  
   4.348 -A list of users which wish delivery to a qmail style maildir. The path to maildir is ~/Maildir/. The maildir will be created if it does not exist.
   4.349  .TP
   4.350 +\fBmda = \fIexpand string\fR
   4.351  
   4.352 -\fBmda = \fIexpand string\f1\fB\f1
   4.353 +If you want local delivery to be transferred to an mda (Mail Delivery Agent),
   4.354 +set this to a command.
   4.355 +The argument will be expanded on delivery time,
   4.356 +you can use variables beginning with a dolloar sign `$', optionally enclosed in curly braces.
   4.357 +Variables you can use are:
   4.358  
   4.359 -If you want local delivery to be transferred to an mda (Mail Delivery Agent), set this to a command. The argument will be expanded on delivery time, you can use variables beginning with a '$' sign, optionally enclosed in curly braces. Variables you can use are:
   4.360 -
   4.361 -uid - the unique message id. This is not necessarily identical with the Message ID as given in the Message ID: header.
   4.362 +uid - the unique message id.
   4.363 +This is not necessarily identical with the Message ID as given in the Message ID: header.
   4.364  
   4.365  received_host - the host the mail was received from
   4.366  
   4.367 -ident - the ident, this is either the ident delivered by the ident protocol or the user id of the sender if the message was received locally.
   4.368 +ident - the ident, this is either the ident delivered by the ident protocol
   4.369 +or the user id of the sender if the message was received locally.
   4.370  
   4.371  return_path_local - the local part of the return path (sender).
   4.372  
   4.373 @@ -212,46 +302,69 @@
   4.374  
   4.375  mda="/usr/bin/procmail \-Y \-d ${rcpt_local}"
   4.376  
   4.377 -For the mda, as for pipe commands, a few environment variables will be set as well. See \fBmasqmail (8)\f1. To use environment variables for the mda, the '$' sign has to be escaped with a backslash, otherwise they will be tried to be expanded with the internal variables.
   4.378 +For the mda, as for pipe commands, a few environment variables will be set as well.
   4.379 +See \fBmasqmail(8)\fR.
   4.380 +To use environment variables for the mda, the dollar sign `$' has to be escaped with a backslash,
   4.381 +otherwise they will be tried to be expanded with the internal variables.
   4.382 +
   4.383  .TP
   4.384 +\fBmda_fromline = \fIboolean\fR
   4.385  
   4.386 -\fBmda_fromline = \fIboolean\f1\fB\f1
   4.387 +If this is set, a from line will be prepended to the output stream whenever
   4.388 +a message is delivered to an mda.
   4.389 +Default is false.
   4.390  
   4.391 -If this is set, a from line will be prepended to the output stream whenever a message is delivered to an mda. Default is false.
   4.392  .TP
   4.393 +\fBmda_fromhack = \fIboolean\fR
   4.394  
   4.395 -\fBmda_fromhack = \fIboolean\f1\fB\f1
   4.396 +If this is set, each line beginning with `From ' is replaced with `>From '
   4.397 +whenever a message is delivered to an mda.
   4.398 +You probably want this if you have set \fBmda_fromline\fR above.
   4.399 +Default is false.
   4.400  
   4.401 -If this is set, each line beginning with 'From ' is replaced with '>From ' whenever a message is delivered to an mda. You probably want this if you have set \fBmda_fromline\f1 above. Default is false.
   4.402  .TP
   4.403 +\fBonline_detect = \fIstring\fR
   4.404  
   4.405 -\fBonline_detect = \fIstring\f1\fB\f1
   4.406 +Defines the method masqmail uses to detect whether there is currently an online connection.
   4.407 +It can have the values \fBfile\fR, \fBpipe\fR, or \fBmserver\fR.
   4.408  
   4.409 -Defines the method MasqMail uses to detect whether there is currently an online connection. It can have the values \fBfile\f1, \fBpipe\f1 or \fBmserver\f1.
   4.410 +When it is set to \fBfile\fR, masqmail first checks for the existence of \fBonline_file\fR
   4.411 +(see below) and if it exists, it reads it.
   4.412 +The content of the file should be the name of the current connection as defined
   4.413 +with \fBconnect_route.\fIname\fR (trailing whitespace is removed).
   4.414  
   4.415 -When it is set to \fBfile\f1, MasqMail first checks for the existence of \fBonline_file\f1 (see below) and if it exists, it reads it. The content of the file should be the name of the current connection as defined with \fBconnect_route.\fIname\f1\fB\f1 (trailing whitespace is removed).
   4.416 +When it is set to \fBpipe\fR, masqmail calls the executable given by the
   4.417 +\fBonline_pipe\fR option (see below) and reads the current online status from its standard output.
   4.418  
   4.419 -When it is set to \fBpipe\f1, MasqMail calls the executable given by the \fBonline_pipe\f1 option (see below) and reads the current online status from its standard output.
   4.420 +When it is set to \fBmserver\fR, masqmail connects to the masqdialer server
   4.421 +using the value of \fBmserver_iface\fR and asks it whether a connection exists and for the name,
   4.422 +which should be the name of the current connection as defined with \fBconnect_route.\fIname\fR.
   4.423  
   4.424 -When it is set to \fBmserver\f1, MasqMail connects to the masqdialer server using the value of \fBmserver_iface\f1 and asks it whether a connection exists and for the name, which should be the name of the current connection as defined with \fBconnect_route.\fIname\f1\fB\f1.
   4.425 +No matter how masqmail detects the online status,
   4.426 +only messages that are accepted at online time will be delivered using the connection.
   4.427 +The spool still has to be emptied with masqmail \fB\-qo\fIconnection\fR.
   4.428  
   4.429 -No matter how MasqMail detects the online status, only messages that are accepted at online time will be delivered using the connection. The spool still has to be emptied with masqmail \fB\-qo\f1\fIconnection\f1.
   4.430  .TP
   4.431 +\fBonline_file = \fIfile\fR
   4.432  
   4.433 -\fBonline_file = \fIfile\f1\fB\f1
   4.434 -
   4.435 -This is the name of the file checked for when MasqMail determines whether it is online. The file should only exist when there is currently a connection. Create it in your ip-up script with eg.
   4.436 +This is the name of the file checked for when masqmail determines whether it is online.
   4.437 +The file should only exist when there is currently a connection.
   4.438 +Create it in your ip-up script with e.g.
   4.439  
   4.440  echo \-n <name> > /tmp/connect_route
   4.441  
   4.442  chmod 0644 /tmp/connect_route
   4.443  
   4.444  Do not forget to delete it in your ip-down script.
   4.445 +
   4.446  .TP
   4.447 +\fBonline_pipe = \fIfile\fR
   4.448  
   4.449 -\fBonline_pipe = \fIfile\f1\fB\f1
   4.450 -
   4.451 -This is the name of the executable which will be called to determine the online status. This executable should just print the name of the current connection to the standard output and return a zero status code. masqmail assumes it is offline if the script returns with a non zero status. Simple example:
   4.452 +This is the name of the executable which will be called to determine the online status.
   4.453 +This executable should just print the name of the current connection to
   4.454 +the standard output and return a zero status code.
   4.455 +masqmail assumes it is offline if the script returns with a non zero status.
   4.456 +Simple example:
   4.457  
   4.458  #!/bin/sh
   4.459  
   4.460 @@ -261,84 +374,109 @@
   4.461  
   4.462  exit 0
   4.463  
   4.464 -Of course, instead of the example above you could as well use \fBfile\f1 as the online detection method, but you can do something more sophisticated.
   4.465 +Of course, instead of the example above you could as well use \fBfile\fR as
   4.466 +the online detection method, but you can do something more sophisticated.
   4.467 +
   4.468  .TP
   4.469 +\fBmserver_iface = \fIinterface\fR
   4.470  
   4.471 -\fBmserver_iface = \fIinterface\f1\fB\f1
   4.472 +The interface the masqdialer server is listening to.
   4.473 +Usually this will be "localhost:224" if mserver is running on the same host as masqmail.
   4.474 +But using this option, you can also let masqmail run on another host by setting
   4.475 +\fBmserver_iface\fR to another hostname, e.g. "foo:224".
   4.476  
   4.477 -The interface the masqdialer server is listening to. Usually this will be "localhost:224" if mserver is running on the same host as masqmail. But using this option, you can also let masqmail run on another host by setting \fBmserver_iface\f1 to another hostname, eg. "foo:224".
   4.478  .TP
   4.479 +\fBget.\fIname\fR = \fIfile\fR
   4.480  
   4.481 -\fBget.\fIname\f1\fB = \fIfile\f1\fB\f1
   4.482 +Replace \fIname\fR with a name to identify a get configuration.
   4.483 +Set this to a filename for the get configuration.
   4.484 +These files will be used to retrieve mail when called with the \-g option.
   4.485  
   4.486 -Replace \fIname\f1 with a name to identify a get configuration. Set this to a filename for the get configuration. These files will be used to retrieve mail when called with the \-g option.
   4.487  .TP
   4.488 +\fBonline_gets.\fIname\fR = \fIlist\fR
   4.489  
   4.490 -\fBonline_gets.\fIname\f1\fB = \fIlist\f1\fB\f1
   4.491 +Replace \fIname\fR with a name to identify an online configuration.
   4.492 +Set this to a filename (or a list of filenames) for the get configuration.
   4.493 +These files will be used to retrieve mail when called with the \-go option.
   4.494  
   4.495 -Replace \fIname\f1 with a name to identify an online configuration. Set this to a filename (or a list of filenames) for the get configuration. These files will be used to retrieve mail when called with the \-go option.
   4.496  .TP
   4.497 +\fBident_trusted_nets = \fIlist\fR
   4.498  
   4.499 -\fBident_trusted_nets = \fIlist\f1\fB\f1
   4.500 +\fIlist\fR is a list of networks of the form a.b.c.d/e (e.g. 192.168.1.0/24),
   4.501 +from which the ident given by the ident protocol will be trusted,
   4.502 +so a user can delete his mail from the queue if the ident is identical to his login name.
   4.503  
   4.504 -\fIlist\f1 is a list of networks of the form a.b.c.d/e (eg. 192.168.1.0/24), from which the ident given by the ident protocol will be trusted, so a user can delete his mail from the queue if the ident is identical to his login name.
   4.505  .TP
   4.506 +\fBerrmsg_file = \fIfile\fR
   4.507  
   4.508 -\fBerrmsg_file = \fIfile\f1\fB\f1
   4.509 -
   4.510 -Set this to a template which will be used to generate delivery failure reports. Variable parts within the template begin with a dollar sign and are identical to those which can be used as arguments for the mda command, see \fBmda\f1 above. Additional information can be included with @failed_rcpts, @msg_headers and @msg_body, these must be at the beginning of a line and will be replaced with the list of the failed recipients, the message headers and the message body of the failed message.
   4.511 +Set this to a template which will be used to generate delivery failure reports.
   4.512 +Variable parts within the template begin with a dollar sign and are identical
   4.513 +to those which can be used as arguments for the mda command, see \fBmda\fR above.
   4.514 +Additional information can be included with @failed_rcpts, @msg_headers and @msg_body,
   4.515 +these must be at the beginning of a line and will be replaced with the list of the failed recipients,
   4.516 +the message headers and the message body of the failed message.
   4.517  
   4.518  Default is /usr/share/masqmail/tpl/failmsg.tpl.
   4.519 +
   4.520  .TP
   4.521 +\fBwarnmsg_file = \fIfile\fR
   4.522  
   4.523 -\fBwarnmsg_file = \fIfile\f1\fB\f1
   4.524 -
   4.525 -Set this to a template which will be used to generate delivery warning reports. It uses the same mechanisms for variables as \fBerrmsg_file\f1, see above.
   4.526 +Set this to a template which will be used to generate delivery warning reports.
   4.527 +It uses the same mechanisms for variables as \fBerrmsg_file\fR, see above.
   4.528  
   4.529  Default is /usr/share/masqmail/tpl/warnmsg.tpl.
   4.530 +
   4.531  .TP
   4.532 +\fBwarn_intervals\fR = \fIlist\fR
   4.533  
   4.534 -\fBwarn_intervals\f1 = \fIlist\f1
   4.535 +Set this to a list of time intervals, at which delivery warnings
   4.536 +(starting with the receiving time of the message) shall be generated.
   4.537  
   4.538 -Set this to a list of time intervals, at which delivery warnings (starting with the receiving time of the message) shall be generated.
   4.539 -
   4.540 -A warning will only be generated just after an attempt to deliver the mail and if that attempt failed temporarily. So a warning may be generated after a longer time, if there was no attempt before.
   4.541 +A warning will only be generated just after an attempt to deliver the mail
   4.542 +and if that attempt failed temporarily.
   4.543 +So a warning may be generated after a longer time, if there was no attempt before.
   4.544  
   4.545  Default is "1h;4h;8h;1d;2d;3d"
   4.546 +
   4.547  .TP
   4.548 +\fBmax_defer_time\fR = \fItime\fR
   4.549  
   4.550 -\fBmax_defer_time\f1 = \fItime\f1
   4.551 +This is the maximum time, in which a temporarily failed mail will be kept in the spool.
   4.552 +When this time is exceeded, it will be handled as a delivery failure,
   4.553 +and the message will be bounced.
   4.554  
   4.555 -This is the maximum time, in which a temporarily failed mail will be kept in the spool. When this time is exceeded, it will be handled as a delivery failure, and the message will be bounced.
   4.556 -
   4.557 -The excedence of this time will only be noticed if the message was actually tried to be delivered. If, for example, the message can only be delivered when online, but you have not been online for that time, no bounce will be generated.
   4.558 +The excedence of this time will only be noticed if the message was actually tried to be delivered.
   4.559 +If, for example, the message can only be delivered when online,
   4.560 +but you have not been online for that time, no bounce will be generated.
   4.561  
   4.562  Default is 4d (4 days)
   4.563 +
   4.564  .TP
   4.565 +\fBlog_user = \fIname\fR
   4.566  
   4.567 -\fBlog_user = \fIname\f1\fB\f1
   4.568 +Replace \fIname\fR with a valid local or remote mail address.
   4.569  
   4.570 -Replace \fIname\f1 with a valid local or remote mail address.
   4.571 +If this option is not empty, then a copy of every mail,
   4.572 +that passes trough the masqmail system will also be sent to the given mail address.
   4.573  
   4.574 -If this option is not empty, then a copy of every mail, that passes trough the masqmail system will also be sent to the given mail address.
   4.575 +For example you can feed your mails into a program like hypermail
   4.576 +for archiving purpose by placing an appropriate pipe command in masqmail.alias
   4.577  
   4.578 -For example you can feed your mails into a program like hypermail for archiving purpose by placing an appropriate pipe command in masqmail.alias
   4.579 +
   4.580  .SH AUTHOR
   4.581  
   4.582 -masqmail was written by Oliver Kurth. It is now maintained by Markus Schnalke <meillo@marmaro.de>.
   4.583 +Masqmail was written by Oliver Kurth.
   4.584 +It is now maintained by Markus Schnalke <meillo@marmaro.de>.
   4.585  
   4.586 -You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\f1.
   4.587 +You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\fR.
   4.588  There is also a mailing list, you will find information about it at masqmail's main site.
   4.589  
   4.590 +
   4.591  .SH BUGS
   4.592  
   4.593 -You should report them to the mailing list.
   4.594 +Please report bugs to the mailing list.
   4.595 +
   4.596  
   4.597  .SH SEE ALSO
   4.598  
   4.599 -\fBmasqmail (8)\f1, \fBmasqmail.route (5)\f1, \fBmasqmail.get (5)\f1
   4.600 -
   4.601 -.SH COMMENTS
   4.602 -
   4.603 -This man page was written using \fBxml2man (1)\f1 by the same author.
   4.604 -
   4.605 +\fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.get(5)\fR

     5.1 --- a/docs/masqmail.get.5	Thu May 06 13:31:57 2010 +0200
     5.2 +++ b/docs/masqmail.get.5	Fri May 07 13:50:23 2010 +0200
     5.3 @@ -1,100 +1,134 @@
     5.4 -.TH masqmail.get 5 User Manuals
     5.5 +.TH masqmail.get 5 2010-05-07 masqmail-0.2.21 "File Formats"
     5.6 +
     5.7  .SH NAME
     5.8  masqmail.get \- masqmail get configuration file
     5.9 +
    5.10 +
    5.11  .SH DESCRIPTION
    5.12   
    5.13  This man page describes the options available for the masqmail get configuration.
    5.14  
    5.15 +
    5.16  .SH OPTIONS
    5.17 +
    5.18  .TP
    5.19 +\fBprotocol\fR = \fIstring\fR
    5.20  
    5.21 -\fBprotocol\f1 = \fIstring\f1
    5.22 +The protocol with which you retrieve your mail.
    5.23 +Currently only `pop3' and `apop' are supported.
    5.24 +There is no default.
    5.25  
    5.26 -The protocol with which you retrieve your mail. Currently only 'pop3' and 'apop' are supported. There is no default.
    5.27  .TP
    5.28 -
    5.29 -\fBserver\f1 = \fIstring\f1
    5.30 +\fBserver\fR = \fIstring\fR
    5.31  
    5.32  The server you get your mail from.
    5.33 +
    5.34  .TP
    5.35 +\fBresolve_list\fR = \fIlist\fR
    5.36  
    5.37 -\fBresolve_list\f1 = \fIlist\f1
    5.38 +Specify the method how the domain of the server is resolved.
    5.39 +Possible values are dns_mx, dns_a, byname.
    5.40 +For `dns_mx', the domain is assumed to be an MX pointer to a list of host names,
    5.41 +these will be tried each in order
    5.42 +(lowest preference value first, equal preference values in random order).
    5.43 +For `dns_a', the domain is assumed to be an A pointer.
    5.44 +For `byname', the library function \fBgethostbyname(3)\fR will be used.
    5.45  
    5.46 -Specify the method how the domain of the server is resolved. Possible values are dns_mx, dns_a, byname. For 'dns_mx', the domain is assumed to be an MX pointer to a list of host names, these will be tried each in order (lowest preference value first, equal preference values in random order). For 'dns_a', the domain is assumed to be an A pointer. For 'byname', the library function \fBgethostbyname (3)\f1 will be used.
    5.47 +The default is "dns_a;byname".
    5.48 +It does not make much sense here to use `dns_mx'.
    5.49  
    5.50 -The default is "dns_a;byname". It does not make much sense here to use 'dns_mx'.
    5.51  .TP
    5.52 -
    5.53 -\fBuser\f1 = \fIstring\f1
    5.54 +\fBuser\fR = \fIstring\fR
    5.55  
    5.56  Your login name.
    5.57 +
    5.58  .TP
    5.59 -
    5.60 -\fBpass\f1 = \fIstring\f1
    5.61 +\fBpass\fR = \fIstring\fR
    5.62  
    5.63  Your password.
    5.64 +
    5.65  .TP
    5.66 +\fBaddress\fR = \fIaddress\fR
    5.67  
    5.68 -\fBaddress\f1 = \fIaddress\f1
    5.69 +The address where the retrieved mail should be sent to.
    5.70 +It can be any address, but you probably want to set this to a local address on your LAN.
    5.71  
    5.72 -The address where the retrieved mail should be sent to. It can be any address, but you probably want to set this to a local address on your LAN.
    5.73  .TP
    5.74 +\fBreturn_path\fR = \fIaddress\fR
    5.75  
    5.76 -\fBreturn_path\f1 = \fIaddress\f1
    5.77 +If set, masqmail sets the return path to this address.
    5.78 +Bounces generated during further delivery will be sent to this address.
    5.79 +If unset, masqmail looks for the Return-Path: header in the mail,
    5.80 +if this does not exist it uses the From: address and if this fails, postmaster will be used.
    5.81  
    5.82 -If set, masqmail sets the return path to this address. Bounces generated during further delivery will be sent to this address. If unset, masqmail looks for the Return-Path: header in the mail, if this does not exist it uses the From: address and if this fails, postmaster will be used.
    5.83 +It is in most cases not useful to set this to the same address as the `address'
    5.84 +option as this may generate multiple bounces.
    5.85 +postmaster is recommended.
    5.86  
    5.87 -It is in most cases not useful to set this to the same address as the 'address' option as this may generate multiple bounces. postmaster is recommended.
    5.88  .TP
    5.89 +\fBdo_keep\fR = \fIboolean\fR
    5.90  
    5.91 -\fBdo_keep\f1 = \fIboolean\f1
    5.92 +If you want to keep your mail on the server after you retrieved it, set this to true.
    5.93 +It is recommended that you also set do_uidl,
    5.94 +otherwise you will get the mail again each time you connect to the server.
    5.95 +Masqmail does not check any headers before it retrieves mail, which may mark it as already fetched.
    5.96 +Note that this behaviour is different to that of fetchmail.
    5.97 +The default is false.
    5.98  
    5.99 -If you want to keep your mail on the server after you retrieved it, set this to true. It is recommended that you also set do_uidl, otherwise you will get the mail again each time you connect to the server. Masqmail does not check any headers before it retrieves mail, which may mark it as already fetched. Note that this behaviour is different to that of fetchmail. The default is false.
   5.100  .TP
   5.101 +\fBdo_uidl\fR = \fIboolean\fR
   5.102  
   5.103 -\fBdo_uidl\f1 = \fIboolean\f1
   5.104 +If set, masqmail keeps a list of unique IDs of mails already fetched,
   5.105 +so that they will not be retrieved again.
   5.106 +Default is false.
   5.107  
   5.108 -If set, MasqMail keeps a list of unique IDs of mails already fetched, so that they will not be retrieved again. Default is false.
   5.109  .TP
   5.110 +\fBdo_uidl_dele\fR = \fIboolean\fR
   5.111  
   5.112 -\fBdo_uidl_dele\f1 = \fIboolean\f1
   5.113 +If set, and \fBdo_uidl\fR is also set, MasqMail sends a delete (DELE) command
   5.114 +to the server for each message uid in the uid listing at the beginning of the session.
   5.115 +This prevents mail to be left on the server if masqmail gets interrupted during
   5.116 +a session before it can send the QUIT command to the server.
   5.117 +Default is false.
   5.118  
   5.119 -If set, and \fBdo_uidl\f1 is also set, MasqMail sends a delete (DELE) command to the server for each message uid in the uid listing at the beginning of the session. This prevents mail to be left on the server if masqmail gets interrupted during a session before it can send the QUIT command to the server. Default is false.
   5.120  .TP
   5.121 +\fBmax_size\fR = \fInumeric\fR
   5.122  
   5.123 -\fBmax_size\f1 = \fInumeric\f1
   5.124 +If set to a value > 0, only messages smaller than this in bytes will be retrieved.
   5.125 +The default is 0.
   5.126  
   5.127 -If set to a value > 0, only messages smaller than this in bytes will be retrieved. The default is 0.
   5.128  .TP
   5.129 +\fBmax_count\fR = \fInumeric\fR
   5.130  
   5.131 -\fBmax_count\f1 = \fInumeric\f1
   5.132 +If set to a value > 0, only \fBmax_count\fR messages will be retrieved.
   5.133 +The default is 0.
   5.134  
   5.135 -If set to a value > 0, only \fBmax_count\f1 messages will be retrieved. The default is 0.
   5.136  .TP
   5.137 +\fBwrapper\fR = \fIcommand\fR
   5.138  
   5.139 -\fBwrapper\f1 = \fIcommand\f1
   5.140 -
   5.141 -If set, instead of opening a connection to a remote server, \fIcommand\f1 will be called and all traffic will be piped to its stdin and from its stdout. Purpose is to tunnel ip traffic, eg. for ssl.
   5.142 +If set, instead of opening a connection to a remote server,
   5.143 +\fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout.
   5.144 +Purpose is to tunnel ip traffic, e.g. for ssl.
   5.145  
   5.146  Example for ssl tunneling:
   5.147  
   5.148  wrapper="/usr/bin/openssl s_client \-quiet \-connect pop.gmx.net:995 2>/dev/null"
   5.149 +
   5.150 +
   5.151  .SH AUTHOR
   5.152  
   5.153 -masqmail was written by Oliver Kurth. It is now maintained by Markus Schnalke <meillo@marmaro.de>.
   5.154 +Masqmail was written by Oliver Kurth.
   5.155 +It is now maintained by Markus Schnalke <meillo@marmaro.de>.
   5.156  
   5.157 -You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\f1.
   5.158 +You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\fR.
   5.159  There is also a mailing list, you will find information about it at masqmail's main site.
   5.160  
   5.161 +
   5.162  .SH BUGS
   5.163  
   5.164 -You should report them to the mailing list.
   5.165 +Please report bugs to the mailing list.
   5.166 +
   5.167  
   5.168  .SH SEE ALSO
   5.169  
   5.170 -\fBmasqmail (8)\f1, \fBmasqmail.route (5)\f1, \fBmasqmail.conf (5)\f1
   5.171 -
   5.172 -.SH COMMENTS
   5.173 -
   5.174 -This man page was written using \fBxml2man (1)\f1 by the same author.
   5.175 -
   5.176 +\fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.conf(5)\fR

     6.1 --- a/docs/masqmail.route.5	Thu May 06 13:31:57 2010 +0200
     6.2 +++ b/docs/masqmail.route.5	Fri May 07 13:50:23 2010 +0200
     6.3 @@ -1,213 +1,308 @@
     6.4 -.TH masqmail.route 5 User Manuals
     6.5 +.TH masqmail.route 5 2010-05-07 masqmail-0.2.21 "File Formats"
     6.6 +
     6.7  .SH NAME
     6.8  masqmail.route \- masqmail route configuration file
     6.9 +
    6.10 +
    6.11  .SH DESCRIPTION
    6.12  
    6.13 -This man page describes the syntax of the route configuration files of \fBmasqmail (8)\f1. Their usual locations are in \fI/etc/masqmail/\f1.
    6.14 +This man page describes the syntax of the route configuration files of \fBmasqmail (8)\fR.
    6.15 +Their usual locations are in \fI/etc/masqmail/\fR.
    6.16  
    6.17  .SH OPTIONS
    6.18 +
    6.19  .TP
    6.20 +\fBprotocol\fR = \fIstring\fR
    6.21  
    6.22 -\fBprotocol\f1 = \fIstring\f1
    6.23 +\fIstring\fR can be one of `smtp' or `pipe', default is `smtp'.
    6.24 +If set to `smtp', mail will be sent with the SMTP protocol to its destination.
    6.25 +If set to `pipe', you also have to set `pipe' to a command, the message will then be piped to a program.
    6.26 +See option `pipe' below.
    6.27  
    6.28 -\fIstring\f1 can be one of 'smtp' or 'pipe', default is 'smtp'. If set to 'smtp', mail will be sent with the SMTP protocol to its destination. If set to 'pipe', you also have to set 'pipe' to a command, the message will then be piped to a program. See option 'pipe' below.
    6.29  .TP
    6.30 +\fBmail_host\fR = \fIstring\fR
    6.31  
    6.32 -\fBmail_host\f1 = \fIstring\f1
    6.33 -
    6.34 -This is preferably the mail server of your ISP. All outgoing messages will be sent to this host which will distribute them to their destinations. If you do not set this mails will be sent directly. Because the mail server is probably 'near' to you, mail transfer will be much faster if you use it.
    6.35 +This is preferably the mail server of your ISP.
    6.36 +All outgoing messages will be sent to this host which will distribute them to their destinations.
    6.37 +If you do not set this mails will be sent directly.
    6.38 +Because the mail server is probably `near' to you, mail transfer will be much faster if you use it.
    6.39  
    6.40  You can optionally give a port number following the host name and a colon, eg mail_host="mail.foo.com:25".
    6.41 +
    6.42  .TP
    6.43 +\fBresolve_list\fR = \fIlist\fR
    6.44  
    6.45 -\fBresolve_list\f1 = \fIlist\f1
    6.46 -
    6.47 -Specify the method how the domain of the server is resolved. Possible values are dns_mx, dns_a, byname. For 'dns_mx', the domain is assumed to be an MX pointer to a list of host names, these will be tried each in order (lowest preference value first, equal preference values in random order). For 'dns_a', the domain is assumed to be an A pointer. For 'byname', the library function \fBgethostbyname (3)\f1 will be used.
    6.48 +Specify the method how the domain of the server is resolved.
    6.49 +Possible values are dns_mx, dns_a, byname.
    6.50 +For `dns_mx', the domain is assumed to be an MX pointer to a list of host names,
    6.51 +these will be tried each in order (lowest preference value first, equal preference values in random order).
    6.52 +For `dns_a', the domain is assumed to be an A pointer.
    6.53 +For `byname', the library function \fBgethostbyname(3)\fR will be used.
    6.54  
    6.55  The default is "dns_mx;dns_a;byname".
    6.56 +
    6.57  .TP
    6.58 +\fBconnect_error_fail\fR = \fIboolean\fR
    6.59  
    6.60 -\fBconnect_error_fail\f1 = \fIboolean\f1
    6.61 +If this is set, a connection error will cause a mail delivery to fail, ie. it will be bounced.
    6.62 +If it is unset, it will just be defered.
    6.63  
    6.64 -If this is set, a connection error will cause a mail delivery to fail, ie. it will be bounced. If it is unset, it will just be defered.
    6.65 -
    6.66 -Default is false. The reason for this is that masqmail is designed for non permanent internet connections, where such errors may occur quite often, and a bounce would be annoying.
    6.67 +Default is false.
    6.68 +The reason for this is that masqmail is designed for non permanent internet connections,
    6.69 +where such errors may occur quite often, and a bounce would be annoying.
    6.70  
    6.71  For the default local_net route is is set to true.
    6.72 +
    6.73  .TP
    6.74 +\fBhelo_name\fR = \fIstring\fR
    6.75  
    6.76 -\fBhelo_name\f1 = \fIstring\f1
    6.77 +Set the name given with the HELO/EHLO command. If this is not set,
    6.78 +\fBhost_name\fR from \fImasqmail.conf\fR will be used,
    6.79 +if the \fBdo_correct_helo\fR option (see below) is unset.
    6.80  
    6.81 -Set the name given with the HELO/EHLO command. If this is not set, \fBhost_name\f1 from \fImasqmail.conf\f1 will be used, if the \fBdo_correct_helo\f1 option (see below) is unset.
    6.82  .TP
    6.83 +\fBdo_correct_helo\fR = \fIboolean\fR
    6.84  
    6.85 -\fBdo_correct_helo\f1 = \fIboolean\f1
    6.86 +If this is set, masqmail tries to look up your host name as it appears
    6.87 +on the internet and sends this in the HELO/EHLO command.
    6.88 +Some servers are so picky that they want this.
    6.89 +Which is really crazy.
    6.90 +It just does not make any sense to lie about ones own identity,
    6.91 +because it can always be looked up by the server.
    6.92 +Nobody should believe in the name given by HELO/EHLO anyway.
    6.93 +If this is not set, \fBhost_name\fR from \fImasqmail.conf\fR or as given with
    6.94 +the \fBhelo_name\fR (see above) will be used.
    6.95  
    6.96 -If this is set, masqmail tries to look up your host name as it appears on the internet and sends this in the HELO/EHLO command. Some servers are so picky that they want this. Which is really crazy. It just does not make any sense to lie about ones own identity, because it can always be looked up by the server. Nobody should believe in the name given by HELO/EHLO anyway. If this is not set, \fBhost_name\f1 from \fImasqmail.conf\f1 or as given with the \fBhelo_name\f1 (see above) will be used.
    6.97  .TP
    6.98 +\fBdo_pipelining\fR = \fIboolean\fR
    6.99  
   6.100 -\fBdo_pipelining\f1 = \fIboolean\f1
   6.101 +If this is set to false, masqmail will not use ESMTP PIPELINING,
   6.102 +even if the server announces that it is able to cope with it.
   6.103 +Default is true.
   6.104  
   6.105 -If this is set to false, masqmail will not use ESMTP PIPELINING, even if the server announces that it is able to cope with it. Default is true.
   6.106 +You do not want to set this to false unless the mail setup on the
   6.107 +remote server side is really broken.
   6.108 +Keywords: wingate.
   6.109  
   6.110 -You do not want to set this to false unless the mail setup on the remote server side is really broken. Keywords: wingate.
   6.111  .TP
   6.112 +\fBallowed_mail_locals\fR = \fIlist\fR
   6.113  
   6.114 -\fBallowed_mail_locals\f1 = \fIlist\f1
   6.115 +This is a semicolon `;' separated list of local parts which will be allowed
   6.116 +to send mail through this connection.
   6.117 +If unset and \fBnot_allowed_mail_locals\fR is also unset, all users are allowed.
   6.118  
   6.119 -This is a semicolon ';' separated list of local parts which will be allowed to send mail through this connection. If unset and \fBnot_allowed_mail_locals\f1 is also unset, all users are allowed.
   6.120  .TP
   6.121 +\fBnot_allowed_mail_locals\fR = \fIlist\fR
   6.122  
   6.123 -\fBnot_allowed_mail_locals\f1 = \fIlist\f1
   6.124 +This is a semicolon `;' separated list of local parts which will be not allowed
   6.125 +to send mail through this connection.
   6.126 +Local parts in this list will not be allowed to use this route even if they
   6.127 +are part of \fBallowed_mail_locals\fR (see above).
   6.128  
   6.129 -This is a semicolon ';' separated list of local parts which will be not allowed to send mail through this connection. Local parts in this list will not be allowed to use this route even if they are part of \fBallowed_mail_locals\f1 (see above).
   6.130  .TP
   6.131 +\fBallowed_return_paths\fR = \fIlist\fR
   6.132  
   6.133 -\fBallowed_return_paths\f1 = \fIlist\f1
   6.134 +This is a semicolon `;' separated list of addresses.
   6.135 +Messages which have one one of these addresses as the return path will be used using this route
   6.136 +(if not also in \fBnot_allowed_return_paths\fR or an item in \fBnot_allowed_mail_locals\fR matches).
   6.137  
   6.138 -This is a semicolon ';' separated list of addresses. Messages which have one one of these addresses as the return path will be used using this route (if not also in \fBnot_allowed_return_paths\f1 or an item in \fBnot_allowed_mail_locals\f1 matches).
   6.139 +Patterns containing `?' and `*' can be used.
   6.140 +The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
   6.141  
   6.142 -Patterns containing '?' and '*' can be used. The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
   6.143  .TP
   6.144 +\fBnot_allowed_return_paths\fR = \fIlist\fR
   6.145  
   6.146 -\fBnot_allowed_return_paths\f1 = \fIlist\f1
   6.147 +This is a semicolon `;' separated list of addresses.
   6.148 +Messages which have one one of these addresses as the return path will not
   6.149 +be used using this route (even if also in \fBallowed_return_paths\fR
   6.150 +or an item in \fBallowed_mail_locals\fR matches).
   6.151  
   6.152 -This is a semicolon ';' separated list of addresses. Messages which have one one of these addresses as the return path will not be used using this route (even if also in \fBallowed_return_paths\f1 or an item in \fBallowed_mail_locals\f1 matches).
   6.153 +Patterns containing `?' and `*' can be used.
   6.154 +The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
   6.155  
   6.156 -Patterns containing '?' and '*' can be used. The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
   6.157  .TP
   6.158 +\fBallowed_rcpt_domains\fR = \fIlist\fR
   6.159  
   6.160 -\fBallowed_rcpt_domains\f1 = \fIlist\f1
   6.161 +A list of recipient domains where mail will be sent to.
   6.162 +This is for example useful if you use this route configuration when connected to another LAN via ppp.
   6.163 +Patterns containing `?' and `*' can be used.
   6.164  
   6.165 -A list of recipient domains where mail will be sent to. This is for example useful if you use this route configuration when connected to another LAN via ppp. Patterns containing '?' and '*' can be used.
   6.166  .TP
   6.167 +\fBnot_allowed_rcpt_domains\fR = \fIlist\fR
   6.168  
   6.169 -\fBnot_allowed_rcpt_domains\f1 = \fIlist\f1
   6.170 +A list of recipient domains where mail will not be sent to.
   6.171 +This is for example useful if you send mail directly (\fBmail_host\fR is not set)
   6.172 +and you know of hosts that will not accept mail from you because they use a dialup list
   6.173 +(eg. \fBhttp://maps.vix.com/dul/\fR).
   6.174 +If any domain matches both \fBallowed_rcpt_domains\fR and \fBnot_allowed_rcpt_domains\fR,
   6.175 +mail will not be sent to this domain.
   6.176 +Patterns containing `?' and `*' can be used.
   6.177  
   6.178 -A list of recipient domains where mail will not be sent to. This is for example useful if you send mail directly (\fBmail_host\f1 is not set) and you know of hosts that will not accept mail from you because they use a dialup list (eg. \fBhttp://maps.vix.com/dul/\f1. If any domain matches both \fBallowed_rcpt_domains\f1 and \fBnot_allowed_rcpt_domains\f1, mail will not be sent to this domain. Patterns containing '?' and '*' can be used.
   6.179  .TP
   6.180 +\fBset_h_from_domain\fR = \fIstring\fR
   6.181  
   6.182 -\fBset_h_from_domain\f1 = \fIstring\f1
   6.183 +Replace the domain part in `From:' headers with this value.
   6.184 +This may be useful if you use a private, outside unknown address on your local LAN
   6.185 +and want this to be replaced by the domain of the address of your email addrsss on the internet.
   6.186 +Note that this is different to \fBset_return_path_domain\fR, see below.
   6.187  
   6.188 -Replace the domain part in 'From:' headers with this value. This may be useful if you use a private, outside unknown address on your local LAN and want this to be replaced by the domain of the address of your email addrsss on the internet. Note that this is different to \fBset_return_path_domain\f1, see below.
   6.189  .TP
   6.190 +\fBset_return_path_domain\fR = \fIstring\fR
   6.191  
   6.192 -\fBset_return_path_domain\f1 = \fIstring\f1
   6.193 +Sets the domain part of the envelope from address.
   6.194 +Some hosts check whether this is the same as the net the connection is coming from.
   6.195 +If not, they reject the mail because they suspect spamming.
   6.196 +It should be a valid address, because some mail servers also check that.
   6.197 +You can also use this to set it to your usual address on the internet
   6.198 +and put a local address only known on your LAN in the configuration of your mailer.
   6.199 +Only the domain part will be changed, the local part remains unchanged.
   6.200 +Use \fBmap_return_path_addresses\fR for rewriting local parts.
   6.201  
   6.202 -Sets the domain part of the envelope from address. Some hosts check whether this is the same as the net the connection is coming from. If not, they reject the mail because they suspect spamming. It should be a valid address, because some mail servers also check that. You can also use this to set it to your usual address on the internet and put a local address only known on your LAN in the configuration of your mailer. Only the domain part will be changed, the local part remains unchanged. Use \fBmap_return_path_addresses\f1 for rewriting local parts.
   6.203  .TP
   6.204 +\fBmap_h_from_addresses\fR = \fIlist\fR
   6.205  
   6.206 -\fBmap_h_from_addresses\f1 = \fIlist\f1
   6.207 -
   6.208 -This is similar to \fBset_h_from_domain\f1, but more flexible. Set this to a list which maps local parts to a full RFC 822 compliant email address, the local parts (the keys) are separated from the addresses (the values) by colons (':').
   6.209 +This is similar to \fBset_h_from_domain\fR, but more flexible.
   6.210 +Set this to a list which maps local parts to a full RFC 822 compliant email address,
   6.211 +the local parts (the keys) are separated from the addresses (the values) by colons (`:').
   6.212  
   6.213  Example:
   6.214  
   6.215  map_h_from_addresses = "john: John Smith <jsmith@mail.academic.edu>; charlie: Charlie Miller <cmiller@mx.commercial.com>"
   6.216  
   6.217  You can use patterns, eg. * as keys.
   6.218 +
   6.219  .TP
   6.220 +\fBmap_h_reply_to_addresses\fR = \fIlist\fR
   6.221  
   6.222 -\fBmap_h_reply_to_addresses\f1 = \fIlist\f1
   6.223 +Same as \fBmap_h_from_addresses\fR, but for the `Reply-To:' header.
   6.224  
   6.225 -Same as \fBmap_h_from_addresses\f1, but for the 'Reply-To:' header.
   6.226  .TP
   6.227 +\fBmap_h_mail_followup_to_addresses\fR = \fIlist\fR
   6.228  
   6.229 -\fBmap_h_mail_followup_to_addresses\f1 = \fIlist\f1
   6.230 +Same as \fBmap_h_from_addresses\fR, but for the `Mail-Followup-To:' header.
   6.231 +Useful when replying to mailing lists.
   6.232  
   6.233 -Same as \fBmap_h_from_addresses\f1, but for the 'Mail-Followup-To:' header. Useful when replying to mailing lists.
   6.234  .TP
   6.235 +\fBmap_return_path_addresses\fR = \fIlist\fR
   6.236  
   6.237 -\fBmap_return_path_addresses\f1 = \fIlist\f1
   6.238 -
   6.239 -This is similar to \fBset_return_path_domain\f1, but more flexible. Set this to a list which maps local parts to a full RFC 821 compliant email address, the local parts (the keys) are separated from the addresses (the values) by colons (':'). Note that this option takes RFC 821 addresses while \fBmap_h_from_addresses\f1 takes RFC 822 addresses. The most important difference is that RFC 821 addresses have no full name.
   6.240 +This is similar to \fBset_return_path_domain\fR, but more flexible.
   6.241 +Set this to a list which maps local parts to a full RFC 821 compliant email address,
   6.242 +the local parts (the keys) are separated from the addresses (the values) by colons (`:').
   6.243 +Note that this option takes RFC 821 addresses while \fBmap_h_from_addresses\fR takes RFC 822 addresses.
   6.244 +The most important difference is that RFC 821 addresses have no full name.
   6.245  
   6.246  Example:
   6.247  
   6.248  map_return_path_addresses = "john: <jsmith@mail.academic.edu>; charlie: <cmiller@mx.commercial.com>"
   6.249  
   6.250  You can use patterns, eg. * as keys.
   6.251 +
   6.252  .TP
   6.253 +\fBexpand_h_sender_address\fR = \fIboolean\fR
   6.254  
   6.255 -\fBexpand_h_sender_address\f1 = \fIboolean\f1
   6.256 +This sets the domain of the sender address as given by the Sender: header
   6.257 +to the same address as in the envelope return path address
   6.258 +(which can be set by either \fBset_return_path_domain\fR or \fBmap_return_path_addresses\fR).
   6.259 +This is for mail clients (eg. Microsoft Outlook) which use this address as the sender address.
   6.260 +Though they should use the From: address, see RFC 821.
   6.261 +If \fBfetchmail(1)\fR encounters an unqualified Sender: address,
   6.262 +it will be expanded to the domain of the pop server, which is almost never correct.
   6.263 +Default is true.
   6.264  
   6.265 -This sets the domain of the sender address as given by the Sender: header to the same address as in the envelope return path address (which can be set by either \fBset_return_path_domain\f1 or \fBmap_return_path_addresses\f1). This is for mail clients (eg. Microsoft Outlook) which use this address as the sender address. Though they should use the From: address, see RFC 821. If \fBfetchmail (1)\f1 encounters an unqualified Sender: address, it will be expanded to the domain of the pop server, which is almost never correct. Default is true.
   6.266  .TP
   6.267 +\fBexpand_h_sender_domain\fR = \fIboolean\fR
   6.268  
   6.269 -\fBexpand_h_sender_domain\f1 = \fIboolean\f1
   6.270 +Like \fBexpand_h_sender_address\fR, but sets the domain only.
   6.271 +Deprecated, will be removed in a later version.
   6.272  
   6.273 -Like \fBexpand_h_sender_address\f1, but sets the domain only. Deprecated, will be removed in a later version.
   6.274  .TP
   6.275 +\fBlast_route\fR = \fIboolean\fR
   6.276  
   6.277 -\fBlast_route\f1 = \fIboolean\f1
   6.278 +If this is set, a mail which would have been delivered using this route,
   6.279 +but has failed temporarily, will not be tried to be delivered using the next route.
   6.280  
   6.281 -If this is set, a mail which would have been delivered using this route, but has failed temporarily, will not be tried to be delivered using the next route.
   6.282 -
   6.283 -If you have set up a special route with filters using the lists 'allowed_rcpt_domains', 'allowed_return_paths', and 'allowed_mail_locals' or their complements (not_), and the mail passing these rules should be delivered using this route only, you should set this to 'true'. Otherwise the mail would be passed to the next route (if any), unless that route has rules which prevent that.
   6.284 +If you have set up a special route with filters using the lists `allowed_rcpt_domains',
   6.285 +`allowed_return_paths', and `allowed_mail_locals' or their complements (not_),
   6.286 +and the mail passing these rules should be delivered using this route only,
   6.287 +you should set this to `true'.
   6.288 +Otherwise the mail would be passed to the next route (if any),
   6.289 +unless that route has rules which prevent that.
   6.290  
   6.291  Default is false.
   6.292 +
   6.293  .TP
   6.294 +\fBauth_name\fR = \fIstring\fR
   6.295  
   6.296 -\fBauth_name\f1 = \fIstring\f1
   6.297 +Set the authentication type for ESMTP AUTH authentication.
   6.298 +Currently only `cram-md5' and `login' are supported.
   6.299  
   6.300 -Set the authentication type for ESMTP AUTH authentication. Currently only 'cram-md5' and 'login' are supported.
   6.301  .TP
   6.302 -
   6.303 -\fBauth_login\f1 = \fIstring\f1
   6.304 +\fBauth_login\fR = \fIstring\fR
   6.305  
   6.306  Your account name for ESMTP AUTH authentication.
   6.307 +
   6.308  .TP
   6.309 -
   6.310 -\fBauth_secret\f1 = \fIstring\f1
   6.311 +\fBauth_secret\fR = \fIstring\fR
   6.312  
   6.313  Your secret for ESMTP AUTH authentication.
   6.314 +
   6.315  .TP
   6.316 +\fBpop3_login\fR = \fIfile\fR
   6.317  
   6.318 -\fBpop3_login\f1 = \fIfile\f1
   6.319 +If your Mail server requires SMTP-after-POP,
   6.320 +set this to a get configuration (see \fBmasqmail.get(5)\fR).
   6.321 +If you login to the POP server before you send, this is not necessary.
   6.322  
   6.323 -If your Mail server requires SMTP-after-POP, set this to a get configuration (see \fBmasqmail.get (5)\f1). If you login to the POP server before you send, this is not necessary.
   6.324  .TP
   6.325 +\fBwrapper\fR = \fIcommand\fR
   6.326  
   6.327 -\fBwrapper\f1 = \fIcommand\f1
   6.328 -
   6.329 -If set, instead of opening a connection to a remote server, \fIcommand\f1 will be called and all traffic will be piped to its stdin and from its stdout. Purpose is to tunnel ip traffic, eg. for ssl.
   6.330 +If set, instead of opening a connection to a remote server,
   6.331 +\fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout.
   6.332 +Purpose is to tunnel ip traffic, eg. for ssl.
   6.333  
   6.334  Example for ssl tunneling:
   6.335  
   6.336  wrapper="/usr/bin/openssl s_client \-quiet \-connect pop.gmx.net:995 2>/dev/null"
   6.337 +
   6.338  .TP
   6.339 +\fBpipe\fR = \fIcommand\fR
   6.340  
   6.341 -\fBpipe\f1 = \fIcommand\f1
   6.342 +If set, and protocol is set to `pipe',
   6.343 +\fIcommand\fR will be called and the message will be piped to its stdin.
   6.344 +Purpose is to use gateways to uucp, fax, sms or whatever else.
   6.345  
   6.346 -If set, and protocol is set to 'pipe', \fIcommand\f1 will be called and the message will be piped to its stdin. Purpose is to use gateways to uucp, fax, sms or whatever else.
   6.347 +You can use variables to give as arguments to the command,
   6.348 +these are the same as for the mda in the main configuration, see \fBmasqmail.conf(5)\fR.
   6.349  
   6.350 -You can use variables to give as arguments to the command, these are the same as for the mda in the main configuration, see \fBmasqmail.conf (5)\f1.
   6.351  .TP
   6.352 +\fBpipe_fromline = \fIboolean\fR
   6.353  
   6.354 -\fBpipe_fromline = \fIboolean\f1\fB\f1
   6.355 +If this is set, and protocol is set to `pipe',
   6.356 +a from line will be prepended to the output stream whenever a pipe command is called.
   6.357 +Default is false.
   6.358  
   6.359 -If this is set, and protocol is set to 'pipe', a from line will be prepended to the output stream whenever a pipe command is called. Default is false.
   6.360  .TP
   6.361 +\fBpipe_fromhack = \fIboolean\fR
   6.362  
   6.363 -\fBpipe_fromhack = \fIboolean\f1\fB\f1
   6.364 +If this is set, and protocol is set to `pipe',
   6.365 +each line beginning with `From ' is replaced with `>From ' whenever a pipe command is called.
   6.366 +You probably want this if you have set \fBpipe_fromline\fR above.
   6.367 +Default is false.
   6.368  
   6.369 -If this is set, and protocol is set to 'pipe', each line beginning with 'From ' is replaced with '>From ' whenever a pipe command is called. You probably want this if you have set \fBpipe_fromline\f1 above. Default is false.
   6.370 +
   6.371  .SH AUTHOR
   6.372  
   6.373 -masqmail was written by Oliver Kurth. It is now maintained by Markus Schnalke <meillo@marmaro.de>.
   6.374 +Masqmail was written by Oliver Kurth.
   6.375 +It is now maintained by Markus Schnalke <meillo@marmaro.de>.
   6.376  
   6.377 -You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\f1.
   6.378 +You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\fR.
   6.379  There is also a mailing list, you will find information about it at masqmail's main site.
   6.380  
   6.381 +
   6.382  .SH BUGS
   6.383  
   6.384 -You should report them to the mailing list.
   6.385 +Please report bugs to the mailing list.
   6.386  
   6.387  .SH SEE ALSO
   6.388  
   6.389 -\fBmasqmail (8)\f1, \fBmasqmail.conf (5)\f1, \fBmasqmail.get (5)\f1
   6.390 -
   6.391 -.SH COMMENTS
   6.392 -
   6.393 -This man page was written using \fBxml2man (1)\f1 by the same author.
   6.394 -
   6.395 +\fBmasqmail(8)\fR, \fBmasqmail.conf(5)\fR, \fBmasqmail.get(5)\fR

     7.1 --- a/docs/mservdetect.8	Thu May 06 13:31:57 2010 +0200
     7.2 +++ b/docs/mservdetect.8	Fri May 07 13:50:23 2010 +0200
     7.3 @@ -1,43 +1,49 @@
     7.4 -.TH mservdetect 8 User Manuals
     7.5 +.TH mservdetect 8 2010-05-07 masqmail-0.2.21 "Maintenance Commands"
     7.6 +
     7.7  .SH NAME
     7.8  mservdetect \- Helper for masqmail and masqdialer
     7.9 +
    7.10 +
    7.11  .SH SYNOPSIS
    7.12 -\fB/usr/bin/masqmail \fIhost\f1\fB \fIport\f1\fB
    7.13 +\fB/usr/bin/masqmail \fIhost port\fR
    7.14  
    7.15 -\fB
    7.16 +
    7.17  .SH DESCRIPTION
    7.18  
    7.19 -mservdetect is a small helper application for masqmail to detect its online status if the modem server masqdialer is used. It connects to the\fIhost\f1 at \fIport\f1 and prints the connection name to stdout.
    7.20 +Mservdetect is a small helper application for masqmail to detect its online status
    7.21 +if the modem server masqdialer is used.
    7.22 +It connects to the\fIhost\fR at \fIport\fR and prints the connection name to stdout.
    7.23  
    7.24 -If you want to use it, set \fBonline_detect\f1=\fIpipe\f1 and \fBonline_pipe\f1=\fI"/usr/bin/mservdetect host port"\f1.
    7.25 +If you want to use it, set \fBonline_detect\fR=\fIpipe\fR and
    7.26 +\fBonline_pipe\fR=\fI"/usr/bin/mservdetect host port"\fR.
    7.27  
    7.28  .SH OPTIONS
    7.29 +
    7.30  .TP
    7.31 -
    7.32 -\fBhost\f1
    7.33 +\fBhost\fR
    7.34  
    7.35  The hostname where the masqdialer server is running.
    7.36 +
    7.37  .TP
    7.38 -
    7.39 -\fBport\f1
    7.40 +\fBport\fR
    7.41  
    7.42  The port number where the masqdialer server is listening.
    7.43 +
    7.44 +
    7.45  .SH AUTHOR
    7.46  
    7.47 -masqmail was written by Oliver Kurth. It is now maintained by Markus Schnalke <meillo@marmaro.de>.
    7.48 +Masqmail was written by Oliver Kurth.
    7.49 +It is now maintained by Markus Schnalke <meillo@marmaro.de>.
    7.50  
    7.51 -You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\f1.
    7.52 +You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\fR.
    7.53  There is also a mailing list, you will find information about it at masqmail's main site.
    7.54  
    7.55 +
    7.56  .SH BUGS
    7.57  
    7.58 -You should report them to the mailing list.
    7.59 +Please report bugs to the mailing list.
    7.60 +
    7.61  
    7.62  .SH SEE ALSO
    7.63  
    7.64 -\fBmasqmail.conf (5)\f1
    7.65 -
    7.66 -.SH COMMENTS
    7.67 -
    7.68 -This man page was written using \fBxml2man (1)\f1 by the same author.
    7.69 -
    7.70 +\fBmasqmail.conf(5)\fR