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

Diff of /code/trunk/README

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

revision 109 by ph10, Wed Mar 7 15:35:57 2007 UTC revision 312 by ph10, Wed Jan 23 18:02:23 2008 UTC
# Line 5  The latest release of PCRE is always ava Line 5  The latest release of PCRE is always ava
5    
6    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
7    
8    There is a mailing list for discussion about the development of PCRE at
9    
10      pcre-dev@exim.org
11    
12  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.
13  The contents of this README file are:  The contents of this README file are:
14    
# Line 12  The contents of this README file are: Line 16  The contents of this README file are:
16    Documentation for PCRE    Documentation for PCRE
17    Contributions by users of PCRE    Contributions by users of PCRE
18    Building PCRE on non-Unix systems    Building PCRE on non-Unix systems
19    Building PCRE on a Unix-like system    Building PCRE on Unix-like systems
20    Retrieving configuration information on a Unix-like system    Retrieving configuration information on Unix-like systems
21    Shared libraries on Unix-like systems    Shared libraries on Unix-like systems
22    Cross-compiling on a Unix-like system    Cross-compiling on Unix-like systems
23    Using HP's ANSI C++ compiler (aCC)    Using HP's ANSI C++ compiler (aCC)
24      Making new tarballs
25    Testing PCRE    Testing PCRE
26    Character tables    Character tables
27    File manifest    File manifest
# Line 25  The contents of this README file are: Line 30  The contents of this README file are:
30  The PCRE APIs  The PCRE APIs
31  -------------  -------------
32    
33  PCRE is written in C, and it has its own API. The distribution now includes a  PCRE is written in C, and it has its own API. The distribution also includes a
34  set of C++ wrapper functions, courtesy of Google Inc. (see the pcrecpp man page  set of C++ wrapper functions (see the pcrecpp man page for details), courtesy
35  for details).  of Google Inc.
36    
37  Also included in the distribution are a set of C wrapper functions that are  In addition, there is a set of C wrapper functions that are based on the POSIX
38  based on the POSIX API. These end up in the library called libpcreposix. Note  regular expression API (see the pcreposix man page). These end up in the
39  that this just provides a POSIX calling interface to PCRE; the regular  library called libpcreposix. Note that this just provides a POSIX calling
40  expressions themselves still follow Perl syntax and semantics. The POSIX API is  interface to PCRE; the regular expressions themselves still follow Perl syntax
41  restricted, and does not give full access to all of PCRE's facilities.  and semantics. The POSIX API is restricted, and does not give full access to
42    all of PCRE's facilities.
43    
44  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
45  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 48  ensure that they link with PCRE's libpcr Line 54  ensure that they link with PCRE's libpcr
54  up the POSIX functions of the same name from the other library.  up the POSIX functions of the same name from the other library.
55    
56  One way of avoiding this confusion is to compile PCRE with the addition of  One way of avoiding this confusion is to compile PCRE with the addition of
57  -Dregcomp=PCREregcomp (and similarly for the other functions) to the compiler  -Dregcomp=PCREregcomp (and similarly for the other POSIX functions) to the
58  flags (CFLAGS if you are using "configure" -- see below). This has the effect  compiler flags (CFLAGS if you are using "configure" -- see below). This has the
59  of renaming the functions so that the names no longer clash. Of course, you  effect of renaming the functions so that the names no longer clash. Of course,
60  have to do the same thing for your applications, or write them using the new  you have to do the same thing for your applications, or write them using the
61  names.  new names.
62    
63    
64  Documentation for PCRE  Documentation for PCRE
65  ----------------------  ----------------------
66    
67  If you install PCRE in the normal way, you will end up with an installed set of  If you install PCRE in the normal way on a Unix-like system, you will end up
68  man pages whose names all start with "pcre". The one that is just called "pcre"  with a set of man pages whose names all start with "pcre". The one that is just
69  lists all the others. In addition to these man pages, the PCRE documentation is  called "pcre" lists all the others. In addition to these man pages, the PCRE
70  supplied in two other forms:  documentation is supplied in two other forms:
71    
72    1. There are files called doc/pcre.txt, doc/pcregrep.txt, and    1. There are files called doc/pcre.txt, doc/pcregrep.txt, and
73       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
# Line 69  supplied in two other forms: Line 75  supplied in two other forms:
75       those that summarize individual functions. The other two are the text       those that summarize individual functions. The other two are the text
76       forms of the section 1 man pages for the pcregrep and pcretest commands.       forms of the section 1 man pages for the pcregrep and pcretest commands.
77       These text forms are provided for ease of scanning with text editors or       These text forms are provided for ease of scanning with text editors or
78       similar tools.       similar tools. They are installed in <prefix>/share/doc/pcre, where
79         <prefix> is the installation prefix (defaulting to /usr/local).
80    
81    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
82       in various ways, and rooted in a file called index.html, is installed in       in various ways, and rooted in a file called index.html, is distributed in
83       the directory <prefix>/share/doc/pcre/html, where <prefix> is the       doc/html and installed in <prefix>/share/doc/pcre/html.
      installation prefix (defaulting to /usr/local).  
