path: root/doc/pcre_study.3
diff options
Diffstat (limited to 'doc/pcre_study.3')
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/pcre_study.3 b/doc/pcre_study.3
new file mode 100644
index 0000000..1200e0a
--- /dev/null
+++ b/doc/pcre_study.3
@@ -0,0 +1,54 @@
+.TH PCRE_STUDY 3 " 24 June 2012" "PCRE 8.30"
+PCRE - Perl-compatible regular expressions
+.B #include <pcre.h>
+.B pcre_extra *pcre_study(const pcre *\fIcode\fP, int \fIoptions\fP,
+.B " const char **\fIerrptr\fP);"
+.B pcre16_extra *pcre16_study(const pcre16 *\fIcode\fP, int \fIoptions\fP,
+.B " const char **\fIerrptr\fP);"
+.B pcre32_extra *pcre32_study(const pcre32 *\fIcode\fP, int \fIoptions\fP,
+.B " const char **\fIerrptr\fP);"
+This function studies a compiled pattern, to see if additional information can
+be extracted that might speed up matching. Its arguments are:
+ \fIcode\fP A compiled regular expression
+ \fIoptions\fP Options for \fBpcre[16|32]_study()\fP
+ \fIerrptr\fP Where to put an error message
+If the function succeeds, it returns a value that can be passed to
+\fBpcre[16|32]_exec()\fP or \fBpcre[16|32]_dfa_exec()\fP via their \fIextra\fP
+If the function returns NULL, either it could not find any additional
+information, or there was an error. You can tell the difference by looking at
+the error value. It is NULL in first case.
+The only option is PCRE_STUDY_JIT_COMPILE. It requests just-in-time compilation
+if possible. If PCRE has been compiled without JIT support, this option is
+ignored. See the
+.\" HREF
+page for further details.
+There is a complete description of the PCRE native API in the
+.\" HREF
+page and a description of the POSIX API in the
+.\" HREF