meillo@431: .TH masqmail.aliases 5 2015-02-07 masqmail-0.3.5 "File Formats"
meillo@34: 
meillo@0: .SH NAME
meillo@0: masqmail.aliases \- masqmail alias file format
meillo@34: 
meillo@34: 
meillo@0: .SH DESCRIPTION
meillo@0: 
meillo@34: This man page describes the format of the masqmail alias file.
meillo@387: It's usual location is \fI/etc/aliases\fR.
meillo@387: 
meillo@387: There exists also a variant of this format for glob patterns.
meillo@387: It's used with the \fIglobalias_file\fP config option.
meillo@387: 
meillo@387: The difference between the two formats are only on the left-hand side.
meillo@387: A normal alias file has a local_part there that gets string-compared
meillo@387: against the local part;
meillo@387: whereas a glob alias file has a glob pattern that is matched against
meillo@387: the whole address. The right-hand side of the two aliasing kinds
meillo@387: has the same format.
meillo@34: 
meillo@0: 
meillo@0: .SH FILE FORMAT
meillo@0: 
meillo@387: Normal alias files consist of lines of the form:
meillo@387: 
meillo@387: .RS
meillo@0: local_part: item1, item2, ...
meillo@387: .RE
meillo@387: 
meillo@387: Glob-pattern alias files consist of lines of the form:
meillo@387: 
meillo@387: .RS
meillo@387: glob_pattern: item1, item2, ...
meillo@387: .RE
meillo@387: 
meillo@34: Items can be surrounded by double quotes `"'.
meillo@34: If within the quotes other quotes are needed for an address they can be
meillo@34: escaped with a leading backslash `\\'.
meillo@0: 
meillo@387: A leading backslash `\\' indicates that this address shall not be
meillo@387: further expanded.
meillo@0: 
meillo@387: A leading pipe symbol `|' indicates that the item shall be treated as a
meillo@387: pipe command.
meillo@387: The content of the message will then be sent to the standard input of the
meillo@387: command.
meillo@34: The command will run under the user id and group id masqmail is running as.
meillo@34: If quotes are needed, the pipe symbol must appear within the quotes.
meillo@0: 
meillo@0: Loops will be detected, the offending address will be ignored.
meillo@0: 
meillo@34: Aliases will be expanded at delivery time.
meillo@34: This means that if there is a message still in the queue and you change
meillo@34: any alias which matches one of the recipient addresses,
meillo@34: the change will have effect next time a delivery is attemped.
meillo@0: 
meillo@387: There is no need to restart masqmail or run any command when the alias
meillo@387: file has been changed. (`masqmail -bi' is a no-op.)
meillo@0: 
meillo@34: 
meillo@308: .SH EXAMPLE
meillo@308: 
meillo@387: A normal alias file:
meillo@387: 
meillo@387: .RS
meillo@308: .nf
meillo@308: # postmaster is required by RFC 2821
meillo@308: postmaster: root
meillo@308: 
meillo@308: # forward abuse mail to another address
meillo@308: abuse: abuse@example.org
meillo@308: 
meillo@308: # copy root's mail also to meillo
meillo@308: root: \\root, meillo
meillo@308: 
meillo@308: # pass mail to a script
meillo@308: foo: |/usr/bin/foo
meillo@308: .fi
meillo@387: .RE
meillo@387: 
meillo@387: 
meillo@387: A glob-pattern alias file:
meillo@387: 
meillo@387: .RS
meillo@387: .nf
meillo@387: # the postmaster for any domain on this host
meillo@387: postmaster@*: ken
meillo@387: 
meillo@387: # split virtual domains
meillo@387: info@foo.example.org: doug
meillo@387: info@bar.example.org: rob
meillo@387: 
meillo@387: # the order of entries is important
meillo@387: # this must be before the catch-all line
meillo@387: list\-*@example.org: |/path/to/some/script
meillo@387: 
meillo@387: # catch-all address forwarded to extern
meillo@387: *@example.org: brian@other.host.net
meillo@387: .fi
meillo@387: .RE
meillo@308: 
meillo@308: 
meillo@0: .SH AUTHOR
meillo@0: 
meillo@34: Masqmail was written by Oliver Kurth.
meillo@34: It is now maintained by Markus Schnalke <meillo@marmaro.de>.
meillo@0: 
meillo@387: You will find the newest version of masqmail at
meillo@387: \fBhttp://marmaro.de/prog/masqmail/\fR.
meillo@387: There is also a mailing list, you will find information about
meillo@387: it at masqmail's main site.
meillo@0: 
meillo@34: 
meillo@0: .SH BUGS
meillo@0: 
meillo@34: Please report bugs to the mailing list.
meillo@34: 
meillo@0: 
meillo@0: .SH SEE ALSO
meillo@0: 
meillo@34: \fBmasqmail.conf(5)\fR, \fBmasqmail(8)\fR,