/[pcre]/code/trunk/README
ViewVC logotype

Diff of /code/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 836 by ph10, Wed Dec 28 17:16:11 2011 UTC revision 1503 by ph10, Wed Sep 24 09:09:40 2014 UTC
# Line 9  from: Line 9  from:
9    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.zip    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.zip
10    
11  There is a mailing list for discussion about the development of PCRE at  There is a mailing list for discussion about the development of PCRE at
12    pcre-dev@exim.org. You can access the archives and subscribe or manage your
13    subscription here:
14    
15    pcre-dev@exim.org     https://lists.exim.org/mailman/listinfo/pcre-dev
16    
17  Please read the NEWS file if you are upgrading from a previous release.  Please read the NEWS file if you are upgrading from a previous release.
18  The contents of this README file are:  The contents of this README file are:
# Line 18  The contents of this README file are: Line 20  The contents of this README file are:
20    The PCRE APIs    The PCRE APIs
21    Documentation for PCRE    Documentation for PCRE
22    Contributions by users of PCRE    Contributions by users of PCRE
23    Building PCRE on non-Unix systems    Building PCRE on non-Unix-like systems
24    Building PCRE on Unix-like systems    Building PCRE without using autotools
25    Retrieving configuration information on Unix-like systems    Building PCRE using autotools
26    Shared libraries on Unix-like systems    Retrieving configuration information
27    Cross-compiling on Unix-like systems    Shared libraries
28      Cross-compiling using autotools
29    Using HP's ANSI C++ compiler (aCC)    Using HP's ANSI C++ compiler (aCC)
30      Compiling in Tru64 using native compilers
31      Using Sun's compilers for Solaris
32    Using PCRE from MySQL    Using PCRE from MySQL
33    Making new tarballs    Making new tarballs
34    Testing PCRE    Testing PCRE
# Line 34  The contents of this README file are: Line 39  The contents of this README file are:
39  The PCRE APIs  The PCRE APIs
40  -------------  -------------
41    
42  PCRE is written in C, and it has its own API. The distribution also includes a  PCRE is written in C, and it has its own API. There are three sets of
43  set of C++ wrapper functions (see the pcrecpp man page for details), courtesy  functions, one for the 8-bit library, which processes strings of bytes, one for
44  of Google Inc.  the 16-bit library, which processes strings of 16-bit values, and one for the
45    32-bit library, which processes strings of 32-bit values. The distribution also
46  In addition, there is a set of C wrapper functions that are based on the POSIX  includes a set of C++ wrapper functions (see the pcrecpp man page for details),
47  regular expression API (see the pcreposix man page). These end up in the  courtesy of Google Inc., which can be used to call the 8-bit PCRE library from
48  library called libpcreposix. Note that this just provides a POSIX calling  C++. Other C++ wrappers have been created from time to time. See, for example:
49  interface to PCRE; the regular expressions themselves still follow Perl syntax  https://github.com/YasserAsmi/regexp, which aims to be simple and similar in
50  and semantics. The POSIX API is restricted, and does not give full access to  style to the C API.
51  all of PCRE's facilities.  
52    The distribution also contains a set of C wrapper functions (again, just for
53    the 8-bit library) that are based on the POSIX regular expression API (see the
54    pcreposix man page). These end up in the library called libpcreposix. Note that
55    this just provides a POSIX calling interface to PCRE; the regular expressions
56    themselves still follow Perl syntax and semantics. The POSIX API is restricted,
57    and does not give full access to all of PCRE's facilities.
58    
59  The header file for the POSIX-style functions is called pcreposix.h. The  The header file for the POSIX-style functions is called pcreposix.h. The
60  official POSIX name is regex.h, but I did not want to risk possible problems  official POSIX name is regex.h, but I did not want to risk possible problems
# Line 76  documentation is supplied in two other f Line 87  documentation is supplied in two other f
87    1. There are files called doc/pcre.txt, doc/pcregrep.txt, and    1. There are files called doc/pcre.txt, doc/pcregrep.txt, and
88       doc/pcretest.txt in the source distribution. The first of these is a       doc/pcretest.txt in the source distribution. The first of these is a
89       concatenation of the text forms of all the section 3 man pages except       concatenation of the text forms of all the section 3 man pages except
90       those that summarize individual functions. The other two are the text       the listing of pcredemo.c and those that summarize individual functions.
91       forms of the section 1 man pages for the pcregrep and pcretest commands.       The other two are the text forms of the section 1 man pages for the
92       These text forms are provided for ease of scanning with text editors or       pcregrep and pcretest commands. These text forms are provided for ease of
93       similar tools. They are installed in <prefix>/share/doc/pcre, where       scanning with text editors or similar tools. They are installed in
94       <prefix> is the installation prefix (defaulting to /usr/local).       <prefix>/share/doc/pcre, where <prefix> is the installation prefix
95         (defaulting to /usr/local).
96    
97    2. A set of files containing all the documentation in HTML form, hyperlinked    2. A set of files containing all the documentation in HTML form, hyperlinked
98       in various ways, and rooted in a file called index.html, is distributed in       in various ways, and rooted in a file called index.html, is distributed in
# Line 105  contributions provided support for compi Line 117  contributions provided support for compi
117  Windows (I myself do not use Windows). Nowadays there is more Windows support  Windows (I myself do not use Windows). Nowadays there is more Windows support
118  in the standard distribution, so these contibutions have been archived.  in the standard distribution, so these contibutions have been archived.
119    
120    A PCRE user maintains downloadable Windows binaries of the pcregrep and
121    pcretest programs here:
122    
123  Building PCRE on non-Unix systems    http://www.rexegg.com/pcregrep-pcretest.html
124  ---------------------------------  
125    
126    Building PCRE on non-Unix-like systems
127    --------------------------------------
128    
129    For a non-Unix-like system, please read the comments in the file
130    NON-AUTOTOOLS-BUILD, though if your system supports the use of "configure" and
131    "make" you may be able to build PCRE using autotools in the same way as for
132    many Unix-like systems.
133    
134  For a non-Unix system, please read the comments in the file NON-UNIX-USE,  PCRE can also be configured using the GUI facility provided by CMake's
135  though if your system supports the use of "configure" and "make" you may be  cmake-gui command. This creates Makefiles, solution files, etc. The file
136  able to build PCRE in the same way as for Unix-like systems. PCRE can also be  NON-AUTOTOOLS-BUILD has information about CMake.
 configured in many platform environments using the GUI facility provided by  
 CMake's cmake-gui command. This creates Makefiles, solution files, etc.  
