/[pcre]/code/trunk/doc/pcre_config.3
ViewVC logotype

Contents of /code/trunk/doc/pcre_config.3

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1404 - (hide annotations) (download)
Tue Nov 19 15:36:57 2013 UTC (5 months ago) by ph10
File size: 3301 byte(s)
Source tidies for 8.34-RC1.

1 ph10 1389 .TH PCRE_CONFIG 3 "05 November 2013" "PCRE 8.34"
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 ph10 1404 PCRE_CONFIG_PARENS_LIMIT Parentheses nesting limit
37 nigel 73 PCRE_CONFIG_MATCH_LIMIT Internal resource limit
38 nigel 87 PCRE_CONFIG_MATCH_LIMIT_RECURSION
39     Internal recursion depth limit
40 ph10 231 PCRE_CONFIG_NEWLINE Value of the default newline sequence:
41 nigel 93 13 (0x000d) for CR
42     10 (0x000a) for LF
43     3338 (0x0d0a) for CRLF
44 ph10 149 -2 for ANYCRLF
45 nigel 93 -1 for ANY
46 ph10 231 PCRE_CONFIG_BSR Indicates what \eR matches by default:
47     0 all Unicode line endings
48     1 CR, LF, or CRLF only
49 nigel 63 PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
50 ph10 678 Threshold of return slots, above which
51     \fBmalloc()\fP is used by the POSIX API
52 nigel 73 PCRE_CONFIG_STACKRECURSE Recursion implementation (1=stack 0=heap)
53 ph10 868 PCRE_CONFIG_UTF16 Availability of UTF-16 support (1=yes
54     0=no); option for \fBpcre16_config()\fP
55 chpe 1055 PCRE_CONFIG_UTF32 Availability of UTF-32 support (1=yes
56     0=no); option for \fBpcre32_config()\fP
57 ph10 868 PCRE_CONFIG_UTF8 Availability of UTF-8 support (1=yes 0=no);
58     option for \fBpcre_config()\fP
59 nigel 75 PCRE_CONFIG_UNICODE_PROPERTIES
60     Availability of Unicode property support
61     (1=yes 0=no)
62     .sp
63 ph10 903 The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise. That error
64 chpe 1055 is also given if PCRE_CONFIG_UTF16 or PCRE_CONFIG_UTF32 is passed to
65     \fBpcre_config()\fP, if PCRE_CONFIG_UTF8 or PCRE_CONFIG_UTF32 is passed to
66     \fBpcre16_config()\fP, or if PCRE_CONFIG_UTF8 or PCRE_CONFIG_UTF16 is passed to
67     \fBpcre32_config()\fP.
68 nigel 75 .P
69 nigel 63 There is a complete description of the PCRE native API in the
70     .\" HREF
71 ph10 583 \fBpcreapi\fP
72 nigel 63 .\"
73 nigel 75 page and a description of the POSIX API in the
74 nigel 63 .\" HREF
75 ph10 583 \fBpcreposix\fP
76 nigel 63 .\"
77     page.

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12