Annotation of embedaddon/pcre/doc/pcre_config.3, revision 1.1.1.4
1.1.1.4 ! misho 1: .TH PCRE_CONFIG 3 "24 June 2012" "PCRE 8.30"
1.1 misho 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: .B int pcre_config(int \fIwhat\fP, void *\fIwhere\fP);
1.1.1.2 misho 11: .PP
12: .B int pcre16_config(int \fIwhat\fP, void *\fIwhere\fP);
1.1.1.4 ! misho 13: .PP
! 14: .B int pcre32_config(int \fIwhat\fP, void *\fIwhere\fP);
1.1 misho 15: .
16: .SH DESCRIPTION
17: .rs
18: .sp
19: This function makes it possible for a client program to find out which optional
20: features are available in the version of the PCRE library it is using. The
21: arguments are as follows:
22: .sp
23: \fIwhat\fP A code specifying what information is required
24: \fIwhere\fP Points to where to put the data
25: .sp
26: 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: .sp
30: PCRE_CONFIG_JIT Availability of just-in-time compiler
31: support (1=yes 0=no)
1.1.1.2 misho 32: PCRE_CONFIG_JITTARGET String containing information about the
33: target architecture for the JIT compiler,
34: or NULL if there is no JIT support
1.1 misho 35: PCRE_CONFIG_LINK_SIZE Internal link size: 2, 3, or 4
36: PCRE_CONFIG_MATCH_LIMIT Internal resource limit
37: PCRE_CONFIG_MATCH_LIMIT_RECURSION
38: Internal recursion depth limit
39: PCRE_CONFIG_NEWLINE Value of the default newline sequence:
40: 13 (0x000d) for CR
41: 10 (0x000a) for LF
42: 3338 (0x0d0a) for CRLF
43: -2 for ANYCRLF
44: -1 for ANY
45: PCRE_CONFIG_BSR Indicates what \eR matches by default:
46: 0 all Unicode line endings
47: 1 CR, LF, or CRLF only
48: PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
49: Threshold of return slots, above which
50: \fBmalloc()\fP is used by the POSIX API
51: PCRE_CONFIG_STACKRECURSE Recursion implementation (1=stack 0=heap)
1.1.1.2 misho 52: PCRE_CONFIG_UTF16 Availability of UTF-16 support (1=yes
53: 0=no); option for \fBpcre16_config()\fP
1.1.1.4 ! misho 54: PCRE_CONFIG_UTF32 Availability of UTF-32 support (1=yes
! 55: 0=no); option for \fBpcre32_config()\fP
1.1.1.2 misho 56: PCRE_CONFIG_UTF8 Availability of UTF-8 support (1=yes 0=no);
57: option for \fBpcre_config()\fP
1.1 misho 58: PCRE_CONFIG_UNICODE_PROPERTIES
59: Availability of Unicode property support
60: (1=yes 0=no)
61: .sp
1.1.1.2 misho 62: The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise. That error
1.1.1.4 ! misho 63: 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.
1.1 misho 67: .P
68: There is a complete description of the PCRE native API in the
69: .\" HREF
70: \fBpcreapi\fP
71: .\"
72: page and a description of the POSIX API in the
73: .\" HREF
74: \fBpcreposix\fP
75: .\"
76: page.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>