pcre_compile specification

From 582b500cd996c96054615870fd13d6ab0ea77428 Mon Sep 17 00:00:00 2001 From: Jay Berkenbilt Date: Sat, 10 Oct 2009 15:10:05 +0000 Subject: start integrating windows port git-svn-id: svn+q:///qpdf/trunk@757 71b93d88-0707-0410-a8cf-f5a4172ac649 --- external-libs/pcre/doc/html/pcre_compile.html | 71 +++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 external-libs/pcre/doc/html/pcre_compile.html (limited to 'external-libs/pcre/doc/html/pcre_compile.html') 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 @@ + + +pcre_compile specification + + +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.
+
+SYNOPSIS +
+

+#include <pcre.h> +

+pcre *pcre_compile(const char *pattern, int options, +const char **errptr, int *erroffset, +const unsigned char *tableptr); +

+
+DESCRIPTION +
+

+This function compiles a regular expression into an internal form. Its +arguments are: +

+  pattern       A zero-terminated string containing the
+                  regular expression to be compiled
+  options       Zero or more option bits
+  errptr        Where to put an error message
+  erroffset     Offset in pattern where error was found
+  tableptr      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 +pcreapi +page. -- cgit v1.2.3-54-g00ecf