aboutsummaryrefslogtreecommitdiffstats
path: root/external-libs/pcre/doc/pcre_compile.3
diff options
context:
space:
mode:
Diffstat (limited to 'external-libs/pcre/doc/pcre_compile.3')
-rw-r--r--external-libs/pcre/doc/pcre_compile.359
1 files changed, 59 insertions, 0 deletions
diff --git a/external-libs/pcre/doc/pcre_compile.3 b/external-libs/pcre/doc/pcre_compile.3
new file mode 100644
index 00000000..a8273151
--- /dev/null
+++ b/external-libs/pcre/doc/pcre_compile.3
@@ -0,0 +1,59 @@
+.TH PCRE 3
+.SH NAME
+PCRE - Perl-compatible regular expressions
+.SH SYNOPSIS
+.rs
+.sp
+.B #include <pcre.h>
+.PP
+.SM
+.br
+.B pcre *pcre_compile(const char *\fIpattern\fR, int \fIoptions\fR,
+.ti +5n
+.B const char **\fIerrptr\fR, int *\fIerroffset\fR,
+.ti +5n
+.B const unsigned char *\fItableptr\fR);
+
+.SH DESCRIPTION
+.rs
+.sp
+This function compiles a regular expression into an internal form. Its
+arguments are:
+
+ \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
+
+The option bits are:
+
+ PCRE_ANCHORED Force pattern anchoring
+ PCRE_CASELESS Do caseless matching
+ PCRE_DOLLAR_ENDONLY $ not to match newline at end
+ PCRE_DOTALL . matches anything including NL
+ PCRE_EXTENDED Ignore whitespace and # comments
+ PCRE_EXTRA PCRE extra features
+ (not much use currently)
+ PCRE_MULTILINE ^ and $ match newlines within data
+ 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)
+
+PCRE must be compiled with UTF-8 support in order to use PCRE_UTF8
+(or PCRE_NO_UTF8_CHECK).
+
+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
+.\" HREF
+\fBpcreapi\fR
+.\"
+page.