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

Diff of /code/trunk/README

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

revision 149 by ph10, Mon Apr 16 15:28:08 2007 UTC revision 840 by ph10, Fri Dec 30 19:32:50 2011 UTC
# Line 1  Line 1 
1  README file for PCRE (Perl-compatible regular expression library)  README file for PCRE (Perl-compatible regular expression library)
2  -----------------------------------------------------------------  -----------------------------------------------------------------
3    
4  The latest release of PCRE is always available from  The latest release of PCRE is always available in three alternative formats
5    from:
6    
7    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.gz    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.gz
8      ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.bz2
9      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    
# Line 21  The contents of this README file are: Line 24  The contents of this README file are:
24    Shared libraries on Unix-like systems    Shared libraries on Unix-like systems
25    Cross-compiling on Unix-like systems    Cross-compiling on Unix-like systems
26    Using HP's ANSI C++ compiler (aCC)    Using HP's ANSI C++ compiler (aCC)
27      Using PCRE from MySQL
28    Making new tarballs    Making new tarballs
29    Testing PCRE    Testing PCRE
30    Character tables    Character tables
# Line 30  The contents of this README file are: Line 34  The contents of this README file are:
34  The PCRE APIs  The PCRE APIs
35  -------------  -------------
36    
37  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 two sets of functions,
38  set of C++ wrapper functions (see the pcrecpp man page for details), courtesy  one for the 8-bit library, which processes strings of bytes, and one for the
39  of Google Inc.  16-bit library, which processes strings of 16-bit values. The distribution also
40    includes a set of C++ wrapper functions (see the pcrecpp man page for details),
41  In addition, there is a set of C wrapper functions that are based on the POSIX  courtesy of Google Inc., which can be used to call the 8-bit PCRE library from
42  regular expression API (see the pcreposix man page). These end up in the  C++.
43  library called libpcreposix. Note that this just provides a POSIX calling  
44  interface to PCRE; the regular expressions themselves still follow Perl syntax  In addition, there is a set of C wrapper functions (again, just for the 8-bit
45  and semantics. The POSIX API is restricted, and does not give full access to  library) that are based on the POSIX regular expression API (see the pcreposix
46  all of PCRE's facilities.  man page). These end up in the library called libpcreposix. Note that this just
47    provides a POSIX calling interface to PCRE; the regular expressions themselves
48    still follow Perl syntax and semantics. The POSIX API is restricted, and does
49    not give full access to all of PCRE's facilities.
50    
51  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
52  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 82  documentation is supplied in two other f Line 89  documentation is supplied in two other f
89       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
90       doc/html and installed in <prefix>/share/doc/pcre/html.       doc/html and installed in <prefix>/share/doc/pcre/html.
91    
92    Users of PCRE have contributed files containing the documentation for various
93    releases in CHM format. These can be found in the Contrib directory of the FTP
94    site (see next section).
95    
96    
97  Contributions by users of PCRE  Contributions by users of PCRE
98  ------------------------------  ------------------------------
# Line 103  Building PCRE on non-Unix systems Line 114  Building PCRE on non-Unix systems
114    
115  For a non-Unix system, please read the comments in the file NON-UNIX-USE,  For a non-Unix system, please read the comments in the file NON-UNIX-USE,
116  though if your system supports the use of "configure" and "make" you may be  though if your system supports the use of "configure" and "make" you may be
117  able to build PCRE in the same way as for Unix-like systems.  able to build PCRE in the same way as for Unix-like systems. PCRE can also be
118    configured in many platform environments using the GUI facility provided by
119    CMake's cmake-gui command. This creates Makefiles, solution files, etc.
120    
121  PCRE has been compiled on many different operating systems. It should be  PCRE has been compiled on many different operating systems. It should be
122  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
# Line 117  If you are using HP's ANSI C++ compiler Line 130  If you are using HP's ANSI C++ compiler
130  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
131    
132  The following instructions assume the use of the widely used "configure, make,  The following instructions assume the use of the widely used "configure, make,
133  make install" process. There is also some experimental support for "cmake" in  make install" process. There is also support for CMake in the PCRE
134  the PCRE distribution, but it is incomplete and not documented. However, if you  distribution; there are some comments about using CMake in the NON-UNIX-USE
135  are a "cmake" user, you might want to try it.  file, though it can also be used in Unix-like systems.
136    
137  To build PCRE on a Unix-like system, first run the "configure" command from the  To build PCRE on a Unix-like system, first run the "configure" command from the
138  PCRE distribution directory, with your current directory set to the directory  PCRE distribution directory, with your current directory set to the directory
# Line 133  the usual methods of changing standard d Line 146  the usual methods of changing standard d
146    
147  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
148    
149  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
150  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
151  instead of the default /usr/local.  under /opt/local instead of the default /usr/local.
152    
153  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
154  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 149  possible to build it as a C++ library, t Line 162  possible to build it as a C++ library, t
162  does not have any features to support this.  does not have any features to support this.
163    
164  There are some optional features that can be included or omitted from the PCRE  There are some optional features that can be included or omitted from the PCRE
165  library. You can read more about them in the pcrebuild man page.  library. They are also documented in the pcrebuild man page.
166    
167    . By default, both shared and static libraries are built. You can change this
168      by adding one of these options to the "configure" command:
169    
170  . If you want to suppress the building of the C++ wrapper library, you can add    --disable-shared
171    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-static
172    it will try to find a C++ compiler and C++ header files, and if it succeeds,  
173    it will try to build the C++ wrapper.    (See also "Shared libraries on Unix-like systems" below.)
174    
175  . If you want to make use of the support for UTF-8 character strings in PCRE,  . By default, only the 8-bit library is built. If you add --enable-pcre16 to
176    you must add --enable-utf8 to the "configure" command. Without it, the code    the "configure" command, the 16-bit library is also built. If you want only
177    for handling UTF-8 is not included in the library. (Even when included, it    the 16-bit library, use "./configure --enable-pcre16 --disable-pcre8".
178    still has to be enabled by an option at run time.)  
179    . If you are building the 8-bit library and want to suppress the building of
180  . If, in addition to support for UTF-8 character strings, you want to include    the C++ wrapper library, you can add --disable-cpp to the "configure"
181    support for the \P, \p, and \X sequences that recognize Unicode character    command. Otherwise, when "configure" is run without --disable-pcre8, it will
182    properties, you must add --enable-unicode-properties to the "configure"    try to find a C++ compiler and C++ header files, and if it succeeds, it will
183    command. This adds about 30K to the size of the library (in the form of a    try to build the C++ wrapper.
184    property table); only the basic two-letter properties such as Lu are  
185    supported.  . If you want to include support for just-in-time compiling, which can give
186      large performance improvements on certain platforms, add --enable-jit to the
187      "configure" command. This support is available only for certain hardware
188      architectures. If you try to enable it on an unsupported architecture, there
189      will be a compile time error.
190    
191    . When JIT support is enabled, pcregrep automatically makes use of it, unless
192      you add --disable-pcregrep-jit to the "configure" command.
193    
194    . If you want to make use of the support for UTF-8 Unicode character strings in
195      the 8-bit library, or UTF-16 Unicode character strings in the 16-bit library,
196      you must add --enable-utf to the "configure" command. Without it, the code
197      for handling UTF-8 and UTF-16 is not included in the relevant library. Even
198      when --enable-utf included, the use of UTF encoding still has to be enabled
199      by an option at run time. When PCRE is compiled with this option, its input
200      can only either be ASCII or UTF-8/16, even when running on EBCDIC platforms.
201      It is not possible to use both --enable-utf and --enable-ebcdic at the same
202      time.
203    
204    . The option --enable-utf8 is retained for backwards compatibility with earlier
205      releases that did not support 16-bit character strings. It is synonymous with
206      --enable-utf. It is not possible to configure one library with UTF support
207      and the other without in the same configuration.
208    
209    . If, in addition to support for UTF-8/16 character strings, you want to
210      include support for the \P, \p, and \X sequences that recognize Unicode
211      character properties, you must add --enable-unicode-properties to the
212      "configure" command. This adds about 30K to the size of the library (in the
213      form of a property table); only the basic two-letter properties such as Lu
214      are supported.
215    
216  . 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
217    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 184  library. You can read more about them in Line 229  library. You can read more about them in
229    --enable-newline-is-any, many tests should succeed, but there may be some    --enable-newline-is-any, many tests should succeed, but there may be some
230    failures.    failures.
231    
232    . By default, the sequence \R in a pattern matches any Unicode line ending
233      sequence. This is independent of the option specifying what PCRE considers to
234      be the end of a line (see above). However, the caller of PCRE can restrict \R
235      to match only CR, LF, or CRLF. You can make this the default by adding
236      --enable-bsr-anycrlf to the "configure" command (bsr = "backslash R").
237    
238  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
239    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
240    them in a pattern. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
# Line 213  library. You can read more about them in Line 264  library. You can read more about them in
264    sizes in the pcrestack man page.    sizes in the pcrestack man page.
265    
266  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
267    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
268    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
269    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
270    performance.    the same as --with-link-size=4, which (in both libraries) uses four-byte
271      offsets. Increasing the internal link size reduces performance.
272    
273  . 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
274    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 228  library. You can read more about them in Line 280  library. You can read more about them in
280    
281    on the "configure" command. PCRE runs more slowly in this mode, but it may be    on the "configure" command. PCRE runs more slowly in this mode, but it may be
282    necessary in environments with limited stack sizes. This applies only to the    necessary in environments with limited stack sizes. This applies only to the
283    pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not    normal execution of the pcre_exec() function; if JIT support is being
284    use deeply nested recursion. There is a discussion about stack sizes in the    successfully used, it is not relevant. Equally, it does not apply to
285    pcrestack man page.    pcre_dfa_exec(), which does not use deeply nested recursion. There is a
286      discussion about stack sizes in the pcrestack man page.
287    
288  . For speed, PCRE uses four tables for manipulating and identifying characters  . For speed, PCRE uses four tables for manipulating and identifying characters
289    whose code point values are less than 256. By default, it uses a set of    whose code point values are less than 256. By default, it uses a set of
# Line 244  library. You can read more about them in Line 297  library. You can read more about them in
297    pcre_chartables.c.dist. See "Character tables" below for further information.    pcre_chartables.c.dist. See "Character tables" below for further information.
298    
299  . 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
300    default character code (as opposed to ASCII) by specifying    character code (as opposed to ASCII) by specifying
301    
302    --enable-ebcdic    --enable-ebcdic
303    
304    This automatically implies --enable-rebuild-chartables (see above).    This automatically implies --enable-rebuild-chartables (see above). However,
305      when PCRE is built this way, it always operates in EBCDIC. It cannot support
306      both EBCDIC and UTF-8/16.
307    
308    . The pcregrep program currently supports only 8-bit data files, and so
309      requires the 8-bit PCRE library. It is possible to compile pcregrep to use
310      libz and/or libbz2, in order to read .gz and .bz2 files (respectively), by
311      specifying one or both of
312    
313      --enable-pcregrep-libz
314      --enable-pcregrep-libbz2
315    
316      Of course, the relevant libraries must be installed on your system.
317    
318    . The default size of internal buffer used by pcregrep can be set by, for
319      example:
320    
321      --with-pcregrep-bufsize=50K
322    
323      The default value is 20K.
324    
325    . It is possible to compile pcretest so that it links with the libreadline
326      library, by specifying
327    
328      --enable-pcretest-libreadline
329    
330      If this is done, when pcretest's input is from a terminal, it reads it using
331      the readline() function. This provides line-editing and history facilities.
332      Note that libreadline is GPL-licenced, so if you distribute a binary of
333      pcretest linked in this way, there may be licensing issues.
334    
335      Setting this option causes the -lreadline option to be added to the pcretest
336      build. In many operating environments with a sytem-installed readline
337      library this is sufficient. However, in some environments (e.g. if an
338      unmodified distribution version of readline is in use), it may be necessary
339      to specify something like LIBS="-lncurses" as well. This is because, to quote
340      the readline INSTALL, "Readline uses the termcap functions, but does not link
341      with the termcap or curses library itself, allowing applications which link
342      with readline the to choose an appropriate library." If you get error
343      messages about missing functions tgetstr, tgetent, tputs, tgetflag, or tgoto,
344      this is the problem, and linking with the ncurses library should fix it.
345    
346  The "configure" script builds the following files for the basic C library:  The "configure" script builds the following files for the basic C library:
347    
348  . Makefile is the makefile that builds the library  . Makefile             the makefile that builds the library
349  . config.h contains build-time configuration options for the library  . config.h             build-time configuration options for the library
350  . pcre.h is the public PCRE header file  . pcre.h               the public PCRE header file
351  . pcre-config is a script that shows the settings of "configure" options  . pcre-config          script that shows the building settings such as CFLAGS
352  . libpcre.pc is data for the pkg-config command                           that were set for "configure"
353  . libtool is a script that builds shared and/or static libraries  . libpcre.pc         ) data for the pkg-config command
354  . RunTest is a script for running tests on the basic C library  . libpcre16.pc       )
355  . RunGrepTest is a script for running tests on the pcregrep command  . libpcreposix.pc    )
356    . libtool              script that builds shared and/or static libraries
357  Versions of config.h and pcre.h are distributed in the PCRE tarballs under  . RunTest              script for running tests on the basic C library
358  the names config.h.generic and pcre.h.generic. These are provided for the  . RunGrepTest          script for running tests on the pcregrep command
359  benefit of those who have to built PCRE without the benefit of "configure". If  
360  you use "configure", the .generic versions are not used.  Versions of config.h and pcre.h are distributed in the PCRE tarballs under the
361    names config.h.generic and pcre.h.generic. These are provided for those who
362  If a C++ compiler is found, the following files are also built:  have to built PCRE without using "configure" or CMake. If you use "configure"
363    or CMake, the .generic versions are not used.
364  . libpcrecpp.pc is data for the pkg-config command  
365  . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper  When building the 8-bit library, if a C++ compiler is found, the following
366  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions  files are also built:
367    
368    . libpcrecpp.pc        data for the pkg-config command
369    . pcrecpparg.h         header file for calling PCRE via the C++ wrapper
370    . pcre_stringpiece.h   header for the C++ "stringpiece" functions
371    
372  The "configure" script also creates config.status, which is an executable  The "configure" script also creates config.status, which is an executable
373  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
374  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
375    
376  Once "configure" has run, you can run "make". It builds two libraries, called  Once "configure" has run, you can run "make". This builds either or both of the
377  libpcre and libpcreposix, a test program called pcretest, a demonstration  libraries libpcre and libpcre16, and a test program called pcretest. If you
378  program called pcredemo, and the pcregrep command. If a C++ compiler was found  enabled JIT support with --enable-jit, a test program called pcre_jit_test is
379  on your system, "make" also builds the C++ wrapper library, which is called  built as well.
380  libpcrecpp, and some test programs called pcrecpp_unittest,  
381  pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper  If the 8-bit library is built, libpcreposix and the pcregrep command are also
382  can be disabled by adding --disable-cpp to the "configure" command.  built, and if a C++ compiler was found on your system, and you did not disable
383    it with --disable-cpp, "make" builds the C++ wrapper library, which is called
384    libpcrecpp, as well as some test programs called pcrecpp_unittest,
385    pcre_scanner_unittest, and pcre_stringpiece_unittest.
386    
387  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
388  tests are given below in a separate section of this document.  tests are given below in a separate section of this document.
# Line 293  system. The following are installed (fil Line 393  system. The following are installed (fil
393    
394    Commands (bin):    Commands (bin):
395      pcretest      pcretest
396      pcregrep      pcregrep (if 8-bit support is enabled)
397      pcre-config      pcre-config
398    
399    Libraries (lib):    Libraries (lib):
400      libpcre      libpcre16     (if 16-bit support is enabled)
401      libpcreposix      libpcre       (if 8-bit support is enabled)
402      libpcrecpp (if C++ support is enabled)      libpcreposix  (if 8-bit support is enabled)
403        libpcrecpp    (if 8-bit and C++ support is enabled)
404    
405    Configuration information (lib/pkgconfig):    Configuration information (lib/pkgconfig):
406        libpcre16.pc
407      libpcre.pc      libpcre.pc
408        libpcreposix.pc
409      libpcrecpp.pc (if C++ support is enabled)      libpcrecpp.pc (if C++ support is enabled)
410    
411    Header files (include):    Header files (include):
# Line 316  system. The following are installed (fil Line 419  system. The following are installed (fil
419    Man pages (share/man/man{1,3}):    Man pages (share/man/man{1,3}):
420      pcregrep.1      pcregrep.1
421      pcretest.1      pcretest.1
422        pcre-config.1
423      pcre.3      pcre.3
424      pcre*.3 (lots more pages, all starting "pcre")      pcre*.3 (lots more pages, all starting "pcre")
425    
# Line 330  system. The following are installed (fil Line 434  system. The following are installed (fil
434      LICENCE      LICENCE
435      NEWS      NEWS
436      README      README
437      pcre.txt       (a concatenation of the man(3) pages)      pcre.txt         (a concatenation of the man(3) pages)
438      pcretest.txt   the pcretest man page      pcretest.txt     the pcretest man page
439      pcregrep.txt   the pcregrep man page      pcregrep.txt     the pcregrep man page
440        pcre-config.txt  the pcre-config man page
 Note that the pcredemo program that is built by "configure" is *not* installed  
 anywhere. It is a demonstration for programmers wanting to use PCRE.  