84    
85    
86  Contributions by users of PCRE  Contributions by users of PCRE
# Line 84  You can find contributions from PCRE use Line 90  You can find contributions from PCRE use
90    
91    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
92    
93  where there is also a README file giving brief descriptions of what they are.  There is a README file giving brief descriptions of what they are. Some are
94  Some are complete in themselves; others are pointers to URLs containing  complete in themselves; others are pointers to URLs containing relevant files.
95  relevant files. Some of this material is likely to be well out-of-date. In  Some of this material is likely to be well out-of-date. Several of the earlier
96  particular, several of the contributions provide support for compiling PCRE on  contributions provided support for compiling PCRE on various flavours of
97  various flavours of Windows (I myself do not use Windows), but it is hoped that  Windows (I myself do not use Windows). Nowadays there is more Windows support
98  more Windows support will find its way into the standard distribution.  in the standard distribution, so these contibutions have been archived.
99    
100    
101  Building PCRE on non-Unix systems  Building PCRE on non-Unix systems
102  ---------------------------------  ---------------------------------
103    
104  For a non-Unix system, read the comments in the file NON-UNIX-USE, though if  For a non-Unix system, please read the comments in the file NON-UNIX-USE,
105  the system supports the use of "configure" and "make" you may be able to build  though if your system supports the use of "configure" and "make" you may be
106  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
107    configured in many platform environments using the GUI facility of CMake's
108    CMakeSetup. It creates Makefiles, solution files, etc.
109    
110  PCRE has been compiled on many different operating systems. It should be  PCRE has been compiled on many different operating systems. It should be
111  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
112  library, because it uses only Standard C functions.  library, because it uses only Standard C functions.
113    
114    
115  Building PCRE on a Unix-like system  Building PCRE on Unix-like systems
116  -----------------------------------  ----------------------------------
117    
118  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
119  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
120    
121    The following instructions assume the use of the widely used "configure, make,
122    make install" process. There is also some experimental support for "cmake" in
123    the PCRE distribution, but it is incomplete and not documented. However, if you
124    are a "cmake" user, you might want to try it.
125    
126  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
127  PCRE distribution directory, with your current directory set to the directory  PCRE distribution directory, with your current directory set to the directory
128  where you want the files to be created. This command is a standard GNU  where you want the files to be created. This command is a standard GNU
129  "autoconf" configuration script, for which generic instructions are supplied in  "autoconf" configuration script, for which generic instructions are supplied in
130  INSTALL.  the file INSTALL.
131    
132  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
133  this case, on many systems, just running "./configure" is sufficient. However,  this case, on many systems, just running "./configure" is sufficient. However,
# Line 142  library. You can read more about them in Line 155  library. You can read more about them in
155    
156  . If you want to suppress the building of the C++ wrapper library, you can add  . If you want to suppress the building of the C++ wrapper library, you can add
157    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
158    will try to find a C++ compiler and C++ header files, and if it succeeds, it    it will try to find a C++ compiler and C++ header files, and if it succeeds,
159    will try to build the C++ wrapper.    it will try to build the C++ wrapper.
160    
161  . If you want to make use of the support for UTF-8 character strings in PCRE,  . If you want to make use of the support for UTF-8 character strings in PCRE,
162    you must add --enable-utf8 to the "configure" command. Without it, the code    you must add --enable-utf8 to the "configure" command. Without it, the code
# Line 158  library. You can read more about them in Line 171  library. You can read more about them in
171    supported.    supported.
172    
173  . 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
174    of the Unicode newline sequences as indicating the end of a line. Whatever    of the preceding, or any of the Unicode newline sequences as indicating the
175    you specify at build time is the default; the caller of PCRE can change the    end of a line. Whatever you specify at build time is the default; the caller
176    selection at run time. The default newline indicator is a single LF character    of PCRE can change the selection at run time. The default newline indicator
177    (the Unix standard). You can specify the default newline indicator by adding    is a single LF character (the Unix standard). You can specify the default
178    --newline-is-cr or --newline-is-lf or --newline-is-crlf or --newline-is-any    newline indicator by adding --enable-newline-is-cr or --enable-newline-is-lf
179    to the "configure" command, respectively.    or --enable-newline-is-crlf or --enable-newline-is-anycrlf or
180      --enable-newline-is-any to the "configure" command, respectively.
181    If you specify --newline-is-cr or --newline-is-crlf, some of the standard  
182    tests will fail, because the lines in the test files end with LF. Even if    If you specify --enable-newline-is-cr or --enable-newline-is-crlf, some of
183    the files are edited to change the line endings, there are likely to be some    the standard tests will fail, because the lines in the test files end with
184    failures. With --newline-is-any, many tests should succeed, but there may be    LF. Even if the files are edited to change the line endings, there are likely
185    some failures.    to be some failures. With --enable-newline-is-anycrlf or
186      --enable-newline-is-any, many tests should succeed, but there may be some
187      failures.
188    
189    . By default, the sequence \R in a pattern matches any Unicode line ending
190      sequence. This is independent of the option specifying what PCRE considers to
191      be the end of a line (see above). However, the caller of PCRE can restrict \R
192      to match only CR, LF, or CRLF. You can make this the default by adding
193      --enable-bsr-anycrlf to the "configure" command (bsr = "backslash R").
194    
195  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
196    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
197    them. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
198    
199    --with-posix-malloc-threshold=20    --with-posix-malloc-threshold=20
200    
# Line 186  library. You can read more about them in Line 207  library. You can read more about them in
207    --with-match-limit=500000    --with-match-limit=500000
208    
209    on the "configure" command. This is just the default; individual calls to    on the "configure" command. This is just the default; individual calls to
210    pcre_exec() can supply their own value. There is discussion on the pcreapi    pcre_exec() can supply their own value. There is more discussion on the
211    man page.    pcreapi man page.
212    
213  . There is a separate counter that limits the depth of recursive function calls  . There is a separate counter that limits the depth of recursive function calls
214    during a matching process. This also has a default of ten million, which is    during a matching process. This also has a default of ten million, which is
# Line 202  library. You can read more about them in Line 223  library. You can read more about them in
223  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
224    this by adding --with-link-size=3 to the "configure" command. You can    this by adding --with-link-size=3 to the "configure" command. You can
225    increase it even more by setting --with-link-size=4, but this is unlikely    increase it even more by setting --with-link-size=4, but this is unlikely
226    ever to be necessary. If you build PCRE with an increased link size, test 2    ever to be necessary. Increasing the internal link size will reduce
227    (and 5 if you are using UTF-8) will fail. Part of the output of these tests    performance.
   is a representation of the compiled pattern, and this changes with the link  
   size.  
