--- code/trunk/doc/pcre_compile.3 2007/02/24 21:40:03 63 +++ code/trunk/doc/pcre_compile.3 2007/02/24 21:41:42 93 @@ -1,4 +1,4 @@ -.TH PCRE 3 +.TH PCRE_COMPILE 3 .SH NAME PCRE - Perl-compatible regular expressions .SH SYNOPSIS @@ -8,18 +8,19 @@ .PP .SM .br -.B pcre *pcre_compile(const char *\fIpattern\fR, int \fIoptions\fR, +.B pcre *pcre_compile(const char *\fIpattern\fP, int \fIoptions\fP, .ti +5n -.B const char **\fIerrptr\fR, int *\fIerroffset\fR, +.B const char **\fIerrptr\fP, int *\fIerroffset\fP, .ti +5n -.B const unsigned char *\fItableptr\fR); - +.B const unsigned char *\fItableptr\fP); +. .SH DESCRIPTION .rs .sp -This function compiles a regular expression into an internal form. Its -arguments are: - +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 @@ -27,29 +28,44 @@ \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_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_MULTILINE ^ and $ match newlines within data + PCRE_NEWLINE_ANY Recognize any Unicode newline sequence + 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 must have been compiled with UTF-8 support when PCRE_UTF8 is used. - + 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. - -There is a complete description of the PCRE API in the +.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.