137    
138  PCRE has been compiled on many different operating systems. It should be  PCRE has been compiled on many different operating systems. It should be
139  straightforward to build PCRE on any system that has a Standard C compiler and  straightforward to build PCRE on any system that has a Standard C compiler and
140  library, because it uses only Standard C functions.  library, because it uses only Standard C functions.
141    
142    
143  Building PCRE on Unix-like systems  Building PCRE without using autotools
144  ----------------------------------  -------------------------------------
145    
146    The use of autotools (in particular, libtool) is problematic in some
147    environments, even some that are Unix or Unix-like. See the NON-AUTOTOOLS-BUILD
148    file for ways of building PCRE without using autotools.
149    
150    
151    Building PCRE using autotools
152    -----------------------------
153    
154  If you are using HP's ANSI C++ compiler (aCC), please see the special note  If you are using HP's ANSI C++ compiler (aCC), please see the special note
155  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
156    
157  The following instructions assume the use of the widely used "configure, make,  The following instructions assume the use of the widely used "configure; make;
158  make install" process. There is also support for CMake in the PCRE  make install" (autotools) process.
159  distribution; there are some comments about using CMake in the NON-UNIX-USE  
160  file, though it can also be used in Unix-like systems.  To build PCRE on system that supports autotools, first run the "configure"
161    command from the PCRE distribution directory, with your current directory set
162  To build PCRE on a Unix-like system, first run the "configure" command from the  to the directory where you want the files to be created. This command is a
163  PCRE distribution directory, with your current directory set to the directory  standard GNU "autoconf" configuration script, for which generic instructions
164  where you want the files to be created. This command is a standard GNU  are supplied in the file INSTALL.
 "autoconf" configuration script, for which generic instructions are supplied in  
 the file INSTALL.  