228    
229  . 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
230    pcre_exec() does not call itself recursively. Instead, it uses blocks of data    pcre_exec() does not call itself recursively. Instead, it uses memory blocks
231    from the heap via special functions pcre_stack_malloc() and pcre_stack_free()    obtained from the heap via the special functions pcre_stack_malloc() and
232    to save data that would otherwise be saved on the stack. To build PCRE like    pcre_stack_free() to save data that would otherwise be saved on the stack. To
233    this, use    build PCRE like this, use
234    
235    --disable-stack-for-recursion    --disable-stack-for-recursion
236    
237    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
238    necessary in environments with limited stack sizes. This applies only to the    necessary in environments with limited stack sizes. This applies only to the
239    pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not    pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not
240    use deeply nested recursion.    use deeply nested recursion. There is a discussion about stack sizes in the
241      pcrestack man page.
242    
243    . For speed, PCRE uses four tables for manipulating and identifying characters
244      whose code point values are less than 256. By default, it uses a set of
245      tables for ASCII encoding that is part of the distribution. If you specify
246    
247      --enable-rebuild-chartables
248    
249      a program called dftables is compiled and run in the default C locale when
250      you obey "make". It builds a source file called pcre_chartables.c. If you do
251      not specify this option, pcre_chartables.c is created as a copy of
252      pcre_chartables.c.dist. See "Character tables" below for further information.
253    
254    . It is possible to compile PCRE for use on systems that use EBCDIC as their
255      default character code (as opposed to ASCII) by specifying
256    
257      --enable-ebcdic
258    
259      This automatically implies --enable-rebuild-chartables (see above).
260    
261    . It is possible to compile pcregrep to use libz and/or libbz2, in order to
262      read .gz and .bz2 files (respectively), by specifying one or both of
263    
264      --enable-pcregrep-libz
265      --enable-pcregrep-libbz2
266    
267      Of course, the relevant libraries must be installed on your system.
268    
269    . It is possible to compile pcretest so that it links with the libreadline
270      library, by specifying
271    
272      --enable-pcretest-libreadline
273    
274      If this is done, when pcretest's input is from a terminal, it reads it using
275      the readline() function. This provides line-editing and history facilities.
276      Note that libreadline is GPL-licenced, so if you distribute a binary of
277      pcretest linked in this way, there may be licensing issues.
278    
279  The "configure" script builds the following files for the basic C library:  The "configure" script builds the following files for the basic C library:
280    
# Line 231  The "configure" script builds the follow Line 287  The "configure" script builds the follow
287  . RunTest is a script for running tests on the basic C library  . RunTest is a script for running tests on the basic C library
288  . RunGrepTest is a script for running tests on the pcregrep command  . RunGrepTest is a script for running tests on the pcregrep command
289    
290  Versions of config.h and pcre.h are distributed in the PCRE tarballs. These are  Versions of config.h and pcre.h are distributed in the PCRE tarballs under
291  provided for the benefit of those who have to compile PCRE without the benefit  the names config.h.generic and pcre.h.generic. These are provided for the
292  of "configure". If you use "configure", the distributed copies are replaced.  benefit of those who have to built PCRE without the benefit of "configure". If
293    you use "configure", the .generic versions are not used.
294    
295  If a C++ compiler is found, the following files are also built:  If a C++ compiler is found, the following files are also built:
296    
# Line 246  script that can be run to recreate the c Line 303  script that can be run to recreate the c
303  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
304    
305  Once "configure" has run, you can run "make". It builds two libraries, called  Once "configure" has run, you can run "make". It builds two libraries, called
306  libpcre and libpcreposix, a test program called pcretest, a demonstration  libpcre and libpcreposix, a test program called pcretest, and the pcregrep
307  program called pcredemo, and the pcregrep command. If a C++ compiler was found  command. If a C++ compiler was found on your system, "make" also builds the C++
308  on your system, it also builds the C++ wrapper library, which is called  wrapper library, which is called libpcrecpp, and some test programs called
309  libpcrecpp, and some test programs called pcrecpp_unittest,  pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.
310  pcre_scanner_unittest, and pcre_stringpiece_unittest.  Building the C++ wrapper can be disabled by adding --disable-cpp to the
311    "configure" command.
312    
313  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
314  tests are given below in a separate section of this document.  tests are given below in a separate section of this document.
# Line 262  system. The following are installed (fil Line 320  system. The following are installed (fil
320    Commands (bin):    Commands (bin):
321      pcretest      pcretest
322      pcregrep      pcregrep
323      pcre-config      pcre-config
324    
325    Libraries (lib):    Libraries (lib):
326      libpcre      libpcre
# Line 271  system. The following are installed (fil Line 329  system. The following are installed (fil
329    
330    Configuration information (lib/pkgconfig):    Configuration information (lib/pkgconfig):
331      libpcre.pc      libpcre.pc
332      libpcrecpp.ps (if C++ support is enabled)      libpcrecpp.pc (if C++ support is enabled)
333    
334    Header files (include):    Header files (include):
335      pcre.h      pcre.h
# Line 295  system. The following are installed (fil Line 353  system. The following are installed (fil
353      AUTHORS      AUTHORS
354      COPYING      COPYING
355      ChangeLog      ChangeLog
     INSTALL  
