/[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 - (show annotations)
Thu Jun 19 07:51:33 2014 UTC (13 months, 1 week ago) by chpe
File size: 3393 byte(s)
Error occurred while calculating annotation data.
Update documentation for added pcre_config and pcre_fullinfo values
1 .TH PCRE_CONFIG 3 "20 April 2014" "PCRE 8.36"
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);
11 .PP
12 .B int pcre16_config(int \fIwhat\fP, void *\fIwhere\fP);
13 .PP
14 .B int pcre32_config(int \fIwhat\fP, void *\fIwhere\fP);
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, 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 .sp
32 PCRE_CONFIG_JIT Availability of just-in-time compiler
33 support (1=yes 0=no)
34 PCRE_CONFIG_JITTARGET String containing information about the
35 target architecture for the JIT compiler,
36 or NULL if there is no JIT support
37 PCRE_CONFIG_LINK_SIZE Internal link size: 2, 3, or 4
38 PCRE_CONFIG_PARENS_LIMIT Parentheses nesting limit
39 PCRE_CONFIG_MATCH_LIMIT Internal resource limit
40 PCRE_CONFIG_MATCH_LIMIT_RECURSION
41 Internal recursion depth limit
42 PCRE_CONFIG_NEWLINE Value of the default newline sequence:
43 13 (0x000d) for CR
44 10 (0x000a) for LF
45 3338 (0x0d0a) for CRLF
46 -2 for ANYCRLF
47 -1 for ANY
48 PCRE_CONFIG_BSR Indicates what \eR matches by default:
49 0 all Unicode line endings
50 1 CR, LF, or CRLF only
51 PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
52 Threshold of return slots, above which
53 \fBmalloc()\fP is used by the POSIX API
54 PCRE_CONFIG_STACKRECURSE Recursion implementation (1=stack 0=heap)
55 PCRE_CONFIG_UTF16 Availability of UTF-16 support (1=yes
56 0=no); option for \fBpcre16_config()\fP
57 PCRE_CONFIG_UTF32 Availability of UTF-32 support (1=yes
58 0=no); option for \fBpcre32_config()\fP
59 PCRE_CONFIG_UTF8 Availability of UTF-8 support (1=yes 0=no);
60 option for \fBpcre_config()\fP
61 PCRE_CONFIG_UNICODE_PROPERTIES
62 Availability of Unicode property support
63 (1=yes 0=no)
64 .sp
65 The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise. That error
66 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 .P
71 There is a complete description of the PCRE native API in the
72 .\" HREF
73 \fBpcreapi\fP
74 .\"
75 page and a description of the POSIX API in the
76 .\" HREF
77 \fBpcreposix\fP
78 .\"
79 page.

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5