1.1 --- a/man/masqmail.conf.5	Sat Feb 18 19:59:02 2012 +0100
     1.2 +++ b/man/masqmail.conf.5	Tue Feb 21 14:44:00 2012 +0100
     1.3 @@ -11,29 +11,30 @@
     1.4  
     1.5  The configuration consists of lines of the form
     1.6  
     1.7 +.RS 8
     1.8  \fBval\fR = \fIexpression\fR
     1.9 +.RE
    1.10  
    1.11  Where \fBval\fR is a variable name and \fIexpression\fR a string,
    1.12  which can be quoted with double quotes `"'.
    1.13 -If the expression is on multiple lines or contains characters other than letters,
    1.14 -digits or the characters `.', `-', `_', `/', ';', '@', ':', it must be quoted.
    1.15 +If the expression is on multiple lines or contains characters other
    1.16 +than letters,
    1.17 +digits or the characters `.', `\-', `_', `/', ';', '@', ':', it must be quoted.
    1.18  You can use quotes inside quotes by escaping them with a backslash.
    1.19  
    1.20  Each \fBval\fP has a type, which can be boolean, numeric, string or list.
    1.21 -A boolean variable can be set with one of the values `on', `yes', and `true' or `off', `no' and `false'.
    1.22 +A boolean variable can be set with one of the values `on', `yes', and `true'
    1.23 +or `off', `no' and `false'.
    1.24  List items are separated with semicolons `;'.
    1.25 -For some values, patterns (like `*',`?') can be used.
    1.26 -The spaces in front of and after the equal sign `=' are optional.
    1.27 +The spaces around the equal sign `=' are optional.
    1.28  
    1.29 -Most lists (exceptions: \fBlocal_hosts\fR, \fBlisten_addresses\fR,
    1.30 -\fBquery_routes.\fIname\fR and \fBpermanent_routes\fR) accept files.
    1.31 -These will be recognized by a leading slash `/'.
    1.32 -The contents of these files will be included at the position of the file name,
    1.33 -there can be items or other files before and after the file entry.
    1.34 -The format of the files is different though, within these files each entry is on another line
    1.35 -and the entries are not separated by semicolons.
    1.36 -This makes it easy to include large lists which are common in different configuration files,
    1.37 -so they do not have to appear in every configuration file.
    1.38 +All lists, except
    1.39 +\fBquery_routes.\fIname\fR and \fBpermanent_routes\fR, accept absolute
    1.40 +pathnames (leading slash `/') as entries, too.
    1.41 +They can be intermixed with normal entries.
    1.42 +The contents of these files will be included at this position in the list.
    1.43 +This makes including large lists more convenient.
    1.44 +Within these files, each line is one entry; the semicolon is no separator.
    1.45  
    1.46  Blank lines and lines starting with a hash `#' are ignored.
    1.47  
    1.48 @@ -43,7 +44,8 @@
    1.49  .TP
    1.50  \fBrun_as_user = \fIboolean\fR
    1.51  
    1.52 -If this is set, masqmail runs with the user id of the user who invoked it and never changes it.
    1.53 +If this is set, masqmail runs with the user id of the user who
    1.54 +invoked it and never changes it.
    1.55  This is for debugging purposes only.
    1.56  If the user is not root, masqmail will not be able to listen on a port < 1024
    1.57  and will not be able to deliver local mail to others than the user.
    1.58 @@ -80,7 +82,8 @@
    1.59  .TP
    1.60  \fBmail_dir = \fIfile\fR
    1.61  
    1.62 -The directory where local mail is stored, usually \fI/var/spool/mail\fR or \fI/var/mail\fR.
    1.63 +The directory where local mail is stored,
    1.64 +usually \fI/var/spool/mail\fR or \fI/var/mail\fR.
    1.65  \fIfile\fR must be an absolute path.
    1.66  
    1.67  Default: \fI/var/mail\fR
    1.68 @@ -88,7 +91,8 @@
    1.69  .TP
    1.70  \fBspool_dir = \fIfile\fR
    1.71  
    1.72 -The directory where masqmail stores its spool files (and later also other stuff).
    1.73 +The directory where masqmail stores its spool files
    1.74 +(and later also other stuff).
    1.75  It must have a subdirectory \fIinput\fR.
    1.76  Masqmail needs read and write permissions for this directory.
    1.77  \fIfile\fR must be an absolute path.
    1.78 @@ -106,15 +110,18 @@
    1.79  .TP
    1.80  \fBhost_name = \fIstring\fR
    1.81  
    1.82 -This is used in different places: Masqmail identifies itself in the greeting banner
    1.83 -on incoming connections and in the HELO/EHLO command for outgoing connections with this name,
    1.84 -it is used in the Received: header and to qualify the sender of a locally originating message.
    1.85 +This is used in different places: Masqmail identifies itself in
    1.86 +the greeting banner on incoming connections and in the HELO/EHLO command
    1.87 +for outgoing connections with this name, it is used in the Received: header
    1.88 +and to qualify the sender of a locally originating message.
    1.89  
    1.90  If the string begins with a slash `/', it it assumed that it is a filename,
    1.91  and the first line of this file will be used.
    1.92 -Usually this will be `/etc/mailname' to make masqmail conform to Debian policies.
    1.93 +Usually this will be `/etc/mailname' to make masqmail conform to
    1.94 +Debian policies.
    1.95  
    1.96 -It is not used to find whether an address is local. Use \fBlocal_hosts\fR for that.
    1.97 +It is not used to find whether an address is local.
    1.98 +Use \fBlocal_hosts\fR for that.
    1.99  
   1.100  Default: none; \fBhost_name\fP MUST be set in the config file
   1.101  
   1.102 @@ -127,7 +134,8 @@
   1.103  Normally you should set it to "localhost;foo;foo.bar.com" if your host has the
   1.104  fully qualified domain name `foo.bar.com'.
   1.105  
   1.106 -Default: localhost ; <value of \fBhost_name\fR cut at the first dot> ; <value of \fBhost_name\fR>
   1.107 +Default: localhost ; <value of \fBhost_name\fR cut at the first dot> ;
   1.108 +<value of \fBhost_name\fR>
   1.109  
   1.110  Example: \fIlocalhost;foo;foo.example.org\fR
   1.111  (if you have set \fBhost_name\fR to \fIfoo.example.org\fR)
   1.112 @@ -136,14 +144,22 @@
   1.113  \fBlocal_addresses = \fIlist\fR
   1.114  
   1.115  A semicolon `;' separated list of fully qualified email-addresses which are
   1.116 -considered local although their domain name part is not in the list of \fBlocal_hosts\fR. 
   1.117 +considered local although their domain name part is not in the list of
   1.118 +\fBlocal_hosts\fR. 
   1.119  This list can be seen as an addition to \fBlocal_hosts\fP.
   1.120 -
   1.121 +.IP
   1.122  Further more only the local part of the addresses will be regarded,
   1.123  seeing it as a local user.
   1.124  
   1.125 -Example: \fIlocal_addresses = "person1@yourdomain;person2@yourdomain"\fP
   1.126 +Example:
   1.127  
   1.128 +.RS 8
   1.129 +.nf
   1.130 +local_hosts = "localhost;myhost"
   1.131 +local_addresses = "bob@somewhere;alice@foo"
   1.132 +.fi
   1.133 +.RE
   1.134 +.IP
   1.135  This means mail to person1@yourdomain will effectively go to
   1.136  person1@localhost, if not redirected by an alias.
   1.137  
   1.138 @@ -151,7 +167,8 @@
   1.139  \fBnot_local_addresses = \fIlist\fR
   1.140  
   1.141  A semicolon `;' separated list of fully qualified email-addresses which are
   1.142 -considered not local although their domain name part is in the list of \fBlocal_hosts\fR. 
   1.143 +considered not local although their domain name part is in the list of
   1.144 +\fBlocal_hosts\fR. 
   1.145  This list can be seen as a substraction to \fBlocal_hosts\fP.
   1.146  
   1.147  This is the opposite of the previous case.
   1.148 @@ -161,15 +178,21 @@
   1.149  
   1.150  Example:
   1.151  
   1.152 +.RS 8
   1.153 +.nf
   1.154  local_hosts = "localhost;myhost;mydomain.net"
   1.155 -
   1.156  not_local_addresses = "eric@mydomain.net"
   1.157 +.fi
   1.158 +.RE
   1.159 +.IP
   1.160  
   1.161  .TP
   1.162  \fBlisten_addresses = \fIlist\fR
   1.163  
   1.164 -A semicolon `;' separated list of interfaces on which connections will be accepted.
   1.165 -An interface ist defined by a hostname, optionally followed by a colon `:' and a number for the port.
   1.166 +A semicolon `;' separated list of interfaces on which connections will
   1.167 +be accepted.
   1.168 +An interface ist defined by a hostname, optionally followed by a colon `:'
   1.169 +and a number for the port.
   1.170  If this is left out, port 25 will be used.
   1.171  
   1.172  You can set this to "localhost:25;foo:25" if your hostname is `foo'.
   1.173 @@ -183,8 +206,9 @@
   1.174  .TP
   1.175  \fBdo_save_envelope_to = \fIboolean\fR
   1.176  
   1.177 -If this is set to true, a possibly existing Envelope-to: header in an incoming mail
   1.178 -which is received via either pop3 or smtp will be saved as an X-Orig-Envelope-to: header.
   1.179 +If this is set to true, a possibly existing Envelope-to: header in
   1.180 +an incoming mail which is received via either pop3 or smtp will be saved
   1.181 +as an X-Orig-Envelope-to: header.
   1.182  
   1.183  This is useful if you retrieve mail from a pop3 server with fetchmail,
   1.184  and the server supports Envelope-to: headers,
   1.185 @@ -196,8 +220,9 @@
   1.186  .TP
   1.187  \fBdo_relay = \fIboolean\fR
   1.188  
   1.189 -If this is set to false, mail with a return path that is not local and a destination
   1.190 -that is also not local will not be accepted via smtp and a 550 reply will be given.
   1.191 +If this is set to false, mail with a return path that is not local
   1.192 +and a destination that is also not local will not be accepted via smtp
   1.193 +and a 550 reply will be given.
   1.194  Default is true.
   1.195  
   1.196  Note that this will not protect you from spammers using open relays,
   1.197 @@ -206,7 +231,8 @@
   1.198  .TP
   1.199  \fBdo_queue = \fIboolean\fR
   1.200  
   1.201 -If this is set, masqmail will not try to deliver mail immediately when accepted.
   1.202 +If this is set, masqmail will not try to deliver mail
   1.203 +immediately when accepted.
   1.204  Instead it will always queue it.
   1.205  (Note: Masqmail will always automatically queue mail if neccesary,
   1.206  i.e. if it cannot deliver because no suitable route was available for example.)
   1.207 @@ -229,13 +255,16 @@
   1.208  is in newer versions configured as:
   1.209  `\fBpermanent_routes\fR = \fI"/etc/masqmail/homenet.route"\fR'
   1.210  and the route file `homenet.route' containing:
   1.211 -.in +1in
   1.212 +
   1.213 +.RS 8
   1.214  .nf
   1.215  allowed_recipients = "*@*home.net"
   1.216  connect_error_fail = true
   1.217  resolve_list = byname
   1.218  .fi
   1.219 -.in 0
   1.220 +.RE
   1.221 +.IP
   1.222 +
   1.223  This is just as it had been with \fBlocal_net_route\fP,
   1.224  with the exception that the filtering for appropriate addresses
   1.225  is only in the route file and not with \fBlocal_nets\fR.
   1.226 @@ -257,7 +286,12 @@
   1.227  Example: Your ISP has the name FastNet.
   1.228  Then you write the following line in the main configuration:
   1.229  
   1.230 +.RS 8
   1.231 +.nf
   1.232  \fBquery_routes.\fBFastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
   1.233 +.fi
   1.234 +.RE
   1.235 +.IP
   1.236  
   1.237  \fI/etc/masqmail/fastnet.route\fR is the route configuration file,
   1.238  see \fBmasqmail.route(5)\fR.
   1.239 @@ -322,7 +356,8 @@
   1.240  
   1.241  The default local delivery method.
   1.242  Can be mbox or mda.
   1.243 -You can override this for each user by using the \fBmbox_users\fR or \fBmda_users\fR (see below).
   1.244 +You can override this for each user by using the \fBmbox_users\fR or
   1.245 +\fBmda_users\fR (see below).
   1.246  
   1.247  Default: mbox.
   1.248  
   1.249 @@ -343,35 +378,63 @@
   1.250  If you want local delivery to be transferred to an mda (Mail Delivery Agent),
   1.251  set this to a command.
   1.252  The argument will be expanded on delivery time,
   1.253 -you can use variables beginning with a dolloar sign `$', optionally enclosed in curly braces.
   1.254 +you can use variables beginning with a dolloar sign `$',
   1.255 +optionally enclosed in curly braces.
   1.256  Variables you can use are:
   1.257  
   1.258 -uid - the unique message id.
   1.259 -This is not necessarily identical with the Message ID as given in the Message ID: header.
   1.260 +.RS 8
   1.261 +.TP
   1.262 +uid
   1.263 +the unique message id.
   1.264 +(This is not necessarily identical with the Message ID
   1.265 +as given in the Message ID: header.)
   1.266  
   1.267 -received_host - the host the mail was received from
   1.268 +.TP
   1.269 +received_host
   1.270 +the host the mail was received from
   1.271  
   1.272 -ident - the user id of the sender if the message was received locally.
   1.273 +.TP
   1.274 +ident
   1.275 +the user id of the sender if the message was received locally.
   1.276  
   1.277 -return_path_local - the local part of the return path (sender).
   1.278 +.TP
   1.279 +return_path_local
   1.280 +the local part of the return path (sender).
   1.281  
   1.282 -return_path_domain - the domain part of the return path (sender).
   1.283 +.TP
   1.284 +return_path_domain
   1.285 +the domain part of the return path (sender).
   1.286  
   1.287 -return_path - the complete return path (sender).
   1.288 +.TP
   1.289 +return_path
   1.290 +the complete return path (sender).
   1.291  
   1.292 -rcpt_local - the local part of the recipient.
   1.293 +.TP
   1.294 +rcpt_local
   1.295 +the local part of the recipient.
   1.296  
   1.297 -rcpt_domain - the domain part of the recipient.
   1.298 +.TP
   1.299 +rcpt_domain
   1.300 +the domain part of the recipient.
   1.301  
   1.302 -rcpt - the complete recipient address.
   1.303 +.TP
   1.304 +rcpt
   1.305 +the complete recipient address.
   1.306 +.RE
   1.307 +.IP
   1.308  
   1.309  Example:
   1.310  
   1.311 +.RS 8
   1.312  mda="/usr/bin/procmail \-Y \-d ${rcpt_local}"
   1.313 +.RE
   1.314 +.IP
   1.315  
   1.316 -For the mda, as for pipe commands, a few environment variables will be set as well.
   1.317 +For the mda, as for pipe commands,
   1.318 +a few environment variables will be set as well.
   1.319  See \fBmasqmail(8)\fR.
   1.320 -To use environment variables for the mda, the dollar sign `$' has to be escaped with a backslash,
   1.321 +To use environment variables for the mda,
   1.322 +the dollar sign `$' has to be escaped with a backslash,
   1.323  otherwise they will be tried to be expanded with the internal variables.
   1.324  
   1.325  .TP
   1.326 @@ -392,25 +455,31 @@
   1.327  .TP
   1.328  \fBonline_query = \fIcommand line\fR
   1.329  
   1.330 -Defines the method masqmail uses to detect whether there exists an online connection currently.
   1.331 +Defines the method masqmail uses to detect whether there exists
   1.332 +an online connection currently.
   1.333  
   1.334  Masqmail executes the command given and reads from its standard output.
   1.335  The command should just print a route name, as defined
   1.336 -with \fBquery_routes.\fIname\fR, to standard output and return a zero status code.
   1.337 +with \fBquery_routes.\fIname\fR, to standard output and return
   1.338 +a zero status code.
   1.339  Masqmail assumes it is offline if the script returns with a non-zero status.
   1.340  Leading and trailing whitespace is removed from the output.
   1.341  
   1.342  Simple example:
   1.343  
   1.344 +.RS 8
   1.345  .nf
   1.346  #!/bin/sh
   1.347  test \-e /var/run/masqmail/masqmail-route || exit 1
   1.348  cat /var/run/masqmail/masqmail-route
   1.349  exit 0
   1.350  .fi
   1.351 +.RE
   1.352 +.IP
   1.353  
   1.354  No matter how masqmail detects the online status,
   1.355 -only messages that are accepted at online time will be delivered using the connection.
   1.356 +only messages that are accepted at online time will be
   1.357 +delivered using the connection.
   1.358  The mail spool still needs to be emptied manually
   1.359  (\fB\-qo\fIconnection\fR).
   1.360  
   1.361 @@ -418,24 +487,39 @@
   1.362  It can contain optional arguments.
   1.363  
   1.364  To simulate the old online_method=file, use:
   1.365 +
   1.366 +.RS 8
   1.367  \fI/bin/cat /path/to/file\fP
   1.368 +.RE
   1.369 +.IP
   1.370  
   1.371  To be always online with connection `foo', use:
   1.372 +
   1.373 +.RS 8
   1.374  \fI/bin/echo foo\fP
   1.375 +.RE
   1.376 +.IP
   1.377  
   1.378  To query a masqdialer server
   1.379  (i.e. asking it whether a connection exists and what its name is)
   1.380  use:
   1.381 +
   1.382 +.RS 8
   1.383  \fI/usr/bin/mservdetect localhost 224\fP
   1.384 +.RE
   1.385 +.IP
   1.386  
   1.387  .TP
   1.388  \fBerrmsg_file = \fIfile\fR
   1.389  
   1.390  Set this to a template which will be used to generate delivery failure reports.
   1.391  Variable parts within the template begin with a dollar sign and are identical
   1.392 -to those which can be used as arguments for the mda command, see \fBmda\fR above.
   1.393 -Additional information can be included with @failed_rcpts, @msg_headers and @msg_body,
   1.394 -these must be at the beginning of a line and will be replaced with the list of the failed recipients,
   1.395 +to those which can be used as arguments for the mda command,
   1.396 +see \fBmda\fR above.
   1.397 +Additional information can be included with @failed_rcpts,
   1.398 +@msg_headers and @msg_body,
   1.399 +these must be at the beginning of a line and will be replaced
   1.400 +with the list of the failed recipients,
   1.401  the message headers and the message body of the failed message.
   1.402  
   1.403  Default is /usr/share/masqmail/tpl/failmsg.tpl.
   1.404 @@ -456,18 +540,21 @@
   1.405  
   1.406  A warning will only be generated just after an attempt to deliver the mail
   1.407  and if that attempt failed temporarily.
   1.408 -So a warning may be generated after a longer time, if there was no attempt before.
   1.409 +So a warning may be generated after a longer time,
   1.410 +if there was no attempt before.
   1.411  
   1.412  Default is "1h;4h;8h;1d;2d;3d"
   1.413  
   1.414  .TP
   1.415  \fBmax_defer_time\fR = \fItime\fR
   1.416  
   1.417 -This is the maximum time, in which a temporarily failed mail will be kept in the spool.
   1.418 +This is the maximum time,
   1.419 +in which a temporarily failed mail will be kept in the spool.
   1.420  When this time is exceeded, it will be handled as a delivery failure,
   1.421  and the message will be bounced.
   1.422  
   1.423 -The excedence of this time will only be noticed if the message was actually tried to be delivered.
   1.424 +The excedence of this time will only be noticed if the message
   1.425 +was actually tried to be delivered.
   1.426  If, for example, the message can only be delivered when online,
   1.427  but you have not been online for that time, no bounce will be generated.
   1.428  
   1.429 @@ -479,10 +566,12 @@
   1.430  Replace \fIname\fR with a valid local or remote mail address.
   1.431  
   1.432  If this option is set, then a copy of every mail,
   1.433 -that passes through the masqmail system will also be sent to the given mail address.
   1.434 +that passes through the masqmail system will also be sent
   1.435 +to the given mail address.
   1.436  
   1.437  For example you can feed your mails into a program like hypermail
   1.438 -for archiving purpose by placing an appropriate pipe command in masqmail.alias
   1.439 +for archiving purpose by placing an appropriate pipe command
   1.440 +in masqmail.alias.
   1.441  
   1.442  .TP
   1.443  \fBmax_msg_size\fR = \fIbytes\fR
   1.444 @@ -493,7 +582,7 @@
   1.445  Clients pretending to send, or actually send,
   1.446  more than \fIbytes\fR will get a 552 error message.
   1.447  
   1.448 -`0' means no fixed maximum size limit is in force.
   1.449 +A zero value disables the maximum size limit.
   1.450  
   1.451  Default is 0 (= unlimited).
   1.452  
   1.453 @@ -512,8 +601,10 @@
   1.454  Masqmail was written by Oliver Kurth.
   1.455  It is now maintained by Markus Schnalke <meillo@marmaro.de>.
   1.456  
   1.457 -You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
   1.458 -There is also a mailing list, you will find information about it at masqmail's main site.
   1.459 +You will find the newest version of masqmail at
   1.460 +\fBhttp://marmaro.de/prog/masqmail/\fR.
   1.461 +There is also a mailing list,
   1.462 +you will find information about it at masqmail's main site.
   1.463  
   1.464  
   1.465  .SH BUGS