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

Diff of /code/trunk/README

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

revision 101 by ph10, Tue Mar 6 15:19:44 2007 UTC revision 155 by ph10, Tue Apr 24 13:36:11 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:
14    
15      The PCRE APIs
16      Documentation for PCRE
17      Contributions by users of PCRE
18      Building PCRE on non-Unix systems
19      Building PCRE on Unix-like systems
20      Retrieving configuration information on Unix-like systems
21      Shared libraries on Unix-like systems
22      Cross-compiling on Unix-like systems
23      Using HP's ANSI C++ compiler (aCC)
24      Making new tarballs
25      Testing PCRE
26      Character tables
27      File manifest
28    
29    
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 are a set of C wrapper functions that are based on the POSIX  In addition, there is a set of C wrapper functions that are based on the POSIX
38  API. These end up in the library called libpcreposix. Note that this just  regular expression API (see the pcreposix man page). These end up in the
39  provides a POSIX calling interface to PCRE: the regular expressions themselves  library called libpcreposix. Note that this just provides a POSIX calling
40  still follow Perl syntax and semantics. The header file for the POSIX-style  interface to PCRE; the regular expressions themselves still follow Perl syntax
41  functions is called pcreposix.h. The official POSIX name is regex.h, but I  and semantics. The POSIX API is restricted, and does not give full access to
42  didn't want to risk possible problems with existing files of that name by  all of PCRE's facilities.
43  distributing it that way. To use it with an existing program that uses the  
44  POSIX API, it will have to be renamed or pointed at by a link.  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
46    with existing files of that name by distributing it that way. To use PCRE with
47    an existing program that uses the POSIX API, pcreposix.h will have to be
48    renamed or pointed at by a link.
49    
50  If you are using the POSIX interface to PCRE and there is already a POSIX regex  If you are using the POSIX interface to PCRE and there is already a POSIX regex
51  library installed on your system, you must take care when linking programs to  library installed on your system, as well as worrying about the regex.h header
52    file (as mentioned above), you must also take care when linking programs to
53  ensure that they link with PCRE's libpcreposix library. Otherwise they may pick  ensure that they link with PCRE's libpcreposix library. Otherwise they may pick
54  up the "real" POSIX functions of the same name.  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
57    -Dregcomp=PCREregcomp (and similarly for the other POSIX functions) to the
58    compiler flags (CFLAGS if you are using "configure" -- see below). This has the
59    effect of renaming the functions so that the names no longer clash. Of course,
60    you have to do the same thing for your applications, or write them using the
61    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; however, as there is no standard place to install  documentation is supplied in two other forms:
71  them, they are left in the doc directory of the unpacked source distribution.  
72  These forms are:    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
74    1. Files called doc/pcre.txt, doc/pcregrep.txt, and doc/pcretest.txt. The       concatenation of the text forms of all the section 3 man pages except
75       first of these is a concatenation of the text forms of all the section 3       those that summarize individual functions. The other two are the text
76       man pages except those that summarize individual functions. The other two       forms of the section 1 man pages for the pcregrep and pcretest commands.
77       are the text forms of the section 1 man pages for the pcregrep and       These text forms are provided for ease of scanning with text editors or
78       pcretest commands. Text forms are provided for ease of scanning with text       similar tools. They are installed in <prefix>/share/doc/pcre, where
79       editors or similar tools.       <prefix> is the installation prefix (defaulting to /usr/local).
80    
81    2. A subdirectory called doc/html contains all the documentation in HTML    2. A set of files containing all the documentation in HTML form, hyperlinked
82       form, hyperlinked in various ways, and rooted in a file called       in various ways, and rooted in a file called index.html, is distributed in
83       doc/index.html.       doc/html and installed in <prefix>/share/doc/pcre/html.
84    
85    
86  Contributions by users of PCRE  Contributions by users of PCRE
# Line 59  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  Several of them provide support for compiling PCRE on various flavours of  complete in themselves; others are pointers to URLs containing relevant files.
95  Windows systems (I myself do not use Windows). Some are complete in themselves;  Some of this material is likely to be well out-of-date. Several of the earlier
96  others are pointers to URLs containing relevant files.  contributions provided support for compiling PCRE on various flavours of
97    Windows (I myself do not use Windows). Nowadays there is more Windows support
98    in the standard distribution, so these contibutions have been archived.
99    
100    
101  Building 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 systems.  able to build PCRE in the same way as for Unix-like systems.
107    
108  PCRE has been compiled on Windows systems and on Macintoshes, but I don't know  PCRE has been compiled on many different operating systems. It should be
109  the details because I don't use those systems. It should be straightforward to  straightforward to build PCRE on any system that has a Standard C compiler and
110  build PCRE on any system that has a Standard C compiler and library, because it  library, because it uses only Standard C functions.
 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, but the  this case, on many systems, just running "./configure" is sufficient. However,
