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

Diff of /code/trunk/README

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

revision 77 by nigel, Sat Feb 24 21:40:45 2007 UTC revision 142 by ph10, Fri Mar 30 15:55:18 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 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 PCRE on non-Unix systems
102    ---------------------------------
103    
104    For a non-Unix system, please read the comments in the file NON-UNIX-USE,
105    though if your system supports the use of "configure" and "make" you may be
106    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
109    straightforward to build PCRE on any system that has a Standard C compiler and
110    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
117    in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
118    
119  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
120  PCRE distribution directory, with your current directory set to the directory  PCRE distribution directory, with your current directory set to the directory
121  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
122  "autoconf" configuration script, for which generic instructions are supplied in  "autoconf" configuration script, for which generic instructions are supplied in
123  INSTALL.  the file INSTALL.
124    
125  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
126  this case, on many systems, just running "./configure" is sufficient, but the  this case, on many systems, just running "./configure" is sufficient. However,
127  usual methods of changing standard defaults are available. For example:  the usual methods of changing standard defaults are available. For example:
128    
129  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
130    
# Line 91  into /source/pcre/pcre-xxx, but you want Line 139  into /source/pcre/pcre-xxx, but you want
139  cd /build/pcre/pcre-xxx  cd /build/pcre/pcre-xxx
140  /source/pcre/pcre-xxx/configure  /source/pcre/pcre-xxx/configure
141    
142    PCRE is written in C and is normally compiled as a C library. However, it is
143    possible to build it as a C++ library, though the provided building apparatus
144    does not have any features to support this.
145    
146  There are some optional features that can be included or omitted from the PCRE  There are some optional features that can be included or omitted from the PCRE
147  library. You can read more about them in the pcrebuild man page.  library. You can read more about them in the pcrebuild man page.
148    
149    . If you want to suppress the building of the C++ wrapper library, you can add
150      --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
151      it will try to find a C++ compiler and C++ header files, and if it succeeds,
152      it will try to build the C++ wrapper.
153    
154  . 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,
155    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
156    for handling UTF-8 is not included in the library. (Even when included, it    for handling UTF-8 is not included in the library. (Even when included, it
# Line 102  library. You can read more about them in Line 159  library. You can read more about them in
159  . If, in addition to support for UTF-8 character strings, you want to include  . If, in addition to support for UTF-8 character strings, you want to include
160    support for the \P, \p, and \X sequences that recognize Unicode character    support for the \P, \p, and \X sequences that recognize Unicode character
161    properties, you must add --enable-unicode-properties to the "configure"    properties, you must add --enable-unicode-properties to the "configure"
162    command. This adds about 90K to the size of the library (in the form of a    command. This adds about 30K to the size of the library (in the form of a
163    property table); only the basic two-letter properties such as Lu are    property table); only the basic two-letter properties such as Lu are
164    supported.    supported.
165    
166  . You can build PCRE to recognized CR or NL as the newline character, instead  . You can build PCRE to recognize either CR or LF or the sequence CRLF or any
167    of whatever your compiler uses for "\n", by adding --newline-is-cr or    of the Unicode newline sequences as indicating the end of a line. Whatever
168    --newline-is-nl to the "configure" command, respectively. Only do this if you    you specify at build time is the default; the caller of PCRE can change the
169    really understand what you are doing. On traditional Unix-like systems, the    selection at run time. The default newline indicator is a single LF character
170    newline character is NL.    (the Unix standard). You can specify the default newline indicator by adding
171      --newline-is-cr or --newline-is-lf or --newline-is-crlf or --newline-is-any
172      to the "configure" command, respectively.
173    
174      If you specify --newline-is-cr or --newline-is-crlf, some of the standard
175      tests will fail, because the lines in the test files end with LF. Even if
176      the files are edited to change the line endings, there are likely to be some
177      failures. With --newline-is-any, many tests should succeed, but there may be
178      some failures.
179    
180  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
181    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
182    them. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
183    
184    --with-posix-malloc-threshold=20    --with-posix-malloc-threshold=20
185    
# Line 127  library. You can read more about them in Line 192  library. You can read more about them in
192    --with-match-limit=500000    --with-match-limit=500000
193    
194    on the "configure" command. This is just the default; individual calls to    on the "configure" command. This is just the default; individual calls to
195    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
196    man page.    pcreapi man page.
197    
198    . There is a separate counter that limits the depth of recursive function calls
199      during a matching process. This also has a default of ten million, which is
200      essentially "unlimited". You can change the default by setting, for example,
201    
202      --with-match-limit-recursion=500000
203    
204      Recursive function calls use up the runtime stack; running out of stack can
205      cause programs to crash in strange ways. There is a discussion about stack
206      sizes in the pcrestack man page.
207    
208  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
209    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
210    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
211    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
212    (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.  
213    
214  . 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
215    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
216    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
217    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
218    this, use    build PCRE like this, use
219    
220    --disable-stack-for-recursion    --disable-stack-for-recursion
221    
222    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
223    necessary in environments with limited stack sizes. This applies only to the    necessary in environments with limited stack sizes. This applies only to the
224    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
225    use deeply nested recursion.    use deeply nested recursion. There is a discussion about stack sizes in the
226      pcrestack man page.
227    
228    . For speed, PCRE uses four tables for manipulating and identifying characters
229      whose code point values are less than 256. By default, it uses a set of
230      tables for ASCII encoding that is part of the distribution. If you specify
231    
232      --enable-rebuild-chartables
233    
234      a program called dftables is compiled and run in the default C locale when
235      you obey "make". It builds a source file called pcre_chartables.c. If you do
236      not specify this option, pcre_chartables.c is created as a copy of
237      pcre_chartables.c.dist. See "Character tables" below for further information.
238    
239    . It is possible to compile PCRE for use on systems that use EBCDIC as their
240      default character code (as opposed to ASCII) by specifying
241    
242  The "configure" script builds eight files for the basic C library:    --enable-ebcdic
243    
244      This automatically implies --enable-rebuild-chartables (see above).
245    
246    The "configure" script builds the following files for the basic C library:
247    
 . pcre.h is the header file for C programs that call PCRE  
248  . Makefile is the makefile that builds the library  . Makefile is the makefile that builds the library
249  . config.h contains build-time configuration options for the library  . config.h contains build-time configuration options for the library
250    . pcre.h is the public PCRE header file
251  . pcre-config is a script that shows the settings of "configure" options  . pcre-config is a script that shows the settings of "configure" options
252  . libpcre.pc is data for the pkg-config command  . libpcre.pc is data for the pkg-config command
253  . libtool is a script that builds shared and/or static libraries  . libtool is a script that builds shared and/or static libraries
254  . RunTest is a script for running tests on the library  . RunTest is a script for running tests on the basic C library
255  . RunGrepTest is a script for running tests on the pcregrep command  . RunGrepTest is a script for running tests on the pcregrep command
256    
257  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
258    the names config.h.generic and pcre.h.generic. These are provided for the
259    benefit of those who have to built PCRE without the benefit of "configure". If
260    you use "configure", the .generic versions are not used.
261    
262  . pcrecpp.h is the header file for programs that call PCRE via the C++ wrapper  If a C++ compiler is found, the following files are also built:
263    
264    . libpcrecpp.pc is data for the pkg-config command
265    . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper
266  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions
267    
268  The "configure" script also creates config.status, which is an executable  The "configure" script also creates config.status, which is an executable
# Line 172  script that can be run to recreate the c Line 270  script that can be run to recreate the c
270  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
271    
272  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
273  libpcre and libpcreposix, a test program called pcretest, and the pcregrep  libpcre and libpcreposix, a test program called pcretest, a demonstration
274  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
275  wrapper library, which is called libpcrecpp, and some test programs called  on your system, "make" also builds the C++ wrapper library, which is called
276  pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.  libpcrecpp, and some test programs called pcrecpp_unittest,
277    pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper
278  The command "make test" runs all the appropriate tests. Details of the PCRE  can be disabled by adding --disable-cpp to the "configure" command.
279  tests are given in a separate section of this document, below.  
280    The command "make check" runs all the appropriate tests. Details of the PCRE
281  You can use "make install" to copy the libraries, the public header files  tests are given below in a separate section of this document.
282  pcre.h, pcreposix.h, pcrecpp.h, and pcre_stringpiece.h (the last two only if  
283  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
284  on your system, in the normal way.  system. The following are installed (file names are all relative to the
285    <prefix> that is set when "configure" is run):
286    
287      Commands (bin):
288        pcretest
289        pcregrep
290        pcre-config
291    
292      Libraries (lib):
293        libpcre
294        libpcreposix
295        libpcrecpp (if C++ support is enabled)
296    
297      Configuration information (lib/pkgconfig):
298        libpcre.pc
299        libpcrecpp.pc (if C++ support is enabled)
300    
301      Header files (include):
302        pcre.h
303        pcreposix.h
304        pcre_scanner.h      )
305        pcre_stringpiece.h  ) if C++ support is enabled
306        pcrecpp.h           )
307        pcrecpparg.h        )
308    
309      Man pages (share/man/man{1,3}):
310        pcregrep.1
311        pcretest.1
312        pcre.3
313        pcre*.3 (lots more pages, all starting "pcre")
314    
315      HTML documentation (share/doc/pcre/html):
316        index.html
317        *.html (lots more pages, hyperlinked from index.html)
318    
319      Text file documentation (share/doc/pcre):
320        AUTHORS
321        COPYING
322        ChangeLog
323        LICENCE
324        NEWS
325        README
326        pcre.txt       (a concatenation of the man(3) pages)
327        pcretest.txt   the pcretest man page
328        pcregrep.txt   the pcregrep man page
329    
330    Note that the pcredemo program that is built by "configure" is *not* installed
331    anywhere. It is a demonstration for programmers wanting to use PCRE.
332    
333  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".
334  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 193  remove any directories, because these ar Line 338  remove any directories, because these ar
338  Retrieving configuration information on Unix-like systems  Retrieving configuration information on Unix-like systems
339  ---------------------------------------------------------  ---------------------------------------------------------
340    
341  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
342  to recall information about the PCRE configuration and installation. For  recall information about the PCRE configuration and installation. For example:
 example:  
