aboutsummaryrefslogtreecommitdiffstats
path: root/external-libs/pcre/doc/pcre_config.3
diff options
context:
space:
mode:
Diffstat (limited to 'external-libs/pcre/doc/pcre_config.3')
-rw-r--r--external-libs/pcre/doc/pcre_config.345
1 files changed, 45 insertions, 0 deletions
diff --git a/external-libs/pcre/doc/pcre_config.3 b/external-libs/pcre/doc/pcre_config.3
new file mode 100644
index 00000000..3a0e6998
--- /dev/null
+++ b/external-libs/pcre/doc/pcre_config.3
@@ -0,0 +1,45 @@
+.TH PCRE 3
+.SH NAME
+PCRE - Perl-compatible regular expressions
+.SH SYNOPSIS
+.rs
+.sp
+.B #include <pcre.h>
+.PP
+.SM
+.br
+.B int pcre_config(int \fIwhat\fR, void *\fIwhere\fR);
+
+.SH DESCRIPTION
+.rs
+.sp
+This function makes it possible for a client program to find out which optional
+features are available in the version of the PCRE library it is using. Its
+arguments are as follows:
+
+ \fIwhat\fR A code specifying what information is required
+ \fIwhere\fR Points to where to put the data
+
+The available codes are:
+
+ PCRE_CONFIG_LINK_SIZE Internal link size: 2, 3, or 4
+ PCRE_CONFIG_MATCH_LIMIT Internal resource limit
+ PCRE_CONFIG_NEWLINE Value of the newline character
+ PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
+ Threshold of return slots, above
+ which \fBmalloc()\fR is used by
+ the POSIX API
+ PCRE_CONFIG_STACKRECURSE Recursion implementation (1=stack 0=heap)
+ PCRE_CONFIG_UTF8 Availability of UTF-8 support (1=yes 0=no)
+
+The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise.
+
+There is a complete description of the PCRE native API in the
+.\" HREF
+\fBpcreapi\fR
+.\"
+page, and a description of the POSIX API in the
+.\" HREF
+\fBpcreposix\fR
+.\"
+page.