/[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 1489 - (hide annotations) (download)
Thu Jun 19 07:51:33 2014 UTC (4 months ago) by chpe
File size: 3393 byte(s)
Update documentation for added pcre_config and pcre_fullinfo values
1 chpe 1489 .TH PCRE_CONFIG 3 "20 April 2014" "PCRE 8.36"
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 chpe 1489 PCRE_CONFIG_MATCH_LIMIT, PCRE_CONFIG_MATCH_LIMIT_RECURSION, and
28     PCRE_CONFIG_PARENS_LIMIT, when it must point to an unsigned long integer,
29     and for PCRE_CONFIG_JITTARGET, when it must point to a const char*.
30     The available codes are:
31 nigel 75 .sp
32 ph10 678 PCRE_CONFIG_JIT Availability of just-in-time compiler
33     support (1=yes 0=no)
34 ph10 887 PCRE_CONFIG_JITTARGET String containing information about the
35 ph10 903 target architecture for the JIT compiler,
36 ph10 887 or NULL if there is no JIT support
37 nigel 73 PCRE_CONFIG_LINK_SIZE Internal link size: 2, 3, or 4
38 ph10 1404 PCRE_CONFIG_PARENS_LIMIT Parentheses nesting limit
39 nigel 73 PCRE_CONFIG_MATCH_LIMIT Internal resource limit
40 nigel 87 PCRE_CONFIG_MATCH_LIMIT_RECURSION
41     Internal recursion depth limit
42 ph10 231 PCRE_CONFIG_NEWLINE Value of the default newline sequence:
43 nigel 93 13 (0x000d) for CR
44     10 (0x000a) for LF
45     3338 (0x0d0a) for CRLF
46 ph10 149 -2 for ANYCRLF
47 nigel 93 -1 for ANY
48 ph10 231 PCRE_CONFIG_BSR Indicates what \eR matches by default:
49     0 all Unicode line endings
50     1 CR, LF, or CRLF only
51 nigel 63 PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
52 ph10 678 Threshold of return slots, above which
53     \fBmalloc()\fP is used by the POSIX API
54 nigel 73 PCRE_CONFIG_STACKRECURSE Recursion implementation (1=stack 0=heap)
55 ph10 868 PCRE_CONFIG_UTF16 Availability of UTF-16 support (1=yes
56     0=no); option for \fBpcre16_config()\fP
57 chpe 1055 PCRE_CONFIG_UTF32 Availability of UTF-32 support (1=yes
58     0=no); option for \fBpcre32_config()\fP
59 ph10 868 PCRE_CONFIG_UTF8 Availability of UTF-8 support (1=yes 0=no);
60     option for \fBpcre_config()\fP
61 nigel 75 PCRE_CONFIG_UNICODE_PROPERTIES
62     Availability of Unicode property support
63     (1=yes 0=no)
64     .sp
65 ph10 903 The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise. That error
66 chpe 1055 is also given if PCRE_CONFIG_UTF16 or PCRE_CONFIG_UTF32 is passed to
67     \fBpcre_config()\fP, if PCRE_CONFIG_UTF8 or PCRE_CONFIG_UTF32 is passed to
68     \fBpcre16_config()\fP, or if PCRE_CONFIG_UTF8 or PCRE_CONFIG_UTF16 is passed to
69     \fBpcre32_config()\fP.
70 nigel 75 .P
71 nigel 63 There is a complete description of the PCRE native API in the
72     .\" HREF
73 ph10 583 \fBpcreapi\fP
74 nigel 63 .\"
75 nigel 75 page and a description of the POSIX API in the
76 nigel 63 .\" HREF
77 ph10 583 \fBpcreposix\fP
78 nigel 63 .\"
79     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