trunk/doc/pcre_config.3

.TH PCRE_CONFIG 3 "24 June 2012" "PCRE 8.30"
.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);
.PP
.B int pcre16_config(int \fIwhat\fP, void *\fIwhere\fP);
.PP
.B int pcre32_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_JITTARGET     String containing information about the
                              target architecture for the JIT compiler,
                              or NULL if there is no JIT support
  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_UTF16         Availability of UTF-16 support (1=yes
                               0=no); option for \fBpcre16_config()\fP
  PCRE_CONFIG_UTF32         Availability of UTF-32 support (1=yes
                               0=no); option for \fBpcre32_config()\fP
  PCRE_CONFIG_UTF8          Availability of UTF-8 support (1=yes 0=no);
                              option for \fBpcre_config()\fP
  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. That error
is also given if PCRE_CONFIG_UTF16 or PCRE_CONFIG_UTF32 is passed to
\fBpcre_config()\fP, if PCRE_CONFIG_UTF8 or PCRE_CONFIG_UTF32 is passed to
\fBpcre16_config()\fP, or if PCRE_CONFIG_UTF8 or PCRE_CONFIG_UTF16 is passed to
\fBpcre32_config()\fP.
.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	chpe	1055	.TH PCRE_CONFIG 3 "24 June 2012" "PCRE 8.30"
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	ph10	868	.PP
12			.B int pcre16_config(int \fIwhat\fP, void *\fIwhere\fP);
13	chpe	1055	.PP
14			.B int pcre32_config(int \fIwhat\fP, void *\fIwhere\fP);
15	nigel	75	.
16	nigel	63	.SH DESCRIPTION
17			.rs
18			.sp
19			This function makes it possible for a client program to find out which optional
20	ph10	678	features are available in the version of the PCRE library it is using. The
21	nigel	63	arguments are as follows:
22	nigel	75	.sp
23	ph10	583	\fIwhat\fP A code specifying what information is required
24			\fIwhere\fP Points to where to put the data
25	nigel	75	.sp
26	ph10	678	The \fIwhere\fP argument must point to an integer variable, except for
27			PCRE_CONFIG_MATCH_LIMIT and PCRE_CONFIG_MATCH_LIMIT_RECURSION, when it must
28			point to an unsigned long integer. The available codes are:
29	nigel	75	.sp
30	ph10	678	PCRE_CONFIG_JIT Availability of just-in-time compiler
31			support (1=yes 0=no)
32	ph10	887	PCRE_CONFIG_JITTARGET String containing information about the
33	ph10	903	target architecture for the JIT compiler,
34	ph10	887	or NULL if there is no JIT support
35	nigel	73	PCRE_CONFIG_LINK_SIZE Internal link size: 2, 3, or 4
36			PCRE_CONFIG_MATCH_LIMIT Internal resource limit
37	nigel	87	PCRE_CONFIG_MATCH_LIMIT_RECURSION
38			Internal recursion depth limit
39	ph10	231	PCRE_CONFIG_NEWLINE Value of the default newline sequence:
40	nigel	93	13 (0x000d) for CR
41			10 (0x000a) for LF
42			3338 (0x0d0a) for CRLF
43	ph10	149	-2 for ANYCRLF
44	nigel	93	-1 for ANY
45	ph10	231	PCRE_CONFIG_BSR Indicates what \eR matches by default:
46			0 all Unicode line endings
47			1 CR, LF, or CRLF only
48	nigel	63	PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
49	ph10	678	Threshold of return slots, above which
50			\fBmalloc()\fP is used by the POSIX API
51	nigel	73	PCRE_CONFIG_STACKRECURSE Recursion implementation (1=stack 0=heap)
52	ph10	868	PCRE_CONFIG_UTF16 Availability of UTF-16 support (1=yes
53			0=no); option for \fBpcre16_config()\fP
54	chpe	1055	PCRE_CONFIG_UTF32 Availability of UTF-32 support (1=yes
55			0=no); option for \fBpcre32_config()\fP
56	ph10	868	PCRE_CONFIG_UTF8 Availability of UTF-8 support (1=yes 0=no);
57			option for \fBpcre_config()\fP
58	nigel	75	PCRE_CONFIG_UNICODE_PROPERTIES
59			Availability of Unicode property support
60			(1=yes 0=no)
61			.sp
62	ph10	903	The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise. That error
63	chpe	1055	is also given if PCRE_CONFIG_UTF16 or PCRE_CONFIG_UTF32 is passed to
64			\fBpcre_config()\fP, if PCRE_CONFIG_UTF8 or PCRE_CONFIG_UTF32 is passed to
65			\fBpcre16_config()\fP, or if PCRE_CONFIG_UTF8 or PCRE_CONFIG_UTF16 is passed to
66			\fBpcre32_config()\fP.
67	nigel	75	.P
68	nigel	63	There is a complete description of the PCRE native API in the
69			.\" HREF
70	ph10	583	\fBpcreapi\fP
71	nigel	63	.\"
72	nigel	75	page and a description of the POSIX API in the
73	nigel	63	.\" HREF
74	ph10	583	\fBpcreposix\fP
75	nigel	63	.\"
76			page.
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"