|
version 1.1.1.1, 2012/02/21 23:05:52
|
version 1.1.1.4, 2013/07/22 08:25:57
|
|
Line 13 from the original man page. If there is any nonsense i
|
Line 13 from the original man page. If there is any nonsense i
|
| man page, in case the conversion went wrong. |
man page, in case the conversion went wrong. |
| <br> |
<br> |
| <ul> |
<ul> |
| <li><a name="TOC1" href="#SEC1">PCRE BUILD-TIME OPTIONS</a> | <li><a name="TOC1" href="#SEC1">BUILDING PCRE</a> |
| <li><a name="TOC2" href="#SEC2">BUILDING SHARED AND STATIC LIBRARIES</a> | <li><a name="TOC2" href="#SEC2">PCRE BUILD-TIME OPTIONS</a> |
| <li><a name="TOC3" href="#SEC3">C++ SUPPORT</a> | <li><a name="TOC3" href="#SEC3">BUILDING 8-BIT, 16-BIT AND 32-BIT LIBRARIES</a> |
| <li><a name="TOC4" href="#SEC4">UTF-8 SUPPORT</a> | <li><a name="TOC4" href="#SEC4">BUILDING SHARED AND STATIC LIBRARIES</a> |
| <li><a name="TOC5" href="#SEC5">UNICODE CHARACTER PROPERTY SUPPORT</a> | <li><a name="TOC5" href="#SEC5">C++ SUPPORT</a> |
| <li><a name="TOC6" href="#SEC6">JUST-IN-TIME COMPILER SUPPORT</a> | <li><a name="TOC6" href="#SEC6">UTF-8, UTF-16 AND UTF-32 SUPPORT</a> |
| <li><a name="TOC7" href="#SEC7">CODE VALUE OF NEWLINE</a> | <li><a name="TOC7" href="#SEC7">UNICODE CHARACTER PROPERTY SUPPORT</a> |
| <li><a name="TOC8" href="#SEC8">WHAT \R MATCHES</a> | <li><a name="TOC8" href="#SEC8">JUST-IN-TIME COMPILER SUPPORT</a> |
| <li><a name="TOC9" href="#SEC9">POSIX MALLOC USAGE</a> | <li><a name="TOC9" href="#SEC9">CODE VALUE OF NEWLINE</a> |
| <li><a name="TOC10" href="#SEC10">HANDLING VERY LARGE PATTERNS</a> | <li><a name="TOC10" href="#SEC10">WHAT \R MATCHES</a> |
| <li><a name="TOC11" href="#SEC11">AVOIDING EXCESSIVE STACK USAGE</a> | <li><a name="TOC11" href="#SEC11">POSIX MALLOC USAGE</a> |
| <li><a name="TOC12" href="#SEC12">LIMITING PCRE RESOURCE USAGE</a> | <li><a name="TOC12" href="#SEC12">HANDLING VERY LARGE PATTERNS</a> |
| <li><a name="TOC13" href="#SEC13">CREATING CHARACTER TABLES AT BUILD TIME</a> | <li><a name="TOC13" href="#SEC13">AVOIDING EXCESSIVE STACK USAGE</a> |
| <li><a name="TOC14" href="#SEC14">USING EBCDIC CODE</a> | <li><a name="TOC14" href="#SEC14">LIMITING PCRE RESOURCE USAGE</a> |
| <li><a name="TOC15" href="#SEC15">PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT</a> | <li><a name="TOC15" href="#SEC15">CREATING CHARACTER TABLES AT BUILD TIME</a> |
| <li><a name="TOC16" href="#SEC16">PCREGREP BUFFER SIZE</a> | <li><a name="TOC16" href="#SEC16">USING EBCDIC CODE</a> |
| <li><a name="TOC17" href="#SEC17">PCRETEST OPTION FOR LIBREADLINE SUPPORT</a> | <li><a name="TOC17" href="#SEC17">PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT</a> |
| <li><a name="TOC18" href="#SEC18">SEE ALSO</a> | <li><a name="TOC18" href="#SEC18">PCREGREP BUFFER SIZE</a> |
| <li><a name="TOC19" href="#SEC19">AUTHOR</a> | <li><a name="TOC19" href="#SEC19">PCRETEST OPTION FOR LIBREADLINE SUPPORT</a> |
| <li><a name="TOC20" href="#SEC20">REVISION</a> | <li><a name="TOC20" href="#SEC20">DEBUGGING WITH VALGRIND SUPPORT</a> |
| | <li><a name="TOC21" href="#SEC21">CODE COVERAGE REPORTING</a> |
| | <li><a name="TOC22" href="#SEC22">SEE ALSO</a> |
| | <li><a name="TOC23" href="#SEC23">AUTHOR</a> |
| | <li><a name="TOC24" href="#SEC24">REVISION</a> |
| </ul> |
</ul> |
| <br><a name="SEC1" href="#TOC1">PCRE BUILD-TIME OPTIONS</a><br> | <br><a name="SEC1" href="#TOC1">BUILDING PCRE</a><br> |
| <P> |
<P> |
| This document describes the optional features of PCRE that can be selected when | PCRE is distributed with a <b>configure</b> script that can be used to build the |
| the library is compiled. It assumes use of the <b>configure</b> script, where | library in Unix-like environments using the applications known as Autotools. |
| the optional features are selected or deselected by providing options to | Also in the distribution are files to support building using <b>CMake</b> |
| <b>configure</b> before running the <b>make</b> command. However, the same | instead of <b>configure</b>. The text file |
| options can be selected in both Unix-like and non-Unix-like environments using | <a href="README.txt"><b>README</b></a> |
| the GUI facility of <b>cmake-gui</b> if you are using <b>CMake</b> instead of | contains general information about building with Autotools (some of which is |
| <b>configure</b> to build PCRE. | repeated below), and also has some comments about building on various operating |
| | systems. There is a lot more information about building PCRE 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> |
</P> |
| |
<br><a name="SEC2" href="#TOC1">PCRE BUILD-TIME OPTIONS</a><br> |
| <P> |
<P> |
| There is a lot more information about building PCRE in non-Unix-like | The rest of this document describes the optional features of PCRE that can be |
| environments in the file called <i>NON_UNIX_USE</i>, which is part of the PCRE | selected when the library is compiled. It assumes use of the <b>configure</b> |
| distribution. You should consult this file as well as the <i>README</i> file if | script, where the optional features are selected or deselected by providing |
| you are building in a non-Unix-like environment. | 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>cmake-gui</b> if you are using <b>CMake</b> instead |
| | of <b>configure</b> to build PCRE. |
| </P> |
</P> |
| <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 |
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 |
ones such as the selection of the installation directory) can be obtained by |
| running |
running |
|
Line 63 The following sections include descriptions of options
|
Line 84 The following sections include descriptions of options
|
| --enable and --disable always come in pairs, so the complementary option always |
--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. |
exists as well, but as it specifies the default, it is not described. |
| </P> |
</P> |
| <br><a name="SEC2" href="#TOC1">BUILDING SHARED AND STATIC LIBRARIES</a><br> | <br><a name="SEC3" href="#TOC1">BUILDING 8-BIT, 16-BIT AND 32-BIT LIBRARIES</a><br> |
| <P> |
<P> |
| The PCRE building process uses <b>libtool</b> to build both shared and static | By default, a library called <b>libpcre</b> is built, containing functions that |
| Unix libraries by default. You can suppress one of these by adding one of | take string arguments contained in vectors of bytes, either as single-byte |
| | characters, or interpreted as UTF-8 strings. You can also build a separate |
| | library, called <b>libpcre16</b>, in which strings are contained in vectors of |
| | 16-bit data units and interpreted either as single-unit characters or UTF-16 |
| | strings, by adding |
| <pre> |
<pre> |
| |
--enable-pcre16 |
| |
</pre> |
| |
to the <b>configure</b> command. You can also build yet another separate |
| |
library, called <b>libpcre32</b>, in which strings are contained in vectors of |
| |
32-bit data units and interpreted either as single-unit characters or UTF-32 |
| |
strings, by adding |
| |
<pre> |
| |
--enable-pcre32 |
| |
</pre> |
| |
to the <b>configure</b> command. If you do not want the 8-bit library, add |
| |
<pre> |
| |
--disable-pcre8 |
| |
</pre> |
| |
as well. At least one of the three libraries must be built. Note that the C++ |
| |
and POSIX wrappers are for the 8-bit library only, and that <b>pcregrep</b> is |
| |
an 8-bit program. None 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 PCRE building process uses <b>libtool</b> to build both shared and |
| |
static libraries by default. You can suppress one of these by adding one of |
| |
<pre> |
| --disable-shared |
--disable-shared |
| --disable-static |
--disable-static |
| </pre> |
</pre> |
| to the <b>configure</b> command, as required. |
to the <b>configure</b> command, as required. |
| </P> |
</P> |
| <br><a name="SEC3" href="#TOC1">C++ SUPPORT</a><br> | <br><a name="SEC5" href="#TOC1">C++ SUPPORT</a><br> |
| <P> |
<P> |
| By default, the <b>configure</b> script will search for a C++ compiler and C++ | By default, if the 8-bit library is being built, the <b>configure</b> script |
| header files. If it finds them, it automatically builds the C++ wrapper library | will search for a C++ compiler and C++ header files. If it finds them, it |
| for PCRE. You can disable this by adding | automatically builds the C++ wrapper library (which supports only 8-bit |
| | strings). You can disable this by adding |
| <pre> |
<pre> |
| --disable-cpp |
--disable-cpp |
| </pre> |
</pre> |
| to the <b>configure</b> command. |
to the <b>configure</b> command. |
| </P> |
</P> |
| <br><a name="SEC4" href="#TOC1">UTF-8 SUPPORT</a><br> | <br><a name="SEC6" href="#TOC1">UTF-8, UTF-16 AND UTF-32 SUPPORT</a><br> |
| <P> |
<P> |
| To build PCRE with support for UTF-8 Unicode character strings, add | To build PCRE with support for UTF Unicode character strings, add |
| <pre> |
<pre> |
| --enable-utf8 | --enable-utf |
| </pre> |
</pre> |
| to the <b>configure</b> command. Of itself, this does not make PCRE treat | to the <b>configure</b> command. This setting applies to all three libraries, |
| strings as UTF-8. As well as compiling PCRE with this option, you also have | adding support for UTF-8 to the 8-bit library, support for UTF-16 to the 16-bit |
| have to set the PCRE_UTF8 option when you call the <b>pcre_compile()</b> | library, and support for UTF-32 to the to the 32-bit library. There are no |
| or <b>pcre_compile2()</b> functions. | separate options for enabling UTF-8, UTF-16 and UTF-32 independently because |
| | that would allow ridiculous settings such as requesting UTF-16 support while |
| | building only the 8-bit library. It is not possible to build one library with |
| | UTF support and another without in the same configuration. (For backwards |
| | compatibility, --enable-utf8 is a synonym of --enable-utf.) |
| </P> |
</P> |
| <P> |
<P> |
| If you set --enable-utf8 when compiling in an EBCDIC environment, PCRE expects | Of itself, this setting does not make PCRE treat strings as UTF-8, UTF-16 or |
| its input to be either ASCII or UTF-8 (depending on the runtime option). It is | UTF-32. As well as compiling PCRE with this option, you also have have to set |
| | the PCRE_UTF8, PCRE_UTF16 or PCRE_UTF32 option (as appropriate) when you call |
| | one of the pattern compiling functions. |
| | </P> |
| | <P> |
| | If you set --enable-utf when compiling in an EBCDIC environment, PCRE expects |
| | its input to be either ASCII or UTF-8 (depending on the run-time option). It is |
| not possible to support both EBCDIC and UTF-8 codes in the same version of the |
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 | library. Consequently, --enable-utf and --enable-ebcdic are mutually |
| exclusive. |
exclusive. |
| </P> |
</P> |
| <br><a name="SEC5" href="#TOC1">UNICODE CHARACTER PROPERTY SUPPORT</a><br> | <br><a name="SEC7" href="#TOC1">UNICODE CHARACTER PROPERTY SUPPORT</a><br> |
| <P> |
<P> |
| UTF-8 support allows PCRE to process character values greater than 255 in the | UTF support allows the libraries to process character codepoints up to 0x10ffff |
| strings that it handles. On its own, however, it does not provide any | in the strings that they handle. On its own, however, it does not provide any |
| facilities for accessing the properties of such characters. If you want to be |
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 |
able to use the pattern escapes \P, \p, and \X, which refer to Unicode |
| character properties, you must add |
character properties, you must add |
| <pre> |
<pre> |
| --enable-unicode-properties |
--enable-unicode-properties |
| </pre> |
</pre> |
| to the <b>configure</b> command. This implies UTF-8 support, even if you have | to the <b>configure</b> command. This implies UTF support, even if you have |
| not explicitly requested it. |
not explicitly requested it. |
| </P> |
</P> |
| <P> |
<P> |
|
Line 121 supported. Details are given in the
|
Line 180 supported. Details are given in the
|
| <a href="pcrepattern.html"><b>pcrepattern</b></a> |
<a href="pcrepattern.html"><b>pcrepattern</b></a> |
| documentation. |
documentation. |
| </P> |
</P> |
| <br><a name="SEC6" href="#TOC1">JUST-IN-TIME COMPILER SUPPORT</a><br> | <br><a name="SEC8" href="#TOC1">JUST-IN-TIME COMPILER SUPPORT</a><br> |
| <P> |
<P> |
| Just-in-time compiler support is included in the build by specifying |
Just-in-time compiler support is included in the build by specifying |
| <pre> |
<pre> |
|
Line 138 pcregrep automatically makes use of it, unless you add
|
Line 197 pcregrep automatically makes use of it, unless you add
|
| </pre> |
</pre> |
| to the "configure" command. |
to the "configure" command. |
| </P> |
</P> |
| <br><a name="SEC7" href="#TOC1">CODE VALUE OF NEWLINE</a><br> | <br><a name="SEC9" href="#TOC1">CODE VALUE OF NEWLINE</a><br> |
| <P> |
<P> |
| By default, PCRE interprets the linefeed (LF) character as indicating the end |
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 |
of a line. This is the normal newline character on Unix-like systems. You can |
|
Line 171 Whatever line ending convention is selected when PCRE
|
Line 230 Whatever line ending convention is selected when PCRE
|
| overridden when the library functions are called. At build time it is |
overridden when the library functions are called. At build time it is |
| conventional to use the standard for your operating system. |
conventional to use the standard for your operating system. |
| </P> |
</P> |
| <br><a name="SEC8" href="#TOC1">WHAT \R MATCHES</a><br> | <br><a name="SEC10" href="#TOC1">WHAT \R MATCHES</a><br> |
| <P> |
<P> |
| By default, the sequence \R in a pattern matches any Unicode newline sequence, |
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 |
whatever has been selected as the line ending sequence. If you specify |
|
Line 182 the default is changed so that \R matches only CR, LF,
|
Line 241 the default is changed so that \R matches only CR, LF,
|
| selected when PCRE is built can be overridden when the library functions are |
selected when PCRE is built can be overridden when the library functions are |
| called. |
called. |
| </P> |
</P> |
| <br><a name="SEC9" href="#TOC1">POSIX MALLOC USAGE</a><br> | <br><a name="SEC11" href="#TOC1">POSIX MALLOC USAGE</a><br> |
| <P> |
<P> |
| When PCRE is called through the POSIX interface (see the | When the 8-bit library is called through the POSIX interface (see the |
| <a href="pcreposix.html"><b>pcreposix</b></a> |
<a href="pcreposix.html"><b>pcreposix</b></a> |
| documentation), additional working storage is required for holding the pointers |
documentation), additional working storage is required for holding the pointers |
| to capturing substrings, because PCRE requires three integers per substring, |
to capturing substrings, because PCRE requires three integers per substring, |
|
Line 198 such as
|
Line 257 such as
|
| </pre> |
</pre> |
| to the <b>configure</b> command. |
to the <b>configure</b> command. |
| </P> |
</P> |
| <br><a name="SEC10" href="#TOC1">HANDLING VERY LARGE PATTERNS</a><br> | <br><a name="SEC12" href="#TOC1">HANDLING VERY LARGE PATTERNS</a><br> |
| <P> |
<P> |
| Within a compiled pattern, offset values are used to point from one part to |
Within a compiled pattern, offset values are used to point from one part to |
| another (for example, from an opening parenthesis to an alternation |
another (for example, from an opening parenthesis to an alternation |
| metacharacter). By default, two-byte values are used for these offsets, leading | metacharacter). By default, in the 8-bit and 16-bit libraries, two-byte values |
| to a maximum size for a compiled pattern of around 64K. This is sufficient to | are used for these offsets, leading to a maximum size for a compiled pattern of |
| handle all but the most gigantic patterns. Nevertheless, some people do want to | around 64K. This is sufficient to handle all but the most gigantic patterns. |
| process truyl enormous patterns, so it is possible to compile PCRE to use | Nevertheless, some people do want to process truly enormous patterns, so it is |
| three-byte or four-byte offsets by adding a setting such as | possible to compile PCRE to use three-byte or four-byte offsets by adding a |
| | setting such as |
| <pre> |
<pre> |
| --with-link-size=3 |
--with-link-size=3 |
| </pre> |
</pre> |
| to the <b>configure</b> command. The value given must be 2, 3, or 4. Using | 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 PCRE because it has to load |
longer offsets slows down the operation of PCRE because it has to load |
| additional bytes when handling them. | 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> |
</P> |
| <br><a name="SEC11" href="#TOC1">AVOIDING EXCESSIVE STACK USAGE</a><br> | <br><a name="SEC13" href="#TOC1">AVOIDING EXCESSIVE STACK USAGE</a><br> |
| <P> |
<P> |
| When matching with the <b>pcre_exec()</b> function, PCRE implements backtracking |
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 |
by making recursive calls to an internal function called <b>match()</b>. In |
|
Line 245 perform better than <b>malloc()</b> and <b>free()</b>.
|
Line 307 perform better than <b>malloc()</b> and <b>free()</b>.
|
| slowly when built in this way. This option affects only the <b>pcre_exec()</b> |
slowly when built in this way. This option affects only the <b>pcre_exec()</b> |
| function; it is not relevant for <b>pcre_dfa_exec()</b>. |
function; it is not relevant for <b>pcre_dfa_exec()</b>. |
| </P> |
</P> |
| <br><a name="SEC12" href="#TOC1">LIMITING PCRE RESOURCE USAGE</a><br> | <br><a name="SEC14" href="#TOC1">LIMITING PCRE RESOURCE USAGE</a><br> |
| <P> |
<P> |
| Internally, PCRE has a function called <b>match()</b>, which it calls repeatedly |
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> |
(sometimes recursively) when matching a pattern with the <b>pcre_exec()</b> |
|
Line 274 constraints. However, you can set a lower limit by add
|
Line 336 constraints. However, you can set a lower limit by add
|
| </pre> |
</pre> |
| to the <b>configure</b> command. This value can also be overridden at run time. |
to the <b>configure</b> command. This value can also be overridden at run time. |
| </P> |
</P> |
| <br><a name="SEC13" href="#TOC1">CREATING CHARACTER TABLES AT BUILD TIME</a><br> | <br><a name="SEC15" href="#TOC1">CREATING CHARACTER TABLES AT BUILD TIME</a><br> |
| <P> |
<P> |
| PCRE uses fixed tables for processing characters whose code values are less |
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 |
than 256. By default, PCRE is built with a set of tables that are distributed |
|
Line 285 only. If you add
|
Line 347 only. If you add
|
| </pre> |
</pre> |
| to the <b>configure</b> command, the distributed tables are no longer used. |
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 |
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 | 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 |
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 |
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 |
create alternative tables when cross compiling, you will have to do so "by |
| hand".) |
hand".) |
| </P> |
</P> |
| <br><a name="SEC14" href="#TOC1">USING EBCDIC CODE</a><br> | <br><a name="SEC16" href="#TOC1">USING EBCDIC CODE</a><br> |
| <P> |
<P> |
| PCRE assumes by default that it will run in an environment where the character |
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 |
code is ASCII (or Unicode, which is a superset of ASCII). This is the case for |
|
Line 303 EBCDIC environment by adding
|
Line 365 EBCDIC environment by adding
|
| to the <b>configure</b> command. This setting implies |
to the <b>configure</b> command. This setting implies |
| --enable-rebuild-chartables. You should only use it if you know that you are in |
--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 |
an EBCDIC environment (for example, an IBM mainframe operating system). The |
| --enable-ebcdic option is incompatible with --enable-utf8. | --enable-ebcdic option is incompatible with --enable-utf. |
| </P> |
</P> |
| <br><a name="SEC15" href="#TOC1">PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT</a><br> |
|
| <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> |
| |
<br><a name="SEC17" 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 |
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 |
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 |
them with <b>libz</b> or <b>libbz2</b>, respectively, by adding one or both of |
|
Line 318 to the <b>configure</b> command. These options natural
|
Line 397 to the <b>configure</b> command. These options natural
|
| relevant libraries are installed on your system. Configuration will fail if |
relevant libraries are installed on your system. Configuration will fail if |
| they are not. |
they are not. |
| </P> |
</P> |
| <br><a name="SEC16" href="#TOC1">PCREGREP BUFFER SIZE</a><br> | <br><a name="SEC18" href="#TOC1">PCREGREP BUFFER SIZE</a><br> |
| <P> |
<P> |
| <b>pcregrep</b> uses an internal buffer to hold a "window" on the file it is |
<b>pcregrep</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 |
scanning, in order to be able to output "before" and "after" lines when it |
|
Line 333 parameter value by adding, for example,
|
Line 412 parameter value by adding, for example,
|
| to the <b>configure</b> command. The caller of \fPpcregrep\fP can, however, |
to the <b>configure</b> command. The caller of \fPpcregrep\fP can, however, |
| override this value by specifying a run-time option. |
override this value by specifying a run-time option. |
| </P> |
</P> |
| <br><a name="SEC17" href="#TOC1">PCRETEST OPTION FOR LIBREADLINE SUPPORT</a><br> | <br><a name="SEC19" href="#TOC1">PCRETEST OPTION FOR LIBREADLINE SUPPORT</a><br> |
| <P> |
<P> |
| If you add |
If you add |
| <pre> |
<pre> |
|
Line 364 automatically included, you may need to add something
|
Line 443 automatically included, you may need to add something
|
| </pre> |
</pre> |
| immediately before the <b>configure</b> command. |
immediately before the <b>configure</b> command. |
| </P> |
</P> |
| <br><a name="SEC18" href="#TOC1">SEE ALSO</a><br> | <br><a name="SEC20" href="#TOC1">DEBUGGING WITH VALGRIND SUPPORT</a><br> |
| <P> |
<P> |
| <b>pcreapi</b>(3), <b>pcre_config</b>(3). | By adding the |
| | <pre> |
| | --enable-valgrind |
| | </pre> |
| | option to to the <b>configure</b> command, PCRE 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 PCRE itself. |
| </P> |
</P> |
| <br><a name="SEC19" href="#TOC1">AUTHOR</a><br> | <br><a name="SEC21" href="#TOC1">CODE COVERAGE REPORTING</a><br> |
| <P> |
<P> |
| |
If your C compiler is gcc, you can build a version of PCRE 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 PCRE 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 PCRE, 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 PCRE 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> |
| |
<br><a name="SEC22" href="#TOC1">SEE ALSO</a><br> |
| |
<P> |
| |
<b>pcreapi</b>(3), <b>pcre16</b>, <b>pcre32</b>, <b>pcre_config</b>(3). |
| |
</P> |
| |
<br><a name="SEC23" href="#TOC1">AUTHOR</a><br> |
| |
<P> |
| Philip Hazel |
Philip Hazel |
| <br> |
<br> |
| University Computing Service |
University Computing Service |
|
Line 377 University Computing Service
|
Line 523 University Computing Service
|
| Cambridge CB2 3QH, England. |
Cambridge CB2 3QH, England. |
| <br> |
<br> |
| </P> |
</P> |
| <br><a name="SEC20" href="#TOC1">REVISION</a><br> | <br><a name="SEC24" href="#TOC1">REVISION</a><br> |
| <P> |
<P> |
| Last updated: 06 September 2011 | Last updated: 12 May 2013 |
| <br> |
<br> |
| Copyright © 1997-2011 University of Cambridge. | Copyright © 1997-2013 University of Cambridge. |
| <br> |
<br> |
| <p> |
<p> |
| Return to the <a href="index.html">PCRE index page</a>. |
Return to the <a href="index.html">PCRE index page</a>. |
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to pcrebuild.html CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / pcre / doc / html