Return to pcre_config.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / pcre / doc

Annotation of embedaddon/pcre/doc/pcre_config.3, revision 1.1.1.3

1.1.1.3 ! misho       1: .TH PCRE_CONFIG 3 "21 January 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       misho      13: .
                     14: .SH DESCRIPTION
                     15: .rs
                     16: .sp
                     17: This function makes it possible for a client program to find out which optional
                     18: features are available in the version of the PCRE library it is using. The
                     19: arguments are as follows:
                     20: .sp
                     21:   \fIwhat\fP     A code specifying what information is required
                     22:   \fIwhere\fP    Points to where to put the data
                     23: .sp
                     24: The \fIwhere\fP argument must point to an integer variable, except for
                     25: PCRE_CONFIG_MATCH_LIMIT and PCRE_CONFIG_MATCH_LIMIT_RECURSION, when it must
                     26: point to an unsigned long integer. The available codes are:
                     27: .sp
                     28:   PCRE_CONFIG_JIT           Availability of just-in-time compiler
                     29:                               support (1=yes 0=no)
1.1.1.2   misho      30:   PCRE_CONFIG_JITTARGET     String containing information about the
                     31:                               target architecture for the JIT compiler,
                     32:                               or NULL if there is no JIT support
1.1       misho      33:   PCRE_CONFIG_LINK_SIZE     Internal link size: 2, 3, or 4
                     34:   PCRE_CONFIG_MATCH_LIMIT   Internal resource limit
                     35:   PCRE_CONFIG_MATCH_LIMIT_RECURSION
                     36:                             Internal recursion depth limit
                     37:   PCRE_CONFIG_NEWLINE       Value of the default newline sequence:
                     38:                                 13 (0x000d)    for CR
                     39:                                 10 (0x000a)    for LF
                     40:                               3338 (0x0d0a)    for CRLF
                     41:                                 -2             for ANYCRLF
                     42:                                 -1             for ANY
                     43:   PCRE_CONFIG_BSR           Indicates what \eR matches by default:
                     44:                                  0             all Unicode line endings
                     45:                                  1             CR, LF, or CRLF only
                     46:   PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
                     47:                             Threshold of return slots, above which
                     48:                               \fBmalloc()\fP is used by the POSIX API
                     49:   PCRE_CONFIG_STACKRECURSE  Recursion implementation (1=stack 0=heap)
1.1.1.2   misho      50:   PCRE_CONFIG_UTF16         Availability of UTF-16 support (1=yes
                     51:                                0=no); option for \fBpcre16_config()\fP
                     52:   PCRE_CONFIG_UTF8          Availability of UTF-8 support (1=yes 0=no);
                     53:                               option for \fBpcre_config()\fP
1.1       misho      54:   PCRE_CONFIG_UNICODE_PROPERTIES
                     55:                             Availability of Unicode property support
                     56:                               (1=yes 0=no)
                     57: .sp
1.1.1.2   misho      58: The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise. That error
                     59: is also given if PCRE_CONFIG_UTF16 is passed to \fBpcre_config()\fP or if
                     60: PCRE_CONFIG_UTF8 is passed to \fBpcre16_config()\fP.
1.1       misho      61: .P
                     62: There is a complete description of the PCRE native API in the
                     63: .\" HREF
                     64: \fBpcreapi\fP
                     65: .\"
                     66: page and a description of the POSIX API in the
                     67: .\" HREF
                     68: \fBpcreposix\fP
                     69: .\"
                     70: page.