/[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 1459 by ph10, Tue Mar 4 10:45:15 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++.
49  interface to PCRE; the regular expressions themselves still follow Perl syntax  
50  and semantics. The POSIX API is restricted, and does not give full access to  In addition, there is a set of C wrapper functions (again, just for the 8-bit
51  all of PCRE's facilities.  library) that are based on the POSIX regular expression API (see the pcreposix
52    man page). These end up in the library called libpcreposix. Note that this just
53    provides a POSIX calling interface to PCRE; the regular expressions themselves
54    still follow Perl syntax and semantics. The POSIX API is restricted, and does
55    not give full access to all of PCRE's facilities.
56    
57  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
58  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 85  documentation is supplied in two other f
85    1. There are files called doc/pcre.txt, doc/pcregrep.txt, and    1. There are files called doc/pcre.txt, doc/pcregrep.txt, and
86       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
87       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
88       those that summarize individual functions. The other two are the text       the listing of pcredemo.c and those that summarize individual functions.
89       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
90       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
91       similar tools. They are installed in <prefix>/share/doc/pcre, where       scanning with text editors or similar tools. They are installed in
92       <prefix> is the installation prefix (defaulting to /usr/local).       <prefix>/share/doc/pcre, where <prefix> is the installation prefix
93         (defaulting to /usr/local).
94    
95    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
96       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 115  contributions provided support for compi
115  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
116  in the standard distribution, so these contibutions have been archived.  in the standard distribution, so these contibutions have been archived.
117    
118    A PCRE user maintains downloadable Windows binaries of the pcregrep and
119    pcretest programs here:
120    
121  Building PCRE on non-Unix systems    http://www.rexegg.com/pcregrep-pcretest.html
122  ---------------------------------  
123    
124    Building PCRE on non-Unix-like systems
125    --------------------------------------
126    
127    For a non-Unix-like system, please read the comments in the file
128    NON-AUTOTOOLS-BUILD, though if your system supports the use of "configure" and
129    "make" you may be able to build PCRE using autotools in the same way as for
130    many Unix-like systems.
131    
132  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
133  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
134  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.  
135    
136  PCRE has been compiled on many different operating systems. It should be  PCRE has been compiled on many different operating systems. It should be
137  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
138  library, because it uses only Standard C functions.  library, because it uses only Standard C functions.
139    
140    
141  Building PCRE on Unix-like systems  Building PCRE without using autotools
142  ----------------------------------  -------------------------------------
143    
144    The use of autotools (in particular, libtool) is problematic in some
145    environments, even some that are Unix or Unix-like. See the NON-AUTOTOOLS-BUILD
146    file for ways of building PCRE without using autotools.
147    
148    
149    Building PCRE using autotools
150    -----------------------------
151    
152  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
153  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
154    
155  The following instructions assume the use of the widely used "configure, make,  The following instructions assume the use of the widely used "configure; make;
156  make install" process. There is also support for CMake in the PCRE  make install" (autotools) process.
157  distribution; there are some comments about using CMake in the NON-UNIX-USE  
158  file, though it can also be used in Unix-like systems.  To build PCRE on system that supports autotools, first run the "configure"
159    command from the PCRE distribution directory, with your current directory set
160  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
161  PCRE distribution directory, with your current directory set to the directory  standard GNU "autoconf" configuration script, for which generic instructions
162  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.  
163    
164  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
165  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 167  the usual methods of changing standard d
167    
168  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
169    
170  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
171  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
172  instead of the default /usr/local.  under /opt/local instead of the default /usr/local.
173    
174  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
175  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 193  library. They are also documented in the
193    
194    (See also "Shared libraries on Unix-like systems" below.)    (See also "Shared libraries on Unix-like systems" below.)
195    
196  . 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
197    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    the "configure" command, the 16-bit library is also built. If you add
198    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.
199    it will try to build the C++ wrapper.    If you want only the 16-bit or 32-bit library, use --disable-pcre8 to disable
200      building the 8-bit library.
201    
202    . If you are building the 8-bit library and want to suppress the building of
203      the C++ wrapper library, you can add --disable-cpp to the "configure"
204      command. Otherwise, when "configure" is run without --disable-pcre8, it will
205      try to find a C++ compiler and C++ header files, and if it succeeds, it will
206      try to build the C++ wrapper.
207    
208  . 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
209    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 215  library. They are also documented in the
215    you add --disable-pcregrep-jit to the "configure" command.    you add --disable-pcregrep-jit to the "configure" command.
216    
217  . 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
218    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,
219    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
220    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
221    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
222    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
223    --enable-ebcdic at the same time.    enabled by an option at run time. When PCRE is compiled with this option, its
224      input can only either be ASCII or UTF-8/16/32, even when running on EBCDIC
225  . 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
226    support for the \P, \p, and \X sequences that recognize Unicode character    the same time.
227    properties, you must add --enable-unicode-properties to the "configure"  
228    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
229    property table); only the basic two-letter properties such as Lu are    independently because that would allow ridiculous settings such as requesting
230    supported.    UTF-16 support while building only the 8-bit library. However, the option
231      --enable-utf8 is retained for backwards compatibility with earlier releases
232      that did not support 16-bit or 32-bit character strings. It is synonymous with
233      --enable-utf. It is not possible to configure one library with UTF support
234      and the other without in the same configuration.
235    
236    . If, in addition to support for UTF-8/16/32 character strings, you want to
237      include support for the \P, \p, and \X sequences that recognize Unicode
238      character properties, you must add --enable-unicode-properties to the
239      "configure" command. This adds about 30K to the size of the library (in the
240      form of a property table); only the basic two-letter properties such as Lu
241      are supported.
242    
243  . 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
244    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 270  library. They are also documented in the
270    
271    on the "configure" command.    on the "configure" command.
272    
273  . 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
274    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
275    million. You can change the default by setting, for example,    is compiled. The default is 250, but you can change it by setting, for
276      example,
277    
278      --with-parens-nest-limit=500
279    
280    . PCRE has a counter that can be set to limit the amount of resources it uses
281      when matching a pattern. If the limit is exceeded during a match, the match
282      fails. The default is ten million. You can change the default by setting, for
283      example,
284    
285    --with-match-limit=500000    --with-match-limit=500000
286    
# Line 249  library. They are also documented in the Line 299  library. They are also documented in the
299    sizes in the pcrestack man page.    sizes in the pcrestack man page.
300    
301  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
302    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
303    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
304    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
305    performance.    the same as --with-link-size=4, which (in both libraries) uses four-byte
306      offsets. Increasing the internal link size reduces performance. In the 32-bit
307      library, the only supported link size is 4.
308    
309  . 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
310    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 333  library. They are also documented in the
333    pcre_chartables.c.dist. See "Character tables" below for further information.    pcre_chartables.c.dist. See "Character tables" below for further information.
334    
335  . 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
336    character code (as opposed to ASCII) by specifying    character code (as opposed to ASCII/Unicode) by specifying
337    
338    --enable-ebcdic    --enable-ebcdic
339    
340    This automatically implies --enable-rebuild-chartables (see above). However,    This automatically implies --enable-rebuild-chartables (see above). However,
341    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
342    both EBCDIC and UTF-8.    both EBCDIC and UTF-8/16/32. There is a second option, --enable-ebcdic-nl25,
343      which specifies that the code value for the EBCDIC NL character is 0x25
344  . It is possible to compile pcregrep to use libz and/or libbz2, in order to    instead of the default 0x15.
345    read .gz and .bz2 files (respectively), by specifying one or both of  
346    . In environments where valgrind is installed, if you specify
347    
348      --enable-valgrind
349    
350      PCRE will use valgrind annotations to mark certain memory regions as
351      unaddressable. This allows it to detect invalid memory accesses, and is
352      mostly useful for debugging PCRE itself.
353    
354    . In environments where the gcc compiler is used and lcov version 1.6 or above
355      is installed, if you specify
356    
357      --enable-coverage
358    
359      the build process implements a code coverage report for the test suite. The
360      report is generated by running "make coverage". If ccache is installed on
361      your system, it must be disabled when building PCRE for coverage reporting.
362      You can do this by setting the environment variable CCACHE_DISABLE=1 before
363      running "make" to build PCRE. There is more information about coverage
364      reporting in the "pcrebuild" documentation.
365    
366    . The pcregrep program currently supports only 8-bit data files, and so
367      requires the 8-bit PCRE library. It is possible to compile pcregrep to use
368      libz and/or libbz2, in order to read .gz and .bz2 files (respectively), by
369      specifying one or both of
370    
371    --enable-pcregrep-libz    --enable-pcregrep-libz
372    --enable-pcregrep-libbz2    --enable-pcregrep-libbz2
373    
374    Of course, the relevant libraries must be installed on your system.    Of course, the relevant libraries must be installed on your system.
375    
376  . 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
377    example:    set by, for example:
378    
379    --with-pcregrep-bufsize=50K    --with-pcregrep-bufsize=51200
380    
381    The default value is 20K.    The value must be a plain integer. The default is 20480.
382    
383  . 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
384    library, by specifying    or libedit libraries, by specifying, respectively,
385    
386    --enable-pcretest-libreadline    --enable-pcretest-libreadline or --enable-pcretest-libedit
387    
388    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
389    the readline() function. This provides line-editing and history facilities.    the readline() function. This provides line-editing and history facilities.
390    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
391    pcretest linked in this way, there may be licensing issues.    pcretest linked in this way, there may be licensing issues. These can be
392      avoided by linking with libedit (which has a BSD licence) instead.
393    
394    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
395    build. In many operating environments with a sytem-installed readline    build. In many operating environments with a sytem-installed readline
396    library this is sufficient. However, in some environments (e.g. if an    library this is sufficient. However, in some environments (e.g. if an
397    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 410  The "configure" script builds the follow
410  . pcre-config          script that shows the building settings such as CFLAGS  . pcre-config          script that shows the building settings such as CFLAGS
411                           that were set for "configure"                           that were set for "configure"
412  . libpcre.pc         ) data for the pkg-config command  . libpcre.pc         ) data for the pkg-config command
413    . libpcre16.pc       )
414    . libpcre32.pc       )
415  . libpcreposix.pc    )  . libpcreposix.pc    )
416  . 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  
417    
418  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
419  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
420  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"
421  or CMake, the .generic versions are not used.  or CMake, the .generic versions are not used.
422    
423  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
424    files are also built:
425    
426  . libpcrecpp.pc        data for the pkg-config command  . libpcrecpp.pc        data for the pkg-config command
427  . 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 431  The "configure" script also creates conf
431  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
432  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
433    
434  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
435  libpcre and libpcreposix, a test program called pcretest, and the pcregrep  libpcre, libpcre16 and/or libpcre32, and a test program called pcretest. If you
436  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
437  with --disable-cpp, "make" also builds the C++ wrapper library, which is called  built as well.
438  libpcrecpp, and some test programs called pcrecpp_unittest,  
439  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
440  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
441    it with --disable-cpp, "make" builds the C++ wrapper library, which is called
442    libpcrecpp, as well as some test programs called pcrecpp_unittest,
443    pcre_scanner_unittest, and pcre_stringpiece_unittest.
444    
445  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
446  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 451  system. The following are installed (fil
451    
452    Commands (bin):    Commands (bin):
453      pcretest      pcretest
454      pcregrep      pcregrep (if 8-bit support is enabled)
455      pcre-config      pcre-config
456    
457    Libraries (lib):    Libraries (lib):
458      libpcre      libpcre16     (if 16-bit support is enabled)
459      libpcreposix      libpcre32     (if 32-bit support is enabled)
460      libpcrecpp (if C++ support is enabled)      libpcre       (if 8-bit support is enabled)
461        libpcreposix  (if 8-bit support is enabled)
462        libpcrecpp    (if 8-bit and C++ support is enabled)
463    
464    Configuration information (lib/pkgconfig):    Configuration information (lib/pkgconfig):
465        libpcre16.pc
466        libpcre32.pc
467      libpcre.pc      libpcre.pc
468      libpcreposix.pc      libpcreposix.pc
469      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 504  This removes all the files that "make in
504  remove any directories, because these are often shared with other programs.  remove any directories, because these are often shared with other programs.
505    
506    
507  Retrieving configuration information on Unix-like systems  Retrieving configuration information
508  ---------------------------------------------------------  ------------------------------------
509    
510  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
511  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 530  The data is held in *.pc files that are
530  <prefix>/lib/pkgconfig.  <prefix>/lib/pkgconfig.
531    
532    
533  Shared libraries on Unix-like systems  Shared libraries
534  -------------------------------------  ----------------
535    
536  The default distribution builds PCRE as shared libraries and static libraries,  The default distribution builds PCRE as shared libraries and static libraries,
537  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 556  Then run "make" in the usual way. Simila
556  build only shared libraries.  build only shared libraries.
557    
558    
559  Cross-compiling on Unix-like systems  Cross-compiling using autotools
560  ------------------------------------  -------------------------------
561    
562  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
563  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 594  running the "configure" script:
594    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
595    
596    
597    Compiling in Tru64 using native compilers
598    -----------------------------------------
599    
600    The following error may occur when compiling with native compilers in the Tru64
601    operating system:
602    
603      CXX    libpcrecpp_la-pcrecpp.lo
604    cxx: Error: /usr/lib/cmplrs/cxx/V7.1-006/include/cxx/iosfwd, line 58: #error
605              directive: "cannot include iosfwd -- define __USE_STD_IOSTREAM to
606              override default - see section 7.1.2 of the C++ Using Guide"
607    #error "cannot include iosfwd -- define __USE_STD_IOSTREAM to override default
608    - see section 7.1.2 of the C++ Using Guide"
609    
610    This may be followed by other errors, complaining that 'namespace "std" has no
611    member'. The solution to this is to add the line
612    
613    #define __USE_STD_IOSTREAM 1
614    
615    to the config.h file.
616    
617    
618  Using Sun's compilers for Solaris  Using Sun's compilers for Solaris
619  ---------------------------------  ---------------------------------
620    
# Line 544  script creates the .txt and HTML forms o Line 650  script creates the .txt and HTML forms o
650  Testing PCRE  Testing PCRE
651  ------------  ------------
652    
653  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.
654  created by the configuring process. There is also a script called RunGrepTest  There is another script called RunGrepTest that tests the options of the
655  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
656  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and  called pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest
657  pcre_stringpiece_unittest are also built. When JIT support is enabled, another  are also built. When JIT support is enabled, another test program called
658  test program called pcre_jit_test is built.  pcre_jit_test is built.
659    
660  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
661  "make test". For other systems, see the instructions in NON-UNIX-USE.  "make test". For other environments, see the instructions in
662    NON-AUTOTOOLS-BUILD.
663    
664  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
665  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
666  directory, and compares the output with the contents of the corresponding  directory, and compares the output with the contents of the corresponding
667  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
668  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
669  --enable-utf8 was used. RunTest outputs a comment when it skips a test.  files in some tests.
670    
671    Some tests are relevant only when certain build-time options were selected. For
672    example, the tests for UTF-8/16/32 support are run only if --enable-utf was
673    used. RunTest outputs a comment when it skips a test.
674    
675  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
676  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
677  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
678  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,
679  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.
680    This testing can be suppressed by putting "nojit" on the RunTest command line.
681    
682    The entire set of tests is run once for each of the 8-bit, 16-bit and 32-bit
683    libraries that are enabled. If you want to run just one set of tests, call
684    RunTest with either the -8, -16 or -32 option.
685    
686    If valgrind is installed, you can run the tests under it by putting "valgrind"
687    on the RunTest command line. To run pcretest on just one or more specific test
688    files, give their numbers as arguments to RunTest, for example:
689    
690  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:  
691    
692    RunTest 2  You can also specify ranges of tests such as 3-6 or 3- (meaning 3 to the
693    end), or a number preceded by ~ to exclude a test. For example:
694    
695      Runtest 3-15 ~10
696    
697    This runs tests 3 to 15, excluding test 10, and just ~13 runs all the tests
698    except test 13. Whatever order the arguments are in, the tests are always run
699    in numerical order.
700    
701    You can also call RunTest with the single argument "list" to cause it to output
702    a list of tests.
703    
704  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
705  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
706  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.
707    
708  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_study(),
709  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
710  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
711  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 740  RunTest.bat. The version of RunTest.bat
740  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
741  document entitled NON-UNIX-USE.]  document entitled NON-UNIX-USE.]
742    
743  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
744  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
745    sixth and seventh tests do the same for Unicode character properties support.
746    
747    The eighth, ninth, and tenth tests check the pcre_dfa_exec() alternative
748    matching function, in non-UTF-8/16/32 mode, UTF-8/16/32 mode, and UTF-8/16/32
749    mode with Unicode property support, respectively.
750    
751  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
752  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
753    change) and when Unicode property support is enabled.
754    
755  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
756  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
757  script, provided you are running Perl 5.10 or higher.  features such as information output from pcretest about JIT compilation.
758    
759  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
760  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
761  property support, respectively.  mode. These are tests that generate different output in the two modes. They are
762    for general cases, UTF-8/16/32 support, and Unicode property support,
763    respectively.
764    
765    The twentieth test is run only in 16/32-bit mode. It tests some specific
766    16/32-bit features of the DFA matching engine.
767    
768    The twenty-first and twenty-second tests are run only in 16/32-bit mode, when
769    the link size is set to 2 for the 16-bit library. They test reloading
770    pre-compiled patterns.
771    
772  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
773  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.  
774    
775  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
776  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.  
777    
778    
779  Character tables  Character tables
# Line 701  will cause PCRE to malfunction. Line 833  will cause PCRE to malfunction.
833  File manifest  File manifest
834  -------------  -------------
835    
836  The distribution should contain the following files:  The distribution should contain the files listed below. Where a file name is
837    given as pcre[16|32]_xxx it means that there are three files, one with the name
838    pcre_xxx, one with the name pcre16_xx, and a third with the name pcre32_xxx.
839    
840  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
841    
842    dftables.c              auxiliary program for building pcre_chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
843                              when --enable-rebuild-chartables is specified                            when --enable-rebuild-chartables is specified
844    
845    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
846                              coding; used, unless --enable-rebuild-chartables is                            coding; used, unless --enable-rebuild-chartables is
847                              specified, by copying to pcre_chartables.c                            specified, by copying to pcre[16]_chartables.c
848    
849      pcreposix.c                )
850      pcre[16|32]_byte_order.c   )
851      pcre[16|32]_compile.c      )
852      pcre[16|32]_config.c       )
853      pcre[16|32]_dfa_exec.c     )
854      pcre[16|32]_exec.c         )
855      pcre[16|32]_fullinfo.c     )
856      pcre[16|32]_get.c          ) sources for the functions in the library,
857      pcre[16|32]_globals.c      )   and some internal functions that they use
858      pcre[16|32]_jit_compile.c  )
859      pcre[16|32]_maketables.c   )
860      pcre[16|32]_newline.c      )
861      pcre[16|32]_refcount.c     )
862      pcre[16|32]_string_utils.c )
863      pcre[16|32]_study.c        )
864      pcre[16|32]_tables.c       )
865      pcre[16|32]_ucd.c          )
866      pcre[16|32]_version.c      )
867      pcre[16|32]_xclass.c       )
868      pcre_ord2utf8.c            )
869      pcre_valid_utf8.c          )
870      pcre16_ord2utf16.c         )
871      pcre16_utf16_utils.c       )
872      pcre16_valid_utf16.c       )
873      pcre32_utf32_utils.c       )
874      pcre32_valid_utf32.c       )
875    
876      pcre[16|32]_printint.c     ) debugging function that is used by pcretest,
877                                 )   and can also be #included in pcre_compile()
878    
   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()  
