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

Diff of /code/trunk/README

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

revision 109 by ph10, Wed Mar 7 15:35:57 2007 UTC revision 452 by ph10, Wed Sep 16 19:18:51 2009 UTC
# Line 1  Line 1 
1  README file for PCRE (Perl-compatible regular expression library)  README file for PCRE (Perl-compatible regular expression library)
2  -----------------------------------------------------------------  -----------------------------------------------------------------
3    
4  The latest release of PCRE is always available from  The latest release of PCRE is always available in three alternative formats
5    from:
6    
7    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
8      ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.bz2
9      ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.zip
10    
11    There is a mailing list for discussion about the development of PCRE at
12    
13      pcre-dev@exim.org
14    
15  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.
16  The contents of this README file are:  The contents of this README file are:
# Line 12  The contents of this README file are: Line 19  The contents of this README file are:
19    Documentation for PCRE    Documentation for PCRE
20    Contributions by users of PCRE    Contributions by users of PCRE
21    Building PCRE on non-Unix systems    Building PCRE on non-Unix systems
22    Building PCRE on a Unix-like system    Building PCRE on Unix-like systems
23    Retrieving configuration information on a Unix-like system    Retrieving configuration information on Unix-like systems
24    Shared libraries on Unix-like systems    Shared libraries on Unix-like systems
25    Cross-compiling on a Unix-like system    Cross-compiling on Unix-like systems
26    Using HP's ANSI C++ compiler (aCC)    Using HP's ANSI C++ compiler (aCC)
27      Using PCRE from MySQL
28      Making new tarballs
29    Testing PCRE    Testing PCRE
30    Character tables    Character tables
31    File manifest    File manifest
# Line 25  The contents of this README file are: Line 34  The contents of this README file are:
34  The PCRE APIs  The PCRE APIs
35  -------------  -------------
36    
37  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
38  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
39  for details).  of Google Inc.
40    
41  Also included in the distribution are a set of C wrapper functions that are  In addition, there is a set of C wrapper functions that are based on the POSIX
42  based on the POSIX API. These end up in the library called libpcreposix. Note  regular expression API (see the pcreposix man page). These end up in the
43  that this just provides a POSIX calling interface to PCRE; the regular  library called libpcreposix. Note that this just provides a POSIX calling
44  expressions themselves still follow Perl syntax and semantics. The POSIX API is  interface to PCRE; the regular expressions themselves still follow Perl syntax
45  restricted, and does not give full access to all of PCRE's facilities.  and semantics. The POSIX API is restricted, and does not give full access to
46    all of PCRE's facilities.
47    
48  The header file for the POSIX-style functions is called pcreposix.h. The  The header file for the POSIX-style functions is called pcreposix.h. The
49  official POSIX name is regex.h, but I did not want to risk possible problems  official POSIX name is regex.h, but I did not want to risk possible problems
# Line 48  ensure that they link with PCRE's libpcr Line 58  ensure that they link with PCRE's libpcr
58  up the POSIX functions of the same name from the other library.  up the POSIX functions of the same name from the other library.
59    
60  One way of avoiding this confusion is to compile PCRE with the addition of  One way of avoiding this confusion is to compile PCRE with the addition of
61  -Dregcomp=PCREregcomp (and similarly for the other functions) to the compiler  -Dregcomp=PCREregcomp (and similarly for the other POSIX functions) to the
62  flags (CFLAGS if you are using "configure" -- see below). This has the effect  compiler flags (CFLAGS if you are using "configure" -- see below). This has the
63  of renaming the functions so that the names no longer clash. Of course, you  effect of renaming the functions so that the names no longer clash. Of course,
64  have to do the same thing for your applications, or write them using the new  you have to do the same thing for your applications, or write them using the
65  names.  new names.
66    
67    
68  Documentation for PCRE  Documentation for PCRE
69  ----------------------  ----------------------
70    
71  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
72  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
73  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
74  supplied in two other forms:  documentation is supplied in two other forms:
75    
76    1. There are files called doc/pcre.txt, doc/pcregrep.txt, and    1. There are files called doc/pcre.txt, doc/pcregrep.txt, and
77       doc/pcretest.txt in the source distribution. The first of these is a       doc/pcretest.txt in the source distribution. The first of these is a
# Line 69  supplied in two other forms: Line 79  supplied in two other forms:
79       those that summarize individual functions. The other two are the text       those that summarize individual functions. The other two are the text
80       forms of the section 1 man pages for the pcregrep and pcretest commands.       forms of the section 1 man pages for the pcregrep and pcretest commands.
81       These text forms are provided for ease of scanning with text editors or       These text forms are provided for ease of scanning with text editors or
82       similar tools.       similar tools. They are installed in <prefix>/share/doc/pcre, where
83         <prefix> is the installation prefix (defaulting to /usr/local).
84    
85    2. A set of files containing all the documentation in HTML form, hyperlinked    2. A set of files containing all the documentation in HTML form, hyperlinked
86       in various ways, and rooted in a file called index.html, is installed in       in various ways, and rooted in a file called index.html, is distributed in
87       the directory <prefix>/share/doc/pcre/html, where <prefix> is the       doc/html and installed in <prefix>/share/doc/pcre/html.
88       installation prefix (defaulting to /usr/local).  
89    Users of PCRE have contributed files containing the documentation for various
90    releases in CHM format. These can be found in the Contrib directory of the FTP
91    site (see next section).
92    
93    
94  Contributions by users of PCRE  Contributions by users of PCRE
# Line 84  You can find contributions from PCRE use Line 98  You can find contributions from PCRE use
98    
99    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
100    
101  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
102  Some are complete in themselves; others are pointers to URLs containing  complete in themselves; others are pointers to URLs containing relevant files.
103  relevant files. Some of this material is likely to be well out-of-date. In  Some of this material is likely to be well out-of-date. Several of the earlier
104  particular, several of the contributions provide support for compiling PCRE on  contributions provided support for compiling PCRE on various flavours of
105  various flavours of Windows (I myself do not use Windows), but it is hoped that  Windows (I myself do not use Windows). Nowadays there is more Windows support
106  more Windows support will find its way into the standard distribution.  in the standard distribution, so these contibutions have been archived.
107    
108    
109  Building PCRE on non-Unix systems  Building PCRE on non-Unix systems
110  ---------------------------------  ---------------------------------
111    
112  For a non-Unix system, read the comments in the file NON-UNIX-USE, though if  For a non-Unix system, please read the comments in the file NON-UNIX-USE,
113  the system supports the use of "configure" and "make" you may be able to build  though if your system supports the use of "configure" and "make" you may be
114  PCRE in the same way as for Unix-like systems.  able to build PCRE in the same way as for Unix-like systems. PCRE can also be
115    configured in many platform environments using the GUI facility provided by
116    CMake's cmake-gui command. This creates Makefiles, solution files, etc.
117    
118  PCRE has been compiled on many different operating systems. It should be  PCRE has been compiled on many different operating systems. It should be
119  straightforward to build PCRE on any system that has a Standard C compiler and  straightforward to build PCRE on any system that has a Standard C compiler and
120  library, because it uses only Standard C functions.  library, because it uses only Standard C functions.
121    
122    
123  Building PCRE on a Unix-like system  Building PCRE on Unix-like systems
124  -----------------------------------  ----------------------------------
125    
126  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
127  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
128    
129    The following instructions assume the use of the widely used "configure, make,
130    make install" process. There is also support for CMake in the PCRE
131    distribution; there are some comments about using CMake in the NON-UNIX-USE
132    file, though it can also be used in Unix-like systems.
133    
134  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
135  PCRE distribution directory, with your current directory set to the directory  PCRE distribution directory, with your current directory set to the directory
136  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
137  "autoconf" configuration script, for which generic instructions are supplied in  "autoconf" configuration script, for which generic instructions are supplied in
138  INSTALL.  the file INSTALL.
139    
140  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
141  this case, on many systems, just running "./configure" is sufficient. However,  this case, on many systems, just running "./configure" is sufficient. However,
# Line 142  library. You can read more about them in Line 163  library. You can read more about them in
163    
164  . 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
165    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
166    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,
167    will try to build the C++ wrapper.    it will try to build the C++ wrapper.
168    
169  . 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 Unicode character strings in
170    you must add --enable-utf8 to the "configure" command. Without it, the code    PCRE, you must add --enable-utf8 to the "configure" command. Without it, the
171    for handling UTF-8 is not included in the library. (Even when included, it    code for handling UTF-8 is not included in the library. Even when included,
172    still has to be enabled by an option at run time.)    it still has to be enabled by an option at run time. When PCRE is compiled
173      with this option, its input can only either be ASCII or UTF-8, even when
174      running on EBCDIC platforms. It is not possible to use both --enable-utf8 and
175      --enable-ebcdic at the same time.
176    
177  . If, in addition to support for UTF-8 character strings, you want to include  . If, in addition to support for UTF-8 character strings, you want to include
178    support for the \P, \p, and \X sequences that recognize Unicode character    support for the \P, \p, and \X sequences that recognize Unicode character
# Line 158  library. You can read more about them in Line 182  library. You can read more about them in
182    supported.    supported.
183    
184  . 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
185    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
186    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
187    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
188    (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
189    --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
190    to the "configure" command, respectively.    or --enable-newline-is-crlf or --enable-newline-is-anycrlf or
191      --enable-newline-is-any to the "configure" command, respectively.
192    If you specify --newline-is-cr or --newline-is-crlf, some of the standard  
193    tests will fail, because the lines in the test files end with LF. Even if    If you specify --enable-newline-is-cr or --enable-newline-is-crlf, some of
194    the files are edited to change the line endings, there are likely to be some    the standard tests will fail, because the lines in the test files end with
195    failures. With --newline-is-any, many tests should succeed, but there may be    LF. Even if the files are edited to change the line endings, there are likely
196    some failures.    to be some failures. With --enable-newline-is-anycrlf or
197      --enable-newline-is-any, many tests should succeed, but there may be some
198      failures.
199    
200    . By default, the sequence \R in a pattern matches any Unicode line ending
201      sequence. This is independent of the option specifying what PCRE considers to
202      be the end of a line (see above). However, the caller of PCRE can restrict \R
203      to match only CR, LF, or CRLF. You can make this the default by adding
204      --enable-bsr-anycrlf to the "configure" command (bsr = "backslash R").
205    
206  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
207    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
208    them. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
209    
210    --with-posix-malloc-threshold=20    --with-posix-malloc-threshold=20
211    
# Line 186  library. You can read more about them in Line 218  library. You can read more about them in
218    --with-match-limit=500000    --with-match-limit=500000
219    
220    on the "configure" command. This is just the default; individual calls to    on the "configure" command. This is just the default; individual calls to
221    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
222    man page.    pcreapi man page.
223    
224  . 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
225    during a matching process. This also has a default of ten million, which is    during a matching process. This also has a default of ten million, which is
# Line 202  library. You can read more about them in Line 234  library. You can read more about them in
234  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
235    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
236    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
237    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
238    (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.  
239    
240  . 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
241    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
242    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
243    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
244    this, use    build PCRE like this, use
245    
246    --disable-stack-for-recursion    --disable-stack-for-recursion
247    
248    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
249    necessary in environments with limited stack sizes. This applies only to the    necessary in environments with limited stack sizes. This applies only to the
250    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
251    use deeply nested recursion.    use deeply nested recursion. There is a discussion about stack sizes in the
252      pcrestack man page.
253    
254    . For speed, PCRE uses four tables for manipulating and identifying characters
255      whose code point values are less than 256. By default, it uses a set of
256      tables for ASCII encoding that is part of the distribution. If you specify
257    
258      --enable-rebuild-chartables
259    
260      a program called dftables is compiled and run in the default C locale when
261      you obey "make". It builds a source file called pcre_chartables.c. If you do
262      not specify this option, pcre_chartables.c is created as a copy of
263      pcre_chartables.c.dist. See "Character tables" below for further information.
264    
265    . It is possible to compile PCRE for use on systems that use EBCDIC as their
266      character code (as opposed to ASCII) by specifying
267    
268      --enable-ebcdic
269    
270      This automatically implies --enable-rebuild-chartables (see above). However,
271      when PCRE is built this way, it always operates in EBCDIC. It cannot support
272      both EBCDIC and UTF-8.
273    
274    . It is possible to compile pcregrep to use libz and/or libbz2, in order to
275      read .gz and .bz2 files (respectively), by specifying one or both of
276    
277      --enable-pcregrep-libz
278      --enable-pcregrep-libbz2
279    
280      Of course, the relevant libraries must be installed on your system.
281    
282    . It is possible to compile pcretest so that it links with the libreadline
283      library, by specifying
284    
285      --enable-pcretest-libreadline
286    
287      If this is done, when pcretest's input is from a terminal, it reads it using
288      the readline() function. This provides line-editing and history facilities.
289      Note that libreadline is GPL-licenced, so if you distribute a binary of
290      pcretest linked in this way, there may be licensing issues.
291    
292      Setting this option causes the -lreadline option to be added to the pcretest
293      build. In many operating environments with a sytem-installed readline
294      library this is sufficient. However, in some environments (e.g. if an
295      unmodified distribution version of readline is in use), it may be necessary
296      to specify something like LIBS="-lncurses" as well. This is because, to quote
297      the readline INSTALL, "Readline uses the termcap functions, but does not link
298      with the termcap or curses library itself, allowing applications which link
299      with readline the to choose an appropriate library." If you get error
300      messages about missing functions tgetstr, tgetent, tputs, tgetflag, or tgoto,
301      this is the problem, and linking with the ncurses library should fix it.
302    
303  The "configure" script builds the following files for the basic C library:  The "configure" script builds the following files for the basic C library:
304    
# Line 231  The "configure" script builds the follow Line 311  The "configure" script builds the follow
311  . RunTest is a script for running tests on the basic C library  . RunTest is a script for running tests on the basic C library
312  . RunGrepTest is a script for running tests on the pcregrep command  . RunGrepTest is a script for running tests on the pcregrep command
313    
314  Versions of config.h and pcre.h are distributed in the PCRE tarballs. These are  Versions of config.h and pcre.h are distributed in the PCRE tarballs under
315  provided for the benefit of those who have to compile PCRE without the benefit  the names config.h.generic and pcre.h.generic. These are provided for the
316  of "configure". If you use "configure", the distributed copies are replaced.  benefit of those who have to built PCRE without the benefit of "configure". If
317    you use "configure", the .generic versions are not used.
318    
319  If a C++ compiler is found, the following files are also built:  If a C++ compiler is found, the following files are also built:
320    
# Line 246  script that can be run to recreate the c Line 327  script that can be run to recreate the c
327  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
328    
329  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
330  libpcre and libpcreposix, a test program called pcretest, a demonstration  libpcre and libpcreposix, a test program called pcretest, and the pcregrep
331  program called pcredemo, and the pcregrep command. If a C++ compiler was found  command. If a C++ compiler was found on your system, "make" also builds the C++
332  on your system, it also builds the C++ wrapper library, which is called  wrapper library, which is called libpcrecpp, and some test programs called
333  libpcrecpp, and some test programs called pcrecpp_unittest,  pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.
334  pcre_scanner_unittest, and pcre_stringpiece_unittest.  Building the C++ wrapper can be disabled by adding --disable-cpp to the
335    "configure" command.
336    
337  The command "make check" runs all the appropriate tests. Details of the PCRE  The command "make check" runs all the appropriate tests. Details of the PCRE
338  tests are given below in a separate section of this document.  tests are given below in a separate section of this document.
# Line 262  system. The following are installed (fil Line 344  system. The following are installed (fil
344    Commands (bin):    Commands (bin):
345      pcretest      pcretest
346      pcregrep      pcregrep
347      pcre-config      pcre-config
348    
349    Libraries (lib):    Libraries (lib):
350      libpcre      libpcre
# Line 271  system. The following are installed (fil Line 353  system. The following are installed (fil
353    
354    Configuration information (lib/pkgconfig):    Configuration information (lib/pkgconfig):
355      libpcre.pc      libpcre.pc
356      libpcrecpp.ps (if C++ support is enabled)      libpcrecpp.pc (if C++ support is enabled)
357    
358    Header files (include):    Header files (include):
359      pcre.h      pcre.h
# Line 295  system. The following are installed (fil Line 377  system. The following are installed (fil
377      AUTHORS      AUTHORS
378      COPYING      COPYING
379      ChangeLog      ChangeLog
     INSTALL  
380      LICENCE      LICENCE
     NON-UNIX-USE  
381      NEWS      NEWS
382      README      README
383      pcre.txt       (a concatenation of the man(3) pages)      pcre.txt       (a concatenation of the man(3) pages)
384      pcretest.txt   the pcretest man page      pcretest.txt   the pcretest man page
385      pcregrep.txt   the pcregrep man page      pcregrep.txt   the pcregrep man page
     perltest.txt   some information about the perltest.pl script  
   
 Note that the pcredemo program that is built by "configure" is *not* installed  
 anywhere. It is a demonstration for programmers wanting to use PCRE.  
386    
387  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".
388  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
389  remove any directories, because these are often shared with other programs.  remove any directories, because these are often shared with other programs.
390    
391    
392  Retrieving configuration information on a Unix-like system  Retrieving configuration information on Unix-like systems
393  ----------------------------------------------------------  ---------------------------------------------------------
394    
395  Running "make install" installs the command pcre-config, which can be used to  Running "make install" installs the command pcre-config, which can be used to
396  recall information about the PCRE configuration and installation. For example:  recall information about the PCRE configuration and installation. For example:
# Line 353  built. The programs pcretest and pcregre Line 429  built. The programs pcretest and pcregre
429  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
430  you use "make install" to install shared libraries, pcregrep and pcretest are  you use "make install" to install shared libraries, pcregrep and pcretest are
431  automatically re-built to use the newly installed shared libraries before being  automatically re-built to use the newly installed shared libraries before being
432  installed themselves. However, the versions left in the source directory still  installed themselves. However, the versions left in the build directory still
433  use the uninstalled libraries.  use the uninstalled libraries.
434    
435  To build PCRE using static libraries only you must use --disable-shared when  To build PCRE using static libraries only you must use --disable-shared when
# Line 365  Then run "make" in the usual way. Simila Line 441  Then run "make" in the usual way. Simila
441  build only shared libraries.  build only shared libraries.
442    
443    
444  Cross-compiling on a Unix-like system  Cross-compiling on Unix-like systems
445  -------------------------------------  ------------------------------------
446    
447  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
448  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
449  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
450  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
451  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,
452  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
453  there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)  compiler.
454  when calling the "configure" command. If they are not specified, they default  
455  to the values of CC and CFLAGS.  When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
456    by making a copy of pcre_chartables.c.dist, which is a default set of tables
457    that assumes ASCII code. Cross-compiling with the default tables should not be
458    a problem.
459    
460    If you need to modify the character tables when cross-compiling, you should
461    move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
462    run it on the local host to make a new version of pcre_chartables.c.dist.
463    Then when you cross-compile PCRE this new version of the tables will be used.
464    
465    
466  Using HP's ANSI C++ compiler (aCC)  Using HP's ANSI C++ compiler (aCC)
467  ----------------------------------  ----------------------------------
468    
469  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
470  "configure" script, you *must* include the "-AA" option in the CXXFLAGS  "configure" script, you must include the "-AA" option in the CXXFLAGS
471  environment variable in order for the C++ components to compile correctly.  environment variable in order for the C++ components to compile correctly.
472    
473  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 393  use the workaround of specifying the fol Line 477  use the workaround of specifying the fol
477  running the "configure" script:  running the "configure" script:
478    
479    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
480    
481    
482    Using PCRE from MySQL
483    ---------------------
484    
485    On systems where both PCRE and MySQL are installed, it is possible to make use
486    of PCRE from within MySQL, as an alternative to the built-in pattern matching.
487    There is a web page that tells you how to do this:
488    
489      http://www.mysqludf.org/lib_mysqludf_preg/index.php
490    
491    
492    Making new tarballs
493    -------------------
494    
495    The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
496    zip formats. The command "make distcheck" does the same, but then does a trial
497    build of the new distribution to ensure that it works.
498    
499    If you have modified any of the man page sources in the doc directory, you
500    should first run the PrepareRelease script before making a distribution. This
501    script creates the .txt and HTML forms of the documentation from the man pages.
502    
503    
504  Testing PCRE  Testing PCRE
505  ------------  ------------
506    
507  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
508  configuring process. There is also a script called RunGrepTest that tests the  created by the configuring process. There is also a script called RunGrepTest
509  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
510  test programs called pcrecpp_unittest, pcre_scanner_unittest, and  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
511  pcre_stringpiece_unittest are also built.  pcre_stringpiece_unittest are also built.
512    
513  Both the scripts and all the program tests are run if you obey "make check" or  Both the scripts and all the program tests are run if you obey "make check" or
514  "make test". For other systems, see the instructions in NON-UNIX-USE.  "make test". For other systems, see the instructions in NON-UNIX-USE.
515    
516  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
517  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
518  turn, and compares the output with the contents of the corresponding testoutput  turn, and compares the output with the contents of the corresponding testoutput
519  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
520  (testsavedregex is also used as a working file). To run pcretest on just one of  (testsavedregex is also used as a working file). To run pcretest on just one of
# Line 424  version. Line 530  version.
530  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
531  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
532  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
533  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
534  pcre_compile().  pcre_compile().
535    
536  If you build PCRE with a locale setting that is not the standard C locale, the  If you build PCRE with a locale setting that is not the standard C locale, the
# Line 450  is output to say why. If running this te Line 556  is output to say why. If running this te
556  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,
557  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.
558    
559    [If you are trying to run this test on Windows, you may be able to get it to
560    work by changing "fr_FR" to "french" everywhere it occurs. Alternatively, use
561    RunTest.bat. The version of RunTest.bat included with PCRE 7.4 and above uses
562    Windows versions of test 2. More info on using RunTest.bat is included in the
563    document entitled NON-UNIX-USE.]
564    
565  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
566  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
567  running "configure". This file can be also fed directly to the perltest script,  running "configure". This file can be also fed directly to the perltest script,
# Line 459  commented in the script, can be be used. Line 571  commented in the script, can be be used.
571  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
572  features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
573    
574  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
575  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
576  this you must set --enable-unicode-properties when running "configure".  this you must set --enable-unicode-properties when running "configure".
577    
578  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative
# Line 472  automatically unless PCRE is build with Line 584  automatically unless PCRE is build with
584  Character tables  Character tables
585  ----------------  ----------------
586    
587  PCRE uses four tables for manipulating and identifying characters whose values  For speed, PCRE uses four tables for manipulating and identifying characters
588  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
589  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
590  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
591  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
592  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.
593    
594  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
595  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
596  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
597  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
598  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
599  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
600  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
601  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
602  re-generated.  the default tables by editing pcre_chartables.c and then re-building PCRE. If
603    you do this, you should take care to ensure that the file does not get
604    automatically re-generated. The best way to do this is to move
605    pcre_chartables.c.dist out of the way and replace it with your customized
606    tables.
607    
608    When the dftables program is run as a result of --enable-rebuild-chartables,
609    it uses the default C locale that is set on your system. It does not pay
610    attention to the LC_xxx environment variables. In other words, it uses the
611    system's default locale rather than whatever the compiling user happens to have
612    set. If you really do want to build a source set of character tables in a
613    locale that is specified by the LC_xxx variables, you can run the dftables
614    program by hand with the -L option. For example:
615    
616      ./dftables -L pcre_chartables.c.special
617    
618  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,
619  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
620  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
621  building 32-byte bit maps that represent character classes for code points less  building 32-byte bit maps that represent character classes for code points less
622  than 256.  than 256.
623    
624  The final 256-byte table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
# Line 516  The distribution should contain the foll Line 642  The distribution should contain the foll
642    
643  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
644    
645    dftables.c             auxiliary program for building chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
646                                when --enable-rebuild-chartables is specified
647    pcreposix.c            )  
648    pcre_compile.c         )    pcre_chartables.c.dist  a default set of character tables that assume ASCII
649    pcre_config.c          )                              coding; used, unless --enable-rebuild-chartables is
650    pcre_dfa_exec.c        )                              specified, by copying to pcre_chartables.c
651    pcre_exec.c            )  
652    pcre_fullinfo.c        )    pcreposix.c             )
653    pcre_get.c             ) sources for the functions in the library,    pcre_compile.c          )
654    pcre_globals.c         )   and some internal functions that they use    pcre_config.c           )
655    pcre_info.c            )    pcre_dfa_exec.c         )
656    pcre_maketables.c      )    pcre_exec.c             )
657    pcre_newline.c         )    pcre_fullinfo.c         )
658    pcre_ord2utf8.c        )    pcre_get.c              ) sources for the functions in the library,
659    pcre_refcount.c        )    pcre_globals.c          )   and some internal functions that they use
660    pcre_study.c           )    pcre_info.c             )
661    pcre_tables.c          )    pcre_maketables.c       )
662    pcre_try_flipped.c     )    pcre_newline.c          )
663    pcre_ucp_searchfuncs.c )    pcre_ord2utf8.c         )
664    pcre_valid_utf8.c      )    pcre_refcount.c         )
665    pcre_version.c         )    pcre_study.c            )
666    pcre_xclass.c          )    pcre_tables.c           )
667    pcre_printint.src      ) debugging function that is #included in pcretest,    pcre_try_flipped.c      )
668                           )   and can also be #included in pcre_compile()    pcre_ucd.c              )
669    pcre.h                 ) a version of the public PCRE header file    pcre_valid_utf8.c       )
670                           )   for use in non-"configure" environments    pcre_version.c          )
671    pcre.h.in              template for pcre.h when built by "configure"    pcre_xclass.c           )
672    pcreposix.h            header for the external POSIX wrapper API    pcre_printint.src       ) debugging function that is #included in pcretest,
673    pcre_internal.h        header for internal use                            )   and can also be #included in pcre_compile()
674    ucp.h                  ) headers concerned with    pcre.h.in               template for pcre.h when built by "configure"
675    ucpinternal.h          )   Unicode property handling    pcreposix.h             header for the external POSIX wrapper API
676    ucptable.h             ) (this one is the data table)    pcre_internal.h         header for internal use
677      ucp.h                   header for Unicode property handling
678    config.h               ) a version of config.h for use in non-"configure"  
679                           )   environments    config.h.in             template for config.h, which is built by "configure"
680    config.h.in            template for config.h when built by "configure"  
681      pcrecpp.h               public header file for the C++ wrapper
682    pcrecpp.h              public header file for the C++ wrapper    pcrecpparg.h.in         template for another C++ header file
683    pcrecpparg.h.in        template for another C++ header file    pcre_scanner.h          public header file for C++ scanner functions
684    pcre_scanner.h         public header file for C++ scanner functions    pcrecpp.cc              )
685    pcrecpp.cc             )    pcre_scanner.cc         ) source for the C++ wrapper library
686    pcre_scanner.cc        ) source for the C++ wrapper library  
687      pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
688    pcre_stringpiece.h.in  template for pcre_stringpiece.h, the header for the                              C++ stringpiece functions
689                             C++ stringpiece functions    pcre_stringpiece.cc     source for the C++ stringpiece functions
690    pcre_stringpiece.cc    source for the C++ stringpiece functions  
   
