libraries/spcre/libpcre/pcre/doc/pcre_config.3
changeset 0 7f656887cf89
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 .TH PCRE_CONFIG 3
       
     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 .
       
    12 .SH DESCRIPTION
       
    13 .rs
       
    14 .sp
       
    15 This function makes it possible for a client program to find out which optional
       
    16 features are available in the version of the PCRE library it is using. Its
       
    17 arguments are as follows:
       
    18 .sp
       
    19   \fIwhat\fR     A code specifying what information is required
       
    20   \fIwhere\fR    Points to where to put the data
       
    21 .sp
       
    22 The available codes are:
       
    23 .sp
       
    24   PCRE_CONFIG_LINK_SIZE     Internal link size: 2, 3, or 4
       
    25   PCRE_CONFIG_MATCH_LIMIT   Internal resource limit
       
    26   PCRE_CONFIG_MATCH_LIMIT_RECURSION
       
    27                             Internal recursion depth limit
       
    28   PCRE_CONFIG_NEWLINE       Value of the default newline sequence:
       
    29                                 13 (0x000d)    for CR
       
    30                                 10 (0x000a)    for LF
       
    31                               3338 (0x0d0a)    for CRLF
       
    32                                 -2             for ANYCRLF
       
    33                                 -1             for ANY
       
    34   PCRE_CONFIG_BSR           Indicates what \eR matches by default:
       
    35                                  0             all Unicode line endings
       
    36                                  1             CR, LF, or CRLF only
       
    37   PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
       
    38                             Threshold of return slots, above
       
    39                               which \fBmalloc()\fR is used by
       
    40                               the POSIX API
       
    41   PCRE_CONFIG_STACKRECURSE  Recursion implementation (1=stack 0=heap)
       
    42   PCRE_CONFIG_UTF8          Availability of UTF-8 support (1=yes 0=no)
       
    43   PCRE_CONFIG_UNICODE_PROPERTIES
       
    44                             Availability of Unicode property support
       
    45                               (1=yes 0=no)
       
    46 .sp
       
    47 The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise.
       
    48 .P
       
    49 There is a complete description of the PCRE native API in the
       
    50 .\" HREF
       
    51 \fBpcreapi\fR
       
    52 .\"
       
    53 page and a description of the POSIX API in the
       
    54 .\" HREF
       
    55 \fBpcreposix\fR
       
    56 .\"
       
    57 page.