132  usual methods of changing standard defaults are available. For example:  the usual methods of changing standard defaults are available. For example:
133    
134  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
135    
# Line 116  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 132  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 160  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 176  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  The "configure" script builds eight files for the basic C library:    --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:
254    
255  . Makefile is the makefile that builds the library  . Makefile is the makefile that builds the library
256  . config.h contains build-time configuration options for the library  . config.h contains build-time configuration options for the library
257    . pcre.h is the public PCRE header file
258  . pcre-config is a script that shows the settings of "configure" options  . pcre-config is a script that shows the settings of "configure" options
259  . libpcre.pc is data for the pkg-config command  . libpcre.pc is data for the pkg-config command
260  . libtool is a script that builds shared and/or static libraries  . libtool is a script that builds shared and/or static libraries
261  . RunTest is a script for running tests on the 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  In addition, if a C++ compiler is found, the following are also built:  Versions of config.h and pcre.h are distributed in the PCRE tarballs under
265    the names config.h.generic and pcre.h.generic. These are provided for the
266    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:
270    
271  . pcrecpp.h is the header file for programs that call PCRE via the C++ wrapper  . libpcrecpp.pc is data for the pkg-config command
272    . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper
273  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions
274    
275  The "configure" script also creates config.status, which is an executable  The "configure" script also creates config.status, which is an executable
# Line 214  script that can be run to recreate the c Line 277  script that can be run to recreate the c
277  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
278    
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, and the pcregrep  libpcre and libpcreposix, a test program called pcretest, a demonstration
281  command. If a C++ compiler was found on your system, it also builds the C++  program called pcredemo, and the pcregrep command. If a C++ compiler was found
282  wrapper library, which is called libpcrecpp, and some test programs called  on your system, "make" also builds the C++ wrapper library, which is called
283  pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.  libpcrecpp, and some test programs called pcrecpp_unittest,
284    pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper
285  The command "make test" runs all the appropriate tests. Details of the PCRE  can be disabled by adding --disable-cpp to the "configure" command.
286  tests are given in a separate section of this document, below.  
287    The command "make check" runs all the appropriate tests. Details of the PCRE
288  You can use "make install" to copy the libraries, the public header files  tests are given below in a separate section of this document.
289  pcre.h, pcreposix.h, pcrecpp.h, and pcre_stringpiece.h (the last two only if  
290  the C++ wrapper was built), and the man pages to appropriate live directories  You can use "make install" to install PCRE into live directories on your
291  on your system, in the normal way.  system. The following are installed (file names are all relative to the
292    <prefix> that is set when "configure" is run):
293    
294      Commands (bin):
295        pcretest
296        pcregrep
297        pcre-config
298    
299      Libraries (lib):
300        libpcre
301        libpcreposix
302        libpcrecpp (if C++ support is enabled)
303    
304      Configuration information (lib/pkgconfig):
305        libpcre.pc
306        libpcrecpp.pc (if C++ support is enabled)
307    
308      Header files (include):
309        pcre.h
310        pcreposix.h
311        pcre_scanner.h      )
312        pcre_stringpiece.h  ) if C++ support is enabled
313        pcrecpp.h           )
314        pcrecpparg.h        )
315    
316      Man pages (share/man/man{1,3}):
317        pcregrep.1
318        pcretest.1
319        pcre.3
320        pcre*.3 (lots more pages, all starting "pcre")
321    
322      HTML documentation (share/doc/pcre/html):
323        index.html
324        *.html (lots more pages, hyperlinked from index.html)
325    
326      Text file documentation (share/doc/pcre):
327        AUTHORS
328        COPYING
329        ChangeLog
330        LICENCE
331        NEWS
332        README
333        pcre.txt       (a concatenation of the man(3) pages)
334        pcretest.txt   the pcretest man page
335        pcregrep.txt   the pcregrep man page
336    
337    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.
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".
341  This removes all the files that "make install" installed. However, it does not  This removes all the files that "make install" installed. However, it does not
# Line 235  remove any directories, because these ar Line 345  remove any directories, because these ar
345  Retrieving configuration information on Unix-like systems  Retrieving configuration information on Unix-like systems
346  ---------------------------------------------------------  ---------------------------------------------------------
347    
348  Running "make install" also installs the command pcre-config, which can be used  Running "make install" installs the command pcre-config, which can be used to
349  to recall information about the PCRE configuration and installation. For  recall information about the PCRE configuration and installation. For example:
 example:  
