Mercurial > masqmail

annotate man/masqmail.aliases.5 @ 434:f2a7271746d1 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Removes Freshmeat.net from the docs The site, which was later renamed to freecode.com, is no longer maintained (contains only a static copy).
author markus schnalke <meillo@marmaro.de>
date Sat, 07 Feb 2015 11:45:07 +0100
parents 34c919a8d74e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
431
34c919a8d74e Bumps version number and updates Changelog and NEWS
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
1 .TH masqmail.aliases 5 2015-02-07 masqmail-0.3.5 "File Formats"
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
2
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
3 .SH NAME
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
4 masqmail.aliases \- masqmail alias file format
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
5
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
6
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
7 .SH DESCRIPTION
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
8
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
9 This man page describes the format of the masqmail alias file.
387
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
10 It's usual location is \fI/etc/aliases\fR.
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
11
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
12 There exists also a variant of this format for glob patterns.
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
13 It's used with the \fIglobalias_file\fP config option.
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
14
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
15 The difference between the two formats are only on the left-hand side.
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
16 A normal alias file has a local_part there that gets string-compared
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
17 against the local part;
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
18 whereas a glob alias file has a glob pattern that is matched against
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
19 the whole address. The right-hand side of the two aliasing kinds
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
20 has the same format.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
21
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
22
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
23 .SH FILE FORMAT
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
24
387
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
25 Normal alias files consist of lines of the form:
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
26
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
27 .RS
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
28 local_part: item1, item2, ...
387
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
29 .RE
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
30
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
31 Glob-pattern alias files consist of lines of the form:
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
32
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
33 .RS
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
34 glob_pattern: item1, item2, ...
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
35 .RE
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
36
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
37 Items can be surrounded by double quotes `"'.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
38 If within the quotes other quotes are needed for an address they can be
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
39 escaped with a leading backslash `\\'.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
40
387
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
41 A leading backslash `\\' indicates that this address shall not be
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
42 further expanded.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
43
387
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
44 A leading pipe symbol `|' indicates that the item shall be treated as a
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
45 pipe command.
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
46 The content of the message will then be sent to the standard input of the
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
47 command.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
48 The command will run under the user id and group id masqmail is running as.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
49 If quotes are needed, the pipe symbol must appear within the quotes.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
50
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
51 Loops will be detected, the offending address will be ignored.
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
52
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
53 Aliases will be expanded at delivery time.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
54 This means that if there is a message still in the queue and you change
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
55 any alias which matches one of the recipient addresses,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
56 the change will have effect next time a delivery is attemped.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
57
387
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
58 There is no need to restart masqmail or run any command when the alias
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
59 file has been changed. (`masqmail -bi' is a no-op.)
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
60
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
61
308
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
62 .SH EXAMPLE
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
63
387
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
64 A normal alias file:
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
65
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
66 .RS
308
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
67 .nf
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
68 # postmaster is required by RFC 2821
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
69 postmaster: root
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
70
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
71 # forward abuse mail to another address
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
72 abuse: abuse@example.org
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
73
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
74 # copy root's mail also to meillo
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
75 root: \\root, meillo
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
76
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
77 # pass mail to a script
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
78 foo: |/usr/bin/foo
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
79 .fi
387
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
80 .RE
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
81
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
82
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
83 A glob-pattern alias file:
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
84
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
85 .RS
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
86 .nf
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
87 # the postmaster for any domain on this host
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
88 postmaster@*: ken
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
89
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
90 # split virtual domains
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
91 info@foo.example.org: doug
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
92 info@bar.example.org: rob
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
93
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
94 # the order of entries is important
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
95 # this must be before the catch-all line
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
96 list\-*@example.org: |/path/to/some/script
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
97
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
98 # catch-all address forwarded to extern
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
99 *@example.org: brian@other.host.net
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
100 .fi
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
101 .RE
308
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
102
86d8a3cf517d added alias examples to man page
meillo@marmaro.de
parents: 291
diff changeset
103
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
104 .SH AUTHOR
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
105
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
106 Masqmail was written by Oliver Kurth.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
107 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
108
387
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
109 You will find the newest version of masqmail at
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
110 \fBhttp://marmaro.de/prog/masqmail/\fR.
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
111 There is also a mailing list, you will find information about
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
112 it at masqmail's main site.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
113
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
114
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
115 .SH BUGS
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
116
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
117 Please report bugs to the mailing list.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
118
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
119
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
120 .SH SEE ALSO
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
121
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 26
diff changeset
122 \fBmasqmail.conf(5)\fR, \fBmasqmail(8)\fR,