masqmail
view man/masqmail.aliases.5 @ 391:0ca270ca11fa
Refactoring and code layouting.
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Sat, 18 Feb 2012 17:53:04 +0100 |
| parents | 35c5239ebcc1 |
| children | 34c919a8d74e |
line source
1 .TH masqmail.aliases 5 2012-01-18 masqmail-0.3.4 "File Formats"
3 .SH NAME
4 masqmail.aliases \- masqmail alias file format
7 .SH DESCRIPTION
9 This man page describes the format of the masqmail alias file.
10 It's usual location is \fI/etc/aliases\fR.
12 There exists also a variant of this format for glob patterns.
13 It's used with the \fIglobalias_file\fP config option.
15 The difference between the two formats are only on the left-hand side.
16 A normal alias file has a local_part there that gets string-compared
17 against the local part;
18 whereas a glob alias file has a glob pattern that is matched against
19 the whole address. The right-hand side of the two aliasing kinds
20 has the same format.
23 .SH FILE FORMAT
25 Normal alias files consist of lines of the form:
27 .RS
28 local_part: item1, item2, ...
29 .RE
31 Glob-pattern alias files consist of lines of the form:
33 .RS
34 glob_pattern: item1, item2, ...
35 .RE
37 Items can be surrounded by double quotes `"'.
38 If within the quotes other quotes are needed for an address they can be
39 escaped with a leading backslash `\\'.
41 A leading backslash `\\' indicates that this address shall not be
42 further expanded.
44 A leading pipe symbol `|' indicates that the item shall be treated as a
45 pipe command.
46 The content of the message will then be sent to the standard input of the
47 command.
48 The command will run under the user id and group id masqmail is running as.
49 If quotes are needed, the pipe symbol must appear within the quotes.
51 Loops will be detected, the offending address will be ignored.
53 Aliases will be expanded at delivery time.
54 This means that if there is a message still in the queue and you change
55 any alias which matches one of the recipient addresses,
56 the change will have effect next time a delivery is attemped.
58 There is no need to restart masqmail or run any command when the alias
59 file has been changed. (`masqmail -bi' is a no-op.)
62 .SH EXAMPLE
64 A normal alias file:
66 .RS
67 .nf
68 # postmaster is required by RFC 2821
69 postmaster: root
71 # forward abuse mail to another address
72 abuse: abuse@example.org
74 # copy root's mail also to meillo
75 root: \\root, meillo
77 # pass mail to a script
78 foo: |/usr/bin/foo
79 .fi
80 .RE
83 A glob-pattern alias file:
85 .RS
86 .nf
87 # the postmaster for any domain on this host
88 postmaster@*: ken
90 # split virtual domains
91 info@foo.example.org: doug
92 info@bar.example.org: rob
94 # the order of entries is important
95 # this must be before the catch-all line
96 list\-*@example.org: |/path/to/some/script
98 # catch-all address forwarded to extern
99 *@example.org: brian@other.host.net
100 .fi
101 .RE
104 .SH AUTHOR
106 Masqmail was written by Oliver Kurth.
107 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
109 You will find the newest version of masqmail at
110 \fBhttp://marmaro.de/prog/masqmail/\fR.
111 There is also a mailing list, you will find information about
112 it at masqmail's main site.
115 .SH BUGS
117 Please report bugs to the mailing list.
120 .SH SEE ALSO
122 \fBmasqmail.conf(5)\fR, \fBmasqmail(8)\fR,