441    
442  If you want to remove PCRE from your system, you can run "make uninstall".  If you want to remove PCRE from your system, you can run "make uninstall".
443  This removes all the files that "make install" installed. However, it does not  This removes all the files that "make install" installed. However, it does not
# Line 432  running the "configure" script: Line 534  running the "configure" script:
534    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
535    
536    
537    Using Sun's compilers for Solaris
538    ---------------------------------
539    
540    A user reports that the following configurations work on Solaris 9 sparcv9 and
541    Solaris 9 x86 (32-bit):
542    
543      Solaris 9 sparcv9: ./configure --disable-cpp CC=/bin/cc CFLAGS="-m64 -g"
544      Solaris 9 x86:     ./configure --disable-cpp CC=/bin/cc CFLAGS="-g"
545    
546    
547    Using PCRE from MySQL
548    ---------------------
549    
550    On systems where both PCRE and MySQL are installed, it is possible to make use
551    of PCRE from within MySQL, as an alternative to the built-in pattern matching.
552    There is a web page that tells you how to do this:
553    
554      http://www.mysqludf.org/lib_mysqludf_preg/index.php
555    
556    
557  Making new tarballs  Making new tarballs
558  -------------------  -------------------
559    
560  The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and  The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
561  zip formats. However, if you have modified any of the man page sources in the  zip formats. The command "make distcheck" does the same, but then does a trial
562  doc directory, you should first run the PrepareRelease script. This re-creates  build of the new distribution to ensure that it works.
563  the .txt and HTML forms of the documentation from the man pages.  
564    If you have modified any of the man page sources in the doc directory, you
565    should first run the PrepareRelease script before making a distribution. This
566    script creates the .txt and HTML forms of the documentation from the man pages.
567    
568    
569  Testing PCRE  Testing PCRE
# Line 448  To test the basic PCRE library on a Unix Line 573  To test the basic PCRE library on a Unix
573  created by the configuring process. There is also a script called RunGrepTest  created by the configuring process. There is also a script called RunGrepTest
574  that tests the options of the pcregrep command. If the C++ wrapper library is  that tests the options of the pcregrep command. If the C++ wrapper library is
575  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
576  pcre_stringpiece_unittest are also built.  pcre_stringpiece_unittest are also built. When JIT support is enabled, another
577    test program called pcre_jit_test is built.
578    
579  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
580  "make test". For other systems, see the instructions in NON-UNIX-USE.  "make test". For other systems, see the instructions in NON-UNIX-USE.
581    
582  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
583  own man page) on each of the testinput files in the testdata directory in  own man page) on each of the relevant testinput files in the testdata
584  turn, and compares the output with the contents of the corresponding testoutput  directory, and compares the output with the contents of the corresponding
585  files. A file called testtry is used to hold the main output from pcretest  testoutput files. Some tests are relevant only when certain build-time options
586  (testsavedregex is also used as a working file). To run pcretest on just one of  were selected. For example, the tests for UTF-8/16 support are run only if
587  the test files, give its number as an argument to RunTest, for example:  --enable-utf was used. RunTest outputs a comment when it skips a test.
588    
589    RunTest 2  Many of the tests that are not skipped are run up to three times. The second
590    run forces pcre_study() to be called for all patterns except for a few in some
591  The first test file can also be fed directly into the perltest.pl script to  tests that are marked "never study" (see the pcretest program for how this is
592  check that Perl gives the same results. The only difference you should see is  done). If JIT support is available, the non-DFA tests are run a third time,
593  in the first few lines, where the Perl version is given instead of the PCRE  this time with a forced pcre_study() with the PCRE_STUDY_JIT_COMPILE option.
594  version.  
595    When both 8-bit and 16-bit support is enabled, the entire set of tests is run
596    twice, once for each library. If you want to run just one set of tests, call
597    RunTest with either the -8 or -16 option.
598    
599    RunTest uses a file called testtry to hold the main output from pcretest
600    (testsavedregex is also used as a working file). To run pcretest on just one or
601    more specific test files, give their numbers as arguments to RunTest, for
602    example:
603    
604      RunTest 2 7 11
605    
606    The first test file can be fed directly into the perltest.pl script to check
607    that Perl gives the same results. The only difference you should see is in the
608    first few lines, where the Perl version is given instead of the PCRE version.
609    
610  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_study(),
611  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
612  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
613  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 497  in the comparison output, it means that Line 637  in the comparison output, it means that
637  despite being listed by "locale". This does not mean that PCRE is broken.  despite being listed by "locale". This does not mean that PCRE is broken.
638    
639  [If you are trying to run this test on Windows, you may be able to get it to  [If you are trying to run this test on Windows, you may be able to get it to
640  work by changing "fr_FR" to "french" everywhere it occurs.]  work by changing "fr_FR" to "french" everywhere it occurs. Alternatively, use
641    RunTest.bat. The version of RunTest.bat included with PCRE 7.4 and above uses
642    Windows versions of test 2. More info on using RunTest.bat is included in the
643    document entitled NON-UNIX-USE.]
644    
645    The fourth and fifth tests check the UTF-8/16 support and error handling and
646    internal UTF features of PCRE that are not relevant to Perl, respectively. The
647    sixth and seventh tests do the same for Unicode character properties support.
648    
649    The eighth, ninth, and tenth tests check the pcre_dfa_exec() alternative
650    matching function, in non-UTF-8/16 mode, UTF-8/16 mode, and UTF-8/16 mode with
651    Unicode property support, respectively.
652    
653    The eleventh test checks some internal offsets and code size features; it is
654    run only when the default "link size" of 2 is set (in other cases the sizes
655    change) and when Unicode property support is enabled.
656    
657    The twelfth test is run only when JIT support is available, and the thirteenth
658    test is run only when JIT support is not available. They test some JIT-specific
659    features such as information output from pcretest about JIT compilation.
660    
661    The fourteenth, fifteenth, and sixteenth tests are run only in 8-bit mode, and
662    the seventeenth, eighteenth, and nineteenth tests are run only in 16-bit mode.
663    These are tests that generate different output in the two modes. They are for
664    general cases, UTF-8/16 support, and Unicode property support, respectively.
665    
666  The fourth test checks the UTF-8 support. It is not run automatically unless  The twentieth test is run only in 16-bit mode. It tests some specific 16-bit
667  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when  features of the DFA matching engine.
 running "configure". This file can be also fed directly to the perltest script,  
 provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,  
 commented in the script, can be be used.)  
   
 The fifth test checks error handling with UTF-8 encoding, and internal UTF-8  
 features of PCRE that are not relevant to Perl.  
   
 The sixth test checks the support for Unicode character properties. It it not  
 run automatically unless PCRE is built with Unicode property support. To to  
 this you must set --enable-unicode-properties when running "configure".  
   
 The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  
 matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode  
 property support, respectively. The eighth and ninth tests are not run  
 automatically unless PCRE is build with the relevant support.  
