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

Diff of /code/trunk/README

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

revision 96 by nigel, Fri Mar 2 13:10:43 2007 UTC revision 254 by ph10, Mon Sep 17 11:05:37 2007 UTC
# Line 5  The latest release of PCRE is always ava Line 5  The latest release of PCRE is always ava
5    
6    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.gz    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.gz
7    
8    There is a mailing list for discussion about the development of PCRE at
9    
10      pcre-dev@exim.org
11    
12  Please read the NEWS file if you are upgrading from a previous release.  Please read the NEWS file if you are upgrading from a previous release.
13    The contents of this README file are:
14    
15      The PCRE APIs
16      Documentation for PCRE
17      Contributions by users of PCRE
18      Building PCRE on non-Unix systems
19      Building PCRE on Unix-like systems
20      Retrieving configuration information on Unix-like systems
21      Shared libraries on Unix-like systems
22      Cross-compiling on Unix-like systems
23      Using HP's ANSI C++ compiler (aCC)
24      Making new tarballs
25      Testing PCRE
26      Character tables
27      File manifest
28    
29    
30  The PCRE APIs  The PCRE APIs
31  -------------  -------------
32    
33  PCRE is written in C, and it has its own API. The distribution now includes a  PCRE is written in C, and it has its own API. The distribution also includes a
34  set of C++ wrapper functions, courtesy of Google Inc. (see the pcrecpp man page  set of C++ wrapper functions (see the pcrecpp man page for details), courtesy
35  for details).  of Google Inc.
36    
37  Also included are a set of C wrapper functions that are based on the POSIX  In addition, there is a set of C wrapper functions that are based on the POSIX
38  API. These end up in the library called libpcreposix. Note that this just  regular expression API (see the pcreposix man page). These end up in the
39  provides a POSIX calling interface to PCRE: the regular expressions themselves  library called libpcreposix. Note that this just provides a POSIX calling
40  still follow Perl syntax and semantics. The header file for the POSIX-style  interface to PCRE; the regular expressions themselves still follow Perl syntax
41  functions is called pcreposix.h. The official POSIX name is regex.h, but I  and semantics. The POSIX API is restricted, and does not give full access to
42  didn't want to risk possible problems with existing files of that name by  all of PCRE's facilities.
43  distributing it that way. To use it with an existing program that uses the  
44  POSIX API, it will have to be renamed or pointed at by a link.  The header file for the POSIX-style functions is called pcreposix.h. The
45    official POSIX name is regex.h, but I did not want to risk possible problems
46    with existing files of that name by distributing it that way. To use PCRE with
47    an existing program that uses the POSIX API, pcreposix.h will have to be
48    renamed or pointed at by a link.
49    
50  If you are using the POSIX interface to PCRE and there is already a POSIX regex  If you are using the POSIX interface to PCRE and there is already a POSIX regex
51  library installed on your system, you must take care when linking programs to  library installed on your system, as well as worrying about the regex.h header
52    file (as mentioned above), you must also take care when linking programs to
53  ensure that they link with PCRE's libpcreposix library. Otherwise they may pick  ensure that they link with PCRE's libpcreposix library. Otherwise they may pick
54  up the "real" POSIX functions of the same name.  up the POSIX functions of the same name from the other library.
55    
56    One way of avoiding this confusion is to compile PCRE with the addition of
57    -Dregcomp=PCREregcomp (and similarly for the other POSIX functions) to the
58    compiler flags (CFLAGS if you are using "configure" -- see below). This has the
59    effect of renaming the functions so that the names no longer clash. Of course,
60    you have to do the same thing for your applications, or write them using the
61    new names.
62    
63    
64  Documentation for PCRE  Documentation for PCRE
65  ----------------------  ----------------------
66    
67  If you install PCRE in the normal way, you will end up with an installed set of  If you install PCRE in the normal way on a Unix-like system, you will end up
68  man pages whose names all start with "pcre". The one that is just called "pcre"  with a set of man pages whose names all start with "pcre". The one that is just
69  lists all the others. In addition to these man pages, the PCRE documentation is  called "pcre" lists all the others. In addition to these man pages, the PCRE
70  supplied in two other forms; however, as there is no standard place to install  documentation is supplied in two other forms:
71  them, they are left in the doc directory of the unpacked source distribution.  
72  These forms are:    1. There are files called doc/pcre.txt, doc/pcregrep.txt, and
73         doc/pcretest.txt in the source distribution. The first of these is a
74    1. Files called doc/pcre.txt, doc/pcregrep.txt, and doc/pcretest.txt. The       concatenation of the text forms of all the section 3 man pages except
75       first of these is a concatenation of the text forms of all the section 3       those that summarize individual functions. The other two are the text
76       man pages except those that summarize individual functions. The other two       forms of the section 1 man pages for the pcregrep and pcretest commands.
77       are the text forms of the section 1 man pages for the pcregrep and       These text forms are provided for ease of scanning with text editors or
78       pcretest commands. Text forms are provided for ease of scanning with text       similar tools. They are installed in <prefix>/share/doc/pcre, where
79       editors or similar tools.       <prefix> is the installation prefix (defaulting to /usr/local).
80    
81    2. A subdirectory called doc/html contains all the documentation in HTML    2. A set of files containing all the documentation in HTML form, hyperlinked
82       form, hyperlinked in various ways, and rooted in a file called       in various ways, and rooted in a file called index.html, is distributed in
83       doc/index.html.       doc/html and installed in <prefix>/share/doc/pcre/html.
84    
85    
86  Contributions by users of PCRE  Contributions by users of PCRE
# Line 59  You can find contributions from PCRE use Line 90  You can find contributions from PCRE use
90    
91    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
92    
93  where there is also a README file giving brief descriptions of what they are.  There is a README file giving brief descriptions of what they are. Some are
94  Several of them provide support for compiling PCRE on various flavours of  complete in themselves; others are pointers to URLs containing relevant files.
95  Windows systems (I myself do not use Windows). Some are complete in themselves;  Some of this material is likely to be well out-of-date. Several of the earlier
96  others are pointers to URLs containing relevant files.  contributions provided support for compiling PCRE on various flavours of
97    Windows (I myself do not use Windows). Nowadays there is more Windows support
98    in the standard distribution, so these contibutions have been archived.
99    
100    
101    Building 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  If you are using HP's ANSI C++ compiler (aCC), please see the special note
117  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
118    
119    The following instructions assume the use of the widely used "configure, make,
120    make install" process. There is also some experimental support for "cmake" in
121    the PCRE distribution, but it is incomplete and not documented. However, if you
122    are a "cmake" user, you might want to try it.
123    
124  To build PCRE on a Unix-like system, first run the "configure" command from the  To build PCRE on a Unix-like system, first run the "configure" command from the
125  PCRE distribution directory, with your current directory set to the directory  PCRE distribution directory, with your current directory set to the directory
126  where you want the files to be created. This command is a standard GNU  where you want the files to be created. This command is a standard GNU
127  "autoconf" configuration script, for which generic instructions are supplied in  "autoconf" configuration script, for which generic instructions are supplied in
128  INSTALL.  the file INSTALL.
129    
130  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
131  this case, on many systems, just running "./configure" is sufficient, but the  this case, on many systems, just running "./configure" is sufficient. However,
132  usual methods of changing standard defaults are available. For example:  the usual methods of changing standard defaults are available. For example:
133    
134  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
135    
# Line 103  library. You can read more about them in Line 153  library. You can read more about them in
153    
154  . If you want to suppress the building of the C++ wrapper library, you can add  . If you want to suppress the building of the C++ wrapper library, you can add
155    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
156    will try to find a C++ compiler and C++ header files, and if it succeeds, it    it will try to find a C++ compiler and C++ header files, and if it succeeds,
157    will try to build the C++ wrapper.    it will try to build the C++ wrapper.
158    
159  . If you want to make use of the support for UTF-8 character strings in PCRE,  . If you want to make use of the support for UTF-8 character strings in PCRE,
160    you must add --enable-utf8 to the "configure" command. Without it, the code    you must add --enable-utf8 to the "configure" command. Without it, the code
# Line 119  library. You can read more about them in Line 169  library. You can read more about them in
169    supported.    supported.
170    
171  . You can build PCRE to recognize either CR or LF or the sequence CRLF or any  . You can build PCRE to recognize either CR or LF or the sequence CRLF or any
172    of the Unicode newline sequences as indicating the end of a line. Whatever    of the preceding, or any of the Unicode newline sequences as indicating the
173    you specify at build time is the default; the caller of PCRE can change the    end of a line. Whatever you specify at build time is the default; the caller
174    selection at run time. The default newline indicator is a single LF character    of PCRE can change the selection at run time. The default newline indicator
175    (the Unix standard). You can specify the default newline indicator by adding    is a single LF character (the Unix standard). You can specify the default
176    --newline-is-cr or --newline-is-lf or --newline-is-crlf or --newline-is-any    newline indicator by adding --enable-newline-is-cr or --enable-newline-is-lf
177    to the "configure" command, respectively.    or --enable-newline-is-crlf or --enable-newline-is-anycrlf or
178      --enable-newline-is-any to the "configure" command, respectively.
179    
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    . By default, the sequence \R in a pattern matches any Unicode line ending
188      sequence. This is independent of the option specifying what PCRE considers to
189      be the end of a line (see above). However, the caller of PCRE can restrict \R
190      to match only CR, LF, or CRLF. You can make this the default by adding
191      --enable-bsr-anycrlf to the "configure" command (bsr = "backslash R").
192    
193  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
194    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
195    them. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
196    
197    --with-posix-malloc-threshold=20    --with-posix-malloc-threshold=20
198    
# Line 141  library. You can read more about them in Line 205  library. You can read more about them in
205    --with-match-limit=500000    --with-match-limit=500000
206    
207    on the "configure" command. This is just the default; individual calls to    on the "configure" command. This is just the default; individual calls to
208    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
209    man page.    pcreapi man page.
210    
211  . There is a separate counter that limits the depth of recursive function calls  . There is a separate counter that limits the depth of recursive function calls
212    during a matching process. This also has a default of ten million, which is    during a matching process. This also has a default of ten million, which is
# Line 157  library. You can read more about them in Line 221  library. You can read more about them in
221  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
222    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
223    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
224    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
225    (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.  
226    
227  . 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
228    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
229    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
230    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
231    this, use    build PCRE like this, use
232    
233    --disable-stack-for-recursion    --disable-stack-for-recursion
234    
235    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
236    necessary in environments with limited stack sizes. This applies only to the    necessary in environments with limited stack sizes. This applies only to the
237    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
238    use deeply nested recursion.    use deeply nested recursion. There is a discussion about stack sizes in the
239      pcrestack man page.
240    
241    . For speed, PCRE uses four tables for manipulating and identifying characters
242      whose code point values are less than 256. By default, it uses a set of
243      tables for ASCII encoding that is part of the distribution. If you specify
244    
245      --enable-rebuild-chartables
246    
247      a program called dftables is compiled and run in the default C locale when
248      you obey "make". It builds a source file called pcre_chartables.c. If you do
249      not specify this option, pcre_chartables.c is created as a copy of
250      pcre_chartables.c.dist. See "Character tables" below for further information.
251    
252    . It is possible to compile PCRE for use on systems that use EBCDIC as their
253      default character code (as opposed to ASCII) by specifying
254    
255  The "configure" script builds eight files for the basic C library:    --enable-ebcdic
256    
257      This automatically implies --enable-rebuild-chartables (see above).
258    
259    The "configure" script builds the following files for the basic C library:
260    
261  . Makefile is the makefile that builds the library  . Makefile is the makefile that builds the library
262  . config.h contains build-time configuration options for the library  . config.h contains build-time configuration options for the library
263    . pcre.h is the public PCRE header file
264  . pcre-config is a script that shows the settings of "configure" options  . pcre-config is a script that shows the settings of "configure" options
265  . libpcre.pc is data for the pkg-config command  . libpcre.pc is data for the pkg-config command
266  . libtool is a script that builds shared and/or static libraries  . libtool is a script that builds shared and/or static libraries
267  . RunTest is a script for running tests on the library  . RunTest is a script for running tests on the basic C library
268  . RunGrepTest is a script for running tests on the pcregrep command  . RunGrepTest is a script for running tests on the pcregrep command
269    
270  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
271    the names config.h.generic and pcre.h.generic. These are provided for the
272    benefit of those who have to built PCRE without the benefit of "configure". If
273    you use "configure", the .generic versions are not used.
274    
275  . 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:
276    
277    . libpcrecpp.pc is data for the pkg-config command
278    . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper
279  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions
280    
281  The "configure" script also creates config.status, which is an executable  The "configure" script also creates config.status, which is an executable
# Line 195  script that can be run to recreate the c Line 283  script that can be run to recreate the c
283  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
284    
285  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
286  libpcre and libpcreposix, a test program called pcretest, and the pcregrep  libpcre and libpcreposix, a test program called pcretest, a demonstration
287  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
288  wrapper library, which is called libpcrecpp, and some test programs called  on your system, "make" also builds the C++ wrapper library, which is called
289  pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.  libpcrecpp, and some test programs called pcrecpp_unittest,
290    pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper
291  The command "make test" runs all the appropriate tests. Details of the PCRE  can be disabled by adding --disable-cpp to the "configure" command.
292  tests are given in a separate section of this document, below.  
293    The command "make check" runs all the appropriate tests. Details of the PCRE
294  You can use "make install" to copy the libraries, the public header files  tests are given below in a separate section of this document.
295  pcre.h, pcreposix.h, pcrecpp.h, and pcre_stringpiece.h (the last two only if  
296  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
297  on your system, in the normal way.  system. The following are installed (file names are all relative to the
298    <prefix> that is set when "configure" is run):
299    
300      Commands (bin):
301        pcretest
302        pcregrep
303        pcre-config
304    
305      Libraries (lib):
306        libpcre
307        libpcreposix
308        libpcrecpp (if C++ support is enabled)
309    
310      Configuration information (lib/pkgconfig):
311        libpcre.pc
312        libpcrecpp.pc (if C++ support is enabled)
313    
314      Header files (include):
315        pcre.h
316        pcreposix.h
317        pcre_scanner.h      )
318        pcre_stringpiece.h  ) if C++ support is enabled
319        pcrecpp.h           )
320        pcrecpparg.h        )
321    
322      Man pages (share/man/man{1,3}):
323        pcregrep.1
324        pcretest.1
325        pcre.3
326        pcre*.3 (lots more pages, all starting "pcre")
327    
328      HTML documentation (share/doc/pcre/html):
329        index.html
330        *.html (lots more pages, hyperlinked from index.html)
331    
332      Text file documentation (share/doc/pcre):
333        AUTHORS
334        COPYING
335        ChangeLog
336        LICENCE
337        NEWS
338        README
339        pcre.txt       (a concatenation of the man(3) pages)
340        pcretest.txt   the pcretest man page
341        pcregrep.txt   the pcregrep man page
342    
343    Note that the pcredemo program that is built by "configure" is *not* installed
344    anywhere. It is a demonstration for programmers wanting to use PCRE.
345    
346  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".
347  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 216  remove any directories, because these ar Line 351  remove any directories, because these ar
351  Retrieving configuration information on Unix-like systems  Retrieving configuration information on Unix-like systems
352  ---------------------------------------------------------  ---------------------------------------------------------
353    
354  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
355  to recall information about the PCRE configuration and installation. For  recall information about the PCRE configuration and installation. For example:
 example:  
