1.1 --- a/docs/masqmail.conf.5	Thu May 06 13:31:57 2010 +0200
     1.2 +++ b/docs/masqmail.conf.5	Fri May 07 13:50:23 2010 +0200
     1.3 @@ -1,200 +1,290 @@
     1.4 -.TH masqmail.conf 5 User Manuals
     1.5 +.TH masqmail.conf 5 2010-05-07 masqmail-0.2.21 "File Formats"
     1.6 +
     1.7  .SH NAME
     1.8  masqmail.conf \- masqmail configuration file
     1.9 +
    1.10 +
    1.11  .SH DESCRIPTION
    1.12  
    1.13 -This man page describes the syntax of the main configuration file of masqmail. Its usual location is \fI/etc/masqmail/masqmail.conf\f1
    1.14 +This man page describes the syntax of the main configuration file of masqmail.
    1.15 +Its usual location is \fI/etc/masqmail/masqmail.conf\fR
    1.16  
    1.17  The configuration consists of lines of the form
    1.18  
    1.19 -\fBval\f1 = \fIexpression\f1
    1.20 +\fBval\fR = \fIexpression\fR
    1.21  
    1.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.
    1.23 +Where \fBval\fR is a variable name and \fIexpression\fR a string,
    1.24 +which can be quoted with double quotes `"'.
    1.25 +If the expression is on multiple lines or contains characters other than letters,
    1.26 +digits or the characters `.', `-', `_', `/', it must be quoted.
    1.27 +You can use quotes inside quotes by escaping them with a backslash.
    1.28  
    1.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.
    1.30 +Each val has a type, which can be boolean, numeric, string or list.
    1.31 +A boolean variable can be set with one of the values `on', `yes', and `true' or `off', `no' and `false'.
    1.32 +List items are separated with semicolons `;'.
    1.33 +For some values patterns (like `*',`?') can be used.
    1.34 +The spaces before and after the equal sign `=' are optional.
    1.35  
    1.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.
    1.37 +Most lists (exceptions: \fBlocal_hosts\fR, \fBlocal_nets\fR, \fBlisten_addresses\fR,
    1.38 +\fBonline_routes\fR, and \fBonline_gets\fR) accept files.
    1.39 +These will be recognized by a leading slash `/'.
    1.40 +The contents of these files will be included at the position of the file name,
    1.41 +there can be items or other files before and after the file entry.
    1.42 +The format of the files is different though, within these files each entry is on another line.
    1.43 +(And not separated by semicolons).
    1.44 +This makes it easy to include large lists which are common in different configuration files,
    1.45 +so they do not have to appear in every configuration file.
    1.46  
    1.47 -Blank lines and lines starting with '#' are ignored.
    1.48 +Blank lines and lines starting with a hash `#' are ignored.
    1.49 +
    1.50  
    1.51  .SH OPTIONS
    1.52 +
    1.53  .TP
    1.54 +\fBrun_as_user = \fIboolean\fR
    1.55  
    1.56 -\fBrun_as_user = \fIboolean\f1\fB\f1
    1.57 +If this is set, masqmail runs with the user id of the user who invoked it and never changes it.
    1.58 +This is for debugging purposes only.
    1.59 +If the user is not root, masqmail will not be able to listen on a port < 1024
    1.60 +and will not be able to deliver local mail to others than the user.
    1.61  
    1.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.
    1.63  .TP
    1.64 +\fBuse_syslog = \fIboolean\fR
    1.65  
    1.66 -\fBuse_syslog = \fIboolean\f1\fB\f1
    1.67 +If this is set, masqmail uses syslogd for logging.
    1.68 +It uses facility MAIL.
    1.69 +You still have to set \fBlog_dir\fR for debug files.
    1.70  
    1.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.
    1.72  .TP
    1.73 +\fBdebug_level = \fIn\fR
    1.74  
    1.75 -\fBdebug_level = \fIn\f1\fB\f1
    1.76 +Set the debug level.
    1.77 +Valid values are 0 to 6, increasing it further makes no difference.
    1.78 +Be careful if you set this as high as 5 or higher, the logs may very soon fill your hard drive.
    1.79  
    1.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.
    1.81  .TP
    1.82 +\fBmail_dir = \fIfile\fR
    1.83  
    1.84 -\fBmail_dir = \fIfile\f1\fB\f1
    1.85 +The directory where local mail is stored, usually \fI/var/spool/mail\fR or \fI/var/mail\fR.
    1.86  
    1.87 -The directory where local mail is stored, usually \fI/var/spool/mail\f1 or \fI/var/mail\f1.
    1.88  .TP
    1.89 +\fBspool_dir = \fIfile\fR
    1.90  
    1.91 -\fBspool_dir = \fIfile\f1\fB\f1
    1.92 +The directory where masqmail stores its spool files (and later also other stuff).
    1.93 +It must have a subdirectory \fIinput\fR.
    1.94 +Masqmail needs read and write permissions for this directory.
    1.95 +I suggest to use \fI/var/spool/masqmail\fR.
    1.96  
    1.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.
    1.98  .TP
    1.99 +\fBhost_name = \fIstring\fR
   1.100  
   1.101 -\fBhost_name = \fIstring\f1\fB\f1
   1.102 +This is used in different places: Masqmail identifies itself in the greeting banner
   1.103 +on incoming connections and in the HELO/EHLO command for outgoing connections with this name,
   1.104 +it is used in the Received: header and to qualify the sender of a locally originating message.
   1.105  
   1.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.
   1.107 +If the string begins with a slash `/', it it assumed that it is a filename,
   1.108 +and the first line of this file will be used.
   1.109 +Usually this will be `/etc/mailname' to make masqmail conform to Debian policies.
   1.110  
   1.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.
   1.112 +It is not used to find whether an address is local. Use \fBlocal_hosts\fR for that.
   1.113  
   1.114 -It is not used to find whether an address is local. Use \fBlocal_hosts\f1 for that.
   1.115  .TP
   1.116 -
   1.117 -\fBremote_port = \fIn\f1\fB\f1
   1.118 +\fBremote_port = \fIn\fR
   1.119  
   1.120  The remote port number to be used. This defaults to port 25.
   1.121  
   1.122 -This option is deprecated. Use \fBhost_name\f1 in the route configuration instead. See \fBmasqmail.route (5)\f1.
   1.123 +This option is deprecated.
   1.124 +Use \fBhost_name\fR in the route configuration instead.
   1.125 +See \fBmasqmail.route(5)\fR.
   1.126 +
   1.127  .TP
   1.128 +\fBlocal_hosts = \fIlist\fR
   1.129  
   1.130 -\fBlocal_hosts = \fIlist\f1\fB\f1
   1.131 +A semicolon `;' separated list of hostnames which are considered local.
   1.132 +Normally you set it to "localhost;foo;foo.bar.com" if your host has the
   1.133 +fully qualified domain name `foo.bar.com'.
   1.134  
   1.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'.
   1.136  .TP
   1.137 +\fBlocal_nets = \fIlist\fR
   1.138  
   1.139 -\fBlocal_nets = \fIlist\f1\fB\f1
   1.140 +A semicolon `;' separated list of hostnames which are on the `local' net.
   1.141 +Delivery to these hosts is attempted immediately.
   1.142 +You can use patterns with `*', e.g. "*.bar.com".
   1.143  
   1.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".
   1.145  .TP
   1.146 +\fBlocal_addresses = \fIlist\fR
   1.147  
   1.148 -\fBlocal_addresses = \fIlist\f1\fB\f1
   1.149 +A semicolon `;' separated list of fully qualified email-addresses which are
   1.150 +considered local although their domain name part is not in the list of \fBlocal_hosts\fR. 
   1.151  
   1.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. 
   1.153 -
   1.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
   1.155 +For example: There are two people working at your LAN: person1@yourdomain and person2@yourdomain.
   1.156 +But there are other persons @yourdomain which are NOT local.
   1.157 +So you can not put yourdomain to the list of local_hosts.
   1.158 +If person1 now wants to write to person2@yourdomain and this mail should not leave the LAN then you can put
   1.159  
   1.160  local_addresses = "person1@yourdomain;person2@yourdomain"
   1.161  
   1.162  to your masqmail.conf.
   1.163 +
   1.164  .TP
   1.165 +\fBnot_local_addresses = \fIlist\fR
   1.166  
   1.167 -\fBnot_local_addresses = \fIlist\f1\fB\f1
   1.168 +A semicolon `;' separated list of fully qualified email-addresses which are
   1.169 +considered not local although their domain name part is in the list of \fBlocal_hosts\fR. 
   1.170  
   1.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. 
   1.172 -
   1.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.
   1.174 +This is the opposite of the previous case.
   1.175 +The majority of addresses of a specific domain are local.
   1.176 +But some users are not.
   1.177 +With this option you can easily exclude these users.
   1.178  
   1.179  Example:
   1.180  
   1.181  local_hosts = "localhost;myhost;mydomain.net"
   1.182  
   1.183  not_local_addresses = "eric@mydomain.net"
   1.184 +
   1.185  .TP
   1.186 +\fBlisten_addresses = \fIlist\fR
   1.187  
   1.188 -\fBlisten_addresses = \fIlist\f1\fB\f1
   1.189 +A semicolon `;' separated list of interfaces on which connections will be accepted.
   1.190 +An interface ist defined by a hostname, optionally followed by a colon `:' and a number for the port.
   1.191 +If this is left out, port 25 will be used.
   1.192  
   1.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.
   1.194 +You can set this to "localhost:25;foo:25" if your hostname is `foo'.
   1.195  
   1.196 -You can set this to "localhost:25;foo:25" if your hostname is 'foo'.
   1.197 +Note that the names are resolved to IP addreses.
   1.198 +If your host has different names which resolve to the same IP,
   1.199 +use only one of them, otherwise you will get an error message.
   1.200  
   1.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.
   1.202  .TP
   1.203 +\fBdo_save_envelope_to = \fIboolean\fR
   1.204  
   1.205 -\fBdo_save_envelope_to = \fIboolean\f1\fB\f1
   1.206 +If this is set to true, a possibly existing Envelope-to: header in an incoming mail
   1.207 +which is received via either pop3 or smtp will be saved as an X-Orig-Envelope-to: header.
   1.208  
   1.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.
   1.210 -
   1.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.
   1.212 +This is useful if you retrieve mail from a pop3 server with either masqmail or fetchmail,
   1.213 +and the server supports Envelope-to: headers,
   1.214 +and you want to make use of those with a mail filtering tool, e.g. procmail.
   1.215 +It cannot be preserved because masqmail sets such a header by itself.
   1.216  
   1.217  Default is false.
   1.218 +
   1.219  .TP
   1.220 +\fBdo_relay = \fIboolean\fR
   1.221  
   1.222 -\fBdo_relay = \fIboolean\f1\fB\f1
   1.223 +If this is set to false, mail with a return path that is not local and a destination
   1.224 +that is also not local will not be accepted via smtp and a 550 reply will be given.
   1.225 +Default is true.
   1.226  
   1.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.
   1.228 +Note that this will not protect you from spammers using open relays,
   1.229 +but from users unable to set their address in their mail clients.
   1.230  
   1.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.
   1.232  .TP
   1.233 +\fBdo_queue = \fIboolean\fR
   1.234  
   1.235 -\fBdo_queue = \fIboolean\f1\fB\f1
   1.236 +If this is set, mail will not be delivered immediately when accepted.
   1.237 +Same as calling masqmail with the \fB\-odq\fR option.
   1.238  
   1.239 -If this is set, mail will not be delivered immediately when accepted. Same as calling masqmail with the \fB\-odq\f1 option.
   1.240  .TP
   1.241 +\fBonline_routes.\fIname\fR = \fIlist\fR
   1.242  
   1.243 -\fBonline_routes.\fIname\f1\fB = \fIlist\f1\fB\f1
   1.244 +Replace \fIname\fR with a name to identify a connection.
   1.245 +Set this to a filename (or a list of filenames) for the special route configuration for that connection.
   1.246 +You will use that name to call masqmail with the \fB\-qo\fR option every time a
   1.247 +connection to your ISP is set up.
   1.248  
   1.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.
   1.250 +Example: Your ISP has the name FastNet.
   1.251 +Then you write the following line in the main configuration:
   1.252  
   1.253 -Example: Your ISP has the name FastNet. Then you write the following line in the main configuration:
   1.254 +\fBonline_routes.FastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
   1.255  
   1.256 -\fBonline_routes.FastNet\f1 = \fI"/etc/masqmail/fastnet.route"\f1
   1.257 +\fI/etc/masqmail/fastnet.route\fR is the route configuration file, see \fBmasqmail.route(5)\fR.
   1.258 +As soon as a link to FastNet has been set up, you call masqmail \fB\-qo \fIFastNet\fR.
   1.259 +Masqmail will then read the specified file and send the mails.
   1.260  
   1.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.
   1.262  .TP
   1.263 +\fBconnect_route.\fIname\fR = \fIlist\fR
   1.264  
   1.265 -\fBconnect_route.\fIname\f1\fB = \fIlist\f1\fB\f1
   1.266 +Old name for \fBonline_routes\fR.
   1.267  
   1.268 -Old name for \fBonline_routes\f1.
   1.269  .TP
   1.270 +\fBlocal_net_route = \fIfile\fR
   1.271  
   1.272 -\fBlocal_net_route = \fIfile\f1\fB\f1
   1.273 +This is similar to \fBonline_routes.\fIname\fR but for the local net.
   1.274 +Recipient addresses that are in local_nets will be routed using this route configuration.
   1.275 +Main purpose is to define a mail server with mail_host in your local network.
   1.276 +In simple environments this can be left unset.
   1.277 +If unset, a default route configuration will be used.
   1.278  
   1.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.
   1.280  .TP
   1.281 +\fBalias_file = \fIfile\fR
   1.282  
   1.283 -\fBalias_file = \fIfile\f1\fB\f1
   1.284 +Set this to the location of your alias file.
   1.285 +If unset, no aliasing will be done.
   1.286  
   1.287 -Set this to the location of your alias file. If unset, no aliasing will be done.
   1.288  .TP
   1.289 -
   1.290 -\fBalias_local_caseless = \fIboolean\f1\fB\f1
   1.291 +\fBalias_local_caseless = \fIboolean\fR
   1.292  
   1.293  If this is set, local parts in the alias file will be matched disregarding upper/lower case.
   1.294 +
   1.295  .TP
   1.296 +\fBpipe_fromline = \fIboolean\fR
   1.297  
   1.298 -\fBpipe_fromline = \fIboolean\f1\fB\f1
   1.299 +If this is set, a from line will be prepended to the output stream whenever
   1.300 +a pipe command is called after an alias expansion.
   1.301 +Default is false.
   1.302  
   1.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.
   1.304  .TP
   1.305 +\fBpipe_fromhack = \fIboolean\fR
   1.306  
   1.307 -\fBpipe_fromhack = \fIboolean\f1\fB\f1
   1.308 +If this is set, each line beginning with `From ' is replaced with `>From '
   1.309 +whenever a pipe command is called after an alias expansion.
   1.310 +You probably want this if you have set \fBpipe_fromline\fR above.
   1.311 +Default is false.
   1.312  
   1.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.
   1.314  .TP
   1.315 +\fBmbox_default = \fIstring\fR
   1.316  
   1.317 -\fBmbox_default = \fIstring\f1\fB\f1
   1.318 +The default local delivery method.
   1.319 +Can be one of mbox, mda or maildir (the latter only if maildir support is enabled at compile time).
   1.320 +Default is mbox.
   1.321 +You can override this for each user by using the \fBmbox_users\fR, \fBmda_users\fR,
   1.322 +or \fBmaildir_users\fR options (see below).
   1.323  
   1.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).
   1.325  .TP
   1.326 -
   1.327 -\fBmbox_users = \fIlist\f1\fB\f1
   1.328 +\fBmbox_users = \fIlist\fR
   1.329  
   1.330  A list of users which wish delivery to an mbox style mail folder.
   1.331 +
   1.332  .TP
   1.333 +\fBmda_users = \fIlist\fR
   1.334  
   1.335 -\fBmda_users = \fIlist\f1\fB\f1
   1.336 +A list of users which wish local delivery to an mda.
   1.337 +You have to set \fBmda\fR (see below) as well.
   1.338  
   1.339 -A list of users which wish local delivery to an mda. You have to set \fBmda\f1 (see below) as well.
   1.340  .TP
   1.341 +\fBmaildir_users = \fIlist\fR
   1.342  
   1.343 -\fBmaildir_users = \fIlist\f1\fB\f1
   1.344 +A list of users which wish delivery to a qmail style maildir.
   1.345 +The path to maildir is ~/Maildir/.
   1.346 +The maildir will be created if it does not exist.
   1.347  
   1.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.
   1.349  .TP
   1.350 +\fBmda = \fIexpand string\fR
   1.351  
   1.352 -\fBmda = \fIexpand string\f1\fB\f1
   1.353 +If you want local delivery to be transferred to an mda (Mail Delivery Agent),
   1.354 +set this to a command.
   1.355 +The argument will be expanded on delivery time,
   1.356 +you can use variables beginning with a dolloar sign `$', optionally enclosed in curly braces.
   1.357 +Variables you can use are:
   1.358  
   1.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:
   1.360 -
   1.361 -uid - the unique message id. This is not necessarily identical with the Message ID as given in the Message ID: header.
   1.362 +uid - the unique message id.
   1.363 +This is not necessarily identical with the Message ID as given in the Message ID: header.
   1.364  
   1.365  received_host - the host the mail was received from
   1.366  
   1.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.
   1.368 +ident - the ident, this is either the ident delivered by the ident protocol
   1.369 +or the user id of the sender if the message was received locally.
   1.370  
   1.371  return_path_local - the local part of the return path (sender).
   1.372  
   1.373 @@ -212,46 +302,69 @@
   1.374  
   1.375  mda="/usr/bin/procmail \-Y \-d ${rcpt_local}"
   1.376  
   1.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.
   1.378 +For the mda, as for pipe commands, a few environment variables will be set as well.
   1.379 +See \fBmasqmail(8)\fR.
   1.380 +To use environment variables for the mda, the dollar sign `$' has to be escaped with a backslash,
   1.381 +otherwise they will be tried to be expanded with the internal variables.
   1.382 +
   1.383  .TP
   1.384 +\fBmda_fromline = \fIboolean\fR
   1.385  
   1.386 -\fBmda_fromline = \fIboolean\f1\fB\f1
   1.387 +If this is set, a from line will be prepended to the output stream whenever
   1.388 +a message is delivered to an mda.
   1.389 +Default is false.
   1.390  
   1.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.
   1.392  .TP
   1.393 +\fBmda_fromhack = \fIboolean\fR
   1.394  
   1.395 -\fBmda_fromhack = \fIboolean\f1\fB\f1
   1.396 +If this is set, each line beginning with `From ' is replaced with `>From '
   1.397 +whenever a message is delivered to an mda.
   1.398 +You probably want this if you have set \fBmda_fromline\fR above.
   1.399 +Default is false.
   1.400  
   1.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.
   1.402  .TP
   1.403 +\fBonline_detect = \fIstring\fR
   1.404  
   1.405 -\fBonline_detect = \fIstring\f1\fB\f1
   1.406 +Defines the method masqmail uses to detect whether there is currently an online connection.
   1.407 +It can have the values \fBfile\fR, \fBpipe\fR, or \fBmserver\fR.
   1.408  
   1.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.
   1.410 +When it is set to \fBfile\fR, masqmail first checks for the existence of \fBonline_file\fR
   1.411 +(see below) and if it exists, it reads it.
   1.412 +The content of the file should be the name of the current connection as defined
   1.413 +with \fBconnect_route.\fIname\fR (trailing whitespace is removed).
   1.414  
   1.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).
   1.416 +When it is set to \fBpipe\fR, masqmail calls the executable given by the
   1.417 +\fBonline_pipe\fR option (see below) and reads the current online status from its standard output.
   1.418  
   1.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.
   1.420 +When it is set to \fBmserver\fR, masqmail connects to the masqdialer server
   1.421 +using the value of \fBmserver_iface\fR and asks it whether a connection exists and for the name,
   1.422 +which should be the name of the current connection as defined with \fBconnect_route.\fIname\fR.
   1.423  
   1.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.
   1.425 +No matter how masqmail detects the online status,
   1.426 +only messages that are accepted at online time will be delivered using the connection.
   1.427 +The spool still has to be emptied with masqmail \fB\-qo\fIconnection\fR.
   1.428  
   1.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.
   1.430  .TP
   1.431 +\fBonline_file = \fIfile\fR
   1.432  
   1.433 -\fBonline_file = \fIfile\f1\fB\f1
   1.434 -
   1.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.
   1.436 +This is the name of the file checked for when masqmail determines whether it is online.
   1.437 +The file should only exist when there is currently a connection.
   1.438 +Create it in your ip-up script with e.g.
   1.439  
   1.440  echo \-n <name> > /tmp/connect_route
   1.441  
   1.442  chmod 0644 /tmp/connect_route
   1.443  
   1.444  Do not forget to delete it in your ip-down script.
   1.445 +
   1.446  .TP
   1.447 +\fBonline_pipe = \fIfile\fR
   1.448  
   1.449 -\fBonline_pipe = \fIfile\f1\fB\f1
   1.450 -
   1.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:
   1.452 +This is the name of the executable which will be called to determine the online status.
   1.453 +This executable should just print the name of the current connection to
   1.454 +the standard output and return a zero status code.
   1.455 +masqmail assumes it is offline if the script returns with a non zero status.
   1.456 +Simple example:
   1.457  
   1.458  #!/bin/sh
   1.459  
   1.460 @@ -261,84 +374,109 @@
   1.461  
   1.462  exit 0
   1.463  
   1.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.
   1.465 +Of course, instead of the example above you could as well use \fBfile\fR as
   1.466 +the online detection method, but you can do something more sophisticated.
   1.467 +
   1.468  .TP
   1.469 +\fBmserver_iface = \fIinterface\fR
   1.470  
   1.471 -\fBmserver_iface = \fIinterface\f1\fB\f1
   1.472 +The interface the masqdialer server is listening to.
   1.473 +Usually this will be "localhost:224" if mserver is running on the same host as masqmail.
   1.474 +But using this option, you can also let masqmail run on another host by setting
   1.475 +\fBmserver_iface\fR to another hostname, e.g. "foo:224".
   1.476  
   1.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".
   1.478  .TP
   1.479 +\fBget.\fIname\fR = \fIfile\fR
   1.480  
   1.481 -\fBget.\fIname\f1\fB = \fIfile\f1\fB\f1
   1.482 +Replace \fIname\fR with a name to identify a get configuration.
   1.483 +Set this to a filename for the get configuration.
   1.484 +These files will be used to retrieve mail when called with the \-g option.
   1.485  
   1.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.
   1.487  .TP
   1.488 +\fBonline_gets.\fIname\fR = \fIlist\fR
   1.489  
   1.490 -\fBonline_gets.\fIname\f1\fB = \fIlist\f1\fB\f1
   1.491 +Replace \fIname\fR with a name to identify an online configuration.
   1.492 +Set this to a filename (or a list of filenames) for the get configuration.
   1.493 +These files will be used to retrieve mail when called with the \-go option.
   1.494  
   1.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.
   1.496  .TP
   1.497 +\fBident_trusted_nets = \fIlist\fR
   1.498  
   1.499 -\fBident_trusted_nets = \fIlist\f1\fB\f1
   1.500 +\fIlist\fR is a list of networks of the form a.b.c.d/e (e.g. 192.168.1.0/24),
   1.501 +from which the ident given by the ident protocol will be trusted,
   1.502 +so a user can delete his mail from the queue if the ident is identical to his login name.
   1.503  
   1.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.
   1.505  .TP
   1.506 +\fBerrmsg_file = \fIfile\fR
   1.507  
   1.508 -\fBerrmsg_file = \fIfile\f1\fB\f1
   1.509 -
   1.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.
   1.511 +Set this to a template which will be used to generate delivery failure reports.
   1.512 +Variable parts within the template begin with a dollar sign and are identical
   1.513 +to those which can be used as arguments for the mda command, see \fBmda\fR above.
   1.514 +Additional information can be included with @failed_rcpts, @msg_headers and @msg_body,
   1.515 +these must be at the beginning of a line and will be replaced with the list of the failed recipients,
   1.516 +the message headers and the message body of the failed message.
   1.517  
   1.518  Default is /usr/share/masqmail/tpl/failmsg.tpl.
   1.519 +
   1.520  .TP
   1.521 +\fBwarnmsg_file = \fIfile\fR
   1.522  
   1.523 -\fBwarnmsg_file = \fIfile\f1\fB\f1
   1.524 -
   1.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.
   1.526 +Set this to a template which will be used to generate delivery warning reports.
   1.527 +It uses the same mechanisms for variables as \fBerrmsg_file\fR, see above.
   1.528  
   1.529  Default is /usr/share/masqmail/tpl/warnmsg.tpl.
   1.530 +
   1.531  .TP
   1.532 +\fBwarn_intervals\fR = \fIlist\fR
   1.533  
   1.534 -\fBwarn_intervals\f1 = \fIlist\f1
   1.535 +Set this to a list of time intervals, at which delivery warnings
   1.536 +(starting with the receiving time of the message) shall be generated.
   1.537  
   1.538 -Set this to a list of time intervals, at which delivery warnings (starting with the receiving time of the message) shall be generated.
   1.539 -
   1.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.
   1.541 +A warning will only be generated just after an attempt to deliver the mail
   1.542 +and if that attempt failed temporarily.
   1.543 +So a warning may be generated after a longer time, if there was no attempt before.
   1.544  
   1.545  Default is "1h;4h;8h;1d;2d;3d"
   1.546 +
   1.547  .TP
   1.548 +\fBmax_defer_time\fR = \fItime\fR
   1.549  
   1.550 -\fBmax_defer_time\f1 = \fItime\f1
   1.551 +This is the maximum time, in which a temporarily failed mail will be kept in the spool.
   1.552 +When this time is exceeded, it will be handled as a delivery failure,
   1.553 +and the message will be bounced.
   1.554  
   1.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.
   1.556 -
   1.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.
   1.558 +The excedence of this time will only be noticed if the message was actually tried to be delivered.
   1.559 +If, for example, the message can only be delivered when online,
   1.560 +but you have not been online for that time, no bounce will be generated.
   1.561  
   1.562  Default is 4d (4 days)
   1.563 +
   1.564  .TP
   1.565 +\fBlog_user = \fIname\fR
   1.566  
   1.567 -\fBlog_user = \fIname\f1\fB\f1
   1.568 +Replace \fIname\fR with a valid local or remote mail address.
   1.569  
   1.570 -Replace \fIname\f1 with a valid local or remote mail address.
   1.571 +If this option is not empty, then a copy of every mail,
   1.572 +that passes trough the masqmail system will also be sent to the given mail address.
   1.573  
   1.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.
   1.575 +For example you can feed your mails into a program like hypermail
   1.576 +for archiving purpose by placing an appropriate pipe command in masqmail.alias
   1.577  
   1.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
   1.579 +
   1.580  .SH AUTHOR
   1.581  
   1.582 -masqmail was written by Oliver Kurth. It is now maintained by Markus Schnalke <meillo@marmaro.de>.
   1.583 +Masqmail was written by Oliver Kurth.
   1.584 +It is now maintained by Markus Schnalke <meillo@marmaro.de>.
   1.585  
   1.586 -You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\f1.
   1.587 +You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\fR.
   1.588  There is also a mailing list, you will find information about it at masqmail's main site.
   1.589  
   1.590 +
   1.591  .SH BUGS
   1.592  
   1.593 -You should report them to the mailing list.
   1.594 +Please report bugs to the mailing list.
   1.595 +
   1.596  
   1.597  .SH SEE ALSO
   1.598  
   1.599 -\fBmasqmail (8)\f1, \fBmasqmail.route (5)\f1, \fBmasqmail.get (5)\f1
   1.600 -
   1.601 -.SH COMMENTS
   1.602 -
   1.603 -This man page was written using \fBxml2man (1)\f1 by the same author.
   1.604 -
   1.605 +\fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.get(5)\fR