/[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 150 - (hide annotations) (download)
Tue Apr 17 08:22:40 2007 UTC (7 years, 6 months ago) by ph10
File size: 2587 byte(s)
Update HTML documentation.

1 nigel 79 .TH PCRE_COMPILE 3
2 nigel 63 .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 nigel 75 .B pcre *pcre_compile(const char *\fIpattern\fP, int \fIoptions\fP,
11 nigel 63 .ti +5n
12 nigel 75 .B const char **\fIerrptr\fP, int *\fIerroffset\fP,
13 nigel 63 .ti +5n
14 nigel 75 .B const unsigned char *\fItableptr\fP);
15     .
16 nigel 63 .SH DESCRIPTION
17     .rs
18     .sp
19 nigel 93 This function compiles a regular expression into an internal form. It is the
20     same as \fBpcre_compile2()\fP, except for the absence of the \fIerrorcodeptr\fP
21     argument. Its arguments are:
22 nigel 75 .sp
23 nigel 63 \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 nigel 75 .sp
31 nigel 63 The option bits are:
32 nigel 75 .sp
33 nigel 63 PCRE_ANCHORED Force pattern anchoring
34 nigel 75 PCRE_AUTO_CALLOUT Compile automatic callouts
35 nigel 63 PCRE_CASELESS Do caseless matching
36     PCRE_DOLLAR_ENDONLY $ not to match newline at end
37     PCRE_DOTALL . matches anything including NL
38 nigel 91 PCRE_DUPNAMES Allow duplicate names for subpatterns
39 nigel 63 PCRE_EXTENDED Ignore whitespace and # comments
40     PCRE_EXTRA PCRE extra features
41     (not much use currently)
42 nigel 77 PCRE_FIRSTLINE Force matching to be before newline
43 nigel 63 PCRE_MULTILINE ^ and $ match newlines within data
44 nigel 93 PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
45 ph10 150 PCRE_NEWLINE_ANYCRLF Recognize CR, LF, and CRLF as newline sequences
46 nigel 91 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 nigel 63 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 nigel 71 PCRE_NO_UTF8_CHECK Do not check the pattern for UTF-8
54     validity (only relevant if
55     PCRE_UTF8 is set)
56 nigel 75 .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 nigel 63 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 nigel 75 .P
63     There is a complete description of the PCRE native API in the
64 nigel 63 .\" HREF
65     \fBpcreapi\fR
66     .\"
67 nigel 75 page and a description of the POSIX API in the
68     .\" HREF
69     \fBpcreposix\fR
70     .\"
71 nigel 63 page.

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12