2014-09-29 18:45:37 +02:00
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<title>pcre2build specification</title>
|
|
|
|
|
</head>
|
|
|
|
|
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
|
|
|
|
|
<h1>pcre2build man page</h1>
|
|
|
|
|
<p>
|
|
|
|
|
Return to the <a href="index.html">PCRE2 index page</a>.
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
This page is part of the PCRE2 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">BUILDING PCRE2</a>
|
|
|
|
|
<li><a name="TOC2" href="#SEC2">PCRE2 BUILD-TIME OPTIONS</a>
|
|
|
|
|
<li><a name="TOC3" href="#SEC3">BUILDING 8-BIT, 16-BIT AND 32-BIT LIBRARIES</a>
|
|
|
|
|
<li><a name="TOC4" href="#SEC4">BUILDING SHARED AND STATIC LIBRARIES</a>
|
2014-11-23 19:38:38 +01:00
|
|
|
<li><a name="TOC5" href="#SEC5">UNICODE AND UTF SUPPORT</a>
|
2015-10-17 15:50:56 +02:00
|
|
|
<li><a name="TOC6" href="#SEC6">DISABLING THE USE OF \C</a>
|
|
|
|
|
<li><a name="TOC7" href="#SEC7">JUST-IN-TIME COMPILER SUPPORT</a>
|
|
|
|
|
<li><a name="TOC8" href="#SEC8">NEWLINE RECOGNITION</a>
|
|
|
|
|
<li><a name="TOC9" href="#SEC9">WHAT \R MATCHES</a>
|
|
|
|
|
<li><a name="TOC10" href="#SEC10">HANDLING VERY LARGE PATTERNS</a>
|
|
|
|
|
<li><a name="TOC11" href="#SEC11">AVOIDING EXCESSIVE STACK USAGE</a>
|
|
|
|
|
<li><a name="TOC12" href="#SEC12">LIMITING PCRE2 RESOURCE USAGE</a>
|
|
|
|
|
<li><a name="TOC13" href="#SEC13">CREATING CHARACTER TABLES AT BUILD TIME</a>
|
|
|
|
|
<li><a name="TOC14" href="#SEC14">USING EBCDIC CODE</a>
|
2016-06-05 18:05:34 +02:00
|
|
|
<li><a name="TOC15" href="#SEC15">PCRE2GREP SUPPORT FOR EXTERNAL SCRIPTS</a>
|
|
|
|
|
<li><a name="TOC16" href="#SEC16">PCRE2GREP OPTIONS FOR COMPRESSED FILE SUPPORT</a>
|
|
|
|
|
<li><a name="TOC17" href="#SEC17">PCRE2GREP BUFFER SIZE</a>
|
|
|
|
|
<li><a name="TOC18" href="#SEC18">PCRE2TEST OPTION FOR LIBREADLINE SUPPORT</a>
|
|
|
|
|
<li><a name="TOC19" href="#SEC19">INCLUDING DEBUGGING CODE</a>
|
|
|
|
|
<li><a name="TOC20" href="#SEC20">DEBUGGING WITH VALGRIND SUPPORT</a>
|
|
|
|
|
<li><a name="TOC21" href="#SEC21">CODE COVERAGE REPORTING</a>
|
2016-11-22 16:37:02 +01:00
|
|
|
<li><a name="TOC22" href="#SEC22">SUPPORT FOR FUZZERS</a>
|
|
|
|
|
<li><a name="TOC23" href="#SEC23">SEE ALSO</a>
|
|
|
|
|
<li><a name="TOC24" href="#SEC24">AUTHOR</a>
|
|
|
|
|
<li><a name="TOC25" href="#SEC25">REVISION</a>
|
2014-09-29 18:45:37 +02:00
|
|
|
</ul>
|
|
|
|
|
<br><a name="SEC1" href="#TOC1">BUILDING PCRE2</a><br>
|
|
|
|
|
<P>
|
|
|
|
|
PCRE2 is distributed with a <b>configure</b> script that can be used to build
|
|
|
|
|
the library in Unix-like environments using the applications known as
|
|
|
|
|
Autotools. Also in the distribution are files to support building using
|
|
|
|
|
<b>CMake</b> instead of <b>configure</b>. The text file
|
|
|
|
|
<a href="README.txt"><b>README</b></a>
|
|
|
|
|
contains general information about building with Autotools (some of which is
|
|
|
|
|
repeated below), and also has some comments about building on various operating
|
|
|
|
|
systems. There is a lot more information about building PCRE2 without using
|
|
|
|
|
Autotools (including information about using <b>CMake</b> and building "by
|
|
|
|
|
hand") in the text file called
|
|
|
|
|
<a href="NON-AUTOTOOLS-BUILD.txt"><b>NON-AUTOTOOLS-BUILD</b>.</a>
|
|
|
|
|
You should consult this file as well as the
|
|
|
|
|
<a href="README.txt"><b>README</b></a>
|
|
|
|
|
file if you are building in a non-Unix-like environment.
|
|
|
|
|
</P>
|
|
|
|
|
<br><a name="SEC2" href="#TOC1">PCRE2 BUILD-TIME OPTIONS</a><br>
|
|
|
|
|
<P>
|
|
|
|
|
The rest of this document describes the optional features of PCRE2 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
|
|
|
|
|
if you are using <b>CMake</b> instead of <b>configure</b> to build PCRE2.
|
|
|
|
|
</P>
|
|
|
|
|
<P>
|
|
|
|
|
If you are not using Autotools or <b>CMake</b>, option selection can be done by
|
|
|
|
|
editing the <b>config.h</b> file, or by passing parameter settings to the
|
|
|
|
|
compiler, as described in
|
|
|
|
|
<a href="NON-AUTOTOOLS-BUILD.txt"><b>NON-AUTOTOOLS-BUILD</b>.</a>
|
|
|
|
|
</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="SEC3" href="#TOC1">BUILDING 8-BIT, 16-BIT AND 32-BIT LIBRARIES</a><br>
|
|
|
|
|
<P>
|
|
|
|
|
By default, a library called <b>libpcre2-8</b> is built, containing functions
|
|
|
|
|
that take string arguments contained in vectors of bytes, interpreted either as
|
|
|
|
|
single-byte characters, or UTF-8 strings. You can also build two other
|
|
|
|
|
libraries, called <b>libpcre2-16</b> and <b>libpcre2-32</b>, which process
|
|
|
|
|
strings that are contained in vectors of 16-bit and 32-bit code units,
|
|
|
|
|
respectively. These can be interpreted either as single-unit characters or
|
2014-10-20 19:28:49 +02:00
|
|
|
UTF-16/UTF-32 strings. To build these additional libraries, add one or both of
|
2014-09-29 18:45:37 +02:00
|
|
|
the following to the <b>configure</b> command:
|
|
|
|
|
<pre>
|
2014-11-23 19:38:38 +01:00
|
|
|
--enable-pcre2-16
|
|
|
|
|
--enable-pcre2-32
|
2014-09-29 18:45:37 +02:00
|
|
|
</pre>
|
|
|
|
|
If you do not want the 8-bit library, add
|
|
|
|
|
<pre>
|
2014-11-23 19:38:38 +01:00
|
|
|
--disable-pcre2-8
|
2014-09-29 18:45:37 +02:00
|
|
|
</pre>
|
|
|
|
|
as well. At least one of the three libraries must be built. Note that the POSIX
|
|
|
|
|
wrapper is for the 8-bit library only, and that <b>pcre2grep</b> is an 8-bit
|
|
|
|
|
program. Neither of these are built if you select only the 16-bit or 32-bit
|
|
|
|
|
libraries.
|
|
|
|
|
</P>
|
|
|
|
|
<br><a name="SEC4" href="#TOC1">BUILDING SHARED AND STATIC LIBRARIES</a><br>
|
|
|
|
|
<P>
|
|
|
|
|
The Autotools PCRE2 building process uses <b>libtool</b> to build both shared
|
2014-11-23 19:38:38 +01:00
|
|
|
and static libraries by default. You can suppress an unwanted library by adding
|
|
|
|
|
one of
|
2014-09-29 18:45:37 +02:00
|
|
|
<pre>
|
|
|
|
|
--disable-shared
|
|
|
|
|
--disable-static
|
|
|
|
|
</pre>
|
2014-11-23 19:38:38 +01:00
|
|
|
to the <b>configure</b> command.
|
2014-09-29 18:45:37 +02:00
|
|
|
</P>
|
2014-11-23 19:38:38 +01:00
|
|
|
<br><a name="SEC5" href="#TOC1">UNICODE AND UTF SUPPORT</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<P>
|
2014-11-03 19:27:56 +01:00
|
|
|
By default, PCRE2 is built with support for Unicode and UTF character strings.
|
|
|
|
|
To build it without Unicode support, add
|
2014-09-29 18:45:37 +02:00
|
|
|
<pre>
|
2014-11-03 19:27:56 +01:00
|
|
|
--disable-unicode
|
2014-09-29 18:45:37 +02:00
|
|
|
</pre>
|
2014-11-03 19:27:56 +01:00
|
|
|
to the <b>configure</b> command. This setting applies to all three libraries. It
|
|
|
|
|
is not possible to build one library with Unicode support, and another without,
|
|
|
|
|
in the same configuration.
|
2014-09-29 18:45:37 +02:00
|
|
|
</P>
|
|
|
|
|
<P>
|
2014-11-03 19:27:56 +01:00
|
|
|
Of itself, Unicode support does not make PCRE2 treat strings as UTF-8, UTF-16
|
2015-01-26 15:21:45 +01:00
|
|
|
or UTF-32. To do that, applications that use the library can set the PCRE2_UTF
|
|
|
|
|
option when they call <b>pcre2_compile()</b> to compile a pattern.
|
|
|
|
|
Alternatively, patterns may be started with (*UTF) unless the application has
|
|
|
|
|
locked this out by setting PCRE2_NEVER_UTF.
|
2014-09-29 18:45:37 +02:00
|
|
|
</P>
|
|
|
|
|
<P>
|
2014-11-23 19:38:38 +01:00
|
|
|
UTF support allows the libraries to process character code points up to
|
|
|
|
|
0x10ffff in the strings that they handle. It also provides support for
|
|
|
|
|
accessing the Unicode properties of such characters, using pattern escapes such
|
|
|
|
|
as \P, \p, and \X. Only the general category properties such as <i>Lu</i> and
|
|
|
|
|
<i>Nd</i> are supported. Details are given in the
|
2014-09-29 18:45:37 +02:00
|
|
|
<a href="pcre2pattern.html"><b>pcre2pattern</b></a>
|
|
|
|
|
documentation.
|
|
|
|
|
</P>
|
2015-01-26 15:21:45 +01:00
|
|
|
<P>
|
|
|
|
|
Pattern escapes such as \d and \w do not by default make use of Unicode
|
|
|
|
|
properties. The application can request that they do by setting the PCRE2_UCP
|
|
|
|
|
option. Unless the application has set PCRE2_NEVER_UCP, a pattern may also
|
|
|
|
|
request this by starting with (*UCP).
|
|
|
|
|
</P>
|
2015-10-17 15:50:56 +02:00
|
|
|
<br><a name="SEC6" href="#TOC1">DISABLING THE USE OF \C</a><br>
|
2015-06-18 18:39:25 +02:00
|
|
|
<P>
|
|
|
|
|
The \C escape sequence, which matches a single code unit, even in a UTF mode,
|
|
|
|
|
can cause unpredictable behaviour because it may leave the current matching
|
2015-10-17 15:50:56 +02:00
|
|
|
point in the middle of a multi-code-unit character. The application can lock it
|
|
|
|
|
out by setting the PCRE2_NEVER_BACKSLASH_C option when calling
|
|
|
|
|
<b>pcre2_compile()</b>. There is also a build-time option
|
|
|
|
|
<pre>
|
|
|
|
|
--enable-never-backslash-C
|
|
|
|
|
</pre>
|
|
|
|
|
(note the upper case C) which locks out the use of \C entirely.
|
2015-06-18 18:39:25 +02:00
|
|
|
</P>
|
2015-10-17 15:50:56 +02:00
|
|
|
<br><a name="SEC7" href="#TOC1">JUST-IN-TIME COMPILER SUPPORT</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<P>
|
|
|
|
|
Just-in-time compiler support is included in the build by specifying
|
|
|
|
|
<pre>
|
|
|
|
|
--enable-jit
|
|
|
|
|
</pre>
|
|
|
|
|
This support is available only for certain hardware architectures. If this
|
2014-11-23 19:38:38 +01:00
|
|
|
option is set for an unsupported architecture, a building error occurs.
|
2014-09-29 18:45:37 +02:00
|
|
|
See the
|
|
|
|
|
<a href="pcre2jit.html"><b>pcre2jit</b></a>
|
|
|
|
|
documentation for a discussion of JIT usage. When JIT support is enabled,
|
|
|
|
|
pcre2grep automatically makes use of it, unless you add
|
|
|
|
|
<pre>
|
|
|
|
|
--disable-pcre2grep-jit
|
|
|
|
|
</pre>
|
|
|
|
|
to the "configure" command.
|
|
|
|
|
</P>
|
2015-10-17 15:50:56 +02:00
|
|
|
<br><a name="SEC8" href="#TOC1">NEWLINE RECOGNITION</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<P>
|
|
|
|
|
By default, PCRE2 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 PCRE2 to use carriage return (CR) instead, by adding
|
|
|
|
|
<pre>
|
|
|
|
|
--enable-newline-is-cr
|
|
|
|
|
</pre>
|
2014-11-23 19:38:38 +01:00
|
|
|
to the <b>configure</b> command. There is also an --enable-newline-is-lf option,
|
2014-09-29 18:45:37 +02:00
|
|
|
which explicitly specifies linefeed as the newline character.
|
2014-11-23 19:38:38 +01:00
|
|
|
</P>
|
|
|
|
|
<P>
|
|
|
|
|
Alternatively, you can specify that line endings are to be indicated by the
|
|
|
|
|
two-character sequence CRLF (CR immediately followed by LF). If you want this,
|
|
|
|
|
add
|
2014-09-29 18:45:37 +02:00
|
|
|
<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 PCRE2 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>
|
2014-11-23 19:38:38 +01:00
|
|
|
causes PCRE2 to recognize any Unicode newline sequence. The Unicode newline
|
|
|
|
|
sequences are the three just mentioned, plus the single characters VT (vertical
|
|
|
|
|
tab, U+000B), FF (form feed, U+000C), NEL (next line, U+0085), LS (line
|
|
|
|
|
separator, U+2028), and PS (paragraph separator, U+2029).
|
2014-09-29 18:45:37 +02:00
|
|
|
</P>
|
|
|
|
|
<P>
|
2014-11-23 19:38:38 +01:00
|
|
|
Whatever default line ending convention is selected when PCRE2 is built can be
|
|
|
|
|
overridden by applications that use the library. At build time it is
|
2014-09-29 18:45:37 +02:00
|
|
|
conventional to use the standard for your operating system.
|
|
|
|
|
</P>
|
2015-10-17 15:50:56 +02:00
|
|
|
<br><a name="SEC9" href="#TOC1">WHAT \R MATCHES</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<P>
|
|
|
|
|
By default, the sequence \R in a pattern matches any Unicode newline sequence,
|
2014-11-23 19:38:38 +01:00
|
|
|
independently of what has been selected as the line ending sequence. If you
|
|
|
|
|
specify
|
2014-09-29 18:45:37 +02:00
|
|
|
<pre>
|
|
|
|
|
--enable-bsr-anycrlf
|
|
|
|
|
</pre>
|
|
|
|
|
the default is changed so that \R matches only CR, LF, or CRLF. Whatever is
|
2014-11-23 19:38:38 +01:00
|
|
|
selected when PCRE2 is built can be overridden by applications that use the
|
2014-09-29 18:45:37 +02:00
|
|
|
called.
|
|
|
|
|
</P>
|
2015-10-17 15:50:56 +02:00
|
|
|
<br><a name="SEC10" href="#TOC1">HANDLING VERY LARGE PATTERNS</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<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, in the 8-bit and 16-bit libraries, two-byte values
|
|
|
|
|
are used for these offsets, leading to a maximum size for a compiled pattern of
|
2014-11-23 19:38:38 +01:00
|
|
|
around 64K code units. This is sufficient to handle all but the most gigantic
|
|
|
|
|
patterns. Nevertheless, some people do want to process truly enormous patterns,
|
|
|
|
|
so it is possible to compile PCRE2 to use three-byte or four-byte offsets by
|
|
|
|
|
adding a setting such as
|
2014-09-29 18:45:37 +02:00
|
|
|
<pre>
|
|
|
|
|
--with-link-size=3
|
|
|
|
|
</pre>
|
|
|
|
|
to the <b>configure</b> command. The value given must be 2, 3, or 4. For the
|
|
|
|
|
16-bit library, a value of 3 is rounded up to 4. In these libraries, using
|
|
|
|
|
longer offsets slows down the operation of PCRE2 because it has to load
|
|
|
|
|
additional data when handling them. For the 32-bit library the value is always
|
|
|
|
|
4 and cannot be overridden; the value of --with-link-size is ignored.
|
|
|
|
|
</P>
|
2015-10-17 15:50:56 +02:00
|
|
|
<br><a name="SEC11" href="#TOC1">AVOIDING EXCESSIVE STACK USAGE</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<P>
|
|
|
|
|
When matching with the <b>pcre2_match()</b> function, PCRE2 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 PCRE2'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="pcre2stack.html"><b>pcre2stack</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 PCRE2 that works this way, add
|
|
|
|
|
<pre>
|
|
|
|
|
--disable-stack-for-recursion
|
|
|
|
|
</pre>
|
|
|
|
|
to the <b>configure</b> command. By default, the system functions <b>malloc()</b>
|
|
|
|
|
and <b>free()</b> are called to manage the heap memory that is required, but
|
|
|
|
|
custom memory management functions can be called instead. PCRE2 runs noticeably
|
|
|
|
|
more slowly when built in this way. This option affects only the
|
|
|
|
|
<b>pcre2_match()</b> function; it is not relevant for <b>pcre2_dfa_match()</b>.
|
|
|
|
|
</P>
|
2015-10-17 15:50:56 +02:00
|
|
|
<br><a name="SEC12" href="#TOC1">LIMITING PCRE2 RESOURCE USAGE</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<P>
|
|
|
|
|
Internally, PCRE2 has a function called <b>match()</b>, which it calls
|
|
|
|
|
repeatedly (sometimes recursively) when matching a pattern with the
|
|
|
|
|
<b>pcre2_match()</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>pcre2_match()</b>. The limit
|
|
|
|
|
can be changed at run time, as described in the
|
|
|
|
|
<a href="pcre2api.html"><b>pcre2api</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>pcre2_dfa_match()</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>
|
2015-10-17 15:50:56 +02:00
|
|
|
<br><a name="SEC13" href="#TOC1">CREATING CHARACTER TABLES AT BUILD TIME</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<P>
|
|
|
|
|
PCRE2 uses fixed tables for processing characters whose code points are less
|
|
|
|
|
than 256. By default, PCRE2 is built with a set of tables that are distributed
|
|
|
|
|
in the file <i>src/pcre2_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 run-time
|
|
|
|
|
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>
|
2015-10-17 15:50:56 +02:00
|
|
|
<br><a name="SEC14" href="#TOC1">USING EBCDIC CODE</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<P>
|
|
|
|
|
PCRE2 assumes by default that it will run in an environment where the character
|
2014-11-23 19:38:38 +01:00
|
|
|
code is ASCII or Unicode, which is a superset of ASCII. This is the case for
|
2014-09-29 18:45:37 +02:00
|
|
|
most computer operating systems. PCRE2 can, however, be compiled to run in an
|
2014-11-23 19:38:38 +01:00
|
|
|
8-bit EBCDIC environment by adding
|
2014-09-29 18:45:37 +02:00
|
|
|
<pre>
|
2014-11-03 19:27:56 +01:00
|
|
|
--enable-ebcdic --disable-unicode
|
2014-09-29 18:45:37 +02:00
|
|
|
</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
|
2014-11-23 19:38:38 +01:00
|
|
|
an EBCDIC environment (for example, an IBM mainframe operating system).
|
|
|
|
|
</P>
|
|
|
|
|
<P>
|
|
|
|
|
It is not possible to support both EBCDIC and UTF-8 codes in the same version
|
|
|
|
|
of the library. Consequently, --enable-unicode and --enable-ebcdic are mutually
|
|
|
|
|
exclusive.
|
2014-09-29 18:45:37 +02:00
|
|
|
</P>
|
|
|
|
|
<P>
|
|
|
|
|
The EBCDIC character that corresponds to an ASCII LF is assumed to have the
|
|
|
|
|
value 0x15 by default. However, in some EBCDIC environments, 0x25 is used. In
|
|
|
|
|
such an environment you should use
|
|
|
|
|
<pre>
|
|
|
|
|
--enable-ebcdic-nl25
|
|
|
|
|
</pre>
|
|
|
|
|
as well as, or instead of, --enable-ebcdic. The EBCDIC character for CR has the
|
|
|
|
|
same value as in ASCII, namely, 0x0d. Whichever of 0x15 and 0x25 is <i>not</i>
|
|
|
|
|
chosen as LF is made to correspond to the Unicode NEL character (which, in
|
|
|
|
|
Unicode, is 0x85).
|
|
|
|
|
</P>
|
|
|
|
|
<P>
|
|
|
|
|
The options that select newline behaviour, such as --enable-newline-is-cr,
|
|
|
|
|
and equivalent run-time options, refer to these character values in an EBCDIC
|
|
|
|
|
environment.
|
|
|
|
|
</P>
|
2016-06-05 18:05:34 +02:00
|
|
|
<br><a name="SEC15" href="#TOC1">PCRE2GREP SUPPORT FOR EXTERNAL SCRIPTS</a><br>
|
|
|
|
|
<P>
|
2016-06-29 18:52:05 +02:00
|
|
|
By default, on non-Windows systems, <b>pcre2grep</b> supports the use of
|
|
|
|
|
callouts with string arguments within the patterns it is matching, in order to
|
2016-06-05 18:05:34 +02:00
|
|
|
run external scripts. For details, see the
|
|
|
|
|
<a href="pcre2grep.html"><b>pcre2grep</b></a>
|
2016-06-29 18:52:05 +02:00
|
|
|
documentation. This support can be disabled by adding
|
|
|
|
|
--disable-pcre2grep-callout to the <b>configure</b> command.
|
2016-06-05 18:05:34 +02:00
|
|
|
</P>
|
|
|
|
|
<br><a name="SEC16" href="#TOC1">PCRE2GREP OPTIONS FOR COMPRESSED FILE SUPPORT</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<P>
|
|
|
|
|
By default, <b>pcre2grep</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-pcre2grep-libz
|
|
|
|
|
--enable-pcre2grep-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>
|
2016-06-05 18:05:34 +02:00
|
|
|
<br><a name="SEC17" href="#TOC1">PCRE2GREP BUFFER SIZE</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<P>
|
|
|
|
|
<b>pcre2grep</b> uses an internal buffer to hold a "window" on the file it is
|
|
|
|
|
scanning, in order to be able to output "before" and "after" lines when it
|
2016-11-22 16:37:02 +01:00
|
|
|
finds a match. The starting size of the buffer is controlled by a parameter
|
|
|
|
|
whose default value is 20K. The buffer itself is three times this size, but
|
|
|
|
|
because of the way it is used for holding "before" lines, the longest line that
|
|
|
|
|
is guaranteed to be processable is the parameter size. If a longer line is
|
|
|
|
|
encountered, <b>pcre2grep</b> automatically expands the buffer, up to a
|
|
|
|
|
specified maximum size, whose default is 1M or the starting size, whichever is
|
|
|
|
|
the larger. You can change the default parameter values by adding, for example,
|
2014-09-29 18:45:37 +02:00
|
|
|
<pre>
|
2016-11-22 16:37:02 +01:00
|
|
|
--with-pcre2grep-bufsize=51200
|
|
|
|
|
--with-pcre2grep-max-bufsize=2097152
|
2014-09-29 18:45:37 +02:00
|
|
|
</pre>
|
2016-11-22 16:37:02 +01:00
|
|
|
to the <b>configure</b> command. The caller of \fPpcre2grep\fP can override
|
|
|
|
|
these values by using --buffer-size and --max-buffer-size on the command line.
|
2014-09-29 18:45:37 +02:00
|
|
|
</P>
|
2016-06-05 18:05:34 +02:00
|
|
|
<br><a name="SEC18" href="#TOC1">PCRE2TEST OPTION FOR LIBREADLINE SUPPORT</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<P>
|
|
|
|
|
If you add one of
|
|
|
|
|
<pre>
|
|
|
|
|
--enable-pcre2test-libreadline
|
2014-10-20 19:28:49 +02:00
|
|
|
--enable-pcre2test-libedit
|
2014-09-29 18:45:37 +02:00
|
|
|
</pre>
|
|
|
|
|
to the <b>configure</b> command, <b>pcre2test</b> is linked with the
|
|
|
|
|
<b>libreadline</b> or<b>libedit</b> library, respectively, 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-licensed, so if you distribute a binary of <b>pcre2test</b> linked in this
|
2014-11-23 19:38:38 +01:00
|
|
|
way, there may be licensing issues. These can be avoided by linking instead
|
|
|
|
|
with <b>libedit</b>, which has a BSD licence.
|
2014-09-29 18:45:37 +02:00
|
|
|
</P>
|
|
|
|
|
<P>
|
2014-11-23 19:38:38 +01:00
|
|
|
Setting --enable-pcre2test-libreadline causes the <b>-lreadline</b> option to be
|
|
|
|
|
added to the <b>pcre2test</b> build. In many operating environments with a
|
|
|
|
|
sytem-installed readline library 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:
|
2014-09-29 18:45:37 +02:00
|
|
|
<pre>
|
2014-10-20 19:28:49 +02:00
|
|
|
"Readline uses the termcap functions, but does not link with
|
|
|
|
|
the termcap or curses library itself, allowing applications
|
2014-09-29 18:45:37 +02:00
|
|
|
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>
|
2016-06-05 18:05:34 +02:00
|
|
|
<br><a name="SEC19" href="#TOC1">INCLUDING DEBUGGING CODE</a><br>
|
2015-06-18 18:39:25 +02:00
|
|
|
<P>
|
|
|
|
|
If you add
|
|
|
|
|
<pre>
|
|
|
|
|
--enable-debug
|
|
|
|
|
</pre>
|
|
|
|
|
to the <b>configure</b> command, additional debugging code is included in the
|
|
|
|
|
build. This feature is intended for use by the PCRE2 maintainers.
|
|
|
|
|
</P>
|
2016-06-05 18:05:34 +02:00
|
|
|
<br><a name="SEC20" href="#TOC1">DEBUGGING WITH VALGRIND SUPPORT</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<P>
|
2014-11-23 19:38:38 +01:00
|
|
|
If you add
|
2014-09-29 18:45:37 +02:00
|
|
|
<pre>
|
|
|
|
|
--enable-valgrind
|
|
|
|
|
</pre>
|
2014-11-23 19:38:38 +01:00
|
|
|
to the <b>configure</b> command, PCRE2 will use valgrind annotations to mark
|
|
|
|
|
certain memory regions as unaddressable. This allows it to detect invalid
|
|
|
|
|
memory accesses, and is mostly useful for debugging PCRE2 itself.
|
2014-09-29 18:45:37 +02:00
|
|
|
</P>
|
2016-06-05 18:05:34 +02:00
|
|
|
<br><a name="SEC21" href="#TOC1">CODE COVERAGE REPORTING</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<P>
|
|
|
|
|
If your C compiler is gcc, you can build a version of PCRE2 that can generate a
|
|
|
|
|
code coverage report for its test suite. To enable this, you must install
|
|
|
|
|
<b>lcov</b> version 1.6 or above. Then specify
|
|
|
|
|
<pre>
|
|
|
|
|
--enable-coverage
|
|
|
|
|
</pre>
|
|
|
|
|
to the <b>configure</b> command and build PCRE2 in the usual way.
|
|
|
|
|
</P>
|
|
|
|
|
<P>
|
|
|
|
|
Note that using <b>ccache</b> (a caching C compiler) is incompatible with code
|
|
|
|
|
coverage reporting. If you have configured <b>ccache</b> to run automatically
|
|
|
|
|
on your system, you must set the environment variable
|
|
|
|
|
<pre>
|
|
|
|
|
CCACHE_DISABLE=1
|
|
|
|
|
</pre>
|
|
|
|
|
before running <b>make</b> to build PCRE2, so that <b>ccache</b> is not used.
|
|
|
|
|
</P>
|
|
|
|
|
<P>
|
|
|
|
|
When --enable-coverage is used, the following addition targets are added to the
|
|
|
|
|
<i>Makefile</i>:
|
|
|
|
|
<pre>
|
|
|
|
|
make coverage
|
|
|
|
|
</pre>
|
|
|
|
|
This creates a fresh coverage report for the PCRE2 test suite. It is equivalent
|
|
|
|
|
to running "make coverage-reset", "make coverage-baseline", "make check", and
|
|
|
|
|
then "make coverage-report".
|
|
|
|
|
<pre>
|
|
|
|
|
make coverage-reset
|
|
|
|
|
</pre>
|
|
|
|
|
This zeroes the coverage counters, but does nothing else.
|
|
|
|
|
<pre>
|
|
|
|
|
make coverage-baseline
|
|
|
|
|
</pre>
|
|
|
|
|
This captures baseline coverage information.
|
|
|
|
|
<pre>
|
|
|
|
|
make coverage-report
|
|
|
|
|
</pre>
|
|
|
|
|
This creates the coverage report.
|
|
|
|
|
<pre>
|
|
|
|
|
make coverage-clean-report
|
|
|
|
|
</pre>
|
|
|
|
|
This removes the generated coverage report without cleaning the coverage data
|
|
|
|
|
itself.
|
|
|
|
|
<pre>
|
|
|
|
|
make coverage-clean-data
|
|
|
|
|
</pre>
|
|
|
|
|
This removes the captured coverage data without removing the coverage files
|
|
|
|
|
created at compile time (*.gcno).
|
|
|
|
|
<pre>
|
|
|
|
|
make coverage-clean
|
|
|
|
|
</pre>
|
|
|
|
|
This cleans all coverage data including the generated coverage report. For more
|
|
|
|
|
information about code coverage, see the <b>gcov</b> and <b>lcov</b>
|
|
|
|
|
documentation.
|
|
|
|
|
</P>
|
2016-11-22 16:37:02 +01:00
|
|
|
<br><a name="SEC22" href="#TOC1">SUPPORT FOR FUZZERS</a><br>
|
|
|
|
|
<P>
|
|
|
|
|
There is a special option for use by people who want to run fuzzing tests on
|
|
|
|
|
PCRE2:
|
|
|
|
|
<pre>
|
|
|
|
|
--enable-fuzz-support
|
|
|
|
|
</pre>
|
|
|
|
|
At present this applies only to the 8-bit library. If set, it causes an extra
|
|
|
|
|
library called libpcre2-fuzzsupport.a to be built, but not installed. This
|
|
|
|
|
contains a single function called LLVMFuzzerTestOneInput() whose arguments are
|
|
|
|
|
a pointer to a string and the length of the string. When called, this function
|
|
|
|
|
tries to compile the string as a pattern, and if that succeeds, to match it.
|
|
|
|
|
This is done both with no options and with some random options bits that are
|
|
|
|
|
generated from the string. Setting --enable-fuzz-support also causes a binary
|
|
|
|
|
called <b>pcre2fuzzcheck</b> to be created. This is normally run under valgrind
|
|
|
|
|
or used when PCRE2 is compiled with address sanitizing enabled. It calls the
|
|
|
|
|
fuzzing function and outputs information about it is doing. The input strings
|
|
|
|
|
are specified by arguments: if an argument starts with "=" the rest of it is a
|
|
|
|
|
literal input string. Otherwise, it is assumed to be a file name, and the
|
|
|
|
|
contents of the file are the test string.
|
|
|
|
|
</P>
|
|
|
|
|
<br><a name="SEC23" href="#TOC1">SEE ALSO</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<P>
|
2014-11-17 17:59:02 +01:00
|
|
|
<b>pcre2api</b>(3), <b>pcre2-config</b>(3).
|
2014-09-29 18:45:37 +02:00
|
|
|
</P>
|
2016-11-22 16:37:02 +01:00
|
|
|
<br><a name="SEC24" href="#TOC1">AUTHOR</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<P>
|
|
|
|
|
Philip Hazel
|
|
|
|
|
<br>
|
|
|
|
|
University Computing Service
|
|
|
|
|
<br>
|
2014-11-21 17:45:06 +01:00
|
|
|
Cambridge, England.
|
2014-09-29 18:45:37 +02:00
|
|
|
<br>
|
|
|
|
|
</P>
|
2016-11-22 16:37:02 +01:00
|
|
|
<br><a name="SEC25" href="#TOC1">REVISION</a><br>
|
2014-09-29 18:45:37 +02:00
|
|
|
<P>
|
2016-11-22 16:37:02 +01:00
|
|
|
Last updated: 01 November 2016
|
2014-09-29 18:45:37 +02:00
|
|
|
<br>
|
2016-06-05 18:05:34 +02:00
|
|
|
Copyright © 1997-2016 University of Cambridge.
|
2014-09-29 18:45:37 +02:00
|
|
|
<br>
|
|
|
|
|
<p>
|
|
|
|
|
Return to the <a href="index.html">PCRE2 index page</a>.
|
|
|
|
|
</p>
|