691  (B) Source files for programs that use PCRE:  (B) Source files for programs that use PCRE:
692    
693    pcredemo.c             simple demonstration of coding calls to PCRE    pcredemo.c              simple demonstration of coding calls to PCRE
694    pcregrep.c             source of a grep utility that uses PCRE    pcregrep.c              source of a grep utility that uses PCRE
695    pcretest.c             comprehensive test program    pcretest.c              comprehensive test program
696    
697  (C) Auxiliary files:  (C) Auxiliary files:
698    
699    AUTHORS                information about the author of PCRE    132html                 script to turn "man" pages into HTML
700    ChangeLog              log of changes to the code    AUTHORS                 information about the author of PCRE
701    INSTALL                generic installation instructions    ChangeLog               log of changes to the code
702    LICENCE                conditions for the use of PCRE    CleanTxt                script to clean nroff output for txt man pages
703    COPYING                the same, using GNU's standard name    Detrail                 script to remove trailing spaces
704    Makefile.in            ) template for Unix Makefile, which is built by    HACKING                 some notes about the internals of PCRE
705                           )   "configure"    INSTALL                 generic installation instructions
706    Makefile.am            ) the automake input that was used to create    LICENCE                 conditions for the use of PCRE
707                           )   Makefile.in    COPYING                 the same, using GNU's standard name
708    NEWS                   important changes in this release    Makefile.in             ) template for Unix Makefile, which is built by
709    NON-UNIX-USE           notes on building PCRE on non-Unix systems                            )   "configure"
710    README                 this file    Makefile.am             ) the automake input that was used to create
711    RunTest.in             template for a Unix shell script for running tests                            )   Makefile.in
712    RunGrepTest.in         template for a Unix shell script for pcregrep tests    NEWS                    important changes in this release
713    aclocal.m4             m4 macros (generated by "aclocal")    NON-UNIX-USE            notes on building PCRE on non-Unix systems
714    config.guess           ) files used by libtool,    PrepareRelease          script to make preparations for "make dist"
715    config.sub             )   used only when building a shared library    README                  this file
716    configure              a configuring shell script (built by autoconf)    RunTest                 a Unix shell script for running tests
717    configure.ac           ) the autoconf input that was used to build    RunGrepTest             a Unix shell script for pcregrep tests
718                           )   "configure" and config.h    aclocal.m4              m4 macros (generated by "aclocal")
719    depcomp                ) script to find program dependencies, generated by    config.guess            ) files used by libtool,
720                           )   automake    config.sub              )   used only when building a shared library
721    doc/*.3                man page sources for the PCRE functions    configure               a configuring shell script (built by autoconf)
722    doc/*.1                man page sources for pcregrep and pcretest    configure.ac            ) the autoconf input that was used to build
723    doc/html/*             HTML documentation                            )   "configure" and config.h
724    doc/pcre.txt           plain text version of the man pages    depcomp                 ) script to find program dependencies, generated by
725    doc/pcretest.txt       plain text documentation of test program                            )   automake
726    doc/perltest.txt       plain text documentation of Perl test program    doc/*.3                 man page sources for PCRE
727    install-sh             a shell script for installing files    doc/*.1                 man page sources for pcregrep and pcretest
728    libpcre.pc.in          template for libpcre.pc for pkg-config    doc/index.html.src      the base HTML page
729    libpcrecpp.pc.in       template for libpcrecpp.pc for pkg-config    doc/html/*              HTML documentation
730    ltmain.sh              file used to build a libtool script    doc/pcre.txt            plain text version of the man pages
731    missing                ) common stub for a few missing GNU programs while    doc/pcretest.txt        plain text documentation of test program
732                           )   installing, generated by automake    doc/perltest.txt        plain text documentation of Perl test program
733    mkinstalldirs          script for making install directories    install-sh              a shell script for installing files
734    perltest.pl            Perl test program    libpcre.pc.in           template for libpcre.pc for pkg-config
735    pcre-config.in         source of script which retains PCRE information    libpcreposix.pc.in      template for libpcreposix.pc for pkg-config
736    pcrecpp_unittest.c           )    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
737    pcre_scanner_unittest.c      ) test programs for the C++ wrapper    ltmain.sh               file used to build a libtool script
738    pcre_stringpiece_unittest.c  )    missing                 ) common stub for a few missing GNU programs while
739    testdata/testinput*    test data for main library tests                            )   installing, generated by automake
740    testdata/testoutput*   expected test results    mkinstalldirs           script for making install directories
741    testdata/grep*         input and output for pcregrep tests    perltest.pl             Perl test program
742      pcre-config.in          source of script which retains PCRE information
743      pcrecpp_unittest.cc          )
744      pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
745      pcre_stringpiece_unittest.cc )
746      testdata/testinput*     test data for main library tests
747      testdata/testoutput*    expected test results
748      testdata/grep*          input and output for pcregrep tests
749    
750  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
751    
752      cmake/COPYING-CMAKE-SCRIPTS
753      cmake/FindPackageHandleStandardArgs.cmake
754      cmake/FindReadline.cmake
755    CMakeLists.txt    CMakeLists.txt
756    config-cmake.h.in    config-cmake.h.in
757    
758  (E) Auxiliary files for VPASCAL  (E) Auxiliary files for VPASCAL
759    
760    makevp.bat    makevp.bat
761    !compile.txt    makevp_c.txt
762    !linklib.txt    makevp_l.txt
763    pcregexp.pas    pcregexp.pas
764    
765    (F) Auxiliary files for building PCRE "by hand"
766    
767      pcre.h.generic          ) a version of the public PCRE header file
768                              )   for use in non-"configure" environments
769      config.h.generic        ) a version of config.h for use in non-"configure"
770                              )   environments
771    
772  (F) Miscellaneous  (F) Miscellaneous
773    
774    RunTest.bat            a script for running tests under Windows    RunTest.bat            a script for running tests under Windows
# Line 634  The distribution should contain the foll Line 776  The distribution should contain the foll
776  Philip Hazel  Philip Hazel
777  Email local part: ph10  Email local part: ph10
778  Email domain: cam.ac.uk  Email domain: cam.ac.uk
779  Last updated: March 2007  Last updated: 16 September 2009

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

  ViewVC Help
Powered by ViewVC 1.1.5