349 lines
15 KiB
HTML
349 lines
15 KiB
HTML
<html>
|
|
<head>
|
|
<title>pcrebuild specification</title>
|
|
</head>
|
|
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
|
|
<h1>pcrebuild man page</h1>
|
|
<p>
|
|
Return to the <a href="index.html">PCRE index page</a>.
|
|
</p>
|
|
<p>
|
|
This page is part of the PCRE HTML documentation. It was generated automatically
|
|
from the original man page. If there is any nonsense in it, please consult the
|
|
man page, in case the conversion went wrong.
|
|
<br>
|
|
<ul>
|
|
<li><a name="TOC1" href="#SEC1">PCRE BUILD-TIME OPTIONS</a>
|
|
<li><a name="TOC2" href="#SEC2">C++ SUPPORT</a>
|
|
<li><a name="TOC3" href="#SEC3">UTF-8 SUPPORT</a>
|
|
<li><a name="TOC4" href="#SEC4">UNICODE CHARACTER PROPERTY SUPPORT</a>
|
|
<li><a name="TOC5" href="#SEC5">CODE VALUE OF NEWLINE</a>
|
|
<li><a name="TOC6" href="#SEC6">WHAT \R MATCHES</a>
|
|
<li><a name="TOC7" href="#SEC7">BUILDING SHARED AND STATIC LIBRARIES</a>
|
|
<li><a name="TOC8" href="#SEC8">POSIX MALLOC USAGE</a>
|
|
<li><a name="TOC9" href="#SEC9">HANDLING VERY LARGE PATTERNS</a>
|
|
<li><a name="TOC10" href="#SEC10">AVOIDING EXCESSIVE STACK USAGE</a>
|
|
<li><a name="TOC11" href="#SEC11">LIMITING PCRE RESOURCE USAGE</a>
|
|
<li><a name="TOC12" href="#SEC12">CREATING CHARACTER TABLES AT BUILD TIME</a>
|
|
<li><a name="TOC13" href="#SEC13">USING EBCDIC CODE</a>
|
|
<li><a name="TOC14" href="#SEC14">PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT</a>
|
|
<li><a name="TOC15" href="#SEC15">PCRETEST OPTION FOR LIBREADLINE SUPPORT</a>
|
|
<li><a name="TOC16" href="#SEC16">SEE ALSO</a>
|
|
<li><a name="TOC17" href="#SEC17">AUTHOR</a>
|
|
<li><a name="TOC18" href="#SEC18">REVISION</a>
|
|
</ul>
|
|
<br><a name="SEC1" href="#TOC1">PCRE BUILD-TIME OPTIONS</a><br>
|
|
<P>
|
|
This document describes the optional features of PCRE that can be selected when
|
|
the library is compiled. It assumes use of the <b>configure</b> script, where
|
|
the optional features are selected or deselected by providing options to
|
|
<b>configure</b> before running the <b>make</b> command. However, the same
|
|
options can be selected in both Unix-like and non-Unix-like environments using
|
|
the GUI facility of <b>CMakeSetup</b> if you are using <b>CMake</b> instead of
|
|
<b>configure</b> to build PCRE.
|
|
</P>
|
|
<P>
|
|
The complete list of options for <b>configure</b> (which includes the standard
|
|
ones such as the selection of the installation directory) can be obtained by
|
|
running
|
|
<pre>
|
|
./configure --help
|
|
</pre>
|
|
The following sections include descriptions of options whose names begin with
|
|
--enable or --disable. These settings specify changes to the defaults for the
|
|
<b>configure</b> command. Because of the way that <b>configure</b> works,
|
|
--enable and --disable always come in pairs, so the complementary option always
|
|
exists as well, but as it specifies the default, it is not described.
|
|
</P>
|
|
<br><a name="SEC2" href="#TOC1">C++ SUPPORT</a><br>
|
|
<P>
|
|
By default, the <b>configure</b> script will search for a C++ compiler and C++
|
|
header files. If it finds them, it automatically builds the C++ wrapper library
|
|
for PCRE. You can disable this by adding
|
|
<pre>
|
|
--disable-cpp
|
|
</pre>
|
|
to the <b>configure</b> command.
|
|
</P>
|
|
<br><a name="SEC3" href="#TOC1">UTF-8 SUPPORT</a><br>
|
|
<P>
|
|
To build PCRE with support for UTF-8 Unicode character strings, add
|
|
<pre>
|
|
--enable-utf8
|
|
</pre>
|
|
to the <b>configure</b> command. Of itself, this does not make PCRE treat
|
|
strings as UTF-8. As well as compiling PCRE with this option, you also have
|
|
have to set the PCRE_UTF8 option when you call the <b>pcre_compile()</b>
|
|
function.
|
|
</P>
|
|
<P>
|
|
If you set --enable-utf8 when compiling in an EBCDIC environment, PCRE expects
|
|
its input to be either ASCII or UTF-8 (depending on the runtime option). It is
|
|
not possible to support both EBCDIC and UTF-8 codes in the same version of the
|
|
library. Consequently, --enable-utf8 and --enable-ebcdic are mutually
|
|
exclusive.
|
|
</P>
|
|
<br><a name="SEC4" href="#TOC1">UNICODE CHARACTER PROPERTY SUPPORT</a><br>
|
|
<P>
|
|
UTF-8 support allows PCRE to process character values greater than 255 in the
|
|
strings that it handles. On its own, however, it does not provide any
|
|
facilities for accessing the properties of such characters. If you want to be
|
|
able to use the pattern escapes \P, \p, and \X, which refer to Unicode
|
|
character properties, you must add
|
|
<pre>
|
|
--enable-unicode-properties
|
|
</pre>
|
|
to the <b>configure</b> command. This implies UTF-8 support, even if you have
|
|
not explicitly requested it.
|
|
</P>
|
|
<P>
|
|
Including Unicode property support adds around 30K of tables to the PCRE
|
|
library. Only the general category properties such as <i>Lu</i> and <i>Nd</i> are
|
|
supported. Details are given in the
|
|
<a href="pcrepattern.html"><b>pcrepattern</b></a>
|
|
documentation.
|
|
</P>
|
|
<br><a name="SEC5" href="#TOC1">CODE VALUE OF NEWLINE</a><br>
|
|
<P>
|
|
By default, PCRE interprets the linefeed (LF) character as indicating the end
|
|
of a line. This is the normal newline character on Unix-like systems. You can
|
|
compile PCRE to use carriage return (CR) instead, by adding
|
|
<pre>
|
|
--enable-newline-is-cr
|
|
</pre>
|
|
to the <b>configure</b> command. There is also a --enable-newline-is-lf option,
|
|
which explicitly specifies linefeed as the newline character.
|
|
<br>
|
|
<br>
|
|
Alternatively, you can specify that line endings are to be indicated by the two
|
|
character sequence CRLF. If you want this, add
|
|
<pre>
|
|
--enable-newline-is-crlf
|
|
</pre>
|
|
to the <b>configure</b> command. There is a fourth option, specified by
|
|
<pre>
|
|
--enable-newline-is-anycrlf
|
|
</pre>
|
|
which causes PCRE to recognize any of the three sequences CR, LF, or CRLF as
|
|
indicating a line ending. Finally, a fifth option, specified by
|
|
<pre>
|
|
--enable-newline-is-any
|
|
</pre>
|
|
causes PCRE to recognize any Unicode newline sequence.
|
|
</P>
|
|
<P>
|
|
Whatever line ending convention is selected when PCRE is built can be
|
|
overridden when the library functions are called. At build time it is
|
|
conventional to use the standard for your operating system.
|
|
</P>
|
|
<br><a name="SEC6" href="#TOC1">WHAT \R MATCHES</a><br>
|
|
<P>
|
|
By default, the sequence \R in a pattern matches any Unicode newline sequence,
|
|
whatever has been selected as the line ending sequence. If you specify
|
|
<pre>
|
|
--enable-bsr-anycrlf
|
|
</pre>
|
|
the default is changed so that \R matches only CR, LF, or CRLF. Whatever is
|
|
selected when PCRE is built can be overridden when the library functions are
|
|
called.
|
|
</P>
|
|
<br><a name="SEC7" href="#TOC1">BUILDING SHARED AND STATIC LIBRARIES</a><br>
|
|
<P>
|
|
The PCRE building process uses <b>libtool</b> to build both shared and static
|
|
Unix libraries by default. You can suppress one of these by adding one of
|
|
<pre>
|
|
--disable-shared
|
|
--disable-static
|
|
</pre>
|
|
to the <b>configure</b> command, as required.
|
|
</P>
|
|
<br><a name="SEC8" href="#TOC1">POSIX MALLOC USAGE</a><br>
|
|
<P>
|
|
When PCRE is called through the POSIX interface (see the
|
|
<a href="pcreposix.html"><b>pcreposix</b></a>
|
|
documentation), additional working storage is required for holding the pointers
|
|
to capturing substrings, because PCRE requires three integers per substring,
|
|
whereas the POSIX interface provides only two. If the number of expected
|
|
substrings is small, the wrapper function uses space on the stack, because this
|
|
is faster than using <b>malloc()</b> for each call. The default threshold above
|
|
which the stack is no longer used is 10; it can be changed by adding a setting
|
|
such as
|
|
<pre>
|
|
--with-posix-malloc-threshold=20
|
|
</pre>
|
|
to the <b>configure</b> command.
|
|
</P>
|
|
<br><a name="SEC9" href="#TOC1">HANDLING VERY LARGE PATTERNS</a><br>
|
|
<P>
|
|
Within a compiled pattern, offset values are used to point from one part to
|
|
another (for example, from an opening parenthesis to an alternation
|
|
metacharacter). By default, two-byte values are used for these offsets, leading
|
|
to a maximum size for a compiled pattern of around 64K. This is sufficient to
|
|
handle all but the most gigantic patterns. Nevertheless, some people do want to
|
|
process enormous patterns, so it is possible to compile PCRE to use three-byte
|
|
or four-byte offsets by adding a setting such as
|
|
<pre>
|
|
--with-link-size=3
|
|
</pre>
|
|
to the <b>configure</b> command. The value given must be 2, 3, or 4. Using
|
|
longer offsets slows down the operation of PCRE because it has to load
|
|
additional bytes when handling them.
|
|
</P>
|
|
<br><a name="SEC10" href="#TOC1">AVOIDING EXCESSIVE STACK USAGE</a><br>
|
|
<P>
|
|
When matching with the <b>pcre_exec()</b> function, PCRE implements backtracking
|
|
by making recursive calls to an internal function called <b>match()</b>. In
|
|
environments where the size of the stack is limited, this can severely limit
|
|
PCRE's operation. (The Unix environment does not usually suffer from this
|
|
problem, but it may sometimes be necessary to increase the maximum stack size.
|
|
There is a discussion in the
|
|
<a href="pcrestack.html"><b>pcrestack</b></a>
|
|
documentation.) An alternative approach to recursion that uses memory from the
|
|
heap to remember data, instead of using recursive function calls, has been
|
|
implemented to work round the problem of limited stack size. If you want to
|
|
build a version of PCRE that works this way, add
|
|
<pre>
|
|
--disable-stack-for-recursion
|
|
</pre>
|
|
to the <b>configure</b> command. With this configuration, PCRE will use the
|
|
<b>pcre_stack_malloc</b> and <b>pcre_stack_free</b> variables to call memory
|
|
management functions. By default these point to <b>malloc()</b> and
|
|
<b>free()</b>, but you can replace the pointers so that your own functions are
|
|
used.
|
|
</P>
|
|
<P>
|
|
Separate functions are provided rather than using <b>pcre_malloc</b> and
|
|
<b>pcre_free</b> because the usage is very predictable: the block sizes
|
|
requested are always the same, and the blocks are always freed in reverse
|
|
order. A calling program might be able to implement optimized functions that
|
|
perform better than <b>malloc()</b> and <b>free()</b>. PCRE runs noticeably more
|
|
slowly when built in this way. This option affects only the <b>pcre_exec()</b>
|
|
function; it is not relevant for the the <b>pcre_dfa_exec()</b> function.
|
|
</P>
|
|
<br><a name="SEC11" href="#TOC1">LIMITING PCRE RESOURCE USAGE</a><br>
|
|
<P>
|
|
Internally, PCRE has a function called <b>match()</b>, which it calls repeatedly
|
|
(sometimes recursively) when matching a pattern with the <b>pcre_exec()</b>
|
|
function. By controlling the maximum number of times this function may be
|
|
called during a single matching operation, a limit can be placed on the
|
|
resources used by a single call to <b>pcre_exec()</b>. The limit can be changed
|
|
at run time, as described in the
|
|
<a href="pcreapi.html"><b>pcreapi</b></a>
|
|
documentation. The default is 10 million, but this can be changed by adding a
|
|
setting such as
|
|
<pre>
|
|
--with-match-limit=500000
|
|
</pre>
|
|
to the <b>configure</b> command. This setting has no effect on the
|
|
<b>pcre_dfa_exec()</b> matching function.
|
|
</P>
|
|
<P>
|
|
In some environments it is desirable to limit the depth of recursive calls of
|
|
<b>match()</b> more strictly than the total number of calls, in order to
|
|
restrict the maximum amount of stack (or heap, if --disable-stack-for-recursion
|
|
is specified) that is used. A second limit controls this; it defaults to the
|
|
value that is set for --with-match-limit, which imposes no additional
|
|
constraints. However, you can set a lower limit by adding, for example,
|
|
<pre>
|
|
--with-match-limit-recursion=10000
|
|
</pre>
|
|
to the <b>configure</b> command. This value can also be overridden at run time.
|
|
</P>
|
|
<br><a name="SEC12" href="#TOC1">CREATING CHARACTER TABLES AT BUILD TIME</a><br>
|
|
<P>
|
|
PCRE uses fixed tables for processing characters whose code values are less
|
|
than 256. By default, PCRE is built with a set of tables that are distributed
|
|
in the file <i>pcre_chartables.c.dist</i>. These tables are for ASCII codes
|
|
only. If you add
|
|
<pre>
|
|
--enable-rebuild-chartables
|
|
</pre>
|
|
to the <b>configure</b> command, the distributed tables are no longer used.
|
|
Instead, a program called <b>dftables</b> is compiled and run. This outputs the
|
|
source for new set of tables, created in the default locale of your C runtime
|
|
system. (This method of replacing the tables does not work if you are cross
|
|
compiling, because <b>dftables</b> is run on the local host. If you need to
|
|
create alternative tables when cross compiling, you will have to do so "by
|
|
hand".)
|
|
</P>
|
|
<br><a name="SEC13" href="#TOC1">USING EBCDIC CODE</a><br>
|
|
<P>
|
|
PCRE assumes by default that it will run in an environment where the character
|
|
code is ASCII (or Unicode, which is a superset of ASCII). This is the case for
|
|
most computer operating systems. PCRE can, however, be compiled to run in an
|
|
EBCDIC environment by adding
|
|
<pre>
|
|
--enable-ebcdic
|
|
</pre>
|
|
to the <b>configure</b> command. This setting implies
|
|
--enable-rebuild-chartables. You should only use it if you know that you are in
|
|
an EBCDIC environment (for example, an IBM mainframe operating system). The
|
|
--enable-ebcdic option is incompatible with --enable-utf8.
|
|
</P>
|
|
<br><a name="SEC14" href="#TOC1">PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT</a><br>
|
|
<P>
|
|
By default, <b>pcregrep</b> reads all files as plain text. You can build it so
|
|
that it recognizes files whose names end in <b>.gz</b> or <b>.bz2</b>, and reads
|
|
them with <b>libz</b> or <b>libbz2</b>, respectively, by adding one or both of
|
|
<pre>
|
|
--enable-pcregrep-libz
|
|
--enable-pcregrep-libbz2
|
|
</pre>
|
|
to the <b>configure</b> command. These options naturally require that the
|
|
relevant libraries are installed on your system. Configuration will fail if
|
|
they are not.
|
|
</P>
|
|
<br><a name="SEC15" href="#TOC1">PCRETEST OPTION FOR LIBREADLINE SUPPORT</a><br>
|
|
<P>
|
|
If you add
|
|
<pre>
|
|
--enable-pcretest-libreadline
|
|
</pre>
|
|
to the <b>configure</b> command, <b>pcretest</b> is linked with the
|
|
<b>libreadline</b> library, and when its input is from a terminal, it reads it
|
|
using the <b>readline()</b> function. This provides line-editing and history
|
|
facilities. Note that <b>libreadline</b> is GPL-licenced, so if you distribute a
|
|
binary of <b>pcretest</b> linked in this way, there may be licensing issues.
|
|
</P>
|
|
<P>
|
|
Setting this option causes the <b>-lreadline</b> option to be added to the
|
|
<b>pcretest</b> build. In many operating environments with a sytem-installed
|
|
<b>libreadline</b> this is sufficient. However, in some environments (e.g.
|
|
if an unmodified distribution version of readline is in use), some extra
|
|
configuration may be necessary. The INSTALL file for <b>libreadline</b> says
|
|
this:
|
|
<pre>
|
|
"Readline uses the termcap functions, but does not link with the
|
|
termcap or curses library itself, allowing applications which link
|
|
with readline the to choose an appropriate library."
|
|
</pre>
|
|
If your environment has not been set up so that an appropriate library is
|
|
automatically included, you may need to add something like
|
|
<pre>
|
|
LIBS="-ncurses"
|
|
</pre>
|
|
immediately before the <b>configure</b> command.
|
|
</P>
|
|
<br><a name="SEC16" href="#TOC1">SEE ALSO</a><br>
|
|
<P>
|
|
<b>pcreapi</b>(3), <b>pcre_config</b>(3).
|
|
</P>
|
|
<br><a name="SEC17" href="#TOC1">AUTHOR</a><br>
|
|
<P>
|
|
Philip Hazel
|
|
<br>
|
|
University Computing Service
|
|
<br>
|
|
Cambridge CB2 3QH, England.
|
|
<br>
|
|
</P>
|
|
<br><a name="SEC18" href="#TOC1">REVISION</a><br>
|
|
<P>
|
|
Last updated: 17 March 2009
|
|
<br>
|
|
Copyright © 1997-2009 University of Cambridge.
|
|
<br>
|
|
<p>
|
|
Return to the <a href="index.html">PCRE index page</a>.
|
|
</p>
|