668    
669    
670  Character tables  Character tables
# Line 575  will cause PCRE to malfunction. Line 724  will cause PCRE to malfunction.
724  File manifest  File manifest
725  -------------  -------------
726    
727  The distribution should contain the following files:  The distribution should contain the files listed below. Where a file name is
728    given as pcre[16]_xxx it means that there are two files, one with the name
729    pcre_xxx and the other with the name pcre16_xxx.
730    
731  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
732    
# Line 584  The distribution should contain the foll Line 735  The distribution should contain the foll
735    
736    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
737                              coding; used, unless --enable-rebuild-chartables is                              coding; used, unless --enable-rebuild-chartables is
738                              specified, by copying to pcre_chartables.c                              specified, by copying to pcre[16]_chartables.c
739    
740    pcreposix.c             )    pcreposix.c             )
741    pcre_compile.c          )    pcre[16]_byte_order.c   )
742    pcre_config.c           )    pcre[16]_compile.c      )
743    pcre_dfa_exec.c         )    pcre[16]_config.c       )
744    pcre_exec.c             )    pcre[16]_dfa_exec.c     )
745    pcre_fullinfo.c         )    pcre[16]_exec.c         )
746    pcre_get.c              ) sources for the functions in the library,    pcre[16]_fullinfo.c     )
747    pcre_globals.c          )   and some internal functions that they use    pcre[16]_get.c          ) sources for the functions in the library,
748    pcre_info.c             )    pcre[16]_globals.c      )   and some internal functions that they use
749    pcre_maketables.c       )    pcre[16]_jit_compile.c  )
750    pcre_newline.c          )    pcre[16]_maketables.c   )
751      pcre[16]_newline.c      )
752      pcre[16]_refcount.c     )
753      pcre[16]_string_utils.c )
754      pcre[16]_study.c        )
755      pcre[16]_tables.c       )
756      pcre[16]_ucd.c          )
757      pcre[16]_version.c      )
758      pcre[16]_xclass.c       )
759    pcre_ord2utf8.c         )    pcre_ord2utf8.c         )
   pcre_refcount.c         )  
   pcre_study.c            )  
   pcre_tables.c           )  
   pcre_try_flipped.c      )  
   pcre_ucp_searchfuncs.c  )  
