blob: d0846e18984a5f118b64c2830f9e7b67e8eae6e1 [file] [log] [blame]
Tristan Matthews04616462013-11-14 16:09:34 -05001.TH PCRE_CONFIG 3
2.SH NAME
3PCRE - Perl-compatible regular expressions
4.SH SYNOPSIS
5.rs
6.sp
7.B #include <pcre.h>
8.PP
9.SM
10.B int pcre_config(int \fIwhat\fP, void *\fIwhere\fP);
11.
12.SH DESCRIPTION
13.rs
14.sp
15This function makes it possible for a client program to find out which optional
16features are available in the version of the PCRE library it is using. The
17arguments are as follows:
18.sp
19 \fIwhat\fP A code specifying what information is required
20 \fIwhere\fP Points to where to put the data
21.sp
22The \fIwhere\fP argument must point to an integer variable, except for
23PCRE_CONFIG_MATCH_LIMIT and PCRE_CONFIG_MATCH_LIMIT_RECURSION, when it must
24point to an unsigned long integer. The available codes are:
25.sp
26 PCRE_CONFIG_JIT Availability of just-in-time compiler
27 support (1=yes 0=no)
28 PCRE_CONFIG_LINK_SIZE Internal link size: 2, 3, or 4
29 PCRE_CONFIG_MATCH_LIMIT Internal resource limit
30 PCRE_CONFIG_MATCH_LIMIT_RECURSION
31 Internal recursion depth limit
32 PCRE_CONFIG_NEWLINE Value of the default newline sequence:
33 13 (0x000d) for CR
34 10 (0x000a) for LF
35 3338 (0x0d0a) for CRLF
36 -2 for ANYCRLF
37 -1 for ANY
38 PCRE_CONFIG_BSR Indicates what \eR matches by default:
39 0 all Unicode line endings
40 1 CR, LF, or CRLF only
41 PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
42 Threshold of return slots, above which
43 \fBmalloc()\fP is used by the POSIX API
44 PCRE_CONFIG_STACKRECURSE Recursion implementation (1=stack 0=heap)
45 PCRE_CONFIG_UTF8 Availability of UTF-8 support (1=yes 0=no)
46 PCRE_CONFIG_UNICODE_PROPERTIES
47 Availability of Unicode property support
48 (1=yes 0=no)
49.sp
50The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise.
51.P
52There is a complete description of the PCRE native API in the
53.\" HREF
54\fBpcreapi\fP
55.\"
56page and a description of the POSIX API in the
57.\" HREF
58\fBpcreposix\fP
59.\"
60page.