356      LICENCE      LICENCE
     NON-UNIX-USE  
357      NEWS      NEWS
358      README      README
359      pcre.txt       (a concatenation of the man(3) pages)      pcre.txt       (a concatenation of the man(3) pages)
360      pcretest.txt   the pcretest man page      pcretest.txt   the pcretest man page
361      pcregrep.txt   the pcregrep man page      pcregrep.txt   the pcregrep man page
     perltest.txt   some information about the perltest.pl script  
   
 Note that the pcredemo program that is built by "configure" is *not* installed  
 anywhere. It is a demonstration for programmers wanting to use PCRE.  
362    
363  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".
364  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
365  remove any directories, because these are often shared with other programs.  remove any directories, because these are often shared with other programs.
366    
367    
368  Retrieving configuration information on a Unix-like system  Retrieving configuration information on Unix-like systems
369  ----------------------------------------------------------  ---------------------------------------------------------
370    
371  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
372  recall information about the PCRE configuration and installation. For example:  recall information about the PCRE configuration and installation. For example:
# Line 353  built. The programs pcretest and pcregre Line 405  built. The programs pcretest and pcregre
405  libraries (by means of wrapper scripts in the case of shared libraries). When  libraries (by means of wrapper scripts in the case of shared libraries). When
406  you use "make install" to install shared libraries, pcregrep and pcretest are  you use "make install" to install shared libraries, pcregrep and pcretest are
407  automatically re-built to use the newly installed shared libraries before being  automatically re-built to use the newly installed shared libraries before being
408  installed themselves. However, the versions left in the source directory still  installed themselves. However, the versions left in the build directory still
409  use the uninstalled libraries.  use the uninstalled libraries.
410    
411  To build PCRE using static libraries only you must use --disable-shared when  To build PCRE using static libraries only you must use --disable-shared when
# Line 365  Then run "make" in the usual way. Simila Line 417  Then run "make" in the usual way. Simila
417  build only shared libraries.  build only shared libraries.
418    
419    
420  Cross-compiling on a Unix-like system  Cross-compiling on Unix-like systems
421  -------------------------------------  ------------------------------------
422    
423  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
424  order to cross-compile PCRE for some other host. However, during the building  order to cross-compile PCRE for some other host. However, you should NOT
425  process, the dftables.c source file is compiled *and run* on the local host, in  specify --enable-rebuild-chartables, because if you do, the dftables.c source
426  order to generate the default character tables (the chartables.c file). It  file is compiled and run on the local host, in order to generate the inbuilt
427  therefore needs to be compiled with the local compiler, not the cross compiler.  character tables (the pcre_chartables.c file). This will probably not work,
428  You can do this by specifying CC_FOR_BUILD (and if necessary CFLAGS_FOR_BUILD;  because dftables.c needs to be compiled with the local compiler, not the cross
429  there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)  compiler.
430  when calling the "configure" command. If they are not specified, they default  
431  to the values of CC and CFLAGS.  When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
432    by making a copy of pcre_chartables.c.dist, which is a default set of tables
433    that assumes ASCII code. Cross-compiling with the default tables should not be
434    a problem.
435    
436    If you need to modify the character tables when cross-compiling, you should
437    move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
438    run it on the local host to make a new version of pcre_chartables.c.dist.
439    Then when you cross-compile PCRE this new version of the tables will be used.
440    
441    
442  Using HP's ANSI C++ compiler (aCC)  Using HP's ANSI C++ compiler (aCC)
443  ----------------------------------  ----------------------------------
444    
445  Unless C++ support is disabled by specifying the "--disable-cpp" option of the  Unless C++ support is disabled by specifying the "--disable-cpp" option of the
446  "configure" script, you *must* include the "-AA" option in the CXXFLAGS  "configure" script, you must include the "-AA" option in the CXXFLAGS
447  environment variable in order for the C++ components to compile correctly.  environment variable in order for the C++ components to compile correctly.
448    
449  Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby  Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby
# Line 395  running the "configure" script: Line 455  running the "configure" script:
455    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
456    
457    
458    Making new tarballs
459    -------------------
460    
461    The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
462    zip formats. The command "make distcheck" does the same, but then does a trial
463    build of the new distribution to ensure that it works.
464    
465    If you have modified any of the man page sources in the doc directory, you
466    should first run the PrepareRelease script before making a distribution. This
467    script creates the .txt and HTML forms of the documentation from the man pages.
468    
469    
470  Testing PCRE  Testing PCRE
471  ------------  ------------
472    
473  To test PCRE on a Unix system, run the RunTest script that is created by the  To test the basic PCRE library on a Unix system, run the RunTest script that is
474  configuring process. There is also a script called RunGrepTest that tests the  created by the configuring process. There is also a script called RunGrepTest
475  options of the pcregrep command. If the C++ wrapper library is build, three  that tests the options of the pcregrep command. If the C++ wrapper library is
476  test programs called pcrecpp_unittest, pcre_scanner_unittest, and  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
477  pcre_stringpiece_unittest are also built.  pcre_stringpiece_unittest are also built.
478    
479  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
480  "make test". For other systems, see the instructions in NON-UNIX-USE.  "make test". For other systems, see the instructions in NON-UNIX-USE.
481    
482  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
483  own man page) on each of the testinput files (in the testdata directory) in  own man page) on each of the testinput files in the testdata directory in
484  turn, and compares the output with the contents of the corresponding testoutput  turn, and compares the output with the contents of the corresponding testoutput
485  files. A file called testtry is used to hold the main output from pcretest  files. A file called testtry is used to hold the main output from pcretest
486  (testsavedregex is also used as a working file). To run pcretest on just one of  (testsavedregex is also used as a working file). To run pcretest on just one of
# Line 424  version. Line 496  version.
496  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
497  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
498  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
499  wrapper API. It also uses the debugging flag to check some of the internals of  wrapper API. It also uses the debugging flags to check some of the internals of
500  pcre_compile().  pcre_compile().
501    
502  If you build PCRE with a locale setting that is not the standard C locale, the  If you build PCRE with a locale setting that is not the standard C locale, the
# Line 450  is output to say why. If running this te Line 522  is output to say why. If running this te
522  in the comparison output, it means that locale is not available on your system,  in the comparison output, it means that locale is not available on your system,
523  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.
524    
525    [If you are trying to run this test on Windows, you may be able to get it to
526    work by changing "fr_FR" to "french" everywhere it occurs. Alternatively, use
527    RunTest.bat. The version of RunTest.bat included with PCRE 7.4 and above uses
528    Windows versions of test 2. More info on using RunTest.bat is included in the
529    document entitled NON-UNIX-USE.]
530    
531  The fourth test checks the UTF-8 support. It is not run automatically unless  The fourth test checks the UTF-8 support. It is not run automatically unless
532  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when
533  running "configure". This file can be also fed directly to the perltest script,  running "configure". This file can be also fed directly to the perltest script,
# Line 459  commented in the script, can be be used. Line 537  commented in the script, can be be used.
537  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8
538  features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
539    
540  The sixth and test checks the support for Unicode character properties. It it  The sixth test checks the support for Unicode character properties. It it not
541  not run automatically unless PCRE is built with Unicode property support. To to  run automatically unless PCRE is built with Unicode property support. To to
542  this you must set --enable-unicode-properties when running "configure".  this you must set --enable-unicode-properties when running "configure".
543    
544  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative
# Line 472  automatically unless PCRE is build with Line 550  automatically unless PCRE is build with
550  Character tables  Character tables
551  ----------------  ----------------
552    
553  PCRE uses four tables for manipulating and identifying characters whose values  For speed, PCRE uses four tables for manipulating and identifying characters
554  are less than 256. The final argument of the pcre_compile() function is a  whose code point values are less than 256. The final argument of the
555  pointer to a block of memory containing the concatenated tables. A call to  pcre_compile() function is a pointer to a block of memory containing the
556  pcre_maketables() can be used to generate a set of tables in the current  concatenated tables. A call to pcre_maketables() can be used to generate a set
557  locale. If the final argument for pcre_compile() is passed as NULL, a set of  of tables in the current locale. If the final argument for pcre_compile() is
558  default tables that is built into the binary is used.  passed as NULL, a set of default tables that is built into the binary is used.
559    
560  The source file called chartables.c contains the default set of tables. This is  The source file called pcre_chartables.c contains the default set of tables. By
561  not supplied in the distribution, but is built by the program dftables  default, this is created as a copy of pcre_chartables.c.dist, which contains
562  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
563  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
564  sources. This means that the default C locale which is set for your system will  program dftables (compiled from dftables.c), which uses the ANSI C character
565  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
566  by editing chartables.c and then re-building PCRE. If you do this, you should  build the table sources. This means that the default C locale which is set for
567  probably also edit Makefile to ensure that the file doesn't ever get  your system will control the contents of these default tables. You can change
568  re-generated.  the default tables by editing pcre_chartables.c and then re-building PCRE. If
569    you do this, you should take care to ensure that the file does not get
570    automatically re-generated. The best way to do this is to move
571    pcre_chartables.c.dist out of the way and replace it with your customized
572    tables.
573    
574    When the dftables program is run as a result of --enable-rebuild-chartables,
575    it uses the default C locale that is set on your system. It does not pay
576    attention to the LC_xxx environment variables. In other words, it uses the
577    system's default locale rather than whatever the compiling user happens to have
578    set. If you really do want to build a source set of character tables in a
579    locale that is specified by the LC_xxx variables, you can run the dftables
580    program by hand with the -L option. For example:
581    
582      ./dftables -L pcre_chartables.c.special
583    
584  The first two 256-byte tables provide lower casing and case flipping functions,  The first two 256-byte tables provide lower casing and case flipping functions,
585  respectively. The next table consists of three 32-byte bit maps which identify  respectively. The next table consists of three 32-byte bit maps which identify
586  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
587  building 32-byte bit maps that represent character classes for code points less  building 32-byte bit maps that represent character classes for code points less
588  than 256.  than 256.
589    
590  The final 256-byte table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
# Line 516  The distribution should contain the foll Line 608  The distribution should contain the foll
608    
609  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
610    
611    dftables.c             auxiliary program for building chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
612                                when --enable-rebuild-chartables is specified
613    pcreposix.c            )  
614    pcre_compile.c         )    pcre_chartables.c.dist  a default set of character tables that assume ASCII
615    pcre_config.c          )                              coding; used, unless --enable-rebuild-chartables is
616    pcre_dfa_exec.c        )                              specified, by copying to pcre_chartables.c
617    pcre_exec.c            )  
618    pcre_fullinfo.c        )    pcreposix.c             )
619    pcre_get.c             ) sources for the functions in the library,    pcre_compile.c          )
620    pcre_globals.c         )   and some internal functions that they use    pcre_config.c           )
621    pcre_info.c            )    pcre_dfa_exec.c         )
622    pcre_maketables.c      )    pcre_exec.c             )
623    pcre_newline.c         )    pcre_fullinfo.c         )
624    pcre_ord2utf8.c        )    pcre_get.c              ) sources for the functions in the library,
625    pcre_refcount.c        )    pcre_globals.c          )   and some internal functions that they use
626    pcre_study.c           )    pcre_info.c             )
627    pcre_tables.c          )    pcre_maketables.c       )
628    pcre_try_flipped.c     )    pcre_newline.c          )
629    pcre_ucp_searchfuncs.c )    pcre_ord2utf8.c         )
630    pcre_valid_utf8.c      )    pcre_refcount.c         )
631    pcre_version.c         )    pcre_study.c            )
632    pcre_xclass.c          )    pcre_tables.c           )
633    pcre_printint.src      ) debugging function that is #included in pcretest,    pcre_try_flipped.c      )
634                           )   and can also be #included in pcre_compile()    pcre_ucp_searchfuncs.c  )
635    pcre.h                 ) a version of the public PCRE header file    pcre_valid_utf8.c       )
636                           )   for use in non-"configure" environments    pcre_version.c          )
637    pcre.h.in              template for pcre.h when built by "configure"    pcre_xclass.c           )
638    pcreposix.h            header for the external POSIX wrapper API    pcre_printint.src       ) debugging function that is #included in pcretest,
639    pcre_internal.h        header for internal use                            )   and can also be #included in pcre_compile()
640    ucp.h                  ) headers concerned with    pcre.h.in               template for pcre.h when built by "configure"
641    ucpinternal.h          )   Unicode property handling    pcreposix.h             header for the external POSIX wrapper API
642    ucptable.h             ) (this one is the data table)    pcre_internal.h         header for internal use
643      ucp.h                   ) headers concerned with
644    config.h               ) a version of config.h for use in non-"configure"    ucpinternal.h           )   Unicode property handling
645                           )   environments    ucptable.h              ) (this one is the data table)
646    config.h.in            template for config.h when built by "configure"  
647      config.h.in             template for config.h, which is built by "configure"
648    pcrecpp.h              public header file for the C++ wrapper  
649    pcrecpparg.h.in        template for another C++ header file    pcrecpp.h               public header file for the C++ wrapper
650    pcre_scanner.h         public header file for C++ scanner functions    pcrecpparg.h.in         template for another C++ header file
651    pcrecpp.cc             )    pcre_scanner.h          public header file for C++ scanner functions
652    pcre_scanner.cc        ) source for the C++ wrapper library    pcrecpp.cc              )
653      pcre_scanner.cc         ) source for the C++ wrapper library
654    pcre_stringpiece.h.in  template for pcre_stringpiece.h, the header for the  
655                             C++ stringpiece functions    pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
656    pcre_stringpiece.cc    source for the C++ stringpiece functions                              C++ stringpiece functions
657      pcre_stringpiece.cc     source for the C++ stringpiece functions
658    
659  (B) Source files for programs that use PCRE:  (B) Source files for programs that use PCRE:
660    
661    pcredemo.c             simple demonstration of coding calls to PCRE    pcredemo.c              simple demonstration of coding calls to PCRE
662    pcregrep.c             source of a grep utility that uses PCRE    pcregrep.c              source of a grep utility that uses PCRE
663    pcretest.c             comprehensive test program    pcretest.c              comprehensive test program
664    
665  (C) Auxiliary files:  (C) Auxiliary files:
666    
667    AUTHORS                information about the author of PCRE    132html                 script to turn "man" pages into HTML
668    ChangeLog              log of changes to the code    AUTHORS                 information about the author of PCRE
669    INSTALL                generic installation instructions    ChangeLog               log of changes to the code
670    LICENCE                conditions for the use of PCRE    CleanTxt                script to clean nroff output for txt man pages
671    COPYING                the same, using GNU's standard name    Detrail                 script to remove trailing spaces
672    Makefile.in            ) template for Unix Makefile, which is built by    HACKING                 some notes about the internals of PCRE
673                           )   "configure"    INSTALL                 generic installation instructions
674    Makefile.am            ) the automake input that was used to create    LICENCE                 conditions for the use of PCRE
675                           )   Makefile.in    COPYING                 the same, using GNU's standard name
676    NEWS                   important changes in this release    Makefile.in             ) template for Unix Makefile, which is built by
677    NON-UNIX-USE           notes on building PCRE on non-Unix systems                            )   "configure"
678    README                 this file    Makefile.am             ) the automake input that was used to create
679    RunTest.in             template for a Unix shell script for running tests                            )   Makefile.in
680    RunGrepTest.in         template for a Unix shell script for pcregrep tests    NEWS                    important changes in this release
681    aclocal.m4             m4 macros (generated by "aclocal")    NON-UNIX-USE            notes on building PCRE on non-Unix systems
682    config.guess           ) files used by libtool,    PrepareRelease          script to make preparations for "make dist"
683    config.sub             )   used only when building a shared library    README                  this file
684    configure              a configuring shell script (built by autoconf)    RunTest                 a Unix shell script for running tests
685    configure.ac           ) the autoconf input that was used to build    RunGrepTest             a Unix shell script for pcregrep tests
686                           )   "configure" and config.h    aclocal.m4              m4 macros (generated by "aclocal")
687    depcomp                ) script to find program dependencies, generated by    config.guess            ) files used by libtool,
688                           )   automake    config.sub              )   used only when building a shared library
689    doc/*.3                man page sources for the PCRE functions    configure               a configuring shell script (built by autoconf)
690    doc/*.1                man page sources for pcregrep and pcretest    configure.ac            ) the autoconf input that was used to build
691    doc/html/*             HTML documentation                            )   "configure" and config.h
692    doc/pcre.txt           plain text version of the man pages    depcomp                 ) script to find program dependencies, generated by
693    doc/pcretest.txt       plain text documentation of test program                            )   automake
694    doc/perltest.txt       plain text documentation of Perl test program    doc/*.3                 man page sources for the PCRE functions
695    install-sh             a shell script for installing files    doc/*.1                 man page sources for pcregrep and pcretest
696    libpcre.pc.in          template for libpcre.pc for pkg-config    doc/index.html.src      the base HTML page
697    libpcrecpp.pc.in       template for libpcrecpp.pc for pkg-config    doc/html/*              HTML documentation
698    ltmain.sh              file used to build a libtool script    doc/pcre.txt            plain text version of the man pages
699    missing                ) common stub for a few missing GNU programs while    doc/pcretest.txt        plain text documentation of test program
700                           )   installing, generated by automake    doc/perltest.txt        plain text documentation of Perl test program
701    mkinstalldirs          script for making install directories    install-sh              a shell script for installing files
702    perltest.pl            Perl test program    libpcre.pc.in           template for libpcre.pc for pkg-config
703    pcre-config.in         source of script which retains PCRE information    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
704    pcrecpp_unittest.c           )    ltmain.sh               file used to build a libtool script
705    pcre_scanner_unittest.c      ) test programs for the C++ wrapper    missing                 ) common stub for a few missing GNU programs while
706    pcre_stringpiece_unittest.c  )                            )   installing, generated by automake
707    testdata/testinput*    test data for main library tests    mkinstalldirs           script for making install directories
708    testdata/testoutput*   expected test results    perltest.pl             Perl test program
709    testdata/grep*         input and output for pcregrep tests    pcre-config.in          source of script which retains PCRE information
710      pcrecpp_unittest.cc          )
711      pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
712      pcre_stringpiece_unittest.cc )
713      testdata/testinput*     test data for main library tests
714      testdata/testoutput*    expected test results
715      testdata/grep*          input and output for pcregrep tests
716    
717  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
718    
719    CMakeLists.txt    CMakeLists.txt
720    config-cmake.h.in    config-cmake.h.in
721    
722  (E) Auxiliary files for VPASCAL  (E) Auxiliary files for VPASCAL
723    
724    makevp.bat    makevp.bat
725    !compile.txt    makevp_c.txt
726    !linklib.txt    makevp_l.txt
727    pcregexp.pas    pcregexp.pas
728    
729    (F) Auxiliary files for building PCRE "by hand"
730    
731      pcre.h.generic          ) a version of the public PCRE header file
732                              )   for use in non-"configure" environments
733      config.h.generic        ) a version of config.h for use in non-"configure"
734                              )   environments
735    
736  (F) Miscellaneous  (F) Miscellaneous
737    
738    RunTest.bat            a script for running tests under Windows    RunTest.bat            a script for running tests under Windows
# Line 634  The distribution should contain the foll Line 740  The distribution should contain the foll
740  Philip Hazel  Philip Hazel
741  Email local part: ph10  Email local part: ph10
742  Email domain: cam.ac.uk  Email domain: cam.ac.uk
743  Last updated: March 2007  Last updated: 23 January 2008

Legend:
Removed from v.109  
changed lines
  Added in v.312

  ViewVC Help
Powered by ViewVC 1.1.5