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

Diff of /code/trunk/README

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

revision 65 by nigel, Sat Feb 24 21:40:08 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  PCRE has its own native API, but a set of "wrapper" functions that are based on    The PCRE APIs
16  the POSIX API are also supplied in the library libpcreposix. Note that this    Documentation for PCRE
17  just provides a POSIX calling interface to PCRE: the regular expressions    Contributions by users of PCRE
18  themselves still follow Perl syntax and semantics. The header file    Building PCRE on non-Unix systems
19  for the POSIX-style functions is called pcreposix.h. The official POSIX name is    Building PCRE on Unix-like systems
20  regex.h, but I didn't want to risk possible problems with existing files of    Retrieving configuration information on Unix-like systems
21  that name by distributing it that way. To use it with an existing program that    Shared libraries on Unix-like systems
22  uses the POSIX API, it will have to be renamed or pointed at by a link.    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
31    -------------
32    
33    PCRE is written in C, and it has its own API. The distribution also includes a
34    set of C++ wrapper functions (see the pcrecpp man page for details), courtesy
35    of Google Inc.
36    
37    In addition, there is a set of C wrapper functions that are based on the POSIX
38    regular expression API (see the pcreposix man page). These end up in the
39    library called libpcreposix. Note that this just provides a POSIX calling
40    interface to PCRE; the regular expressions themselves still follow Perl syntax
41    and semantics. The POSIX API is restricted, and does not give full access to
42    all of PCRE's facilities.
43    
44    The header file for the POSIX-style functions is called pcreposix.h. The
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
51    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
54    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
65    ----------------------
66    
67    If you install PCRE in the normal way on a Unix-like system, you will end up
68    with a set of man pages whose names all start with "pcre". The one that is just
69    called "pcre" lists all the others. In addition to these man pages, the PCRE
70    documentation is supplied in two other forms:
71    
72      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         concatenation of the text forms of all the section 3 man pages except
75         those that summarize individual functions. The other two are the text
76         forms of the section 1 man pages for the pcregrep and pcretest commands.
77         These text forms are provided for ease of scanning with text editors or
78         similar tools. They are installed in <prefix>/share/doc/pcre, where
79         <prefix> is the installation prefix (defaulting to /usr/local).
80    
81      2. A set of files containing all the documentation in HTML form, hyperlinked
82         in various ways, and rooted in a file called index.html, is distributed in
83         doc/html and installed in <prefix>/share/doc/pcre/html.
84    
85    
86  Contributions by users of PCRE  Contributions by users of PCRE
# Line 24  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  Building PCRE on a Unix-like system  
113  -----------------------------------  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    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 56  into /source/pcre/pcre-xxx, but you want Line 144  into /source/pcre/pcre-xxx, but you want
144  cd /build/pcre/pcre-xxx  cd /build/pcre/pcre-xxx
145  /source/pcre/pcre-xxx/configure  /source/pcre/pcre-xxx/configure
146    
147    PCRE is written in C and is normally compiled as a C library. However, it is
148    possible to build it as a C++ library, though the provided building apparatus
149    does not have any features to support this.
150    
151  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
152  library. You can read more about them in the pcrebuild man page.  library. You can read more about them in the pcrebuild man page.
153    
154    . 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,
156      it will try to find a C++ compiler and C++ header files, and if it succeeds,
157      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
161    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
162    still has to be enabled by an option at run time.)    still has to be enabled by an option at run time.)
163    
164  . You can build PCRE to recognized CR or NL as the newline character, instead  . If, in addition to support for UTF-8 character strings, you want to include
165    of whatever your compiler uses for "\n", by adding --newline-is-cr or    support for the \P, \p, and \X sequences that recognize Unicode character
166    --newline-is-nl to the "configure" command, respectively. Only do this if you    properties, you must add --enable-unicode-properties to the "configure"
167    really understand what you are doing. On traditional Unix-like systems, the    command. This adds about 30K to the size of the library (in the form of a
168    newline character is NL.    property table); only the basic two-letter properties such as Lu are
169      supported.
170    
171    . You can build PCRE to recognize either CR or LF or the sequence CRLF or any
172      of the preceding, or any of the Unicode newline sequences as indicating the
173      end of a line. Whatever you specify at build time is the default; the caller
174      of PCRE can change the selection at run time. The default newline indicator
175      is a single LF character (the Unix standard). You can specify the default
176      newline indicator by adding --enable-newline-is-cr or --enable-newline-is-lf
177      or --enable-newline-is-crlf or --enable-newline-is-anycrlf or
178      --enable-newline-is-any to the "configure" command, respectively.
179    
180      If you specify --enable-newline-is-cr or --enable-newline-is-crlf, some of
181      the standard tests will fail, because the lines in the test files end with
182      LF. Even if the files are edited to change the line endings, there are likely
183      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    
193    on the "configure" command.    on the "configure" command.
194    
195  . PCRE has a counter which can be set to limit the amount of resources it uses.  . PCRE has a counter that can be set to limit the amount of resources it uses.
196    If the limit is exceeded during a match, the match fails. The default is ten    If the limit is exceeded during a match, the match fails. The default is ten
197    million. You can change the default by setting, for example,    million. You can change the default by setting, for example,
198    
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
206      during a matching process. This also has a default of ten million, which is
207      essentially "unlimited". You can change the default by setting, for example,
208    
209      --with-match-limit-recursion=500000
210    
211      Recursive function calls use up the runtime stack; running out of stack can
212      cause programs to crash in strange ways. There is a discussion about stack
213      sizes in the pcrestack man page.
214    
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.
220    is a representation of the compiled pattern, and this changes with the link  
221    size.  . 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 memory blocks
223      obtained from the heap via the special functions pcre_stack_malloc() and
224      pcre_stack_free() to save data that would otherwise be saved on the stack. To
225      build PCRE like this, use
226    
227      --disable-stack-for-recursion
228    
229      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
231      pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not
232      use deeply nested recursion. There is a discussion about stack sizes in the
233      pcrestack man page.
234    
235    . For speed, PCRE uses four tables for manipulating and identifying characters
236      whose code point values are less than 256. By default, it uses a set of
237      tables for ASCII encoding that is part of the distribution. If you specify
238    
239      --enable-rebuild-chartables
240    
241      a program called dftables is compiled and run in the default C locale when
242      you obey "make". It builds a source file called pcre_chartables.c. If you do
243      not specify this option, pcre_chartables.c is created as a copy of
244      pcre_chartables.c.dist. See "Character tables" below for further information.
245    
246  The "configure" script builds five files:  . 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
256    . 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
259    . 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  . Makefile is built by copying Makefile.in and making substitutions.  . RunTest is a script for running tests on the basic C library
262  . config.h is built by copying config.in and making substitutions.  . RunGrepTest is a script for running tests on the pcregrep command
263  . pcre-config is built by copying pcre-config.in and making substitutions.  
264  . RunTest is a script for running tests  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  Once "configure" has run, you can run "make". It builds two libraries called  benefit of those who have to built PCRE without the benefit of "configure". If
267  libpcre and libpcreposix, a test program called pcretest, and the pcregrep  you use "configure", the .generic versions are not used.
268  command. You can use "make install" to copy these, the public header files  
269  pcre.h and pcreposix.h, and the man pages to appropriate live directories on  If a C++ compiler is found, the following files are also built:
270  your system, in the normal way.  
271    . libpcrecpp.pc is data for the pkg-config command
272  Running "make install" also installs the command pcre-config, which can be used  . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper
273  to recall information about the PCRE configuration and installation. For  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions
274  example,  
275    The "configure" script also creates config.status, which is an executable
276    script that can be run to recreate the configuration, and config.log, which
277    contains compiler output from tests that "configure" runs.
278    
279    Once "configure" has run, you can run "make". It builds two libraries, called
280    libpcre and libpcreposix, a test program called pcretest, a demonstration
281    program called pcredemo, and the pcregrep command. If a C++ compiler was found
282    on your system, "make" also builds the C++ wrapper library, which is called
283    libpcrecpp, and some test programs called pcrecpp_unittest,
284    pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper
285    can be disabled by adding --disable-cpp to the "configure" command.
286    
287    The command "make check" runs all the appropriate tests. Details of the PCRE
288    tests are given below in a separate section of this document.
289    
290    You can use "make install" to install PCRE into live directories on your
291    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".
341    This removes all the files that "make install" installed. However, it does not
342    remove any directories, because these are often shared with other programs.
343    
344    
345    Retrieving configuration information on Unix-like systems
346    ---------------------------------------------------------
347    
348    Running "make install" installs the command pcre-config, which can be used to
349    recall information about the PCRE configuration and installation. For example:
350    
351    pcre-config --version    pcre-config --version
352    
353  prints the version number, and  prints the version number, and
354    
355   pcre-config --libs    pcre-config --libs
356    
357  outputs information about where the library is installed. This command can be  outputs information about where the library is installed. This command can be
358  included in makefiles for programs that use PCRE, saving the programmer from  included in makefiles for programs that use PCRE, saving the programmer from
359  having to remember too many details.  having to remember too many details.
360    
361    The pkg-config command is another system for saving and retrieving information
362    about installed libraries. Instead of separate commands for each library, a
363    single command is used. For example:
364    
365  Cross-compiling PCRE on a Unix-like system    pkg-config --cflags pcre
 ------------------------------------------  