343    
344    pcre-config --version    pcre-config --version
345    
# Line 214  single command is used. For example: Line 358  single command is used. For example:
358    pkg-config --cflags pcre    pkg-config --cflags pcre
359    
360  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
361  pkgconfig.  <prefix>/lib/pkgconfig.
362    
363    
364  Shared libraries on Unix-like systems  Shared libraries on Unix-like systems
# Line 231  built. The programs pcretest and pcregre Line 375  built. The programs pcretest and pcregre
375  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
376  you use "make install" to install shared libraries, pcregrep and pcretest are  you use "make install" to install shared libraries, pcregrep and pcretest are
377  automatically re-built to use the newly installed shared libraries before being  automatically re-built to use the newly installed shared libraries before being
378  installed themselves. However, the versions left in the source directory still  installed themselves. However, the versions left in the build directory still
379  use the uninstalled libraries.  use the uninstalled libraries.
380    
381  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 243  Then run "make" in the usual way. Simila Line 387  Then run "make" in the usual way. Simila
387  build only shared libraries.  build only shared libraries.
388    
389    
390  Cross-compiling on a Unix-like system  Cross-compiling on Unix-like systems
391  -------------------------------------  ------------------------------------
392    
393  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
394  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
395  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
396  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
397  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,
398  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
399  there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)  compiler.
400  when calling the "configure" command. If they are not specified, they default  
401  to the values of CC and CFLAGS.  When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
402    by making a copy of pcre_chartables.c.dist, which is a default set of tables
403    that assumes ASCII code. Cross-compiling with the default tables should not be
404  Building on non-Unix systems  a problem.
405  ----------------------------  
406    If you need to modify the character tables when cross-compiling, you should
407  For a non-Unix system, read the comments in the file NON-UNIX-USE, though if  move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
408  the system supports the use of "configure" and "make" you may be able to build  run it on the local host to make a new version of pcre_chartables.c.dist.
409  PCRE in the same way as for Unix systems.  Then when you cross-compile PCRE this new version of the tables will be used.
410    
411  PCRE has been compiled on Windows systems and on Macintoshes, but I don't know  
412  the details because I don't use those systems. It should be straightforward to  Using HP's ANSI C++ compiler (aCC)
413  build PCRE on any system that has a Standard C compiler, because it uses only  ----------------------------------
414  Standard C functions.  
415    Unless C++ support is disabled by specifying the "--disable-cpp" option of the
416    "configure" script, you must include the "-AA" option in the CXXFLAGS
417    environment variable in order for the C++ components to compile correctly.
418    
419    Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby
420    needed libraries fail to get included when specifying the "-AA" compiler
421    option. If you experience unresolved symbols when linking the C++ programs,
422    use the workaround of specifying the following environment variable prior to
423    running the "configure" script:
424    
425      CXXLDFLAGS="-lstd_v2 -lCsup_v2"
426    
427    
428    Making new tarballs
429    -------------------
430    
431    The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
432    zip formats. However, if you have modified any of the man page sources in the
433    doc directory, you should first run the PrepareRelease script. This re-creates
434    the .txt and HTML forms of the documentation from the man pages.
435    
436    
437  Testing PCRE  Testing PCRE
438  ------------  ------------
439    
440  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
441  configuring process. There is also a script called RunGrepTest that tests the  created by the configuring process. There is also a script called RunGrepTest
442  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
443  test programs called pcrecpp_unittest, pcre_scanner_unittest, and  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
444  pcre_stringpiece_unittest are provided.  pcre_stringpiece_unittest are also built.
445    
446  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
447  "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.  
448    
449  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
450  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
451  turn, and compares the output with the contents of the corresponding testoutput  turn, and compares the output with the contents of the corresponding testoutput
452  file. 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
453  (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
454  the test files, give its number as an argument to RunTest, for example:  the test files, give its number as an argument to RunTest, for example:
455    
456    RunTest 2    RunTest 2
457    
458  The first file can also be fed directly into the perltest script to check that  The first test file can also be fed directly into the perltest.pl script to
459  Perl gives the same results. The only difference you should see is in the first  check that Perl gives the same results. The only difference you should see is
460  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
461    version.
462    
463  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
464  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
465  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
466  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
467  pcre_compile().  pcre_compile().
468    
469  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 325  is output to say why. If running this te Line 489  is output to say why. If running this te
489  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,
490  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.
491    
492    [If you are trying to run this test on Windows, you may be able to get it to
493    work by changing "fr_FR" to "french" everywhere it occurs.]
494    
495  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
496  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
497  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 334  commented in the script, can be be used. Line 501  commented in the script, can be be used.
501  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
502  features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
503    
504  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
505  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
506  this you must set --enable-unicode-properties when running "configure".  this you must set --enable-unicode-properties when running "configure".
507    
508  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 347  automatically unless PCRE is build with Line 514  automatically unless PCRE is build with
514  Character tables  Character tables
515  ----------------  ----------------
516    
517  PCRE uses four tables for manipulating and identifying characters whose values  For speed, PCRE uses four tables for manipulating and identifying characters
518  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
519  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
520  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
521  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
522  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.
523    
524  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
525  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
526  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
527  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
528  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
529  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
530  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
531  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
532  re-generated.  the default tables by editing pcre_chartables.c and then re-building PCRE. If
533    you do this, you should take care to ensure that the file does not get
534    automatically re-generated. The best way to do this is to move
535    pcre_chartables.c.dist out of the way and replace it with your customized
536    tables.
537    
538    When the dftables program is run as a result of --enable-rebuild-chartables,
539    it uses the default C locale that is set on your system. It does not pay
540    attention to the LC_xxx environment variables. In other words, it uses the
541    system's default locale rather than whatever the compiling user happens to have
542    set. If you really do want to build a source set of character tables in a
543    locale that is specified by the LC_xxx variables, you can run the dftables
544    program by hand with the -L option. For example:
545    
546      ./dftables -L pcre_chartables.c.special
547    
548  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,
549  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
550  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
551  building 32-byte bit maps that represent character classes.  building 32-byte bit maps that represent character classes for code points less
552    than 256.
553    
554  The final 256-byte table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
555  follows:  follows:
# Line 383  You should not alter the set of characte Line 565  You should not alter the set of characte
565  will cause PCRE to malfunction.  will cause PCRE to malfunction.
566    
567    
568  Manifest  File manifest
569  --------  -------------
570    
571  The distribution should contain the following files:  The distribution should contain the following files:
572    
573  (A) The actual source files of the PCRE library functions and their  (A) Source files of the PCRE library functions and their headers:
574      headers:  
575      dftables.c              auxiliary program for building pcre_chartables.c
576                                when --enable-rebuild-chartables is specified
577    
578    dftables.c            auxiliary program for building chartables.c    pcre_chartables.c.dist  a default set of character tables that assume ASCII
579                                coding; used, unless --enable-rebuild-chartables is
580                                specified, by copying to pcre_chartables.c
581    
582      pcreposix.c             )
583      pcre_compile.c          )
584      pcre_config.c           )
585      pcre_dfa_exec.c         )
586      pcre_exec.c             )
587      pcre_fullinfo.c         )
588      pcre_get.c              ) sources for the functions in the library,
589      pcre_globals.c          )   and some internal functions that they use
590      pcre_info.c             )
591      pcre_maketables.c       )
592      pcre_newline.c          )
593      pcre_ord2utf8.c         )
594      pcre_refcount.c         )
595      pcre_study.c            )
596      pcre_tables.c           )
597      pcre_try_flipped.c      )
598      pcre_ucp_searchfuncs.c  )
599      pcre_valid_utf8.c       )
600      pcre_version.c          )
601      pcre_xclass.c           )
602      pcre_printint.src       ) debugging function that is #included in pcretest,
603                              )   and can also be #included in pcre_compile()
604      pcre.h.in               template for pcre.h when built by "configure"
605      pcreposix.h             header for the external POSIX wrapper API
606      pcre_internal.h         header for internal use
607      ucp.h                   ) headers concerned with
608      ucpinternal.h           )   Unicode property handling
609      ucptable.h              ) (this one is the data table)
610    
611      config.h.in             template for config.h, which is built by "configure"
612    
613      pcrecpp.h               public header file for the C++ wrapper
614      pcrecpparg.h.in         template for another C++ header file
615      pcre_scanner.h          public header file for C++ scanner functions
616      pcrecpp.cc              )
617      pcre_scanner.cc         ) source for the C++ wrapper library
618    
619      pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
620                                C++ stringpiece functions
621      pcre_stringpiece.cc     source for the C++ stringpiece functions
622    
623    (B) Source files for programs that use PCRE:
624    
625      pcredemo.c              simple demonstration of coding calls to PCRE
626      pcregrep.c              source of a grep utility that uses PCRE
627      pcretest.c              comprehensive test program
628    
629    (C) Auxiliary files:
630    
631      132html                 script to turn "man" pages into HTML
632      AUTHORS                 information about the author of PCRE
633      ChangeLog               log of changes to the code
634      CleanTxt                script to clean nroff output for txt man pages
635      Detrail                 script to remove trailing spaces
636      HACKING                 some notes about the internals of PCRE
637      INSTALL                 generic installation instructions
638      LICENCE                 conditions for the use of PCRE
639      COPYING                 the same, using GNU's standard name
640      Makefile.in             ) template for Unix Makefile, which is built by
641                              )   "configure"
642      Makefile.am             ) the automake input that was used to create
643                              )   Makefile.in
644      NEWS                    important changes in this release
645      NON-UNIX-USE            notes on building PCRE on non-Unix systems
646      PrepareRelease          script to make preparations for "make dist"
647      README                  this file
648      RunTest                 a Unix shell script for running tests
649      RunGrepTest             a Unix shell script for pcregrep tests
650      aclocal.m4              m4 macros (generated by "aclocal")
651      config.guess            ) files used by libtool,
652      config.sub              )   used only when building a shared library
653      configure               a configuring shell script (built by autoconf)
654      configure.ac            ) the autoconf input that was used to build
655                              )   "configure" and config.h
656      depcomp                 ) script to find program dependencies, generated by
657                              )   automake
658      doc/*.3                 man page sources for the PCRE functions
659      doc/*.1                 man page sources for pcregrep and pcretest
660      doc/index.html.src      the base HTML page
661      doc/html/*              HTML documentation
662      doc/pcre.txt            plain text version of the man pages
663      doc/pcretest.txt        plain text documentation of test program
664      doc/perltest.txt        plain text documentation of Perl test program
665      install-sh              a shell script for installing files
666      libpcre.pc.in           template for libpcre.pc for pkg-config
667      libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
668      ltmain.sh               file used to build a libtool script
669      missing                 ) common stub for a few missing GNU programs while
670                              )   installing, generated by automake
671      mkinstalldirs           script for making install directories
672      perltest.pl             Perl test program
673      pcre-config.in          source of script which retains PCRE information
674      pcrecpp_unittest.cc          )
675      pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
676      pcre_stringpiece_unittest.cc )
677      testdata/testinput*     test data for main library tests
678      testdata/testoutput*    expected test results
679      testdata/grep*          input and output for pcregrep tests
680    
681    pcreposix.c           )  (D) Auxiliary files for cmake support
   pcre_compile.c        )  
   pcre_config.c         )  
   pcre_dfa_exec.c       )  
   pcre_exec.c           )  
   pcre_fullinfo.c       )  
   pcre_get.c            ) sources for the functions in the library,  
   pcre_globals.c        )   and some internal functions that they use  
   pcre_info.c           )  
   pcre_maketables.c     )  
   pcre_ord2utf8.c       )  
   pcre_printint.c       )  
   pcre_study.c          )  
   pcre_tables.c         )  
   pcre_try_flipped.c    )  
   pcre_ucp_findchar.c   )  
   pcre_valid_utf8.c     )  
   pcre_version.c        )  
   pcre_xclass.c         )  
   
   ucp_findchar.c        )  
   ucp.h                 ) source for the code that is used for  
   ucpinternal.h         )   Unicode property handling  
   ucptable.c            )  
   ucptypetable.c        )  
   
   pcre.in               "source" for the header for the external API; pcre.h  
                           is built from this by "configure"  
   pcreposix.h           header for the external POSIX wrapper API  
   pcre_internal.h       header for internal use  
   config.in             template for config.h, which is built by configure  
   
   pcrecpp.h.in          "source" for the header file for the C++ wrapper  
   pcrecpp.cc            )  
   pcre_scanner.cc       ) source for the C++ wrapper library  
   
   pcre_stringpiece.h.in "source" for pcre_stringpiece.h, the header for the  
                           C++ stringpiece functions  
   pcre_stringpiece.cc   source for the C++ stringpiece functions  
   
 (B) Auxiliary files:  
   
   AUTHORS               information about the author of PCRE  
   ChangeLog             log of changes to the code  
   INSTALL               generic installation instructions  
   LICENCE               conditions for the use of PCRE  
   COPYING               the same, using GNU's standard name  
   Makefile.in           template for Unix Makefile, which is built by configure  
   NEWS                  important changes in this release  
   NON-UNIX-USE          notes on building PCRE on non-Unix systems  
   README                this file  
   RunTest.in            template for a Unix shell script for running tests  
   RunGrepTest.in        template for a Unix shell script for pcregrep tests  
   config.guess          ) files used by libtool,  
   config.sub            )   used only when building a shared library  
   configure             a configuring shell script (built by autoconf)  
   configure.in          the autoconf input used to build configure  
   doc/Tech.Notes        notes on the encoding  
   doc/*.3               man page sources for the PCRE functions  
   doc/*.1               man page sources for pcregrep and pcretest  
   doc/html/*            HTML documentation  
   doc/pcre.txt          plain text version of the man pages  
   doc/pcretest.txt      plain text documentation of test program  
   doc/perltest.txt      plain text documentation of Perl test program  
   install-sh            a shell script for installing files  
   libpcre.pc.in         "source" for libpcre.pc for pkg-config  
   ltmain.sh             file used to build a libtool script  
   mkinstalldirs         script for making install directories  
   pcretest.c            comprehensive test program  
   pcredemo.c            simple demonstration of coding calls to PCRE  
   perltest              Perl test program  
   pcregrep.c            source of a grep utility that uses PCRE  
   pcre-config.in        source of script which retains PCRE information  
   pcrecpp_unittest.c           )  
   pcre_scanner_unittest.c      ) test programs for the C++ wrapper  
   pcre_stringpiece_unittest.c  )  
   testdata/testinput*   test data for main library tests  
   testdata/testoutput*  expected test results  
   testdata/grep*        input and output for pcregrep tests  
   
 (C) Auxiliary files for Win32 DLL  
   
   libpcre.def  
   libpcreposix.def  
   pcre.def  
682    
683  (D) Auxiliary file for VPASCAL    CMakeLists.txt
684      config-cmake.h.in
685    
686    (E) Auxiliary files for VPASCAL
687    
688    makevp.bat    makevp.bat
689      makevp_c.txt
690      makevp_l.txt
691      pcregexp.pas
692    
693    (F) Auxiliary files for building PCRE "by hand"
694    
695      pcre.h.generic          ) a version of the public PCRE header file
696                              )   for use in non-"configure" environments
697      config.h.generic        ) a version of config.h for use in non-"configure"
698                              )   environments
699    
700    (F) Miscellaneous
701    
702      RunTest.bat            a script for running tests under Windows
703    
704  Philip Hazel  Philip Hazel
705  Email local part: ph10  Email local part: ph10
706  Email domain: cam.ac.uk  Email domain: cam.ac.uk
707  June 2005  Last updated: 29 March 2007

Legend:
Removed from v.77  
changed lines
  Added in v.142

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12