356    
357    pcre-config --version    pcre-config --version
358    
# Line 237  single command is used. For example: Line 371  single command is used. For example:
371    pkg-config --cflags pcre    pkg-config --cflags pcre
372    
373  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
374  pkgconfig.  <prefix>/lib/pkgconfig.
375    
376    
377  Shared libraries on Unix-like systems  Shared libraries on Unix-like systems
# Line 254  built. The programs pcretest and pcregre Line 388  built. The programs pcretest and pcregre
388  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
389  you use "make install" to install shared libraries, pcregrep and pcretest are  you use "make install" to install shared libraries, pcregrep and pcretest are
390  automatically re-built to use the newly installed shared libraries before being  automatically re-built to use the newly installed shared libraries before being
391  installed themselves. However, the versions left in the source directory still  installed themselves. However, the versions left in the build directory still
392  use the uninstalled libraries.  use the uninstalled libraries.
393    
394  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 266  Then run "make" in the usual way. Simila Line 400  Then run "make" in the usual way. Simila
400  build only shared libraries.  build only shared libraries.
401    
402    
403  Cross-compiling on a Unix-like system  Cross-compiling on Unix-like systems
404  -------------------------------------  ------------------------------------
405    
406  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
407  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
408  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
409  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
410  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,
411  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
412  there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)  compiler.
413  when calling the "configure" command. If they are not specified, they default  
414  to the values of CC and CFLAGS.  When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
415    by making a copy of pcre_chartables.c.dist, which is a default set of tables
416    that assumes ASCII code. Cross-compiling with the default tables should not be
417    a problem.
418    
419    If you need to modify the character tables when cross-compiling, you should
420    move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
421    run it on the local host to make a new version of pcre_chartables.c.dist.
422    Then when you cross-compile PCRE this new version of the tables will be used.
423    
424    
425  Using HP's ANSI C++ compiler (aCC)  Using HP's ANSI C++ compiler (aCC)
426  ----------------------------------  ----------------------------------
427    
428  Unless C++ support is disabled by specifying the "--disable-cpp" option of the  Unless C++ support is disabled by specifying the "--disable-cpp" option of the
429  "configure" script, you *must* include the "-AA" option in the CXXFLAGS  "configure" script, you must include the "-AA" option in the CXXFLAGS
430  environment variable in order for the C++ components to compile correctly.  environment variable in order for the C++ components to compile correctly.
431    
432  Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby  Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby
# Line 296  running the "configure" script: Line 438  running the "configure" script:
438    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
439    
440    
441  Building on non-Unix systems  Making new tarballs
442  ----------------------------  -------------------
443    
444  For a non-Unix system, read the comments in the file NON-UNIX-USE, though if  The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
445  the system supports the use of "configure" and "make" you may be able to build  zip formats. The command "make distcheck" does the same, but then does a trial
446  PCRE in the same way as for Unix systems.  build of the new distribution to ensure that it works.
447    
448  PCRE has been compiled on Windows systems and on Macintoshes, but I don't know  If you have modified any of the man page sources in the doc directory, you
449  the details because I don't use those systems. It should be straightforward to  should first run the PrepareRelease script before making a distribution. This
450  build PCRE on any system that has a Standard C compiler and library, because it  script creates the .txt and HTML forms of the documentation from the man pages.
 uses only Standard C functions.  