165    
166  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
167  this case, on many systems, just running "./configure" is sufficient. However,  this case, on many systems, just running "./configure" is sufficient. However,
# Line 143  the usual methods of changing standard d Line 169  the usual methods of changing standard d
169    
170  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
171    
172  specifies that the C compiler should be run with the flags '-O2 -Wall' instead  This command specifies that the C compiler should be run with the flags '-O2
173  of the default, and that "make install" should install PCRE under /opt/local  -Wall' instead of the default, and that "make install" should install PCRE
174  instead of the default /usr/local.  under /opt/local instead of the default /usr/local.
175    
176  If you want to build in a different directory, just run "configure" with that  If you want to build in a different directory, just run "configure" with that
177  directory as current. For example, suppose you have unpacked the PCRE source  directory as current. For example, suppose you have unpacked the PCRE source
# Line 169  library. They are also documented in the Line 195  library. They are also documented in the
195    
196    (See also "Shared libraries on Unix-like systems" below.)    (See also "Shared libraries on Unix-like systems" below.)
197    
198  . If you want to suppress the building of the C++ wrapper library, you can add  . By default, only the 8-bit library is built. If you add --enable-pcre16 to
199    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    the "configure" command, the 16-bit library is also built. If you add
200    it will try to find a C++ compiler and C++ header files, and if it succeeds,    --enable-pcre32 to the "configure" command, the 32-bit library is also built.
201    it will try to build the C++ wrapper.    If you want only the 16-bit or 32-bit library, use --disable-pcre8 to disable
202      building the 8-bit library.
203    
204    . If you are building the 8-bit library and want to suppress the building of
205      the C++ wrapper library, you can add --disable-cpp to the "configure"
206      command. Otherwise, when "configure" is run without --disable-pcre8, it will
207      try to find a C++ compiler and C++ header files, and if it succeeds, it will
208      try to build the C++ wrapper.
209    
210  . If you want to include support for just-in-time compiling, which can give  . If you want to include support for just-in-time compiling, which can give
211    large performance improvements on certain platforms, add --enable-jit to the    large performance improvements on certain platforms, add --enable-jit to the
# Line 184  library. They are also documented in the Line 217  library. They are also documented in the
217    you add --disable-pcregrep-jit to the "configure" command.    you add --disable-pcregrep-jit to the "configure" command.
218    
219  . If you want to make use of the support for UTF-8 Unicode character strings in  . If you want to make use of the support for UTF-8 Unicode character strings in
220    PCRE, you must add --enable-utf8 to the "configure" command. Without it, the    the 8-bit library, or UTF-16 Unicode character strings in the 16-bit library,
221    code for handling UTF-8 is not included in the library. Even when included,    or UTF-32 Unicode character strings in the 32-bit library, you must add
222    it still has to be enabled by an option at run time. When PCRE is compiled    --enable-utf to the "configure" command. Without it, the code for handling
223    with this option, its input can only either be ASCII or UTF-8, even when    UTF-8, UTF-16 and UTF-8 is not included in the relevant library. Even
224    running on EBCDIC platforms. It is not possible to use both --enable-utf8 and    when --enable-utf is included, the use of a UTF encoding still has to be
225    --enable-ebcdic at the same time.    enabled by an option at run time. When PCRE is compiled with this option, its
226      input can only either be ASCII or UTF-8/16/32, even when running on EBCDIC
227  . If, in addition to support for UTF-8 character strings, you want to include    platforms. It is not possible to use both --enable-utf and --enable-ebcdic at
228    support for the \P, \p, and \X sequences that recognize Unicode character    the same time.
229    properties, you must add --enable-unicode-properties to the "configure"  
230    command. This adds about 30K to the size of the library (in the form of a  . There are no separate options for enabling UTF-8, UTF-16 and UTF-32
231    property table); only the basic two-letter properties such as Lu are    independently because that would allow ridiculous settings such as requesting
232    supported.    UTF-16 support while building only the 8-bit library. However, the option
233      --enable-utf8 is retained for backwards compatibility with earlier releases
234      that did not support 16-bit or 32-bit character strings. It is synonymous with
235      --enable-utf. It is not possible to configure one library with UTF support
236      and the other without in the same configuration.
237    
238    . If, in addition to support for UTF-8/16/32 character strings, you want to
239      include support for the \P, \p, and \X sequences that recognize Unicode
240      character properties, you must add --enable-unicode-properties to the
241      "configure" command. This adds about 30K to the size of the library (in the
242      form of a property table); only the basic two-letter properties such as Lu
243      are supported.
244    
245  . You can build PCRE to recognize either CR or LF or the sequence CRLF or any  . You can build PCRE to recognize either CR or LF or the sequence CRLF or any
246    of the preceding, or any of the Unicode newline sequences as indicating the    of the preceding, or any of the Unicode newline sequences as indicating the
# Line 228  library. They are also documented in the Line 272  library. They are also documented in the
272    
273    on the "configure" command.    on the "configure" command.
274    
275  . PCRE has a counter that can be set to limit the amount of resources it uses.  . PCRE has a counter that limits the depth of nesting of parentheses in a
276    If the limit is exceeded during a match, the match fails. The default is ten    pattern. This limits the amount of system stack that a pattern uses when it
277    million. You can change the default by setting, for example,    is compiled. The default is 250, but you can change it by setting, for
278      example,
279    
280      --with-parens-nest-limit=500
281    
282    . PCRE has a counter that can be set to limit the amount of resources it uses
283      when matching a pattern. If the limit is exceeded during a match, the match
284      fails. The default is ten million. You can change the default by setting, for
285      example,
286    
287    --with-match-limit=500000    --with-match-limit=500000
288    
# Line 249  library. They are also documented in the Line 301  library. They are also documented in the
301    sizes in the pcrestack man page.    sizes in the pcrestack man page.
302    
303  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
304    this by adding --with-link-size=3 to the "configure" command. You can    this by adding --with-link-size=3 to the "configure" command. In the 8-bit
305    increase it even more by setting --with-link-size=4, but this is unlikely    library, PCRE then uses three bytes instead of two for offsets to different
306    ever to be necessary. Increasing the internal link size will reduce    parts of the compiled pattern. In the 16-bit library, --with-link-size=3 is
307    performance.    the same as --with-link-size=4, which (in both libraries) uses four-byte
308      offsets. Increasing the internal link size reduces performance. In the 32-bit
309      library, the only supported link size is 4.
310    
311  . You can build PCRE so that its internal match() function that is called from  . You can build PCRE so that its internal match() function that is called from
312    pcre_exec() does not call itself recursively. Instead, it uses memory blocks    pcre_exec() does not call itself recursively. Instead, it uses memory blocks
# Line 281  library. They are also documented in the Line 335  library. They are also documented in the
335    pcre_chartables.c.dist. See "Character tables" below for further information.    pcre_chartables.c.dist. See "Character tables" below for further information.
336    
337  . It is possible to compile PCRE for use on systems that use EBCDIC as their  . It is possible to compile PCRE for use on systems that use EBCDIC as their
338    character code (as opposed to ASCII) by specifying    character code (as opposed to ASCII/Unicode) by specifying
339    
340    --enable-ebcdic    --enable-ebcdic
341    
342    This automatically implies --enable-rebuild-chartables (see above). However,    This automatically implies --enable-rebuild-chartables (see above). However,
343    when PCRE is built this way, it always operates in EBCDIC. It cannot support    when PCRE is built this way, it always operates in EBCDIC. It cannot support
344    both EBCDIC and UTF-8.    both EBCDIC and UTF-8/16/32. There is a second option, --enable-ebcdic-nl25,
345      which specifies that the code value for the EBCDIC NL character is 0x25
346  . It is possible to compile pcregrep to use libz and/or libbz2, in order to    instead of the default 0x15.
347    read .gz and .bz2 files (respectively), by specifying one or both of  
348    . In environments where valgrind is installed, if you specify
349    
350      --enable-valgrind
351    
352      PCRE will use valgrind annotations to mark certain memory regions as
353      unaddressable. This allows it to detect invalid memory accesses, and is
354      mostly useful for debugging PCRE itself.
355    
356    . In environments where the gcc compiler is used and lcov version 1.6 or above
357      is installed, if you specify
358    
359      --enable-coverage
360    
361      the build process implements a code coverage report for the test suite. The
362      report is generated by running "make coverage". If ccache is installed on
363      your system, it must be disabled when building PCRE for coverage reporting.
364      You can do this by setting the environment variable CCACHE_DISABLE=1 before
365      running "make" to build PCRE. There is more information about coverage
366      reporting in the "pcrebuild" documentation.
367    
368    . The pcregrep program currently supports only 8-bit data files, and so
369      requires the 8-bit PCRE library. It is possible to compile pcregrep to use
370      libz and/or libbz2, in order to read .gz and .bz2 files (respectively), by
371      specifying one or both of
372    
373    --enable-pcregrep-libz    --enable-pcregrep-libz
374    --enable-pcregrep-libbz2    --enable-pcregrep-libbz2
375    
376    Of course, the relevant libraries must be installed on your system.    Of course, the relevant libraries must be installed on your system.
377    
378  . The default size of internal buffer used by pcregrep can be set by, for  . The default size (in bytes) of the internal buffer used by pcregrep can be
379    example:    set by, for example:
380    
381    --with-pcregrep-bufsize=50K    --with-pcregrep-bufsize=51200
382    
383    The default value is 20K.    The value must be a plain integer. The default is 20480.
384    
385  . It is possible to compile pcretest so that it links with the libreadline  . It is possible to compile pcretest so that it links with the libreadline
386    library, by specifying    or libedit libraries, by specifying, respectively,
387    
388    --enable-pcretest-libreadline    --enable-pcretest-libreadline or --enable-pcretest-libedit
389    
390    If this is done, when pcretest's input is from a terminal, it reads it using    If this is done, when pcretest's input is from a terminal, it reads it using
391    the readline() function. This provides line-editing and history facilities.    the readline() function. This provides line-editing and history facilities.
392    Note that libreadline is GPL-licenced, so if you distribute a binary of    Note that libreadline is GPL-licenced, so if you distribute a binary of
393    pcretest linked in this way, there may be licensing issues.    pcretest linked in this way, there may be licensing issues. These can be
394      avoided by linking with libedit (which has a BSD licence) instead.
395    
396    Setting this option causes the -lreadline option to be added to the pcretest    Enabling libreadline causes the -lreadline option to be added to the pcretest
397    build. In many operating environments with a sytem-installed readline    build. In many operating environments with a sytem-installed readline
398    library this is sufficient. However, in some environments (e.g. if an    library this is sufficient. However, in some environments (e.g. if an
399    unmodified distribution version of readline is in use), it may be necessary    unmodified distribution version of readline is in use), it may be necessary
# Line 333  The "configure" script builds the follow Line 412  The "configure" script builds the follow
412  . pcre-config          script that shows the building settings such as CFLAGS  . pcre-config          script that shows the building settings such as CFLAGS
413                           that were set for "configure"                           that were set for "configure"
414  . libpcre.pc         ) data for the pkg-config command  . libpcre.pc         ) data for the pkg-config command
415    . libpcre16.pc       )
416    . libpcre32.pc       )
417  . libpcreposix.pc    )  . libpcreposix.pc    )
418  . libtool              script that builds shared and/or static libraries  . libtool              script that builds shared and/or static libraries
 . RunTest              script for running tests on the basic C library  
 . RunGrepTest          script for running tests on the pcregrep command  
