/[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 77 - (show annotations) (download)
Sat Feb 24 21:40:45 2007 UTC (7 years, 9 months ago) by nigel
File size: 2119 byte(s)
Load pcre-6.0 into code/trunk.

1 .TH PCRE 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. Its
21 arguments are:
22 .sp
23 \fIpattern\fR A zero-terminated string containing the
24 regular expression to be compiled
25 \fIoptions\fR Zero or more option bits
26 \fIerrptr\fR Where to put an error message
27 \fIerroffset\fR Offset in pattern where error was found
28 \fItableptr\fR Pointer to character tables, or NULL to
29 use the built-in default
30 .sp
31 The option bits are:
32 .sp
33 PCRE_ANCHORED Force pattern anchoring
34 PCRE_AUTO_CALLOUT Compile automatic callouts
35 PCRE_CASELESS Do caseless matching
36 PCRE_DOLLAR_ENDONLY $ not to match newline at end
37 PCRE_DOTALL . matches anything including NL
38 PCRE_EXTENDED Ignore whitespace and # comments
39 PCRE_EXTRA PCRE extra features
40 (not much use currently)
41 PCRE_FIRSTLINE Force matching to be before newline
42 PCRE_MULTILINE ^ and $ match newlines within data
43 PCRE_NO_AUTO_CAPTURE Disable numbered capturing paren-
44 theses (named ones available)
45 PCRE_UNGREEDY Invert greediness of quantifiers
46 PCRE_UTF8 Run in UTF-8 mode
47 PCRE_NO_UTF8_CHECK Do not check the pattern for UTF-8
48 validity (only relevant if
49 PCRE_UTF8 is set)
50 .sp
51 PCRE must be built with UTF-8 support in order to use PCRE_UTF8 and
52 PCRE_NO_UTF8_CHECK.
53 .P
54 The yield of the function is a pointer to a private data structure that
55 contains the compiled pattern, or NULL if an error was detected.
56 .P
57 There is a complete description of the PCRE native API in the
58 .\" HREF
59 \fBpcreapi\fR
60 .\"
61 page and a description of the POSIX API in the
62 .\" HREF
63 \fBpcreposix\fR
64 .\"
65 page.

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12