masqmail

diff man/masqmail.conf.5 @ 354:08932c629849

reworked the route concept; removed the idea of the localnet Renamed to reflect the actual meaning more clearly: s/online_routes/query_routes/g s/local_net_route/permanent_routes/g Removed local_nets, which are now represented by allowed_recipients in a permanent route. (See. examples/localnet.route) There is no more abiguity between `local' and `local net'. Run admin/config-transition on your config to learn how to update it.
author markus schnalke <meillo@marmaro.de>
date Sun, 04 Sep 2011 11:25:38 +0200
parents 1ca9bc4c6552
children 3f923f97563b
line diff
     1.1 --- a/man/masqmail.conf.5	Sun Sep 04 10:23:00 2011 +0200
     1.2 +++ b/man/masqmail.conf.5	Sun Sep 04 11:25:38 2011 +0200
     1.3 @@ -25,8 +25,8 @@
     1.4  For some values, patterns (like `*',`?') can be used.
     1.5  The spaces in front of and after the equal sign `=' are optional.
     1.6  
     1.7 -Most lists (exceptions: \fBlocal_hosts\fR, \fBlocal_nets\fR, \fBlisten_addresses\fR,
     1.8 -and \fBonline_routes\fR) accept files.
     1.9 +Most lists (exceptions: \fBlocal_hosts\fR, \fBlisten_addresses\fR,
    1.10 +\fBquery_routes.\fIname\fR and \fBpermanent_routes\fR) accept files.
    1.11  These will be recognized by a leading slash `/'.
    1.12  The contents of these files will be included at the position of the file name,
    1.13  there can be items or other files before and after the file entry.
    1.14 @@ -164,13 +164,6 @@
    1.15  not_local_addresses = "eric@mydomain.net"
    1.16  
    1.17  .TP
    1.18 -\fBlocal_nets = \fIlist\fR
    1.19 -
    1.20 -A semicolon `;' separated list of hostnames which are on the `local' net.
    1.21 -Delivery to these hosts is attempted immediately.
    1.22 -You can use patterns with `*', e.g. "*.bar.com".
    1.23 -
    1.24 -.TP
    1.25  \fBlisten_addresses = \fIlist\fR
    1.26  
    1.27  A semicolon `;' separated list of interfaces on which connections will be accepted.
    1.28 @@ -222,35 +215,55 @@
    1.29  Default: false
    1.30  
    1.31  .TP
    1.32 -\fBonline_routes.\fIname\fR = \fIlist\fR
    1.33 +\fBpermanent_routes\fR = \fIlist\fR
    1.34  
    1.35 -Replace \fIname\fR with a name to identify a connection.
    1.36 -Set this to a filename (or a list of filenames) for the special route configuration for that connection.
    1.37 -You will use that name to call masqmail with the \fB\-qo\fR option every time a
    1.38 -connection to your ISP is set up.
    1.39 +Set this to the filename (or a semicolon-separated list of filenames)
    1.40 +of the route configuration for always available connections.
    1.41 +Main purpose is to define a mail server with mail_host in your local network,
    1.42 +or if masqmail should send mail directly to the target host.
    1.43 +If you have only a single host, you can leave it unset.
    1.44 +
    1.45 +A setting `\fBlocal_nets\fR = \fI"*home.net"\fR' in versions <= 0.3.3
    1.46 +is in newer versions configured as:
    1.47 +`\fBpermanent_routes\fR = \fI"/etc/masqmail/homenet.route"\fR'
    1.48 +and the route file `homenet.route' containing:
    1.49 +.in +1in
    1.50 +.nf
    1.51 +allowed_recipients = "*@*home.net"
    1.52 +connect_error_fail = true
    1.53 +resolve_list = byname
    1.54 +.fi
    1.55 +.in 0
    1.56 +This is just as it had been with \fBlocal_net_route\fP,
    1.57 +with the exception that the filtering for appropriate addresses
    1.58 +is only in the route file and not with \fBlocal_nets\fR.
    1.59 +
    1.60 +.TP
    1.61 +\fBquery_routes.\fIname\fR = \fIlist\fR
    1.62 +
    1.63 +Replace \fIname\fR with a name to identify the connection.
    1.64 +Set this to a filename (or a semicolon-separated list of filenames)
    1.65 +for the route configuration for that connection.
    1.66 +
    1.67 +Routes of this kind cannot be expected to be online always.
    1.68 +Masqmail will query which of the routes are online.
    1.69 +
    1.70 +You can use the name to call masqmail with the \fB\-qo\fR option every time a
    1.71 +connection to your ISP is set up, in order to send queued mail through this 
    1.72 +route.
    1.73  
    1.74  Example: Your ISP has the name FastNet.
    1.75  Then you write the following line in the main configuration:
    1.76  
    1.77 - \fBonline_routes.FastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
    1.78 +\fBquery_routes.\fBFastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
    1.79  
    1.80 -\fI/etc/masqmail/fastnet.route\fR is the route configuration file, see \fBmasqmail.route(5)\fR.
    1.81 -As soon as a link to FastNet has been set up, you call masqmail \fB\-qo \fIFastNet\fR.
    1.82 +\fI/etc/masqmail/fastnet.route\fR is the route configuration file,
    1.83 +see \fBmasqmail.route(5)\fR.
    1.84 +As soon as a link to FastNet has been set up,
    1.85 +you call `masqmail \fB\-qo \fIFastNet\fR'.
    1.86  Masqmail will then read the specified file and send the mails.
    1.87  
    1.88 -.TP
    1.89 -\fBconnect_route.\fIname\fR = \fIlist\fR
    1.90 -
    1.91 -Old name for \fBonline_routes\fR.
    1.92 -
    1.93 -.TP
    1.94 -\fBlocal_net_route = \fIfile\fR
    1.95 -
    1.96 -This is similar to \fBonline_routes.\fIname\fR but used for delilvery to the local net.
    1.97 -Recipient addresses that are in local_nets will be routed using this route configuration.
    1.98 -Main purpose is to define a mail server with mail_host in your local network.
    1.99 -In simple environments this can be left unset.
   1.100 -If unset, a default route configuration (named ``default local_net_route'') will be used.
   1.101 +See \fBonline_query\fP.
   1.102  
   1.103  .TP
   1.104  \fBalias_file = \fIfile\fR
   1.105 @@ -366,7 +379,7 @@
   1.106  
   1.107  Masqmail executes the command given and reads from its standard output.
   1.108  The command should just print a route name, as defined
   1.109 -with \fBonline_routes.\fIname\fR, to standard output and return a zero status code.
   1.110 +with \fBquery_routes.\fIname\fR, to standard output and return a zero status code.
   1.111  Masqmail assumes it is offline if the script returns with a non-zero status.
   1.112  Leading and trailing whitespace is removed from the output.
   1.113