419    
420  Versions of config.h and pcre.h are distributed in the PCRE tarballs under the  Versions of config.h and pcre.h are distributed in the PCRE tarballs under the
421  names config.h.generic and pcre.h.generic. These are provided for those who  names config.h.generic and pcre.h.generic. These are provided for those who
422  have to built PCRE without using "configure" or CMake. If you use "configure"  have to built PCRE without using "configure" or CMake. If you use "configure"
423  or CMake, the .generic versions are not used.  or CMake, the .generic versions are not used.
424    
425  If a C++ compiler is found, the following files are also built:  When building the 8-bit library, if a C++ compiler is found, the following
426    files are also built:
427    
428  . libpcrecpp.pc        data for the pkg-config command  . libpcrecpp.pc        data for the pkg-config command
429  . pcrecpparg.h         header file for calling PCRE via the C++ wrapper  . pcrecpparg.h         header file for calling PCRE via the C++ wrapper
# Line 353  The "configure" script also creates conf Line 433  The "configure" script also creates conf
433  script that can be run to recreate the configuration, and config.log, which  script that can be run to recreate the configuration, and config.log, which
434  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
435    
436  Once "configure" has run, you can run "make". It builds two libraries, called  Once "configure" has run, you can run "make". This builds the the libraries
437  libpcre and libpcreposix, a test program called pcretest, and the pcregrep  libpcre, libpcre16 and/or libpcre32, and a test program called pcretest. If you
438  command. If a C++ compiler was found on your system, and you did not disable it  enabled JIT support with --enable-jit, a test program called pcre_jit_test is
439  with --disable-cpp, "make" also builds the C++ wrapper library, which is called  built as well.
440  libpcrecpp, and some test programs called pcrecpp_unittest,  
441  pcre_scanner_unittest, and pcre_stringpiece_unittest. If you enabled JIT  If the 8-bit library is built, libpcreposix and the pcregrep command are also
442  support with --enable-jit, a test program called pcre_jit_test is also built.  built, and if a C++ compiler was found on your system, and you did not disable
443    it with --disable-cpp, "make" builds the C++ wrapper library, which is called
444    libpcrecpp, as well as some test programs called pcrecpp_unittest,
445    pcre_scanner_unittest, and pcre_stringpiece_unittest.
446    
447  The command "make check" runs all the appropriate tests. Details of the PCRE  The command "make check" runs all the appropriate tests. Details of the PCRE
448  tests are given below in a separate section of this document.  tests are given below in a separate section of this document.
# Line 370  system. The following are installed (fil Line 453  system. The following are installed (fil
453    
454    Commands (bin):    Commands (bin):
455      pcretest      pcretest
456      pcregrep      pcregrep (if 8-bit support is enabled)
457      pcre-config      pcre-config
458    
459    Libraries (lib):    Libraries (lib):
460      libpcre      libpcre16     (if 16-bit support is enabled)
461      libpcreposix      libpcre32     (if 32-bit support is enabled)
462      libpcrecpp (if C++ support is enabled)      libpcre       (if 8-bit support is enabled)
463        libpcreposix  (if 8-bit support is enabled)
464        libpcrecpp    (if 8-bit and C++ support is enabled)
465    
466    Configuration information (lib/pkgconfig):    Configuration information (lib/pkgconfig):
467        libpcre16.pc
468        libpcre32.pc
469      libpcre.pc      libpcre.pc
470      libpcreposix.pc      libpcreposix.pc
471      libpcrecpp.pc (if C++ support is enabled)      libpcrecpp.pc (if C++ support is enabled)
# Line 419  This removes all the files that "make in Line 506  This removes all the files that "make in
506  remove any directories, because these are often shared with other programs.  remove any directories, because these are often shared with other programs.
507    
508    
509  Retrieving configuration information on Unix-like systems  Retrieving configuration information
510  ---------------------------------------------------------  ------------------------------------
511    
512  Running "make install" installs the command pcre-config, which can be used to  Running "make install" installs the command pcre-config, which can be used to
513  recall information about the PCRE configuration and installation. For example:  recall information about the PCRE configuration and installation. For example:
# Line 445  The data is held in *.pc files that are Line 532  The data is held in *.pc files that are
532  <prefix>/lib/pkgconfig.  <prefix>/lib/pkgconfig.
533    
534    
535  Shared libraries on Unix-like systems  Shared libraries
536  -------------------------------------  ----------------
537    
538  The default distribution builds PCRE as shared libraries and static libraries,  The default distribution builds PCRE as shared libraries and static libraries,
539  as long as the operating system supports shared libraries. Shared library  as long as the operating system supports shared libraries. Shared library
# Line 471  Then run "make" in the usual way. Simila Line 558  Then run "make" in the usual way. Simila
558  build only shared libraries.  build only shared libraries.
559    
560    
561  Cross-compiling on Unix-like systems  Cross-compiling using autotools
562  ------------------------------------  -------------------------------
563    
564  You can specify CC and CFLAGS in the normal way to the "configure" command, in  You can specify CC and CFLAGS in the normal way to the "configure" command, in
565  order to cross-compile PCRE for some other host. However, you should NOT  order to cross-compile PCRE for some other host. However, you should NOT
# Line 509  running the "configure" script: Line 596  running the "configure" script:
596    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
597    
598    
599    Compiling in Tru64 using native compilers
600    -----------------------------------------
601    
602    The following error may occur when compiling with native compilers in the Tru64
603    operating system:
604    
605      CXX    libpcrecpp_la-pcrecpp.lo
606    cxx: Error: /usr/lib/cmplrs/cxx/V7.1-006/include/cxx/iosfwd, line 58: #error
607              directive: "cannot include iosfwd -- define __USE_STD_IOSTREAM to
608              override default - see section 7.1.2 of the C++ Using Guide"
609    #error "cannot include iosfwd -- define __USE_STD_IOSTREAM to override default
610    - see section 7.1.2 of the C++ Using Guide"
611    
612    This may be followed by other errors, complaining that 'namespace "std" has no
613    member'. The solution to this is to add the line
614    
615    #define __USE_STD_IOSTREAM 1
616    
617    to the config.h file.
618    
619    
620  Using Sun's compilers for Solaris  Using Sun's compilers for Solaris
621  ---------------------------------  ---------------------------------
622    
# Line 544  script creates the .txt and HTML forms o Line 652  script creates the .txt and HTML forms o
652  Testing PCRE  Testing PCRE
653  ------------  ------------
654    
655  To test the basic PCRE library on a Unix system, run the RunTest script that is  To test the basic PCRE library on a Unix-like system, run the RunTest script.
656  created by the configuring process. There is also a script called RunGrepTest  There is another script called RunGrepTest that tests the options of the
657  that tests the options of the pcregrep command. If the C++ wrapper library is  pcregrep command. If the C++ wrapper library is built, three test programs
658  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and  called pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest
659  pcre_stringpiece_unittest are also built. When JIT support is enabled, another  are also built. When JIT support is enabled, another test program called
660  test program called pcre_jit_test is built.  pcre_jit_test is built.
661    
662  Both the scripts and all the program tests are run if you obey "make check" or  Both the scripts and all the program tests are run if you obey "make check" or
663  "make test". For other systems, see the instructions in NON-UNIX-USE.  "make test". For other environments, see the instructions in
664    NON-AUTOTOOLS-BUILD.
665    
666  The RunTest script runs the pcretest test program (which is documented in its  The RunTest script runs the pcretest test program (which is documented in its
667  own man page) on each of the relevant testinput files in the testdata  own man page) on each of the relevant testinput files in the testdata
668  directory, and compares the output with the contents of the corresponding  directory, and compares the output with the contents of the corresponding
669  testoutput files. Some tests are relevant only when certain build-time options  testoutput files. RunTest uses a file called testtry to hold the main output
670  were selected. For example, the tests for UTF-8 support are run only if  from pcretest. Other files whose names begin with "test" are used as working
671  --enable-utf8 was used. RunTest outputs a comment when it skips a test.  files in some tests.
672    
673    Some tests are relevant only when certain build-time options were selected. For
674    example, the tests for UTF-8/16/32 support are run only if --enable-utf was
675    used. RunTest outputs a comment when it skips a test.
676    
677  Many of the tests that are not skipped are run up to three times. The second  Many of the tests that are not skipped are run up to three times. The second
678  run forces pcre_study() to be called for all patterns except for a few in some  run forces pcre_study() to be called for all patterns except for a few in some
679  tests that are marked "never study" (see the pcretest program for how this is  tests that are marked "never study" (see the pcretest program for how this is
680  done). If JIT support is available, the non-DFA tests are run a third time,  done). If JIT support is available, the non-DFA tests are run a third time,
681  this time with a forced pcre_study() with the PCRE_STUDY_JIT_COMPILE option.  this time with a forced pcre_study() with the PCRE_STUDY_JIT_COMPILE option.
682    This testing can be suppressed by putting "nojit" on the RunTest command line.
683    
684    The entire set of tests is run once for each of the 8-bit, 16-bit and 32-bit
685    libraries that are enabled. If you want to run just one set of tests, call
686    RunTest with either the -8, -16 or -32 option.
687    
688    If valgrind is installed, you can run the tests under it by putting "valgrind"
689    on the RunTest command line. To run pcretest on just one or more specific test
690    files, give their numbers as arguments to RunTest, for example:
691    
692  RunTest uses a file called testtry to hold the main output from pcretest    RunTest 2 7 11
 (testsavedregex is also used as a working file). To run pcretest on just one of  
 the test files, give its number as an argument to RunTest, for example:  