366    
367  PCRE needs to compile and run an auxiliary program as part of the building  The data is held in *.pc files that are installed in a directory called
368  process. Obviously, if the real compilation is for some other system, it can't  <prefix>/lib/pkgconfig.
 use the same CC and CFLAGS values when it is doing this. For cross compilation,  
 therefore, you must set CC_FOR_BUILD to the local host's compiler, and you can  
 set flags in CFLAGS_FOR_BUILD if you need to.  
369    
370    
371  Shared libraries on Unix-like systems  Shared libraries on Unix-like systems
372  -------------------------------------  -------------------------------------
373    
374  The default distribution builds PCRE as two shared libraries and two static  The default distribution builds PCRE as shared libraries and static libraries,
375  libraries, as long as the operating system supports shared libraries. Shared  as long as the operating system supports shared libraries. Shared library
376  library support relies on the "libtool" script which is built as part of the  support relies on the "libtool" script which is built as part of the
377  "configure" process.  "configure" process.
378    
379  The libtool script is used to compile and link both shared and static  The libtool script is used to compile and link both shared and static
# Line 149  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
389  configuring it. For example  configuring it. For example:
390    
391  ./configure --prefix=/usr/gnu --disable-shared  ./configure --prefix=/usr/gnu --disable-shared
392    
# Line 161  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 HOST_CC (and if necessary HOST_CFLAGS) when  because dftables.c needs to be compiled with the local compiler, not the cross
406  calling the "configure" command. If they are not specified, they default to the  compiler.
407  values of CC and CFLAGS.  
408    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  Building on non-Unix systems  that assumes ASCII code. Cross-compiling with the default tables should not be
411  ----------------------------  a problem.
412    
413  For a non-Unix system, read the comments in the file NON-UNIX-USE. PCRE has  If you need to modify the character tables when cross-compiling, you should
414  been compiled on Windows systems and on Macintoshes, but I don't know the  move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
415  details because I don't use those systems. It should be straightforward to  run it on the local host to make a new version of pcre_chartables.c.dist.
416  build PCRE on any system that has a Standard C compiler, because it uses only  Then when you cross-compile PCRE this new version of the tables will be used.
417  Standard C functions.  
418    
419    Using HP's ANSI C++ compiler (aCC)
420    ----------------------------------
421    
422    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
424    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
427    needed libraries fail to get included when specifying the "-AA" compiler
428    option. If you experience unresolved symbols when linking the C++ programs,
429    use the workaround of specifying the following environment variable prior to
430    running the "configure" script:
431    
432      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. (This can also be run by "make runtest", "make check", or  created by the configuring process. There is also a script called RunGrepTest
452  "make test".) For other systems, see the instruction in NON-UNIX-USE.  that tests the options of the pcregrep command. If the C++ wrapper library is
453    built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
454  The script runs the pcretest test program (which is documented in its own man  pcre_stringpiece_unittest are also built.
455  page) on each of the testinput files (in the testdata directory) in turn,  
456  and compares the output with the contents of the corresponding testoutput file.  Both the scripts and all the program tests are run if you obey "make check" or
457  A file called testtry is used to hold the output from pcretest. To run pcretest  "make test". For other systems, see the instructions in NON-UNIX-USE.
458  on just one of the test files, give its number as an argument to RunTest, for  
459  example:  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
461    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
463    (testsavedregex is also used as a working file). To run pcretest on just one of
464    the test files, give its number as an argument to RunTest, for example:
465    
466    RunTest 2    RunTest 2
467    
468  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
469  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
470  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 222  bug in PCRE. Line 488  bug in PCRE.
488    
489  The third set of tests checks pcre_maketables(), the facility for building a  The third set of tests checks pcre_maketables(), the facility for building a
490  set of character tables for a specific locale and using them instead of the  set of character tables for a specific locale and using them instead of the
491  default tables. The tests make use of the "fr" (French) locale. Before running  default tables. The tests make use of the "fr_FR" (French) locale. Before
492  the test, the script checks for the presence of this locale by running the  running the test, the script checks for the presence of this locale by running
493  "locale" command. If that command fails, or if it doesn't include "fr" in the  the "locale" command. If that command fails, or if it doesn't include "fr_FR"
494  list of available locales, the third test cannot be run, and a comment is  in the list of available locales, the third test cannot be run, and a comment
495  output to say why. If running this test produces instances of the error  is output to say why. If running this test produces instances of the error
496    
497    ** Failed to set locale "fr"    ** Failed to set locale "fr_FR"
498    
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,
508  provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,  provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,
509  commented in the script, can be be used.)  commented in the script, can be be used.)
510    
511  The fifth and final file tests error handling with UTF-8 encoding, and internal  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8
512  UTF-8 features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
513    
514    The sixth test checks the support for Unicode character properties. It it not
515    run automatically unless PCRE is built with Unicode property support. To to
516    this you must set --enable-unicode-properties when running "configure".
517    
518    The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative
519    matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode
520    property support, respectively. The eighth and ninth tests are not run
521    automatically unless PCRE is build with the relevant support.
522    
523    
524  Character tables  Character tables
525  ----------------  ----------------
526    
527  PCRE uses four tables for manipulating and identifying characters. The final  For speed, PCRE uses four tables for manipulating and identifying characters
528  argument of the pcre_compile() function is a pointer to a block of memory  whose code point values are less than 256. The final argument of the
529  containing the concatenated tables. A call to pcre_maketables() can be used to  pcre_compile() function is a pointer to a block of memory containing the
530  generate a set of tables in the current locale. If the final argument for  concatenated tables. A call to pcre_maketables() can be used to generate a set
531  pcre_compile() is passed as NULL, a set of default tables that is built into  of tables in the current locale. If the final argument for pcre_compile() is
532  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 282  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:
584      headers:  
585      dftables.c              auxiliary program for building pcre_chartables.c
586                                when --enable-rebuild-chartables is specified
587    
588    dftables.c            auxiliary program for building chartables.c    pcre_chartables.c.dist  a default set of character tables that assume ASCII
589    get.c                 )                              coding; used, unless --enable-rebuild-chartables is
590    maketables.c          )                              specified, by copying to pcre_chartables.c
591    study.c               ) source of  
592    pcre.c                )   the functions    pcreposix.c             )
593    pcreposix.c           )    pcre_compile.c          )
594    printint.c            )    pcre_config.c           )
595    pcre.in               "source" for the header for the external API; pcre.h    pcre_dfa_exec.c         )
596                            is built from this by "configure"    pcre_exec.c             )
597    pcreposix.h           header for the external POSIX wrapper API    pcre_fullinfo.c         )
598    internal.h            header for internal use    pcre_get.c              ) sources for the functions in the library,
599    config.in             template for config.h, which is built by configure    pcre_globals.c          )   and some internal functions that they use
600      pcre_info.c             )
601  (B) Auxiliary files:    pcre_maketables.c       )
602      pcre_newline.c          )
603    AUTHORS               information about the author of PCRE    pcre_ord2utf8.c         )
604    ChangeLog             log of changes to the code    pcre_refcount.c         )
605    INSTALL               generic installation instructions    pcre_study.c            )
606    LICENCE               conditions for the use of PCRE    pcre_tables.c           )
607    COPYING               the same, using GNU's standard name    pcre_try_flipped.c      )
608    Makefile.in           template for Unix Makefile, which is built by configure    pcre_ucp_searchfuncs.c  )
609    NEWS                  important changes in this release    pcre_valid_utf8.c       )
610    NON-UNIX-USE          notes on building PCRE on non-Unix systems    pcre_version.c          )
611    README                this file    pcre_xclass.c           )
612    RunTest.in            template for a Unix shell script for running tests    pcre_printint.src       ) debugging function that is #included in pcretest,
613    config.guess          ) files used by libtool,                            )   and can also be #included in pcre_compile()
614    config.sub            )   used only when building a shared library    pcre.h.in               template for pcre.h when built by "configure"
615    configure             a configuring shell script (built by autoconf)    pcreposix.h             header for the external POSIX wrapper API
616    configure.in          the autoconf input used to build configure    pcre_internal.h         header for internal use
617    doc/Tech.Notes        notes on the encoding    ucp.h                   ) headers concerned with
618    doc/*.3               man page sources for the PCRE functions    ucpinternal.h           )   Unicode property handling
619    doc/*.1               man page sources for pcregrep and pcretest    ucptable.h              ) (this one is the data table)
620    doc/html/*            HTML documentation  
621    doc/pcre.txt          plain text version of the man pages    config.h.in             template for config.h, which is built by "configure"
622    doc/pcretest.txt      plain text documentation of test program  
623    doc/perltest.txt      plain text documentation of Perl test program    pcrecpp.h               public header file for the C++ wrapper
624    install-sh            a shell script for installing files    pcrecpparg.h.in         template for another C++ header file
625    ltmain.sh             file used to build a libtool script    pcre_scanner.h          public header file for C++ scanner functions
626    pcretest.c            comprehensive test program    pcrecpp.cc              )
627    pcredemo.c            simple demonstration of coding calls to PCRE    pcre_scanner.cc         ) source for the C++ wrapper library
628    perltest              Perl test program  
629    pcregrep.c            source of a grep utility that uses PCRE    pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
630    pcre-config.in        source of script which retains PCRE information                              C++ stringpiece functions
631    testdata/testinput1   test data, compatible with Perl    pcre_stringpiece.cc     source for the C++ stringpiece functions
632    testdata/testinput2   test data for error messages and non-Perl things  
633    testdata/testinput3   test data for locale-specific tests  (B) Source files for programs that use PCRE:
634    testdata/testinput4   test data for UTF-8 tests compatible with Perl  
635    testdata/testinput5   test data for other UTF-8 tests    pcredemo.c              simple demonstration of coding calls to PCRE
636    testdata/testoutput1  test results corresponding to testinput1    pcregrep.c              source of a grep utility that uses PCRE
637    testdata/testoutput2  test results corresponding to testinput2    pcretest.c              comprehensive test program
638    testdata/testoutput3  test results corresponding to testinput3  
639    testdata/testoutput4  test results corresponding to testinput4  (C) Auxiliary files:
640    testdata/testoutput5  test results corresponding to testinput5  
641      132html                 script to turn "man" pages into HTML
642      AUTHORS                 information about the author of PCRE
643      ChangeLog               log of changes to the code
644      CleanTxt                script to clean nroff output for txt man pages
645      Detrail                 script to remove trailing spaces
646      HACKING                 some notes about the internals of PCRE
647      INSTALL                 generic installation instructions
648      LICENCE                 conditions for the use of PCRE
649      COPYING                 the same, using GNU's standard name
650      Makefile.in             ) template for Unix Makefile, which is built by
651                              )   "configure"
652      Makefile.am             ) the automake input that was used to create
653                              )   Makefile.in
654      NEWS                    important changes in this release
655      NON-UNIX-USE            notes on building PCRE on non-Unix systems
656      PrepareRelease          script to make preparations for "make dist"
657      README                  this file
658      RunTest                 a Unix shell script for running tests
659      RunGrepTest             a Unix shell script for pcregrep tests
660      aclocal.m4              m4 macros (generated by "aclocal")
661      config.guess            ) files used by libtool,
662      config.sub              )   used only when building a shared library
663      configure               a configuring shell script (built by autoconf)
664      configure.ac            ) the autoconf input that was used to build
665                              )   "configure" and config.h
666      depcomp                 ) script to find program dependencies, generated by
667                              )   automake
668      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    dll.mk    CMakeLists.txt
694    pcre.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 <ph10@cam.ac.uk>  Philip Hazel
715  February 2003  Email local part: ph10
716    Email domain: cam.ac.uk
717    Last updated: 24 April 2007

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

  ViewVC Help
Powered by ViewVC 1.1.5