trunk/doc/pcre_compile.3

.TH PCRE_COMPILE 3
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.SM
.B pcre *pcre_compile(const char *\fIpattern\fP, int \fIoptions\fP,
.ti +5n
.B const char **\fIerrptr\fP, int *\fIerroffset\fP,
.ti +5n
.B const unsigned char *\fItableptr\fP);
.
.SH DESCRIPTION
.rs
.sp
This function compiles a regular expression into an internal form. It is the
same as \fBpcre_compile2()\fP, except for the absence of the \fIerrorcodeptr\fP
argument. Its arguments are:
.sp
  \fIpattern\fR       A zero-terminated string containing the
                  regular expression to be compiled
  \fIoptions\fR       Zero or more option bits
  \fIerrptr\fR        Where to put an error message
  \fIerroffset\fR     Offset in pattern where error was found
  \fItableptr\fR      Pointer to character tables, or NULL to
                  use the built-in default
.sp
The option bits are:
.sp
  PCRE_ANCHORED           Force pattern anchoring
  PCRE_AUTO_CALLOUT       Compile automatic callouts
  PCRE_BSR_ANYCRLF        \eR matches only CR, LF, or CRLF
  PCRE_BSR_UNICODE        \eR matches all Unicode line endings
  PCRE_CASELESS           Do caseless matching
  PCRE_DOLLAR_ENDONLY     $ not to match newline at end
  PCRE_DOTALL             . matches anything including NL
  PCRE_DUPNAMES           Allow duplicate names for subpatterns
  PCRE_EXTENDED           Ignore whitespace and # comments
  PCRE_EXTRA              PCRE extra features
                            (not much use currently)
  PCRE_FIRSTLINE          Force matching to be before newline
  PCRE_JAVASCRIPT_COMPAT  JavaScript compatibility
  PCRE_MULTILINE          ^ and $ match newlines within data
  PCRE_NEWLINE_ANY        Recognize any Unicode newline sequence
  PCRE_NEWLINE_ANYCRLF    Recognize CR, LF, and CRLF as newline
                            sequences
  PCRE_NEWLINE_CR         Set CR as the newline sequence
  PCRE_NEWLINE_CRLF       Set CRLF as the newline sequence
  PCRE_NEWLINE_LF         Set LF as the newline sequence
  PCRE_NO_AUTO_CAPTURE    Disable numbered capturing paren-
                            theses (named ones available)
  PCRE_UNGREEDY           Invert greediness of quantifiers
  PCRE_UTF8               Run in UTF-8 mode
  PCRE_NO_UTF8_CHECK      Do not check the pattern for UTF-8
                            validity (only relevant if
                            PCRE_UTF8 is set)
.sp
PCRE must be built with UTF-8 support in order to use PCRE_UTF8 and
PCRE_NO_UTF8_CHECK.
.P
The yield of the function is a pointer to a private data structure that
contains the compiled pattern, or NULL if an error was detected. Note that
compiling regular expressions with one version of PCRE for use with a different
version is not guaranteed to work and may cause crashes.
.P
There is a complete description of the PCRE native API in the
.\" HREF
\fBpcreapi\fR
.\"
page and a description of the POSIX API in the
.\" HREF
\fBpcreposix\fR
.\"
page.
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	.B pcre pcre_compile(const char \fIpattern\fP, int \fIoptions\fP,
11	.ti +5n
12	.B const char *\fIerrptr\fP, int \fIerroffset\fP,
13	.ti +5n
14	.B const unsigned char *\fItableptr\fP);
15	.
16	.SH DESCRIPTION
17	.rs
18	.sp
19	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	.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_BSR_ANYCRLF \eR matches only CR, LF, or CRLF
36	PCRE_BSR_UNICODE \eR matches all Unicode line endings
37	PCRE_CASELESS Do caseless matching
38	PCRE_DOLLAR_ENDONLY $ not to match newline at end
39	PCRE_DOTALL . matches anything including NL
40	PCRE_DUPNAMES Allow duplicate names for subpatterns
41	PCRE_EXTENDED Ignore whitespace and # comments
42	PCRE_EXTRA PCRE extra features
43	(not much use currently)
44	PCRE_FIRSTLINE Force matching to be before newline
45	PCRE_JAVASCRIPT_COMPAT JavaScript compatibility
46	PCRE_MULTILINE ^ and $ match newlines within data
47	PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
48	PCRE_NEWLINE_ANYCRLF Recognize CR, LF, and CRLF as newline
49	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.
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"