451    
452    
453  Testing PCRE  Testing PCRE
454  ------------  ------------
455    
456  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
457  configuring process. There is also a script called RunGrepTest that tests the  created by the configuring process. There is also a script called RunGrepTest
458  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
459  test programs called pcrecpp_unittest, pcre_scanner_unittest, and  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
460  pcre_stringpiece_unittest are provided.  pcre_stringpiece_unittest are also built.
461    
462  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
463  "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.  
464    
465  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
466  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
467  turn, and compares the output with the contents of the corresponding testoutput  turn, and compares the output with the contents of the corresponding testoutput
468  files. A file called testtry is used to hold the main output from pcretest  files. A file called testtry is used to hold the main output from pcretest
469  (testsavedregex is also used as a working file). To run pcretest on just one of  (testsavedregex is also used as a working file). To run pcretest on just one of
# Line 331  the test files, give its number as an ar Line 471  the test files, give its number as an ar
471    
472    RunTest 2    RunTest 2
473    
474  The first test file can also be fed directly into the perltest script to check  The first test file can also be fed directly into the perltest.pl script to
475  that Perl gives the same results. The only difference you should see is in the  check that Perl gives the same results. The only difference you should see is
476  first few lines, where the Perl version is given instead of the PCRE version.  in the first few lines, where the Perl version is given instead of the PCRE
477    version.
478    
479  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
480  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
481  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
482  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
483  pcre_compile().  pcre_compile().
484    
485  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 364  is output to say why. If running this te Line 505  is output to say why. If running this te
505  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,
506  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.
507    
508    [If you are trying to run this test on Windows, you may be able to get it to
509    work by changing "fr_FR" to "french" everywhere it occurs.]
510    
511  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
512  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
513  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 373  commented in the script, can be be used. Line 517  commented in the script, can be be used.
517  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
518  features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
519    
520  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
521  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
522  this you must set --enable-unicode-properties when running "configure".  this you must set --enable-unicode-properties when running "configure".
523    
524  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 386  automatically unless PCRE is build with Line 530  automatically unless PCRE is build with
530  Character tables  Character tables
531  ----------------  ----------------
532    
533  PCRE uses four tables for manipulating and identifying characters whose values  For speed, PCRE uses four tables for manipulating and identifying characters
534  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
535  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
536  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
537  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
538  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.
539    
540  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
541  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
542  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
543  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
544  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
545  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
546  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
547  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
548  re-generated.  the default tables by editing pcre_chartables.c and then re-building PCRE. If
549    you do this, you should take care to ensure that the file does not get
550    automatically re-generated. The best way to do this is to move
551    pcre_chartables.c.dist out of the way and replace it with your customized
552    tables.
553    
554    When the dftables program is run as a result of --enable-rebuild-chartables,
555    it uses the default C locale that is set on your system. It does not pay
556    attention to the LC_xxx environment variables. In other words, it uses the
557    system's default locale rather than whatever the compiling user happens to have
558    set. If you really do want to build a source set of character tables in a
559    locale that is specified by the LC_xxx variables, you can run the dftables
560    program by hand with the -L option. For example:
561    
562      ./dftables -L pcre_chartables.c.special
563    
564  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,
565  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
566  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
567  building 32-byte bit maps that represent character classes.  building 32-byte bit maps that represent character classes for code points less
568    than 256.
569    
570  The final 256-byte table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
571  follows:  follows:
# Line 422  You should not alter the set of characte Line 581  You should not alter the set of characte
581  will cause PCRE to malfunction.  will cause PCRE to malfunction.
582    
583    
584  Manifest  File manifest
585  --------  -------------
586    
587  The distribution should contain the following files:  The distribution should contain the following files:
588    
589  (A) The actual source files of the PCRE library functions and their  (A) Source files of the PCRE library functions and their headers:
     headers:  
