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