693    
694    RunTest 2  You can also specify ranges of tests such as 3-6 or 3- (meaning 3 to the
695    end), or a number preceded by ~ to exclude a test. For example:
696    
697      Runtest 3-15 ~10
698    
699    This runs tests 3 to 15, excluding test 10, and just ~13 runs all the tests
700    except test 13. Whatever order the arguments are in, the tests are always run
701    in numerical order.
702    
703    You can also call RunTest with the single argument "list" to cause it to output
704    a list of tests.
705    
706  The first test file can be fed directly into the perltest.pl script to check  The first test file can be fed directly into the perltest.pl script to check
707  that Perl gives the same results. The only difference you should see is in the  that Perl gives the same results. The only difference you should see is in the
708  first few lines, where the Perl version is given instead of the PCRE version.  first few lines, where the Perl version is given instead of the PCRE version.
709    
710  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_study(),
711  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
712  detection, and run-time flags that are specific to PCRE, as well as the POSIX  detection, and run-time flags that are specific to PCRE, as well as the POSIX
713  wrapper API. It also uses the debugging flags to check some of the internals of  wrapper API. It also uses the debugging flags to check some of the internals of
# Line 612  RunTest.bat. The version of RunTest.bat Line 742  RunTest.bat. The version of RunTest.bat
742  Windows versions of test 2. More info on using RunTest.bat is included in the  Windows versions of test 2. More info on using RunTest.bat is included in the
743  document entitled NON-UNIX-USE.]  document entitled NON-UNIX-USE.]
744    
745  The fourth test checks the UTF-8 support. This file can be also fed directly to  The fourth and fifth tests check the UTF-8/16/32 support and error handling and
746  the perltest.pl script, provided you are running Perl 5.8 or higher.  internal UTF features of PCRE that are not relevant to Perl, respectively. The
747    sixth and seventh tests do the same for Unicode character properties support.
748    
749    The eighth, ninth, and tenth tests check the pcre_dfa_exec() alternative
750    matching function, in non-UTF-8/16/32 mode, UTF-8/16/32 mode, and UTF-8/16/32
751    mode with Unicode property support, respectively.
752    
753  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8  The eleventh test checks some internal offsets and code size features; it is
754  features of PCRE that are not relevant to Perl.  run only when the default "link size" of 2 is set (in other cases the sizes
755    change) and when Unicode property support is enabled.
756    
757  The sixth test (which is Perl-5.10 compatible) checks the support for Unicode  The twelfth test is run only when JIT support is available, and the thirteenth
758  character properties. This file can be also fed directly to the perltest.pl  test is run only when JIT support is not available. They test some JIT-specific
759  script, provided you are running Perl 5.10 or higher.  features such as information output from pcretest about JIT compilation.
760    
761  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  The fourteenth, fifteenth, and sixteenth tests are run only in 8-bit mode, and
762  matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode  the seventeenth, eighteenth, and nineteenth tests are run only in 16/32-bit
763  property support, respectively.  mode. These are tests that generate different output in the two modes. They are
764    for general cases, UTF-8/16/32 support, and Unicode property support,
765    respectively.
766    
767    The twentieth test is run only in 16/32-bit mode. It tests some specific
768    16/32-bit features of the DFA matching engine.
769    
770    The twenty-first and twenty-second tests are run only in 16/32-bit mode, when
771    the link size is set to 2 for the 16-bit library. They test reloading
772    pre-compiled patterns.
773    
774  The tenth test checks some internal offsets and code size features; it is run  The twenty-third and twenty-fourth tests are run only in 16-bit mode. They are
775  only when the default "link size" of 2 is set (in other cases the sizes  for general cases, and UTF-16 support, respectively.
 change) and when Unicode property support is enabled.  