590    
591    dftables.c            auxiliary program for building chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
592                                when --enable-rebuild-chartables is specified
593    
594    pcreposix.c           )    pcre_chartables.c.dist  a default set of character tables that assume ASCII
595    pcre_compile.c        )                              coding; used, unless --enable-rebuild-chartables is
596    pcre_config.c         )                              specified, by copying to pcre_chartables.c
597    pcre_dfa_exec.c       )  
598    pcre_exec.c           )    pcreposix.c             )
599    pcre_fullinfo.c       )    pcre_compile.c          )
600    pcre_get.c            ) sources for the functions in the library,    pcre_config.c           )
601    pcre_globals.c        )   and some internal functions that they use    pcre_dfa_exec.c         )
602    pcre_info.c           )    pcre_exec.c             )
603    pcre_maketables.c     )    pcre_fullinfo.c         )
604    pcre_newline.c        )    pcre_get.c              ) sources for the functions in the library,
605    pcre_ord2utf8.c       )    pcre_globals.c          )   and some internal functions that they use
606    pcre_refcount.c       )    pcre_info.c             )
607    pcre_study.c          )    pcre_maketables.c       )
608    pcre_tables.c         )    pcre_newline.c          )
609    pcre_try_flipped.c    )    pcre_ord2utf8.c         )
610    pcre_ucp_searchfuncs.c)    pcre_refcount.c         )
611    pcre_valid_utf8.c     )    pcre_study.c            )
612    pcre_version.c        )    pcre_tables.c           )
613    pcre_xclass.c         )    pcre_try_flipped.c      )
614    ucptable.c            )    pcre_ucp_searchfuncs.c  )
615      pcre_valid_utf8.c       )
616    pcre_printint.src     ) debugging function that is #included in pcretest, and    pcre_version.c          )
617                          )   can also be #included in pcre_compile()    pcre_xclass.c           )
618      pcre_printint.src       ) debugging function that is #included in pcretest,
619    pcre.h                the public PCRE header file                            )   and can also be #included in pcre_compile()
620    pcreposix.h           header for the external POSIX wrapper API    pcre.h.in               template for pcre.h when built by "configure"
621    pcre_internal.h       header for internal use    pcreposix.h             header for the external POSIX wrapper API
622    ucp.h                 ) headers concerned with    pcre_internal.h         header for internal use
623    ucpinternal.h         )   Unicode property handling    ucp.h                   ) headers concerned with
624    config.in             template for config.h, which is built by configure    ucpinternal.h           )   Unicode property handling
625      ucptable.h              ) (this one is the data table)
626    pcrecpp.h             the header file for the C++ wrapper  
627    pcrecpparg.h.in       "source" for another C++ header file    config.h.in             template for config.h, which is built by "configure"
628    pcrecpp.cc            )  
629    pcre_scanner.cc       ) source for the C++ wrapper library    pcrecpp.h               public header file for the C++ wrapper
630      pcrecpparg.h.in         template for another C++ header file
631    pcre_stringpiece.h.in "source" for pcre_stringpiece.h, the header for the    pcre_scanner.h          public header file for C++ scanner functions
632                            C++ stringpiece functions    pcrecpp.cc              )
633    pcre_stringpiece.cc   source for the C++ stringpiece functions    pcre_scanner.cc         ) source for the C++ wrapper library
634    
635  (B) Auxiliary files:    pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
636                                C++ stringpiece functions
637    AUTHORS               information about the author of PCRE    pcre_stringpiece.cc     source for the C++ stringpiece functions
638    ChangeLog             log of changes to the code  
639    INSTALL               generic installation instructions  (B) Source files for programs that use PCRE:
640    LICENCE               conditions for the use of PCRE  
641    COPYING               the same, using GNU's standard name    pcredemo.c              simple demonstration of coding calls to PCRE
642    Makefile.in           template for Unix Makefile, which is built by configure    pcregrep.c              source of a grep utility that uses PCRE
643    NEWS                  important changes in this release    pcretest.c              comprehensive test program
644    NON-UNIX-USE          notes on building PCRE on non-Unix systems  
645    README                this file  (C) Auxiliary files:
646    RunTest.in            template for a Unix shell script for running tests  
647    RunGrepTest.in        template for a Unix shell script for pcregrep tests    132html                 script to turn "man" pages into HTML
648    config.guess          ) files used by libtool,    AUTHORS                 information about the author of PCRE
649    config.sub            )   used only when building a shared library    ChangeLog               log of changes to the code
650    config.h.in           "source" for the config.h header file    CleanTxt                script to clean nroff output for txt man pages
651    configure             a configuring shell script (built by autoconf)    Detrail                 script to remove trailing spaces
652    configure.ac          the autoconf input used to build configure    HACKING                 some notes about the internals of PCRE
653    doc/Tech.Notes        notes on the encoding    INSTALL                 generic installation instructions
654    doc/*.3               man page sources for the PCRE functions    LICENCE                 conditions for the use of PCRE
655    doc/*.1               man page sources for pcregrep and pcretest    COPYING                 the same, using GNU's standard name
656    doc/html/*            HTML documentation    Makefile.in             ) template for Unix Makefile, which is built by
657    doc/pcre.txt          plain text version of the man pages                            )   "configure"
658    doc/pcretest.txt      plain text documentation of test program    Makefile.am             ) the automake input that was used to create
659    doc/perltest.txt      plain text documentation of Perl test program                            )   Makefile.in
660    install-sh            a shell script for installing files    NEWS                    important changes in this release
661    libpcre.pc.in         "source" for libpcre.pc for pkg-config    NON-UNIX-USE            notes on building PCRE on non-Unix systems
662    ltmain.sh             file used to build a libtool script    PrepareRelease          script to make preparations for "make dist"
663    mkinstalldirs         script for making install directories    README                  this file
664    pcretest.c            comprehensive test program    RunTest                 a Unix shell script for running tests
665    pcredemo.c            simple demonstration of coding calls to PCRE    RunGrepTest             a Unix shell script for pcregrep tests
666    perltest              Perl test program    aclocal.m4              m4 macros (generated by "aclocal")
667    pcregrep.c            source of a grep utility that uses PCRE    config.guess            ) files used by libtool,
668    pcre-config.in        source of script which retains PCRE information    config.sub              )   used only when building a shared library
669    pcrecpp_unittest.c           )    configure               a configuring shell script (built by autoconf)
670    pcre_scanner_unittest.c      ) test programs for the C++ wrapper    configure.ac            ) the autoconf input that was used to build
671    pcre_stringpiece_unittest.c  )                            )   "configure" and config.h
672    testdata/testinput*   test data for main library tests    depcomp                 ) script to find program dependencies, generated by
673    testdata/testoutput*  expected test results                            )   automake
674    testdata/grep*        input and output for pcregrep tests    doc/*.3                 man page sources for the PCRE functions
675      doc/*.1                 man page sources for pcregrep and pcretest
676      doc/index.html.src      the base HTML page
677      doc/html/*              HTML documentation
678      doc/pcre.txt            plain text version of the man pages
679      doc/pcretest.txt        plain text documentation of test program
680      doc/perltest.txt        plain text documentation of Perl test program
681      install-sh              a shell script for installing files
682      libpcre.pc.in           template for libpcre.pc for pkg-config
683      libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
684      ltmain.sh               file used to build a libtool script
685      missing                 ) common stub for a few missing GNU programs while
686                              )   installing, generated by automake
687      mkinstalldirs           script for making install directories
688      perltest.pl             Perl test program
689      pcre-config.in          source of script which retains PCRE information
690      pcrecpp_unittest.cc          )
691      pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
692      pcre_stringpiece_unittest.cc )
693      testdata/testinput*     test data for main library tests
694      testdata/testoutput*    expected test results
695      testdata/grep*          input and output for pcregrep tests
696    
697  (C) Auxiliary files for Win32 DLL  (D) Auxiliary files for cmake support
698    
699    libpcre.def    CMakeLists.txt
700    libpcreposix.def    config-cmake.h.in
701    
702  (D) Auxiliary file for VPASCAL  (E) Auxiliary files for VPASCAL
703    
704    makevp.bat    makevp.bat
705      makevp_c.txt
706      makevp_l.txt
707      pcregexp.pas
708    
709    (F) Auxiliary files for building PCRE "by hand"
710    
711      pcre.h.generic          ) a version of the public PCRE header file
712                              )   for use in non-"configure" environments
713      config.h.generic        ) a version of config.h for use in non-"configure"
714                              )   environments
715    
716    (F) Miscellaneous
717    
718      RunTest.bat            a script for running tests under Windows
719    
720  Philip Hazel  Philip Hazel
721  Email local part: ph10  Email local part: ph10
722  Email domain: cam.ac.uk  Email domain: cam.ac.uk
723  November 2006  Last updated: 17 September 2007

Legend:
Removed from v.96  
changed lines
  Added in v.254

  ViewVC Help
Powered by ViewVC 1.1.5