ViewVC logotype

Contents of /code/trunk/doc/pcre_compile.3

Parent Directory Parent Directory | Revision Log Revision Log

Revision 99 - (show annotations)
Tue Mar 6 12:27:42 2007 UTC (14 years, 2 months ago) by ph10
File size: 2515 byte(s)
1. Move the comment about version numbers from pcre.h.in to configure.ac 
because that's where they are now set.
2. Update all the man pages to remove the use of .br and .in because this
causes trouble for some HTML converters. Also standardised the final sections 
giving author information and revision date.
3. Update the maintain/132html man page converter to handle .nf/.fi and to barf 
at .br/.in.
3 PCRE - Perl-compatible regular expressions
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 .
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_CASELESS Do caseless matching
36 PCRE_DOLLAR_ENDONLY $ not to match newline at end
37 PCRE_DOTALL . matches anything including NL
38 PCRE_DUPNAMES Allow duplicate names for subpatterns
39 PCRE_EXTENDED Ignore whitespace and # comments
40 PCRE_EXTRA PCRE extra features
41 (not much use currently)
42 PCRE_FIRSTLINE Force matching to be before newline
43 PCRE_MULTILINE ^ and $ match newlines within data
44 PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
45 PCRE_NEWLINE_CR Set CR as the newline sequence
46 PCRE_NEWLINE_CRLF Set CRLF as the newline sequence
47 PCRE_NEWLINE_LF Set LF as the newline sequence
48 PCRE_NO_AUTO_CAPTURE Disable numbered capturing paren-
49 theses (named ones available)
50 PCRE_UNGREEDY Invert greediness of quantifiers
51 PCRE_UTF8 Run in UTF-8 mode
52 PCRE_NO_UTF8_CHECK Do not check the pattern for UTF-8
53 validity (only relevant if
54 PCRE_UTF8 is set)
55 .sp
56 PCRE must be built with UTF-8 support in order to use PCRE_UTF8 and
58 .P
59 The yield of the function is a pointer to a private data structure that
60 contains the compiled pattern, or NULL if an error was detected.
61 .P
62 There is a complete description of the PCRE native API in the
63 .\" HREF
64 \fBpcreapi\fR
65 .\"
66 page and a description of the POSIX API in the
67 .\" HREF
68 \fBpcreposix\fR
69 .\"
70 page.


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

  ViewVC Help
Powered by ViewVC 1.1.5