trunk/doc/pcre_config.3

.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\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. Its
arguments are as follows:
.sp
  \fIwhat\fR     A code specifying what information is required
  \fIwhere\fR    Points to where to put the data
.sp
The available codes are:
.sp
  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)
  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\fR
.\"
page and a description of the POSIX API in the
.\" HREF
\fBpcreposix\fR
.\"
page.
1	nigel	63	.TH PCRE 3
2			.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			.br
11	nigel	75	.B int pcre_config(int \fIwhat\fP, void *\fIwhere\fP);
12			.
13	nigel	63	.SH DESCRIPTION
14			.rs
15			.sp
16			This function makes it possible for a client program to find out which optional
17			features are available in the version of the PCRE library it is using. Its
18			arguments are as follows:
19	nigel	75	.sp
20	nigel	63	\fIwhat\fR A code specifying what information is required
21			\fIwhere\fR Points to where to put the data
22	nigel	75	.sp
23	nigel	63	The available codes are:
24	nigel	75	.sp
25	nigel	73	PCRE_CONFIG_LINK_SIZE Internal link size: 2, 3, or 4
26			PCRE_CONFIG_MATCH_LIMIT Internal resource limit
27			PCRE_CONFIG_NEWLINE Value of the newline character
28	nigel	63	PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
29	nigel	73	Threshold of return slots, above
30			which \fBmalloc()\fR is used by
31			the POSIX API
32			PCRE_CONFIG_STACKRECURSE Recursion implementation (1=stack 0=heap)
33			PCRE_CONFIG_UTF8 Availability of UTF-8 support (1=yes 0=no)
34	nigel	75	PCRE_CONFIG_UNICODE_PROPERTIES
35			Availability of Unicode property support
36			(1=yes 0=no)
37			.sp
38	nigel	63	The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise.
39	nigel	75	.P
40	nigel	63	There is a complete description of the PCRE native API in the
41			.\" HREF
42			\fBpcreapi\fR
43			.\"
44	nigel	75	page and a description of the POSIX API in the
45	nigel	63	.\" HREF
46			\fBpcreposix\fR
47			.\"
48			page.