776    
777  The eleventh and twelfth tests check out features that are new in Perl 5.10,  The twenty-fifth and twenty-sixth tests are run only in 32-bit mode. They are
778  without and with UTF-8 support, respectively. This file can be also fed  for general cases, and UTF-32 support, respectively.
 directly to the perltest.pl script, provided you are running Perl 5.10 or  
 higher.  
   
 The thirteenth test checks a number internals and non-Perl features concerned  
 with Unicode property support.  
   
 The fourteenth test is run only when JIT support is available, and the  
 fifteenth test is run only when JIT support is not available. They test some  
 JIT-specific features such as information output from pcretest about JIT  
 compilation.  
779    
780    
781  Character tables  Character tables
# Line 701  will cause PCRE to malfunction. Line 835  will cause PCRE to malfunction.
835  File manifest  File manifest
836  -------------  -------------
837    
838  The distribution should contain the following files:  The distribution should contain the files listed below. Where a file name is
839    given as pcre[16|32]_xxx it means that there are three files, one with the name
840    pcre_xxx, one with the name pcre16_xx, and a third with the name pcre32_xxx.
841    
842  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
843    
844    dftables.c              auxiliary program for building pcre_chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
845                              when --enable-rebuild-chartables is specified                            when --enable-rebuild-chartables is specified
846    
847    pcre_chartables.c.dist  a default set of character tables that assume ASCII    pcre_chartables.c.dist  a default set of character tables that assume ASCII
848                              coding; used, unless --enable-rebuild-chartables is                            coding; used, unless --enable-rebuild-chartables is
849                              specified, by copying to pcre_chartables.c                            specified, by copying to pcre[16]_chartables.c
850    
851      pcreposix.c                )
852      pcre[16|32]_byte_order.c   )
853      pcre[16|32]_compile.c      )
854      pcre[16|32]_config.c       )
855      pcre[16|32]_dfa_exec.c     )
856      pcre[16|32]_exec.c         )
857      pcre[16|32]_fullinfo.c     )
858      pcre[16|32]_get.c          ) sources for the functions in the library,
859      pcre[16|32]_globals.c      )   and some internal functions that they use
860      pcre[16|32]_jit_compile.c  )
861      pcre[16|32]_maketables.c   )
862      pcre[16|32]_newline.c      )
863      pcre[16|32]_refcount.c     )
864      pcre[16|32]_string_utils.c )
865      pcre[16|32]_study.c        )
866      pcre[16|32]_tables.c       )
867      pcre[16|32]_ucd.c          )
868      pcre[16|32]_version.c      )
869      pcre[16|32]_xclass.c       )
870      pcre_ord2utf8.c            )
871      pcre_valid_utf8.c          )
872      pcre16_ord2utf16.c         )
873      pcre16_utf16_utils.c       )
874      pcre16_valid_utf16.c       )
875      pcre32_utf32_utils.c       )
876      pcre32_valid_utf32.c       )
877    
878      pcre[16|32]_printint.c     ) debugging function that is used by pcretest,
879                                 )   and can also be #included in pcre_compile()
880    
   pcreposix.c             )  
   pcre_byte_order.c       )  
   pcre_compile.c          )  
   pcre_config.c           )  
   pcre_dfa_exec.c         )  
   pcre_exec.c             )  
   pcre_fullinfo.c         )  
   pcre_get.c              ) sources for the functions in the library,  
   pcre_globals.c          )   and some internal functions that they use  
   pcre_info.c             )  
   pcre_jit_compile.c      )  
   pcre_maketables.c       )  
   pcre_newline.c          )  
   pcre_ord2utf8.c         )  
   pcre_refcount.c         )  
   pcre_study.c            )  
   pcre_tables.c           )  
   pcre_ucd.c              )  
   pcre_valid_utf8.c       )  
   pcre_version.c          )  
   pcre_xclass.c           )  
   pcre_printint.src       ) debugging function that is #included in pcretest,  
                           )   and can also be #included in pcre_compile()  
