Patrick Welche <prlw1@cam.ac.uk>
[netbsd-mini2440.git] / external / ibm-public / postfix / dist / man / man5 / pcre_table.5
blobc8a3bae030666af8dfff407ef93e183862139e69
1 .\"     $NetBSD$
2 .\"
3 .TH PCRE_TABLE 5 
4 .ad
5 .fi
6 .SH NAME
7 pcre_table
8 \-
9 format of Postfix PCRE tables
10 .SH "SYNOPSIS"
11 .na
12 .nf
13 \fBpostmap -q "\fIstring\fB" pcre:/etc/postfix/\fIfilename\fR
15 \fBpostmap -q - pcre:/etc/postfix/\fIfilename\fR <\fIinputfile\fR
16 .SH DESCRIPTION
17 .ad
18 .fi
19 The Postfix mail system uses optional tables for address
20 rewriting, mail routing, or access control. These tables
21 are usually in \fBdbm\fR or \fBdb\fR format.
23 Alternatively, lookup tables can be specified in Perl Compatible
24 Regular Expression form. In this case, each input is compared
25 against a list of patterns. When a match is found, the
26 corresponding result is returned and the search is terminated.
28 To find out what types of lookup tables your Postfix system
29 supports use the "\fBpostconf -m\fR" command.
31 To test lookup tables, use the "\fBpostmap -q\fR" command as
32 described in the SYNOPSIS above.
33 .SH "COMPATIBILITY"
34 .na
35 .nf
36 .ad
37 .fi
38 With Postfix version 2.2 and earlier specify "\fBpostmap
39 -fq\fR" to query a table that contains case sensitive
40 patterns. Patterns are case insensitive by default.
41 .SH "TABLE FORMAT"
42 .na
43 .nf
44 .ad
45 .fi
46 The general form of a PCRE table is:
47 .IP "\fB/\fIpattern\fB/\fIflags result\fR"
48 When \fIpattern\fR matches the input string, use
49 the corresponding \fIresult\fR value.
50 .IP "\fB!/\fIpattern\fB/\fIflags result\fR"
51 When \fIpattern\fR does \fBnot\fR match the input string, use
52 the corresponding \fIresult\fR value.
53 .IP "\fBif /\fIpattern\fB/\fIflags\fR"
54 .IP "\fBendif\fR"
55 Match the input string against the patterns between \fBif\fR
56 and \fBendif\fR, if and only if that same input string also matches
57 \fIpattern\fR. The \fBif\fR..\fBendif\fR can nest.
58 .sp
59 Note: do not prepend whitespace to patterns inside
60 \fBif\fR..\fBendif\fR.
61 .sp
62 This feature is available in Postfix 2.1 and later.
63 .IP "\fBif !/\fIpattern\fB/\fIflags\fR"
64 .IP "\fBendif\fR"
65 Match the input string against the patterns between \fBif\fR
66 and \fBendif\fR, if and only if that same input string does \fBnot\fR
67 match \fIpattern\fR. The \fBif\fR..\fBendif\fR can nest.
68 .sp
69 Note: do not prepend whitespace to patterns inside
70 \fBif\fR..\fBendif\fR.
71 .sp
72 This feature is available in Postfix 2.1 and later.
73 .IP "blank lines and comments"
74 Empty lines and whitespace-only lines are ignored, as
75 are lines whose first non-whitespace character is a `#'.
76 .IP "multi-line text"
77 A logical line starts with non-whitespace text. A line that
78 starts with whitespace continues a logical line.
79 .PP
80 Each pattern is a perl-like regular expression. The expression
81 delimiter can be any character, except whitespace or characters
82 that have special meaning (traditionally the forward slash is used).
83 The regular expression can contain whitespace.
85 By default, matching is case-insensitive, and newlines are not
86 treated as special characters. The behavior is controlled by flags,
87 which are toggled by appending one or more of the following
88 characters after the pattern:
89 .IP "\fBi\fR (default: on)"
90 Toggles the case sensitivity flag. By default, matching is case
91 insensitive.
92 .IP "\fBm\fR (default: off)"
93 Toggles the PCRE_MULTILINE flag. When this flag is on, the \fB^\fR
94 and \fB$\fR metacharacters match immediately after and immediately
95 before a newline character, respectively, in addition to
96 matching at the start and end of the subject string.
97 .IP "\fBs\fR (default: on)"
98 Toggles the PCRE_DOTALL flag. When this flag is on, the \fB.\fR
99 metacharacter matches the newline character. With
100 Postfix versions prior to 2.0, The flag is off by
101 default, which is inconvenient for multi-line message header
102 matching.
103 .IP "\fBx\fR (default: off)"
104 Toggles the pcre extended flag. When this flag is on, whitespace
105 characters in the pattern (other than in a character class)
106 are ignored.  To include a whitespace character as part of
107 the pattern, escape it with backslash.
109 Note: do not use \fB#\fIcomment\fR after patterns.
110 .IP "\fBA\fR (default: off)"
111 Toggles the PCRE_ANCHORED flag.  When this flag is on,
112 the pattern is forced to be "anchored", that is, it is
113 constrained to match only at the start of the string which
114 is being searched (the "subject string"). This effect can
115 also be achieved by appropriate constructs in the pattern
116 itself.
117 .IP "\fBE\fR (default: off)"
118 Toggles the PCRE_DOLLAR_ENDONLY flag. When this flag is on,
119 a \fB$\fR metacharacter in the pattern matches only at the
120 end of the subject string. Without this flag, a dollar also
121 matches immediately before the final character if it is a
122 newline character (but not before any other newline
123 characters). This flag is ignored if PCRE_MULTILINE
124 flag is set.
125 .IP "\fBU\fR (default: off)"
126 Toggles the ungreedy matching flag.  When this flag is on,
127 the pattern matching engine inverts the "greediness" of
128 the quantifiers so that they are not greedy by default,
129 but become greedy if followed by "?".  This flag can also
130 set by a (?U) modifier within the pattern.
131 .IP "\fBX\fR (default: off)"
132 Toggles the PCRE_EXTRA flag.
133 When this flag is on, any backslash in a pattern that is
134 followed by a letter that has no special meaning causes an
135 error, thus reserving these combinations for future expansion.
136 .SH "SEARCH ORDER"
141 Patterns are applied in the order as specified in the table, until a
142 pattern is found that matches the input string.
144 Each pattern is applied to the entire input string.
145 Depending on the application, that string is an entire client
146 hostname, an entire client IP address, or an entire mail address.
147 Thus, no parent domain or parent network search is done, and
148 \fIuser@domain\fR mail addresses are not broken up into their
149 \fIuser\fR and \fIdomain\fR constituent parts, nor is \fIuser+foo\fR
150 broken up into \fIuser\fR and \fIfoo\fR.
151 .SH "TEXT SUBSTITUTION"
156 Substitution of substrings from the matched expression into the result
157 string is possible using the conventional perl syntax ($1, $2, etc.);
158 specify $$ to produce a $ character as output.
159 The macros in the result string may need to be written as ${n}
160 or $(n) if they aren't followed by whitespace.
162 Note: since negated patterns (those preceded by \fB!\fR) return a
163 result when the expression does not match, substitutions are not
164 available for negated patterns.
165 .SH "EXAMPLE SMTPD ACCESS MAP"
168 # Protect your outgoing majordomo exploders
169 /^(?!owner-)(.*)-outgoing@(.*)/ 550 Use ${1}@${2} instead
171 # Bounce friend@whatever, except when whatever is our domain (you would
172 # be better just bouncing all friend@ mail - this is just an example).
173 /^(friend@(?!my\\.domain$).*)$/  550 Stick this in your pipe $1
175 # A multi-line entry. The text is sent as one line.
177 /^noddy@my\\.domain$/
178 \ 550 This user is a funny one. You really don't want to send mail to
179 \ them as it only makes their head spin.
180 .SH "EXAMPLE HEADER FILTER MAP"
183 /^Subject: make money fast/     REJECT
184 /^To: friend@public\\.com/       REJECT
185 .SH "EXAMPLE BODY FILTER MAP"
188 # First skip over base 64 encoded text to save CPU cycles.
189 # Requires PCRE version 3.
190 ~^[[:alnum:]+/]{60,}$~          OK
192 # Put your own body patterns here.
193 .SH "SEE ALSO"
196 postmap(1), Postfix lookup table manager
197 postconf(5), configuration parameters
198 regexp_table(5), format of POSIX regular expression tables
199 .SH "README FILES"
204 Use "\fBpostconf readme_directory\fR" or
205 "\fBpostconf html_directory\fR" to locate this information.
208 DATABASE_README, Postfix lookup table overview
209 .SH "AUTHOR(S)"
212 The PCRE table lookup code was originally written by:
213 Andrew McNamara
214 andrewm@connect.com.au
215 connect.com.au Pty. Ltd.
216 Level 3, 213 Miller St
217 North Sydney, NSW, Australia
219 Adopted and adapted by:
220 Wietse Venema
221 IBM T.J. Watson Research
222 P.O. Box 704
223 Yorktown Heights, NY 10598, USA