/[pcre]/code/trunk/doc/pcre_compile.3
ViewVC logotype

Contents of /code/trunk/doc/pcre_compile.3

Parent Directory Parent Directory | Revision Log Revision Log


Revision 93 - (show annotations) (download)
Sat Feb 24 21:41:42 2007 UTC (7 years, 6 months ago) by nigel
File size: 2519 byte(s)
Load pcre-7.0 into code/trunk.

1 .TH PCRE_COMPILE 3
2 .SH NAME
3 PCRE - Perl-compatible regular expressions
4 .SH SYNOPSIS
5 .rs
6 .sp
7 .B #include <pcre.h>
8 .PP
9 .SM
10 .br
11 .B pcre *pcre_compile(const char *\fIpattern\fP, int \fIoptions\fP,
12 .ti +5n
13 .B const char **\fIerrptr\fP, int *\fIerroffset\fP,
14 .ti +5n
15 .B const unsigned char *\fItableptr\fP);
16 .
17 .SH DESCRIPTION
18 .rs
19 .sp
20 This function compiles a regular expression into an internal form. It is the
21 same as \fBpcre_compile2()\fP, except for the absence of the \fIerrorcodeptr\fP
22 argument. Its arguments are:
23 .sp
24 \fIpattern\fR A zero-terminated string containing the
25 regular expression to be compiled
26 \fIoptions\fR Zero or more option bits
27 \fIerrptr\fR Where to put an error message
28 \fIerroffset\fR Offset in pattern where error was found
29 \fItableptr\fR Pointer to character tables, or NULL to
30 use the built-in default
31 .sp
32 The option bits are:
33 .sp
34 PCRE_ANCHORED Force pattern anchoring
35 PCRE_AUTO_CALLOUT Compile automatic callouts
36 PCRE_CASELESS Do caseless matching
37 PCRE_DOLLAR_ENDONLY $ not to match newline at end
38 PCRE_DOTALL . matches anything including NL
39 PCRE_DUPNAMES Allow duplicate names for subpatterns
40 PCRE_EXTENDED Ignore whitespace and # comments
41 PCRE_EXTRA PCRE extra features
42 (not much use currently)
43 PCRE_FIRSTLINE Force matching to be before newline
44 PCRE_MULTILINE ^ and $ match newlines within data
45 PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
46 PCRE_NEWLINE_CR Set CR as the newline sequence
47 PCRE_NEWLINE_CRLF Set CRLF as the newline sequence
48 PCRE_NEWLINE_LF Set LF as the newline sequence
49 PCRE_NO_AUTO_CAPTURE Disable numbered capturing paren-
50 theses (named ones available)
51 PCRE_UNGREEDY Invert greediness of quantifiers
52 PCRE_UTF8 Run in UTF-8 mode
53 PCRE_NO_UTF8_CHECK Do not check the pattern for UTF-8
54 validity (only relevant if
55 PCRE_UTF8 is set)
56 .sp
57 PCRE must be built with UTF-8 support in order to use PCRE_UTF8 and
58 PCRE_NO_UTF8_CHECK.
59 .P
60 The yield of the function is a pointer to a private data structure that
61 contains the compiled pattern, or NULL if an error was detected.
62 .P
63 There is a complete description of the PCRE native API in the
64 .\" HREF
65 \fBpcreapi\fR
66 .\"
67 page and a description of the POSIX API in the
68 .\" HREF
69 \fBpcreposix\fR
70 .\"
71 page.

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12