879    pcre.h.in               template for pcre.h when built by "configure"    pcre.h.in               template for pcre.h when built by "configure"
880    pcreposix.h             header for the external POSIX wrapper API    pcreposix.h             header for the external POSIX wrapper API
881    pcre_internal.h         header for internal use    pcre_internal.h         header for internal use
# Line 775  The distribution should contain the foll Line 916  The distribution should contain the foll
916    Makefile.am             ) the automake input that was used to create    Makefile.am             ) the automake input that was used to create
917                            )   Makefile.in                            )   Makefile.in
918    NEWS                    important changes in this release    NEWS                    important changes in this release
919    NON-UNIX-USE            notes on building PCRE on non-Unix systems    NON-UNIX-USE            the previous name for NON-AUTOTOOLS-BUILD
920      NON-AUTOTOOLS-BUILD     notes on building PCRE without using autotools
921    PrepareRelease          script to make preparations for "make dist"    PrepareRelease          script to make preparations for "make dist"
922    README                  this file    README                  this file
923    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 938  The distribution should contain the foll
938    doc/pcretest.txt        plain text documentation of test program    doc/pcretest.txt        plain text documentation of test program
939    doc/perltest.txt        plain text documentation of Perl test program    doc/perltest.txt        plain text documentation of Perl test program
940    install-sh              a shell script for installing files    install-sh              a shell script for installing files
941      libpcre16.pc.in         template for libpcre16.pc for pkg-config
942      libpcre32.pc.in         template for libpcre32.pc for pkg-config
943    libpcre.pc.in           template for libpcre.pc for pkg-config    libpcre.pc.in           template for libpcre.pc for pkg-config
944    libpcreposix.pc.in      template for libpcreposix.pc for pkg-config    libpcreposix.pc.in      template for libpcreposix.pc for pkg-config
945    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 956  The distribution should contain the foll
956    testdata/testinput*     test data for main library tests    testdata/testinput*     test data for main library tests
957    testdata/testoutput*    expected test results    testdata/testoutput*    expected test results
958    testdata/grep*          input and output for pcregrep tests    testdata/grep*          input and output for pcregrep tests
959      testdata/*              other supporting test files
960    
961  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
962    
963    cmake/COPYING-CMAKE-SCRIPTS    cmake/COPYING-CMAKE-SCRIPTS
964    cmake/FindPackageHandleStandardArgs.cmake    cmake/FindPackageHandleStandardArgs.cmake
965      cmake/FindEditline.cmake
966    cmake/FindReadline.cmake    cmake/FindReadline.cmake
967    CMakeLists.txt    CMakeLists.txt
968    config-cmake.h.in    config-cmake.h.in
# Line 842  The distribution should contain the foll Line 988  The distribution should contain the foll
988  Philip Hazel  Philip Hazel
989  Email local part: ph10  Email local part: ph10
990  Email domain: cam.ac.uk  Email domain: cam.ac.uk
991  Last updated: 06 September 2011  Last updated: 17 January 2014

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

  ViewVC Help
Powered by ViewVC 1.1.5