Diff for /embedaddon/pcre/doc/html/pcrebuild.html between versions 1.1.1.3 and 1.1.1.4

version 1.1.1.3, 2012/10/09 09:19:18 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 8-BIT and 16-BIT LIBRARIES</a><li><a name="TOC2" href="#SEC2">PCRE BUILD-TIME OPTIONS</a>
<li><a name="TOC3" href="#SEC3">BUILDING SHARED AND STATIC LIBRARIES</a><li><a name="TOC3" href="#SEC3">BUILDING 8-BIT, 16-BIT AND 32-BIT LIBRARIES</a>
<li><a name="TOC4" href="#SEC4">C++ SUPPORT</a><li><a name="TOC4" href="#SEC4">BUILDING SHARED AND STATIC LIBRARIES</a>
<li><a name="TOC5" href="#SEC5">UTF-8 and UTF-16 SUPPORT</a><li><a name="TOC5" href="#SEC5">C++ SUPPORT</a>
<li><a name="TOC6" href="#SEC6">UNICODE CHARACTER PROPERTY SUPPORT</a><li><a name="TOC6" href="#SEC6">UTF-8, UTF-16 AND UTF-32 SUPPORT</a>
<li><a name="TOC7" href="#SEC7">JUST-IN-TIME COMPILER SUPPORT</a><li><a name="TOC7" href="#SEC7">UNICODE CHARACTER PROPERTY SUPPORT</a>
<li><a name="TOC8" href="#SEC8">CODE VALUE OF NEWLINE</a><li><a name="TOC8" href="#SEC8">JUST-IN-TIME COMPILER SUPPORT</a>
<li><a name="TOC9" href="#SEC9">WHAT \R MATCHES</a><li><a name="TOC9" href="#SEC9">CODE VALUE OF NEWLINE</a>
<li><a name="TOC10" href="#SEC10">POSIX MALLOC USAGE</a><li><a name="TOC10" href="#SEC10">WHAT \R MATCHES</a>
<li><a name="TOC11" href="#SEC11">HANDLING VERY LARGE PATTERNS</a><li><a name="TOC11" href="#SEC11">POSIX MALLOC USAGE</a>
<li><a name="TOC12" href="#SEC12">AVOIDING EXCESSIVE STACK USAGE</a><li><a name="TOC12" href="#SEC12">HANDLING VERY LARGE PATTERNS</a>
<li><a name="TOC13" href="#SEC13">LIMITING PCRE RESOURCE USAGE</a><li><a name="TOC13" href="#SEC13">AVOIDING EXCESSIVE STACK USAGE</a>
<li><a name="TOC14" href="#SEC14">CREATING CHARACTER TABLES AT BUILD TIME</a><li><a name="TOC14" href="#SEC14">LIMITING PCRE RESOURCE USAGE</a>
<li><a name="TOC15" href="#SEC15">USING EBCDIC CODE</a><li><a name="TOC15" href="#SEC15">CREATING CHARACTER TABLES AT BUILD TIME</a>
<li><a name="TOC16" href="#SEC16">PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT</a><li><a name="TOC16" href="#SEC16">USING EBCDIC CODE</a>
<li><a name="TOC17" href="#SEC17">PCREGREP BUFFER SIZE</a><li><a name="TOC17" href="#SEC17">PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT</a>
<li><a name="TOC18" href="#SEC18">PCRETEST OPTION FOR LIBREADLINE SUPPORT</a><li><a name="TOC18" href="#SEC18">PCREGREP BUFFER SIZE</a>
<li><a name="TOC19" href="#SEC19">SEE ALSO</a><li><a name="TOC19" href="#SEC19">PCRETEST OPTION FOR LIBREADLINE SUPPORT</a>
<li><a name="TOC20" href="#SEC20">AUTHOR</a><li><a name="TOC20" href="#SEC20">DEBUGGING WITH VALGRIND SUPPORT</a>
<li><a name="TOC21" href="#SEC21">REVISION</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 whenPCRE 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, wherelibrary in Unix-like environments using the applications known as Autotools.
the optional features are selected or deselected by providing options toAlso in the distribution are files to support building using <b>CMake</b>
<b>configure</b> before running the <b>make</b> command. However, the sameinstead 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 ofcontains 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-likeThe 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 PCREselected 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 ifscript, 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 64  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 8-BIT and 16-BIT LIBRARIES</a><br><br><a name="SEC3" href="#TOC1">BUILDING 8-BIT, 16-BIT AND 32-BIT LIBRARIES</a><br>
 <P>  <P>
 By default, a library called <b>libpcre</b> is built, containing functions that  By default, a library called <b>libpcre</b> is built, containing functions that
 take string arguments contained in vectors of bytes, either as single-byte  take string arguments contained in vectors of bytes, either as single-byte
