/[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 149 by ph10, Mon Apr 16 15:28:08 2007 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.
107    
108  PCRE has been compiled on many different operating systems. It should be  PCRE has been compiled on many different operating systems. It should be
109  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
110  library, because it uses only Standard C functions.  library, because it uses only Standard C functions.
111    
112    
113  Building PCRE on a Unix-like system  Building PCRE on Unix-like systems
114  -----------------------------------  ----------------------------------
115    
116  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
117  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
118    
119    The following instructions assume the use of the widely used "configure, make,
120    make install" process. There is also some experimental support for "cmake" in
121    the PCRE distribution, but it is incomplete and not documented. However, if you
122    are a "cmake" user, you might want to try it.
123    
124  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
125  PCRE distribution directory, with your current directory set to the directory  PCRE distribution directory, with your current directory set to the directory
126  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
127  "autoconf" configuration script, for which generic instructions are supplied in  "autoconf" configuration script, for which generic instructions are supplied in
128  INSTALL.  the file INSTALL.
129    
130  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
131  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 153  library. You can read more about them in
153    
154  . 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
155    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
156    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,
157    will try to build the C++ wrapper.    it will try to build the C++ wrapper.
158    
159  . 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,
160    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 169  library. You can read more about them in
169    supported.    supported.
170    
171  . 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
172    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
173    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
174    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
175    (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
176    --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
177    to the "configure" command, respectively.    or --enable-newline-is-crlf or --enable-newline-is-anycrlf or
178      --enable-newline-is-any to the "configure" command, respectively.
179    If you specify --newline-is-cr or --newline-is-crlf, some of the standard  
180    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
181    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
182    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
183    some failures.    to be some failures. With --enable-newline-is-anycrlf or
184      --enable-newline-is-any, many tests should succeed, but there may be some
185      failures.
186    
187  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
188    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
189    them. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
190    
191    --with-posix-malloc-threshold=20    --with-posix-malloc-threshold=20
192    
# Line 186  library. You can read more about them in Line 199  library. You can read more about them in
199    --with-match-limit=500000    --with-match-limit=500000
200    
201    on the "configure" command. This is just the default; individual calls to    on the "configure" command. This is just the default; individual calls to
202    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
203    man page.    pcreapi man page.
204    
205  . 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
206    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 215  library. You can read more about them in
215  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
216    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
217    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
218    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
219    (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.  
220    
221  . 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
222    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
223    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
224    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
225    this, use    build PCRE like this, use
226    
227    --disable-stack-for-recursion    --disable-stack-for-recursion
228    
229    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
230    necessary in environments with limited stack sizes. This applies only to the    necessary in environments with limited stack sizes. This applies only to the
231    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
232    use deeply nested recursion.    use deeply nested recursion. There is a discussion about stack sizes in the
233      pcrestack man page.
234    
235    . For speed, PCRE uses four tables for manipulating and identifying characters
236      whose code point values are less than 256. By default, it uses a set of
237      tables for ASCII encoding that is part of the distribution. If you specify
238    
239      --enable-rebuild-chartables
240    
241      a program called dftables is compiled and run in the default C locale when
242      you obey "make". It builds a source file called pcre_chartables.c. If you do
243      not specify this option, pcre_chartables.c is created as a copy of
244      pcre_chartables.c.dist. See "Character tables" below for further information.
245    
246    . It is possible to compile PCRE for use on systems that use EBCDIC as their
247      default character code (as opposed to ASCII) by specifying
248    
249      --enable-ebcdic
250    
251      This automatically implies --enable-rebuild-chartables (see above).
252    
253  The "configure" script builds the following files for the basic C library:  The "configure" script builds the following files for the basic C library:
254    
# Line 231  The "configure" script builds the follow Line 261  The "configure" script builds the follow
261  . RunTest is a script for running tests on the basic C library  . RunTest is a script for running tests on the basic C library
262  . RunGrepTest is a script for running tests on the pcregrep command  . RunGrepTest is a script for running tests on the pcregrep command
263    
264  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
265  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
266  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
267    you use "configure", the .generic versions are not used.
268    
269  If a C++ compiler is found, the following files are also built:  If a C++ compiler is found, the following files are also built:
270    
# Line 248  contains compiler output from tests that Line 279  contains compiler output from tests that
279  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
280  libpcre and libpcreposix, a test program called pcretest, a demonstration  libpcre and libpcreposix, a test program called pcretest, a demonstration
281  program called pcredemo, and the pcregrep command. If a C++ compiler was found  program called pcredemo, and the pcregrep command. If a C++ compiler was found
282  on your system, it also builds the C++ wrapper library, which is called  on your system, "make" also builds the C++ wrapper library, which is called
283  libpcrecpp, and some test programs called pcrecpp_unittest,  libpcrecpp, and some test programs called pcrecpp_unittest,
284  pcre_scanner_unittest, and pcre_stringpiece_unittest.  pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper
285    can be disabled by adding --disable-cpp to the "configure" command.
286    
287  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
288  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 294  system. The following are installed (fil
294    Commands (bin):    Commands (bin):
295      pcretest      pcretest
296      pcregrep      pcregrep
297      pcre-config      pcre-config
298    
299    Libraries (lib):    Libraries (lib):
300      libpcre      libpcre
# Line 271  system. The following are installed (fil Line 303  system. The following are installed (fil
303    
304    Configuration information (lib/pkgconfig):    Configuration information (lib/pkgconfig):
305      libpcre.pc      libpcre.pc
306      libpcrecpp.ps (if C++ support is enabled)      libpcrecpp.pc (if C++ support is enabled)
307    
308    Header files (include):    Header files (include):
309      pcre.h      pcre.h
# Line 295  system. The following are installed (fil Line 327  system. The following are installed (fil
327      AUTHORS      AUTHORS
328      COPYING      COPYING
329      ChangeLog      ChangeLog
     INSTALL  
330      LICENCE      LICENCE
     NON-UNIX-USE  
331      NEWS      NEWS
332      README      README
333      pcre.txt       (a concatenation of the man(3) pages)      pcre.txt       (a concatenation of the man(3) pages)
334      pcretest.txt   the pcretest man page      pcretest.txt   the pcretest man page
335      pcregrep.txt   the pcregrep man page      pcregrep.txt   the pcregrep man page
     perltest.txt   some information about the perltest.pl script  
336    
337  Note that the pcredemo program that is built by "configure" is *not* installed  Note that the pcredemo program that is built by "configure" is *not* installed
338  anywhere. It is a demonstration for programmers wanting to use PCRE.  anywhere. It is a demonstration for programmers wanting to use PCRE.
339    
340  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".
# Line 313  This removes all the files that "make in Line 342  This removes all the files that "make in
342  remove any directories, because these are often shared with other programs.  remove any directories, because these are often shared with other programs.
343    
344    
345  Retrieving configuration information on a Unix-like system  Retrieving configuration information on Unix-like systems
346  ----------------------------------------------------------  ---------------------------------------------------------
347    
348  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
349  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 382  built. The programs pcretest and pcregre
382  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
383  you use "make install" to install shared libraries, pcregrep and pcretest are  you use "make install" to install shared libraries, pcregrep and pcretest are
384  automatically re-built to use the newly installed shared libraries before being  automatically re-built to use the newly installed shared libraries before being
385  installed themselves. However, the versions left in the source directory still  installed themselves. However, the versions left in the build directory still
386  use the uninstalled libraries.  use the uninstalled libraries.
387    
388  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 394  Then run "make" in the usual way. Simila
394  build only shared libraries.  build only shared libraries.
395    
396    
397  Cross-compiling on a Unix-like system  Cross-compiling on Unix-like systems
398  -------------------------------------  ------------------------------------
399    
400  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
401  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
402  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
403  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
404  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,
405  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
406  there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)  compiler.
407  when calling the "configure" command. If they are not specified, they default  
408  to the values of CC and CFLAGS.  When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
409    by making a copy of pcre_chartables.c.dist, which is a default set of tables
410    that assumes ASCII code. Cross-compiling with the default tables should not be
411    a problem.
412    
413    If you need to modify the character tables when cross-compiling, you should
414    move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
415    run it on the local host to make a new version of pcre_chartables.c.dist.
416    Then when you cross-compile PCRE this new version of the tables will be used.
417    
418    
419  Using HP's ANSI C++ compiler (aCC)  Using HP's ANSI C++ compiler (aCC)
420  ----------------------------------  ----------------------------------
421    
422  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
423  "configure" script, you *must* include the "-AA" option in the CXXFLAGS  "configure" script, you must include the "-AA" option in the CXXFLAGS
424  environment variable in order for the C++ components to compile correctly.  environment variable in order for the C++ components to compile correctly.
425    
426  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 432  running the "configure" script:
432    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
433    
434    
435    Making new tarballs
436    -------------------
437    
438    The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
439    zip formats. However, if you have modified any of the man page sources in the
440    doc directory, you should first run the PrepareRelease script. This re-creates
441    the .txt and HTML forms of the documentation from the man pages.
442    
443    
444  Testing PCRE  Testing PCRE
445  ------------  ------------
446    
447  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
448  configuring process. There is also a script called RunGrepTest that tests the  created by the configuring process. There is also a script called RunGrepTest
449  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
450  test programs called pcrecpp_unittest, pcre_scanner_unittest, and  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
451  pcre_stringpiece_unittest are also built.  pcre_stringpiece_unittest are also built.
452    
453  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
454  "make test". For other systems, see the instructions in NON-UNIX-USE.  "make test". For other systems, see the instructions in NON-UNIX-USE.
455    
456  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
457  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
458  turn, and compares the output with the contents of the corresponding testoutput  turn, and compares the output with the contents of the corresponding testoutput
459  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
460  (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 470  version.
470  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
471  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
472  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
473  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
474  pcre_compile().  pcre_compile().
475    
476  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 496  is output to say why. If running this te
496  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,
497  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.
498    
499    [If you are trying to run this test on Windows, you may be able to get it to
500    work by changing "fr_FR" to "french" everywhere it occurs.]
501    
502  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
503  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
504  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 508  commented in the script, can be be used.
508  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
509  features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
510    
511  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
512  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
513  this you must set --enable-unicode-properties when running "configure".  this you must set --enable-unicode-properties when running "configure".
514    
515  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 521  automatically unless PCRE is build with
521  Character tables  Character tables
522  ----------------  ----------------
523    
524  PCRE uses four tables for manipulating and identifying characters whose values  For speed, PCRE uses four tables for manipulating and identifying characters
525  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
526  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
527  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
528  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
529  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.
530    
531  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
532  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
533  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
534  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
535  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
536  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
537  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
538  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
539  re-generated.  the default tables by editing pcre_chartables.c and then re-building PCRE. If
540    you do this, you should take care to ensure that the file does not get
541    automatically re-generated. The best way to do this is to move
542    pcre_chartables.c.dist out of the way and replace it with your customized
543    tables.
544    
545    When the dftables program is run as a result of --enable-rebuild-chartables,
546    it uses the default C locale that is set on your system. It does not pay
547    attention to the LC_xxx environment variables. In other words, it uses the
548    system's default locale rather than whatever the compiling user happens to have
549    set. If you really do want to build a source set of character tables in a
550    locale that is specified by the LC_xxx variables, you can run the dftables
551    program by hand with the -L option. For example:
552    
553      ./dftables -L pcre_chartables.c.special
554    
555  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,
556  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
557  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
558  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
559  than 256.  than 256.
560    
561  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 579  The distribution should contain the foll
579    
580  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
581    
582    dftables.c             auxiliary program for building chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
583                                when --enable-rebuild-chartables is specified
584    pcreposix.c            )  
585    pcre_compile.c         )    pcre_chartables.c.dist  a default set of character tables that assume ASCII
586    pcre_config.c          )                              coding; used, unless --enable-rebuild-chartables is
587    pcre_dfa_exec.c        )                              specified, by copying to pcre_chartables.c
588    pcre_exec.c            )  
589    pcre_fullinfo.c        )    pcreposix.c             )
590    pcre_get.c             ) sources for the functions in the library,    pcre_compile.c          )
591    pcre_globals.c         )   and some internal functions that they use    pcre_config.c           )
592    pcre_info.c            )    pcre_dfa_exec.c         )
593    pcre_maketables.c      )    pcre_exec.c             )
594    pcre_newline.c         )    pcre_fullinfo.c         )
595    pcre_ord2utf8.c        )    pcre_get.c              ) sources for the functions in the library,
596    pcre_refcount.c        )    pcre_globals.c          )   and some internal functions that they use
597    pcre_study.c           )    pcre_info.c             )
598    pcre_tables.c          )    pcre_maketables.c       )
599    pcre_try_flipped.c     )    pcre_newline.c          )
600    pcre_ucp_searchfuncs.c )    pcre_ord2utf8.c         )
601    pcre_valid_utf8.c      )    pcre_refcount.c         )
602    pcre_version.c         )    pcre_study.c            )
603    pcre_xclass.c          )    pcre_tables.c           )
604    pcre_printint.src      ) debugging function that is #included in pcretest,    pcre_try_flipped.c      )
605                           )   and can also be #included in pcre_compile()    pcre_ucp_searchfuncs.c  )
606    pcre.h                 ) a version of the public PCRE header file    pcre_valid_utf8.c       )
607                           )   for use in non-"configure" environments    pcre_version.c          )
608    pcre.h.in              template for pcre.h when built by "configure"    pcre_xclass.c           )
609    pcreposix.h            header for the external POSIX wrapper API    pcre_printint.src       ) debugging function that is #included in pcretest,
610    pcre_internal.h        header for internal use                            )   and can also be #included in pcre_compile()
611    ucp.h                  ) headers concerned with    pcre.h.in               template for pcre.h when built by "configure"
612    ucpinternal.h          )   Unicode property handling    pcreposix.h             header for the external POSIX wrapper API
613    ucptable.h             ) (this one is the data table)    pcre_internal.h         header for internal use
614      ucp.h                   ) headers concerned with
615    config.h               ) a version of config.h for use in non-"configure"    ucpinternal.h           )   Unicode property handling
616                           )   environments    ucptable.h              ) (this one is the data table)
617    config.h.in            template for config.h when built by "configure"  
618      config.h.in             template for config.h, which is built by "configure"
619    pcrecpp.h              public header file for the C++ wrapper  
620    pcrecpparg.h.in        template for another C++ header file    pcrecpp.h               public header file for the C++ wrapper
621    pcre_scanner.h         public header file for C++ scanner functions    pcrecpparg.h.in         template for another C++ header file
622    pcrecpp.cc             )    pcre_scanner.h          public header file for C++ scanner functions
623    pcre_scanner.cc        ) source for the C++ wrapper library    pcrecpp.cc              )
624      pcre_scanner.cc         ) source for the C++ wrapper library
625    pcre_stringpiece.h.in  template for pcre_stringpiece.h, the header for the  
626                             C++ stringpiece functions    pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
627    pcre_stringpiece.cc    source for the C++ stringpiece functions                              C++ stringpiece functions
628      pcre_stringpiece.cc     source for the C++ stringpiece functions
629    
630  (B) Source files for programs that use PCRE:  (B) Source files for programs that use PCRE:
631    
632    pcredemo.c             simple demonstration of coding calls to PCRE    pcredemo.c              simple demonstration of coding calls to PCRE
633    pcregrep.c             source of a grep utility that uses PCRE    pcregrep.c              source of a grep utility that uses PCRE
634    pcretest.c             comprehensive test program    pcretest.c              comprehensive test program
635    
636  (C) Auxiliary files:  (C) Auxiliary files:
637    
638    AUTHORS                information about the author of PCRE    132html                 script to turn "man" pages into HTML
639    ChangeLog              log of changes to the code    AUTHORS                 information about the author of PCRE
640    INSTALL                generic installation instructions    ChangeLog               log of changes to the code
641    LICENCE                conditions for the use of PCRE    CleanTxt                script to clean nroff output for txt man pages
642    COPYING                the same, using GNU's standard name    Detrail                 script to remove trailing spaces
643    Makefile.in            ) template for Unix Makefile, which is built by    HACKING                 some notes about the internals of PCRE
644                           )   "configure"    INSTALL                 generic installation instructions
645    Makefile.am            ) the automake input that was used to create    LICENCE                 conditions for the use of PCRE
646                           )   Makefile.in    COPYING                 the same, using GNU's standard name
647    NEWS                   important changes in this release    Makefile.in             ) template for Unix Makefile, which is built by
648    NON-UNIX-USE           notes on building PCRE on non-Unix systems                            )   "configure"
649    README                 this file    Makefile.am             ) the automake input that was used to create
650    RunTest.in             template for a Unix shell script for running tests                            )   Makefile.in
651    RunGrepTest.in         template for a Unix shell script for pcregrep tests    NEWS                    important changes in this release
652    aclocal.m4             m4 macros (generated by "aclocal")    NON-UNIX-USE            notes on building PCRE on non-Unix systems
653    config.guess           ) files used by libtool,    PrepareRelease          script to make preparations for "make dist"
654    config.sub             )   used only when building a shared library    README                  this file
655    configure              a configuring shell script (built by autoconf)    RunTest                 a Unix shell script for running tests
656    configure.ac           ) the autoconf input that was used to build    RunGrepTest             a Unix shell script for pcregrep tests
657                           )   "configure" and config.h    aclocal.m4              m4 macros (generated by "aclocal")
658    depcomp                ) script to find program dependencies, generated by    config.guess            ) files used by libtool,
659                           )   automake    config.sub              )   used only when building a shared library
660    doc/*.3                man page sources for the PCRE functions    configure               a configuring shell script (built by autoconf)
661    doc/*.1                man page sources for pcregrep and pcretest    configure.ac            ) the autoconf input that was used to build
662    doc/html/*             HTML documentation                            )   "configure" and config.h
663    doc/pcre.txt           plain text version of the man pages    depcomp                 ) script to find program dependencies, generated by
664    doc/pcretest.txt       plain text documentation of test program                            )   automake
665    doc/perltest.txt       plain text documentation of Perl test program    doc/*.3                 man page sources for the PCRE functions
666    install-sh             a shell script for installing files    doc/*.1                 man page sources for pcregrep and pcretest
667    libpcre.pc.in          template for libpcre.pc for pkg-config    doc/index.html.src      the base HTML page
668    libpcrecpp.pc.in       template for libpcrecpp.pc for pkg-config    doc/html/*              HTML documentation
669    ltmain.sh              file used to build a libtool script    doc/pcre.txt            plain text version of the man pages
670    missing                ) common stub for a few missing GNU programs while    doc/pcretest.txt        plain text documentation of test program
671                           )   installing, generated by automake    doc/perltest.txt        plain text documentation of Perl test program
672    mkinstalldirs          script for making install directories    install-sh              a shell script for installing files
673    perltest.pl            Perl test program    libpcre.pc.in           template for libpcre.pc for pkg-config
674    pcre-config.in         source of script which retains PCRE information    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
675    pcrecpp_unittest.c           )    ltmain.sh               file used to build a libtool script
676    pcre_scanner_unittest.c      ) test programs for the C++ wrapper    missing                 ) common stub for a few missing GNU programs while
677    pcre_stringpiece_unittest.c  )                            )   installing, generated by automake
678    testdata/testinput*    test data for main library tests    mkinstalldirs           script for making install directories
679    testdata/testoutput*   expected test results    perltest.pl             Perl test program
680    testdata/grep*         input and output for pcregrep tests    pcre-config.in          source of script which retains PCRE information
681      pcrecpp_unittest.cc          )
682      pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
683      pcre_stringpiece_unittest.cc )
684      testdata/testinput*     test data for main library tests
685      testdata/testoutput*    expected test results
686      testdata/grep*          input and output for pcregrep tests
687    
688  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
689    
690    CMakeLists.txt    CMakeLists.txt
691    config-cmake.h.in    config-cmake.h.in
692    
693  (E) Auxiliary files for VPASCAL  (E) Auxiliary files for VPASCAL
694    
695    makevp.bat    makevp.bat
696    !compile.txt    makevp_c.txt
697    !linklib.txt    makevp_l.txt
698    pcregexp.pas    pcregexp.pas
699    
700    (F) Auxiliary files for building PCRE "by hand"
701    
702      pcre.h.generic          ) a version of the public PCRE header file
703                              )   for use in non-"configure" environments
704      config.h.generic        ) a version of config.h for use in non-"configure"
705                              )   environments
706    
707  (F) Miscellaneous  (F) Miscellaneous
708    
709    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 711  The distribution should contain the foll
711  Philip Hazel  Philip Hazel
712  Email local part: ph10  Email local part: ph10
713  Email domain: cam.ac.uk  Email domain: cam.ac.uk
714  Last updated: March 2007  Last updated: 16 April 2007

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

  ViewVC Help
Powered by ViewVC 1.1.5