masqmail

diff man/masqmail.aliases.5 @ 387:a408411ff8df

Added a glob-pattern aliasing facility. One use-case is virtual hosting another catch-all maildrops, but you may use it as a more flexible aliasing mechanism as well.
author markus schnalke <meillo@marmaro.de>
date Sat, 18 Feb 2012 12:35:12 +0100
parents 35c5239ebcc1
children 34c919a8d74e
line diff
     1.1 --- a/man/masqmail.aliases.5	Sat Feb 18 11:43:06 2012 +0100
     1.2 +++ b/man/masqmail.aliases.5	Sat Feb 18 12:35:12 2012 +0100
     1.3 @@ -7,21 +7,44 @@
     1.4  .SH DESCRIPTION
     1.5  
     1.6  This man page describes the format of the masqmail alias file.
     1.7 -Its usual location is \fI/etc/aliases\fR.
     1.8 +It's usual location is \fI/etc/aliases\fR.
     1.9 +
    1.10 +There exists also a variant of this format for glob patterns.
    1.11 +It's used with the \fIglobalias_file\fP config option.
    1.12 +
    1.13 +The difference between the two formats are only on the left-hand side.
    1.14 +A normal alias file has a local_part there that gets string-compared
    1.15 +against the local part;
    1.16 +whereas a glob alias file has a glob pattern that is matched against
    1.17 +the whole address. The right-hand side of the two aliasing kinds
    1.18 +has the same format.
    1.19  
    1.20  
    1.21  .SH FILE FORMAT
    1.22  
    1.23 -The alias file consists of lines of the form:
    1.24 +Normal alias files consist of lines of the form:
    1.25 +
    1.26 +.RS
    1.27  local_part: item1, item2, ...
    1.28 +.RE
    1.29 +
    1.30 +Glob-pattern alias files consist of lines of the form:
    1.31 +
    1.32 +.RS
    1.33 +glob_pattern: item1, item2, ...
    1.34 +.RE
    1.35 +
    1.36  Items can be surrounded by double quotes `"'.
    1.37  If within the quotes other quotes are needed for an address they can be
    1.38  escaped with a leading backslash `\\'.
    1.39  
    1.40 -A leading backslash `\\' indicates that this address shall not be further expanded.
    1.41 +A leading backslash `\\' indicates that this address shall not be
    1.42 +further expanded.
    1.43  
    1.44 -A leading pipe symbol `|' indicates that the item shall be treated as a pipe command.
    1.45 -The content of the message will then be sent to the standard input of the command.
    1.46 +A leading pipe symbol `|' indicates that the item shall be treated as a
    1.47 +pipe command.
    1.48 +The content of the message will then be sent to the standard input of the
    1.49 +command.
    1.50  The command will run under the user id and group id masqmail is running as.
    1.51  If quotes are needed, the pipe symbol must appear within the quotes.
    1.52  
    1.53 @@ -32,11 +55,15 @@
    1.54  any alias which matches one of the recipient addresses,
    1.55  the change will have effect next time a delivery is attemped.
    1.56  
    1.57 -There is no need to restart masqmail or run any command when the alias file has been changed.
    1.58 +There is no need to restart masqmail or run any command when the alias
    1.59 +file has been changed. (`masqmail -bi' is a no-op.)
    1.60  
    1.61  
    1.62  .SH EXAMPLE
    1.63  
    1.64 +A normal alias file:
    1.65 +
    1.66 +.RS
    1.67  .nf
    1.68  # postmaster is required by RFC 2821
    1.69  postmaster: root
    1.70 @@ -50,6 +77,28 @@
    1.71  # pass mail to a script
    1.72  foo: |/usr/bin/foo
    1.73  .fi
    1.74 +.RE
    1.75 +
    1.76 +
    1.77 +A glob-pattern alias file:
    1.78 +
    1.79 +.RS
    1.80 +.nf
    1.81 +# the postmaster for any domain on this host
    1.82 +postmaster@*: ken
    1.83 +
    1.84 +# split virtual domains
    1.85 +info@foo.example.org: doug
    1.86 +info@bar.example.org: rob
    1.87 +
    1.88 +# the order of entries is important
    1.89 +# this must be before the catch-all line
    1.90 +list\-*@example.org: |/path/to/some/script
    1.91 +
    1.92 +# catch-all address forwarded to extern
    1.93 +*@example.org: brian@other.host.net
    1.94 +.fi
    1.95 +.RE
    1.96  
    1.97  
    1.98  .SH AUTHOR
    1.99 @@ -57,8 +106,10 @@
   1.100  Masqmail was written by Oliver Kurth.
   1.101  It is now maintained by Markus Schnalke <meillo@marmaro.de>.
   1.102  
   1.103 -You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
   1.104 -There is also a mailing list, you will find information about it at masqmail's main site.
   1.105 +You will find the newest version of masqmail at
   1.106 +\fBhttp://marmaro.de/prog/masqmail/\fR.
   1.107 +There is also a mailing list, you will find information about
   1.108 +it at masqmail's main site.
   1.109  
   1.110  
   1.111  .SH BUGS