350    
351    pcre-config --version    pcre-config --version
352    
# Line 256  single command is used. For example: Line 365  single command is used. For example:
365    pkg-config --cflags pcre    pkg-config --cflags pcre
366    
367  The data is held in *.pc files that are installed in a directory called  The data is held in *.pc files that are installed in a directory called
368  pkgconfig.  <prefix>/lib/pkgconfig.
369    
370    
371  Shared libraries on Unix-like systems  Shared libraries on Unix-like systems
# Line 273  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 285  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 315  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. The command "make distcheck" does the same, but then does a trial
440    build of the new distribution to ensure that it works.
441    
442    If you have modified any of the man page sources in the doc directory, you
443    should first run the PrepareRelease script before making a distribution. This
444    script creates the .txt and HTML forms of the documentation from the man pages.
445    
446    
447  Testing PCRE  Testing PCRE
448  ------------  ------------
449    
450  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
451  configuring process. There is also a script called RunGrepTest that tests the  created by the configuring process. There is also a script called RunGrepTest
452  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
453  test programs called pcrecpp_unittest, pcre_scanner_unittest, and  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
454  pcre_stringpiece_unittest are provided.  pcre_stringpiece_unittest are also built.
455    
456  Both the scripts and all the program tests are run if you obey "make runtest",  Both the scripts and all the program tests are run if you obey "make check" or
457  "make check", or "make test". For other systems, see the instructions in  "make test". For other systems, see the instructions in NON-UNIX-USE.
 NON-UNIX-USE.  
