← Back to branch summary

~ubuntu-branches/ubuntu/trusty/pcre3/trusty

« back to all changes in this revision

Viewing changes to doc/pcre_config.3

  • Committer: Package Import Robot
  • Author(s): Mark Baker
  • Date: 2012-03-23 22:34:54 UTC
  • mfrom: (23.1.9 sid)
  • Revision ID: package-import@ubuntu.com-20120323223454-grhqqolk8a7x1h24
Tags: 1:8.30-4
* Reluctantly using an epoch, as it seems the funny version number with
  extra dots causes problems
* Bumped standard version to 3.9.3. No changes needed
* Converted to use new source format / quilt
* Put back obsolete pcre_info() API that upstream have dropped (Closes:
  #665300, #665356)
* Don't include pcregrep binary in debug package

Thanks to Elimar Riesebieter for the conversion to the new source format.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/pcre_config.3
8
8
.PP
9
9
.SM
10
10
.B int pcre_config(int \fIwhat\fP, void *\fIwhere\fP);
 
11
.PP
 
12
.B int pcre16_config(int \fIwhat\fP, void *\fIwhere\fP);
11
13
.
12
14
.SH DESCRIPTION
13
15
.rs
14
16
.sp
15
17
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
 
18
features are available in the version of the PCRE library it is using. The
17
19
arguments are as follows:
18
20
.sp
19
21
  \fIwhat\fP     A code specifying what information is required
20
22
  \fIwhere\fP    Points to where to put the data
21
23
.sp
22
 
The available codes are:
 
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:
23
27
.sp
 
28
  PCRE_CONFIG_JIT           Availability of just-in-time compiler
 
29
                              support (1=yes 0=no)
 
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
24
33
  PCRE_CONFIG_LINK_SIZE     Internal link size: 2, 3, or 4
25
34
  PCRE_CONFIG_MATCH_LIMIT   Internal resource limit
26
35
  PCRE_CONFIG_MATCH_LIMIT_RECURSION
35
44
                                 0             all Unicode line endings
36
45
                                 1             CR, LF, or CRLF only
37
46
  PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
38
 
                            Threshold of return slots, above
39
 
                              which \fBmalloc()\fP is used by
40
 
                              the POSIX API
 
47
                            Threshold of return slots, above which
 
48
                              \fBmalloc()\fP is used by the POSIX API
41
49
  PCRE_CONFIG_STACKRECURSE  Recursion implementation (1=stack 0=heap)
42
 
  PCRE_CONFIG_UTF8          Availability of UTF-8 support (1=yes 0=no)
 
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
43
54
  PCRE_CONFIG_UNICODE_PROPERTIES
44
55
                            Availability of Unicode property support
45
56
                              (1=yes 0=no)
46
57
.sp
47
 
The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise.
 
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.
48
61
.P
49
62
There is a complete description of the PCRE native API in the
50
63
.\" HREF