Line 75  strings, by adding Line 95  strings, by adding
 <pre>  <pre>
   --enable-pcre16    --enable-pcre16
 </pre>  </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  to the <b>configure</b> command. If you do not want the 8-bit library, add
 <pre>  <pre>
   --disable-pcre8    --disable-pcre8
 </pre>  </pre>
as well. At least one of the two libraries must be built. Note that the C++ andas well. At least one of the three libraries must be built. Note that the C++
POSIX wrappers are for the 8-bit library only, and that <b>pcregrep</b> is anand POSIX wrappers are for the 8-bit library only, and that <b>pcregrep</b> is
8-bit program. None of these are built if you select only the 16-bit library.an 8-bit program. None of these are built if you select only the 16-bit or
 32-bit libraries.
 </P>  </P>
<br><a name="SEC3" href="#TOC1">BUILDING SHARED AND STATIC LIBRARIES</a><br><br><a name="SEC4" href="#TOC1">BUILDING SHARED AND STATIC LIBRARIES</a><br>
 <P>  <P>
The PCRE building process uses <b>libtool</b> to build both shared and staticThe Autotools PCRE building process uses <b>libtool</b> to build both shared and
Unix libraries by default. You can suppress one of these by adding one ofstatic libraries by default. You can suppress one of these by adding one of
 <pre>  <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="SEC4" href="#TOC1">C++ SUPPORT</a><br><br><a name="SEC5" href="#TOC1">C++ SUPPORT</a><br>
 <P>  <P>
 By default, if the 8-bit library is being built, the <b>configure</b> script  By default, if the 8-bit library is being built, the <b>configure</b> script
 will search for a C++ compiler and C++ header files. If it finds them, it  will search for a C++ compiler and C++ header files. If it finds them, it
Line 104  strings). You can disable this by adding Line 132  strings). You can disable this by adding
 </pre>  </pre>
 to the <b>configure</b> command.  to the <b>configure</b> command.
 </P>  </P>
<br><a name="SEC5" href="#TOC1">UTF-8 and UTF-16 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 Unicode character strings, add  To build PCRE with support for UTF Unicode character strings, add
 <pre>  <pre>
   --enable-utf    --enable-utf
 </pre>  </pre>
to the <b>configure</b> command. This setting applies to both libraries, addingto the <b>configure</b> command. This setting applies to all three libraries,
support for UTF-8 to the 8-bit library and support for UTF-16 to the 16-bitadding support for UTF-8 to the 8-bit library, support for UTF-16 to the 16-bit
library. There are no separate options for enabling UTF-8 and UTF-16library, and support for UTF-32 to the to the 32-bit library. There are no
independently because that would allow ridiculous settings such as requestingseparate options for enabling UTF-8, UTF-16 and UTF-32 independently because
UTF-16 support while building only the 8-bit library. It is not possible tothat would allow ridiculous settings such as requesting UTF-16 support while
build one library with UTF support and the other without in the samebuilding only the 8-bit library. It is not possible to build one library with
configuration. (For backwards compatibility, --enable-utf8 is a synonym ofUTF support and another without in the same configuration. (For backwards
--enable-utf.)compatibility, --enable-utf8 is a synonym of --enable-utf.)
 </P>  </P>
 <P>  <P>