458    
459  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
460  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
461  turn, and compares the output with the contents of the corresponding testoutput  turn, and compares the output with the contents of the corresponding testoutput
462  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
463  (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 337  the test files, give its number as an ar Line 465  the test files, give its number as an ar
465    
466    RunTest 2    RunTest 2
467    
468  The first test file can also be fed directly into the perltest script to check  The first test file can also be fed directly into the perltest.pl script to
469  that Perl gives the same results. The only difference you should see is in the  check that Perl gives the same results. The only difference you should see is
470  first few lines, where the Perl version is given instead of the PCRE version.  in the first few lines, where the Perl version is given instead of the PCRE
471    version.
472    
473  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
474  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
475  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
476  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
477  pcre_compile().  pcre_compile().
478    
479  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 370  is output to say why. If running this te Line 499  is output to say why. If running this te
499  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,
500  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.
501    
502    [If you are trying to run this test on Windows, you may be able to get it to
503    work by changing "fr_FR" to "french" everywhere it occurs.]
504    
505  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
506  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
507  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 379  commented in the script, can be be used. Line 511  commented in the script, can be be used.
511  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
512  features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
513    
514  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
515  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
516  this you must set --enable-unicode-properties when running "configure".  this you must set --enable-unicode-properties when running "configure".
517    
518  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 392  automatically unless PCRE is build with Line 524  automatically unless PCRE is build with
524  Character tables  Character tables
525  ----------------  ----------------
526    
527  PCRE uses four tables for manipulating and identifying characters whose values  For speed, PCRE uses four tables for manipulating and identifying characters
528  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
529  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
530  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
531  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
532  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.
533    
534  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
535  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
536  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
537  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
538  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
539  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
540  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
541  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
542  re-generated.  the default tables by editing pcre_chartables.c and then re-building PCRE. If
543    you do this, you should take care to ensure that the file does not get
544    automatically re-generated. The best way to do this is to move
545    pcre_chartables.c.dist out of the way and replace it with your customized
546    tables.
547    
548    When the dftables program is run as a result of --enable-rebuild-chartables,
549    it uses the default C locale that is set on your system. It does not pay
550    attention to the LC_xxx environment variables. In other words, it uses the
551    system's default locale rather than whatever the compiling user happens to have
552    set. If you really do want to build a source set of character tables in a
553    locale that is specified by the LC_xxx variables, you can run the dftables
554    program by hand with the -L option. For example:
555    
556      ./dftables -L pcre_chartables.c.special
557    
558  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,
559  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
560  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
561  building 32-byte bit maps that represent character classes.  building 32-byte bit maps that represent character classes for code points less
562    than 256.
563    
564  The final 256-byte table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
565  follows:  follows:
# Line 428  You should not alter the set of characte Line 575  You should not alter the set of characte
575  will cause PCRE to malfunction.  will cause PCRE to malfunction.
576    
577    
578  Manifest  File manifest
579  --------  -------------
580    
581  The distribution should contain the following files:  The distribution should contain the following files:
582    
583  (A) The actual source files of the PCRE library functions and their  (A) Source files of the PCRE library functions and their headers:
     headers:  
584    
585    dftables.c            auxiliary program for building chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
586                                when --enable-rebuild-chartables is specified
587    
588    pcreposix.c           )    pcre_chartables.c.dist  a default set of character tables that assume ASCII
589    pcre_compile.c        )                              coding; used, unless --enable-rebuild-chartables is
590    pcre_config.c         )                              specified, by copying to pcre_chartables.c
591    pcre_dfa_exec.c       )  
592    pcre_exec.c           )    pcreposix.c             )
593    pcre_fullinfo.c       )    pcre_compile.c          )
594    pcre_get.c            ) sources for the functions in the library,    pcre_config.c           )
595    pcre_globals.c        )   and some internal functions that they use    pcre_dfa_exec.c         )
596    pcre_info.c           )    pcre_exec.c             )
597    pcre_maketables.c     )    pcre_fullinfo.c         )
598    pcre_newline.c        )    pcre_get.c              ) sources for the functions in the library,
599    pcre_ord2utf8.c       )    pcre_globals.c          )   and some internal functions that they use
600    pcre_refcount.c       )    pcre_info.c             )
601    pcre_study.c          )    pcre_maketables.c       )
602    pcre_tables.c         )    pcre_newline.c          )
603    pcre_try_flipped.c    )    pcre_ord2utf8.c         )
604    pcre_ucp_searchfuncs.c)    pcre_refcount.c         )
605    pcre_valid_utf8.c     )    pcre_study.c            )
606    pcre_version.c        )    pcre_tables.c           )
607    pcre_xclass.c         )    pcre_try_flipped.c      )
608      pcre_ucp_searchfuncs.c  )
609    pcre_printint.src     ) debugging function that is #included in pcretest, and    pcre_valid_utf8.c       )
610                          )   can also be #included in pcre_compile()    pcre_version.c          )
611      pcre_xclass.c           )
612    pcre.h                the public PCRE header file    pcre_printint.src       ) debugging function that is #included in pcretest,
613    pcreposix.h           header for the external POSIX wrapper API                            )   and can also be #included in pcre_compile()
614    pcre_internal.h       header for internal use    pcre.h.in               template for pcre.h when built by "configure"
615    ucp.h                 ) headers concerned with    pcreposix.h             header for the external POSIX wrapper API
616    ucpinternal.h         )   Unicode property handling    pcre_internal.h         header for internal use
617    ucptable.h            ) (this one is the data table)    ucp.h                   ) headers concerned with
618    config.in             template for config.h, which is built by configure    ucpinternal.h           )   Unicode property handling
619      ucptable.h              ) (this one is the data table)
620    pcrecpp.h             the header file for the C++ wrapper  
621    pcrecpparg.h.in       "source" for another C++ header file    config.h.in             template for config.h, which is built by "configure"
622    pcrecpp.cc            )  
623    pcre_scanner.cc       ) source for the C++ wrapper library    pcrecpp.h               public header file for the C++ wrapper
624      pcrecpparg.h.in         template for another C++ header file
625    pcre_stringpiece.h.in "source" for pcre_stringpiece.h, the header for the    pcre_scanner.h          public header file for C++ scanner functions
626                            C++ stringpiece functions    pcrecpp.cc              )
627    pcre_stringpiece.cc   source for the C++ stringpiece functions    pcre_scanner.cc         ) source for the C++ wrapper library
628    
629  (B) Auxiliary files:    pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
630                                C++ stringpiece functions
631    AUTHORS               information about the author of PCRE    pcre_stringpiece.cc     source for the C++ stringpiece functions
632    ChangeLog             log of changes to the code  
633    INSTALL               generic installation instructions  (B) Source files for programs that use PCRE:
634    LICENCE               conditions for the use of PCRE  
635    COPYING               the same, using GNU's standard name    pcredemo.c              simple demonstration of coding calls to PCRE
636    Makefile.in           template for Unix Makefile, which is built by configure    pcregrep.c              source of a grep utility that uses PCRE
637    NEWS                  important changes in this release    pcretest.c              comprehensive test program
638    NON-UNIX-USE          notes on building PCRE on non-Unix systems  
639    README                this file  (C) Auxiliary files:
640    RunTest.in            template for a Unix shell script for running tests  
641    RunGrepTest.in        template for a Unix shell script for pcregrep tests    132html                 script to turn "man" pages into HTML
642    config.guess          ) files used by libtool,    AUTHORS                 information about the author of PCRE
643    config.sub            )   used only when building a shared library    ChangeLog               log of changes to the code
644    config.h.in           "source" for the config.h header file    CleanTxt                script to clean nroff output for txt man pages
645    configure             a configuring shell script (built by autoconf)    Detrail                 script to remove trailing spaces
646    configure.ac          the autoconf input used to build configure    HACKING                 some notes about the internals of PCRE
647    doc/Tech.Notes        notes on the encoding    INSTALL                 generic installation instructions
648    doc/*.3               man page sources for the PCRE functions    LICENCE                 conditions for the use of PCRE
649    doc/*.1               man page sources for pcregrep and pcretest    COPYING                 the same, using GNU's standard name
650    doc/html/*            HTML documentation    Makefile.in             ) template for Unix Makefile, which is built by
651    doc/pcre.txt          plain text version of the man pages                            )   "configure"
652    doc/pcretest.txt      plain text documentation of test program    Makefile.am             ) the automake input that was used to create
653    doc/perltest.txt      plain text documentation of Perl test program                            )   Makefile.in
654    install-sh            a shell script for installing files    NEWS                    important changes in this release
655    libpcre.pc.in         "source" for libpcre.pc for pkg-config    NON-UNIX-USE            notes on building PCRE on non-Unix systems
656    ltmain.sh             file used to build a libtool script    PrepareRelease          script to make preparations for "make dist"
657    mkinstalldirs         script for making install directories    README                  this file
658    pcretest.c            comprehensive test program    RunTest                 a Unix shell script for running tests
659    pcredemo.c            simple demonstration of coding calls to PCRE    RunGrepTest             a Unix shell script for pcregrep tests
660    perltest.pl           Perl test program    aclocal.m4              m4 macros (generated by "aclocal")
661    pcregrep.c            source of a grep utility that uses PCRE    config.guess            ) files used by libtool,
662    pcre-config.in        source of script which retains PCRE information    config.sub              )   used only when building a shared library
663    pcrecpp_unittest.c           )    configure               a configuring shell script (built by autoconf)
664    pcre_scanner_unittest.c      ) test programs for the C++ wrapper    configure.ac            ) the autoconf input that was used to build
665    pcre_stringpiece_unittest.c  )                            )   "configure" and config.h
666    testdata/testinput*   test data for main library tests    depcomp                 ) script to find program dependencies, generated by
667    testdata/testoutput*  expected test results                            )   automake
668    testdata/grep*        input and output for pcregrep tests    doc/*.3                 man page sources for the PCRE functions
669      doc/*.1                 man page sources for pcregrep and pcretest
670      doc/index.html.src      the base HTML page
671      doc/html/*              HTML documentation
672      doc/pcre.txt            plain text version of the man pages
673      doc/pcretest.txt        plain text documentation of test program
674      doc/perltest.txt        plain text documentation of Perl test program
675      install-sh              a shell script for installing files
676      libpcre.pc.in           template for libpcre.pc for pkg-config
677      libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
678      ltmain.sh               file used to build a libtool script
679      missing                 ) common stub for a few missing GNU programs while
680                              )   installing, generated by automake
681      mkinstalldirs           script for making install directories
682      perltest.pl             Perl test program
683      pcre-config.in          source of script which retains PCRE information
684      pcrecpp_unittest.cc          )
685      pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
686      pcre_stringpiece_unittest.cc )
687      testdata/testinput*     test data for main library tests
688      testdata/testoutput*    expected test results
689      testdata/grep*          input and output for pcregrep tests
690    
691  (C) Auxiliary files for Win32 DLL  (D) Auxiliary files for cmake support
692    
693    libpcre.def    CMakeLists.txt
694    libpcreposix.def    config-cmake.h.in
695    
696  (D) Auxiliary file for VPASCAL  (E) Auxiliary files for VPASCAL
697    
698    makevp.bat    makevp.bat
699      makevp_c.txt
700      makevp_l.txt
701      pcregexp.pas
702    
703    (F) Auxiliary files for building PCRE "by hand"
704    
705      pcre.h.generic          ) a version of the public PCRE header file
706                              )   for use in non-"configure" environments
707      config.h.generic        ) a version of config.h for use in non-"configure"
708                              )   environments
709    
710    (F) Miscellaneous
711    
712      RunTest.bat            a script for running tests under Windows
713    
714  Philip Hazel  Philip Hazel
715  Email local part: ph10  Email local part: ph10
716  Email domain: cam.ac.uk  Email domain: cam.ac.uk
717  March 2007  Last updated: 24 April 2007

Legend:
Removed from v.101  
changed lines
  Added in v.155

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12