diff options
Diffstat (limited to 'external-libs/pcre/doc/html/pcre_compile.html')
| -rw-r--r-- | external-libs/pcre/doc/html/pcre_compile.html | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/external-libs/pcre/doc/html/pcre_compile.html b/external-libs/pcre/doc/html/pcre_compile.html new file mode 100644 index 00000000..e1a43793 --- /dev/null +++ b/external-libs/pcre/doc/html/pcre_compile.html @@ -0,0 +1,71 @@ +<html> +<head> +<title>pcre_compile specification</title> +</head> +<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> +This HTML document has been generated automatically from the original man page. +If there is any nonsense in it, please consult the man page, in case the +conversion went wrong.<br> +<br><b> +SYNOPSIS +</b><br> +<P> +<b>#include <pcre.h></b> +</P> +<P> +<b>pcre *pcre_compile(const char *<i>pattern</i>, int <i>options</i>,</b> +<b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b> +<b>const unsigned char *<i>tableptr</i>);</b> +</P> +<br><b> +DESCRIPTION +</b><br> +<P> +This function compiles a regular expression into an internal form. Its +arguments are: +</P> +<P> +<pre> + <i>pattern</i> A zero-terminated string containing the + regular expression to be compiled + <i>options</i> Zero or more option bits + <i>errptr</i> Where to put an error message + <i>erroffset</i> Offset in pattern where error was found + <i>tableptr</i> Pointer to character tables, or NULL to + use the built-in default +</PRE> +</P> +<P> +The option bits are: +</P> +<P> +<pre> + 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) +</PRE> +</P> +<P> +PCRE must be compiled with UTF-8 support in order to use PCRE_UTF8 +(or PCRE_NO_UTF8_CHECK). +</P> +<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. +</P> +<P> +There is a complete description of the PCRE API in the +<a href="pcreapi.html"><b>pcreapi</b></a> +page. |