Of itself, this setting does not make PCRE treat strings as UTF-8 or UTF-16. AsOf itself, this setting does not make PCRE treat strings as UTF-8, UTF-16 or
well as compiling PCRE with this option, you also have have to set theUTF-32. As well as compiling PCRE with this option, you also have have to set
PCRE_UTF8 or PCRE_UTF16 option when you call one of the pattern compilingthe PCRE_UTF8, PCRE_UTF16 or PCRE_UTF32 option (as appropriate) when you call
functions.one of the pattern compiling functions.
 </P>  </P>
 <P>  <P>
 If you set --enable-utf when compiling in an EBCDIC environment, PCRE expects  If you set --enable-utf when compiling in an EBCDIC environment, PCRE expects
Line 132  not possible to support both EBCDIC and UTF-8 codes in Line 160  not possible to support both EBCDIC and UTF-8 codes in
 library. Consequently, --enable-utf and --enable-ebcdic are mutually  library. Consequently, --enable-utf and --enable-ebcdic are mutually
 exclusive.  exclusive.
 </P>  </P>
<br><a name="SEC6" href="#TOC1">UNICODE CHARACTER PROPERTY SUPPORT</a><br><br><a name="SEC7" href="#TOC1">UNICODE CHARACTER PROPERTY SUPPORT</a><br>
 <P>  <P>
 UTF support allows the libraries to process character codepoints up to 0x10ffff  UTF support allows the libraries to process character codepoints up to 0x10ffff
 in the strings that they handle. On its own, however, it does not provide any  in the strings that they handle. On its own, however, it does not provide any
Line 152  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="SEC7" 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 169  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="SEC8" 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 202  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="SEC9" 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 213  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="SEC10" href="#TOC1">POSIX MALLOC USAGE</a><br><br><a name="SEC11" href="#TOC1">POSIX MALLOC USAGE</a><br>
 <P>  <P>
 When the 8-bit library 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>
Line 229  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="SEC11" 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, leadingmetacharacter). 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 toare 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 toaround 64K. This is sufficient to handle all but the most gigantic patterns.
process truly enormous patterns, so it is possible to compile PCRE to useNevertheless, some people do want to process truly enormous patterns, so it is
three-byte or four-byte offsets by adding a setting such aspossible 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. For the  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. Using longer offsets slows16-bit library, a value of 3 is rounded up to 4. In these libraries, using
down the operation of PCRE because it has to load additional data when handlinglonger offsets slows down the operation of PCRE because it has to load
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="SEC12" 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 277  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="SEC13" 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 306  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="SEC14" 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 323  compiling, because <b>dftables</b> is run on the local Line 353  compiling, because <b>dftables</b> is run on the local
 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="SEC15" 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 337  to the <b>configure</b> command. This setting implies Line 367  to the <b>configure</b> command. This setting implies
 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-utf.  --enable-ebcdic option is incompatible with --enable-utf.
 </P>  </P>
 <br><a name="SEC16" 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 350  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="SEC17" 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 365  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="SEC18" 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 396  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="SEC19" 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>pcre16</b>, <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="SEC20" 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 409  University Computing Service Line 523  University Computing Service
 Cambridge CB2 3QH, England.  Cambridge CB2 3QH, England.
 <br>  <br>
 </P>  </P>
<br><a name="SEC21" href="#TOC1">REVISION</a><br><br><a name="SEC24" href="#TOC1">REVISION</a><br>
 <P>  <P>
Last updated: 07 January 2012Last updated: 12 May 2013
 <br>  <br>
Copyright &copy; 1997-2012 University of Cambridge.Copyright &copy; 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>.

Removed from v.1.1.1.3  
changed lines
  Added in v.1.1.1.4


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>