trunk/doc/pcre_config.3

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