881    pcre.h.in               template for pcre.h when built by "configure"    pcre.h.in               template for pcre.h when built by "configure"
882    pcreposix.h             header for the external POSIX wrapper API    pcreposix.h             header for the external POSIX wrapper API
883    pcre_internal.h         header for internal use    pcre_internal.h         header for internal use
# Line 775  The distribution should contain the foll Line 918  The distribution should contain the foll
918    Makefile.am             ) the automake input that was used to create    Makefile.am             ) the automake input that was used to create
919                            )   Makefile.in                            )   Makefile.in
920    NEWS                    important changes in this release    NEWS                    important changes in this release
921    NON-UNIX-USE            notes on building PCRE on non-Unix systems    NON-UNIX-USE            the previous name for NON-AUTOTOOLS-BUILD
922      NON-AUTOTOOLS-BUILD     notes on building PCRE without using autotools
923    PrepareRelease          script to make preparations for "make dist"    PrepareRelease          script to make preparations for "make dist"
924    README                  this file    README                  this file
925    RunTest                 a Unix shell script for running tests    RunTest                 a Unix shell script for running tests
# Line 796  The distribution should contain the foll Line 940  The distribution should contain the foll
940    doc/pcretest.txt        plain text documentation of test program    doc/pcretest.txt        plain text documentation of test program
941    doc/perltest.txt        plain text documentation of Perl test program    doc/perltest.txt        plain text documentation of Perl test program
942    install-sh              a shell script for installing files    install-sh              a shell script for installing files
943      libpcre16.pc.in         template for libpcre16.pc for pkg-config
944      libpcre32.pc.in         template for libpcre32.pc for pkg-config
945    libpcre.pc.in           template for libpcre.pc for pkg-config    libpcre.pc.in           template for libpcre.pc for pkg-config
946    libpcreposix.pc.in      template for libpcreposix.pc for pkg-config    libpcreposix.pc.in      template for libpcreposix.pc for pkg-config
947    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
# Line 812  The distribution should contain the foll Line 958  The distribution should contain the foll
958    testdata/testinput*     test data for main library tests    testdata/testinput*     test data for main library tests
959    testdata/testoutput*    expected test results    testdata/testoutput*    expected test results
960    testdata/grep*          input and output for pcregrep tests    testdata/grep*          input and output for pcregrep tests
961      testdata/*              other supporting test files
962    
963  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
964    
965    cmake/COPYING-CMAKE-SCRIPTS    cmake/COPYING-CMAKE-SCRIPTS
966    cmake/FindPackageHandleStandardArgs.cmake    cmake/FindPackageHandleStandardArgs.cmake
967      cmake/FindEditline.cmake
968    cmake/FindReadline.cmake    cmake/FindReadline.cmake
969    CMakeLists.txt    CMakeLists.txt
970    config-cmake.h.in    config-cmake.h.in
# Line 842  The distribution should contain the foll Line 990  The distribution should contain the foll
990  Philip Hazel  Philip Hazel
991  Email local part: ph10  Email local part: ph10
992  Email domain: cam.ac.uk  Email domain: cam.ac.uk
993  Last updated: 06 September 2011  Last updated: 24 October 2014

Legend:
Removed from v.836  
changed lines
  Added in v.1503

  ViewVC Help
Powered by ViewVC 1.1.5