760    pcre_valid_utf8.c       )    pcre_valid_utf8.c       )
761    pcre_version.c          )    pcre16_ord2utf16.c      )
762    pcre_xclass.c           )    pcre16_utf16_utils.c    )
763    pcre_printint.src       ) debugging function that is #included in pcretest,    pcre16_valid_utf16.c    )
764    
765      pcre[16]_printint.c     ) debugging function that is used by pcretest,
766                            )   and can also be #included in pcre_compile()                            )   and can also be #included in pcre_compile()
767    
768    pcre.h.in               template for pcre.h when built by "configure"    pcre.h.in               template for pcre.h when built by "configure"
769    pcreposix.h             header for the external POSIX wrapper API    pcreposix.h             header for the external POSIX wrapper API
770    pcre_internal.h         header for internal use    pcre_internal.h         header for internal use
771    ucp.h                   ) headers concerned with    sljit/*                 16 files that make up the JIT compiler
772    ucpinternal.h           )   Unicode property handling    ucp.h                   header for Unicode property handling
   ucptable.h              ) (this one is the data table)  
773    
774    config.h.in             template for config.h, which is built by "configure"    config.h.in             template for config.h, which is built by "configure"
775    
# Line 662  The distribution should contain the foll Line 818  The distribution should contain the foll
818                            )   "configure" and config.h                            )   "configure" and config.h
819    depcomp                 ) script to find program dependencies, generated by    depcomp                 ) script to find program dependencies, generated by
820                            )   automake                            )   automake
821    doc/*.3                 man page sources for the PCRE functions    doc/*.3                 man page sources for PCRE
822    doc/*.1                 man page sources for pcregrep and pcretest    doc/*.1                 man page sources for pcregrep and pcretest
823    doc/index.html.src      the base HTML page    doc/index.html.src      the base HTML page
824    doc/html/*              HTML documentation    doc/html/*              HTML documentation
# Line 670  The distribution should contain the foll Line 826  The distribution should contain the foll
826    doc/pcretest.txt        plain text documentation of test program    doc/pcretest.txt        plain text documentation of test program
827    doc/perltest.txt        plain text documentation of Perl test program    doc/perltest.txt        plain text documentation of Perl test program
828    install-sh              a shell script for installing files    install-sh              a shell script for installing files
829      libpcre16.pc.in         template for libpcre16.pc for pkg-config
830    libpcre.pc.in           template for libpcre.pc for pkg-config    libpcre.pc.in           template for libpcre.pc for pkg-config
831      libpcreposix.pc.in      template for libpcreposix.pc for pkg-config
832    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
833    ltmain.sh               file used to build a libtool script    ltmain.sh               file used to build a libtool script
834    missing                 ) common stub for a few missing GNU programs while    missing                 ) common stub for a few missing GNU programs while
# Line 678  The distribution should contain the foll Line 836  The distribution should contain the foll
836    mkinstalldirs           script for making install directories    mkinstalldirs           script for making install directories
837    perltest.pl             Perl test program    perltest.pl             Perl test program
838    pcre-config.in          source of script which retains PCRE information    pcre-config.in          source of script which retains PCRE information
839      pcre_jit_test.c         test program for the JIT compiler
840    pcrecpp_unittest.cc          )    pcrecpp_unittest.cc          )
841    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
842    pcre_stringpiece_unittest.cc )    pcre_stringpiece_unittest.cc )
843    testdata/testinput*     test data for main library tests    testdata/testinput*     test data for main library tests
844    testdata/testoutput*    expected test results    testdata/testoutput*    expected test results
845    testdata/grep*          input and output for pcregrep tests    testdata/grep*          input and output for pcregrep tests
846      testdata/*              other supporting test files
847    
848  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
849    
850      cmake/COPYING-CMAKE-SCRIPTS
851      cmake/FindPackageHandleStandardArgs.cmake
852      cmake/FindReadline.cmake
853    CMakeLists.txt    CMakeLists.txt
854    config-cmake.h.in    config-cmake.h.in
855    
# Line 711  The distribution should contain the foll Line 874  The distribution should contain the foll
874  Philip Hazel  Philip Hazel
875  Email local part: ph10  Email local part: ph10
876  Email domain: cam.ac.uk  Email domain: cam.ac.uk
877  Last updated: 16 April 2007  Last updated: 30 December 2011

Legend:
Removed from v.149  
changed lines
  Added in v.840

  ViewVC Help
Powered by ViewVC 1.1.5