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

Diff of /code/trunk/README

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

revision 123 by ph10, Mon Mar 12 15:19:06 2007 UTC revision 840 by ph10, Fri Dec 30 19:32:50 2011 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  There is a mailing list for discussion about the development of PCRE at
12    
# Line 21  The contents of this README file are: Line 24  The contents of this README file are:
24    Shared libraries on Unix-like systems    Shared libraries on Unix-like systems
25    Cross-compiling on Unix-like systems    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    Making new tarballs
29    Testing PCRE    Testing PCRE
30    Character tables    Character tables
# Line 30  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. There are two sets of functions,
38  set of C++ wrapper functions, courtesy of Google Inc. (see the pcrecpp man page  one for the 8-bit library, which processes strings of bytes, and one for the
39  for details).  16-bit library, which processes strings of 16-bit values. The distribution also
40    includes a set of C++ wrapper functions (see the pcrecpp man page for details),
41  Also included in the distribution are a set of C wrapper functions that are  courtesy of Google Inc., which can be used to call the 8-bit PCRE library from
42  based on the POSIX API. These end up in the library called libpcreposix. Note  C++.
43  that this just provides a POSIX calling interface to PCRE; the regular  
44  expressions themselves still follow Perl syntax and semantics. The POSIX API is  In addition, there is a set of C wrapper functions (again, just for the 8-bit
45  restricted, and does not give full access to all of PCRE's facilities.  library) that are based on the POSIX regular expression API (see the pcreposix
46    man page). These end up in the library called libpcreposix. Note that this just
47    provides a POSIX calling interface to PCRE; the regular expressions themselves
48    still follow Perl syntax and semantics. The POSIX API is restricted, and does
49    not give full access to all of PCRE's facilities.
50    
51  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
52  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 81  documentation is supplied in two other f Line 89  documentation is supplied in two other f
89       in various ways, and rooted in a file called index.html, is distributed in       in various ways, and rooted in a file called index.html, is distributed in
90       doc/html and installed in <prefix>/share/doc/pcre/html.       doc/html and installed in <prefix>/share/doc/pcre/html.
91    
92    Users of PCRE have contributed files containing the documentation for various
93    releases in CHM format. These can be found in the Contrib directory of the FTP
94    site (see next section).
95    
96    
97  Contributions by users of PCRE  Contributions by users of PCRE
98  ------------------------------  ------------------------------
# Line 91  You can find contributions from PCRE use Line 103  You can find contributions from PCRE use
103    
104  There is a README file giving brief descriptions of what they are. Some are  There is a README file giving brief descriptions of what they are. Some are
105  complete in themselves; others are pointers to URLs containing relevant files.  complete in themselves; others are pointers to URLs containing relevant files.
106  Some of this material is likely to be well out-of-date. In particular, several  Some of this material is likely to be well out-of-date. Several of the earlier
107  of the contributions provide support for compiling PCRE on various flavours of  contributions provided support for compiling PCRE on various flavours of
108  Windows (I myself do not use Windows), but nowadays there is more Windows  Windows (I myself do not use Windows). Nowadays there is more Windows support
109  support in the standard distribution.  in the standard distribution, so these contibutions have been archived.
110    
111    
112  Building PCRE on non-Unix systems  Building PCRE on non-Unix systems
# Line 102  Building PCRE on non-Unix systems Line 114  Building PCRE on non-Unix systems
114    
115  For a non-Unix system, please read the comments in the file NON-UNIX-USE,  For a non-Unix system, please read the comments in the file NON-UNIX-USE,
116  though if your system supports the use of "configure" and "make" you may be  though if your system supports the use of "configure" and "make" you may be
117  able to build 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
118    configured in many platform environments using the GUI facility provided by
119    CMake's cmake-gui command. This creates Makefiles, solution files, etc.
120    
121  PCRE has been compiled on many different operating systems. It should be  PCRE has been compiled on many different operating systems. It should be
122  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
# Line 115  Building PCRE on Unix-like systems Line 129  Building PCRE on Unix-like systems
129  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
130  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
131    
132    The following instructions assume the use of the widely used "configure, make,
133    make install" process. There is also support for CMake in the PCRE
134    distribution; there are some comments about using CMake in the NON-UNIX-USE
135    file, though it can also be used in Unix-like systems.
136    
137  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
138  PCRE distribution directory, with your current directory set to the directory  PCRE distribution directory, with your current directory set to the directory
139  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
# Line 127  the usual methods of changing standard d Line 146  the usual methods of changing standard d
146    
147  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
148    
149  specifies that the C compiler should be run with the flags '-O2 -Wall' instead  This command specifies that the C compiler should be run with the flags '-O2
150  of the default, and that "make install" should install PCRE under /opt/local  -Wall' instead of the default, and that "make install" should install PCRE
151  instead of the default /usr/local.  under /opt/local instead of the default /usr/local.
152    
153  If you want to build in a different directory, just run "configure" with that  If you want to build in a different directory, just run "configure" with that
154  directory as current. For example, suppose you have unpacked the PCRE source  directory as current. For example, suppose you have unpacked the PCRE source
# Line 143  possible to build it as a C++ library, t Line 162  possible to build it as a C++ library, t
162  does not have any features to support this.  does not have any features to support this.
163    
164  There are some optional features that can be included or omitted from the PCRE  There are some optional features that can be included or omitted from the PCRE
165  library. You can read more about them in the pcrebuild man page.  library. They are also documented in the pcrebuild man page.
166    
167    . By default, both shared and static libraries are built. You can change this
168      by adding one of these options to the "configure" command:
169    
170  . If you want to suppress the building of the C++ wrapper library, you can add    --disable-shared
171    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-static
172    will try to find a C++ compiler and C++ header files, and if it succeeds, it  
173    will try to build the C++ wrapper.    (See also "Shared libraries on Unix-like systems" below.)
174    
175  . If you want to make use of the support for UTF-8 character strings in PCRE,  . By default, only the 8-bit library is built. If you add --enable-pcre16 to
176    you must add --enable-utf8 to the "configure" command. Without it, the code    the "configure" command, the 16-bit library is also built. If you want only
177    for handling UTF-8 is not included in the library. (Even when included, it    the 16-bit library, use "./configure --enable-pcre16 --disable-pcre8".
178    still has to be enabled by an option at run time.)  
179    . If you are building the 8-bit library and want to suppress the building of
180  . If, in addition to support for UTF-8 character strings, you want to include    the C++ wrapper library, you can add --disable-cpp to the "configure"
181    support for the \P, \p, and \X sequences that recognize Unicode character    command. Otherwise, when "configure" is run without --disable-pcre8, it will
182    properties, you must add --enable-unicode-properties to the "configure"    try to find a C++ compiler and C++ header files, and if it succeeds, it will
183    command. This adds about 30K to the size of the library (in the form of a    try to build the C++ wrapper.
184    property table); only the basic two-letter properties such as Lu are  
185    supported.  . If you want to include support for just-in-time compiling, which can give
186      large performance improvements on certain platforms, add --enable-jit to the
187      "configure" command. This support is available only for certain hardware
188      architectures. If you try to enable it on an unsupported architecture, there
189      will be a compile time error.
190    
191    . When JIT support is enabled, pcregrep automatically makes use of it, unless
192      you add --disable-pcregrep-jit to the "configure" command.
193    
194    . If you want to make use of the support for UTF-8 Unicode character strings in
195      the 8-bit library, or UTF-16 Unicode character strings in the 16-bit library,
196      you must add --enable-utf to the "configure" command. Without it, the code
197      for handling UTF-8 and UTF-16 is not included in the relevant library. Even
198      when --enable-utf included, the use of UTF encoding still has to be enabled
199      by an option at run time. When PCRE is compiled with this option, its input
200      can only either be ASCII or UTF-8/16, even when running on EBCDIC platforms.
201      It is not possible to use both --enable-utf and --enable-ebcdic at the same
202      time.
203    
204    . The option --enable-utf8 is retained for backwards compatibility with earlier
205      releases that did not support 16-bit character strings. It is synonymous with
206      --enable-utf. It is not possible to configure one library with UTF support
207      and the other without in the same configuration.
208    
209    . If, in addition to support for UTF-8/16 character strings, you want to
210      include support for the \P, \p, and \X sequences that recognize Unicode
211      character properties, you must add --enable-unicode-properties to the
212      "configure" command. This adds about 30K to the size of the library (in the
213      form of a property table); only the basic two-letter properties such as Lu
214      are supported.
215    
216  . 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
217    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
218    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
219    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
220    (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
221    --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
222    to the "configure" command, respectively.    or --enable-newline-is-crlf or --enable-newline-is-anycrlf or
223      --enable-newline-is-any to the "configure" command, respectively.
224    If you specify --newline-is-cr or --newline-is-crlf, some of the standard  
225    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
226    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
227    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
228    some failures.    to be some failures. With --enable-newline-is-anycrlf or
229      --enable-newline-is-any, many tests should succeed, but there may be some
230      failures.
231    
232    . By default, the sequence \R in a pattern matches any Unicode line ending
233      sequence. This is independent of the option specifying what PCRE considers to
234      be the end of a line (see above). However, the caller of PCRE can restrict \R
235      to match only CR, LF, or CRLF. You can make this the default by adding
236      --enable-bsr-anycrlf to the "configure" command (bsr = "backslash R").
237    
238  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
239    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
240    them. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
241    
242    --with-posix-malloc-threshold=20    --with-posix-malloc-threshold=20
243    
# Line 205  library. You can read more about them in Line 264  library. You can read more about them in
264    sizes in the pcrestack man page.    sizes in the pcrestack man page.
265    
266  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
267    this by adding --with-link-size=3 to the "configure" command. You can    this by adding --with-link-size=3 to the "configure" command. In the 8-bit
268    increase it even more by setting --with-link-size=4, but this is unlikely    library, PCRE then uses three bytes instead of two for offsets to different
269    ever to be necessary.    parts of the compiled pattern. In the 16-bit library, --with-link-size=3 is
270      the same as --with-link-size=4, which (in both libraries) uses four-byte
271      offsets. Increasing the internal link size reduces performance.
272    
273  . 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
274    pcre_exec() does not call itself recursively. Instead, it uses memory blocks    pcre_exec() does not call itself recursively. Instead, it uses memory blocks
# Line 219  library. You can read more about them in Line 280  library. You can read more about them in
280    
281    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
282    necessary in environments with limited stack sizes. This applies only to the    necessary in environments with limited stack sizes. This applies only to the
283    pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not    normal execution of the pcre_exec() function; if JIT support is being
284    use deeply nested recursion. There is a discussion about stack sizes in the    successfully used, it is not relevant. Equally, it does not apply to
285    pcrestack man page.    pcre_dfa_exec(), which does not use deeply nested recursion. There is a
286      discussion about stack sizes in the pcrestack man page.
287    
288    . For speed, PCRE uses four tables for manipulating and identifying characters
289      whose code point values are less than 256. By default, it uses a set of
290      tables for ASCII encoding that is part of the distribution. If you specify
291    
292      --enable-rebuild-chartables
293    
294      a program called dftables is compiled and run in the default C locale when
295      you obey "make". It builds a source file called pcre_chartables.c. If you do
296      not specify this option, pcre_chartables.c is created as a copy of
297      pcre_chartables.c.dist. See "Character tables" below for further information.
298    
299    . It is possible to compile PCRE for use on systems that use EBCDIC as their
300      character code (as opposed to ASCII) by specifying
301    
302      --enable-ebcdic
303    
304      This automatically implies --enable-rebuild-chartables (see above). However,
305      when PCRE is built this way, it always operates in EBCDIC. It cannot support
306      both EBCDIC and UTF-8/16.
307    
308    . The pcregrep program currently supports only 8-bit data files, and so
309      requires the 8-bit PCRE library. It is possible to compile pcregrep to use
310      libz and/or libbz2, in order to read .gz and .bz2 files (respectively), by
311      specifying one or both of
312    
313      --enable-pcregrep-libz
314      --enable-pcregrep-libbz2
315    
316      Of course, the relevant libraries must be installed on your system.
317    
318    . The default size of internal buffer used by pcregrep can be set by, for
319      example:
320    
321      --with-pcregrep-bufsize=50K
322    
323      The default value is 20K.
324    
325    . It is possible to compile pcretest so that it links with the libreadline
326      library, by specifying
327    
328      --enable-pcretest-libreadline
329    
330      If this is done, when pcretest's input is from a terminal, it reads it using
331      the readline() function. This provides line-editing and history facilities.
332      Note that libreadline is GPL-licenced, so if you distribute a binary of
333      pcretest linked in this way, there may be licensing issues.
334    
335      Setting this option causes the -lreadline option to be added to the pcretest
336      build. In many operating environments with a sytem-installed readline
337      library this is sufficient. However, in some environments (e.g. if an
338      unmodified distribution version of readline is in use), it may be necessary
339      to specify something like LIBS="-lncurses" as well. This is because, to quote
340      the readline INSTALL, "Readline uses the termcap functions, but does not link
341      with the termcap or curses library itself, allowing applications which link
342      with readline the to choose an appropriate library." If you get error
343      messages about missing functions tgetstr, tgetent, tputs, tgetflag, or tgoto,
344      this is the problem, and linking with the ncurses library should fix it.
345    
346  The "configure" script builds the following files for the basic C library:  The "configure" script builds the following files for the basic C library:
347    
348  . Makefile is the makefile that builds the library  . Makefile             the makefile that builds the library
349  . config.h contains build-time configuration options for the library  . config.h             build-time configuration options for the library
350  . pcre.h is the public PCRE header file  . pcre.h               the public PCRE header file
351  . pcre-config is a script that shows the settings of "configure" options  . pcre-config          script that shows the building settings such as CFLAGS
352  . libpcre.pc is data for the pkg-config command                           that were set for "configure"
353  . libtool is a script that builds shared and/or static libraries  . libpcre.pc         ) data for the pkg-config command
354  . RunTest is a script for running tests on the basic C library  . libpcre16.pc       )
355  . RunGrepTest is a script for running tests on the pcregrep command  . libpcreposix.pc    )
356    . libtool              script that builds shared and/or static libraries
357  Versions of config.h and pcre.h are distributed in the PCRE tarballs under  . RunTest              script for running tests on the basic C library
358  the names config.h.generic and pcre.h.generic. These are provided for the  . RunGrepTest          script for running tests on the pcregrep command
359  benefit of those who have to built PCRE without the benefit of "configure". If  
360  you use "configure", the .generic versions are not used.  Versions of config.h and pcre.h are distributed in the PCRE tarballs under the
361    names config.h.generic and pcre.h.generic. These are provided for those who
362  If a C++ compiler is found, the following files are also built:  have to built PCRE without using "configure" or CMake. If you use "configure"
363    or CMake, the .generic versions are not used.
364  . libpcrecpp.pc is data for the pkg-config command  
365  . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper  When building the 8-bit library, if a C++ compiler is found, the following
366  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions  files are also built:
367    
368    . libpcrecpp.pc        data for the pkg-config command
369    . pcrecpparg.h         header file for calling PCRE via the C++ wrapper
370    . pcre_stringpiece.h   header for the C++ "stringpiece" functions
371    
372  The "configure" script also creates config.status, which is an executable  The "configure" script also creates config.status, which is an executable
373  script that can be run to recreate the configuration, and config.log, which  script that can be run to recreate the configuration, and config.log, which
374  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
375    
376  Once "configure" has run, you can run "make". It builds two libraries, called  Once "configure" has run, you can run "make". This builds either or both of the
377  libpcre and libpcreposix, a test program called pcretest, a demonstration  libraries libpcre and libpcre16, and a test program called pcretest. If you
378  program called pcredemo, and the pcregrep command. If a C++ compiler was found  enabled JIT support with --enable-jit, a test program called pcre_jit_test is
379  on your system, "make" also builds the C++ wrapper library, which is called  built as well.
380  libpcrecpp, and some test programs called pcrecpp_unittest,  
381  pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper  If the 8-bit library is built, libpcreposix and the pcregrep command are also
382  can be disabled by adding --disable-cpp to the "configure" command.  built, and if a C++ compiler was found on your system, and you did not disable
383    it with --disable-cpp, "make" builds the C++ wrapper library, which is called
384    libpcrecpp, as well as some test programs called pcrecpp_unittest,
385    pcre_scanner_unittest, and pcre_stringpiece_unittest.
386    
387  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
388  tests are given below in a separate section of this document.  tests are given below in a separate section of this document.
# Line 266  system. The following are installed (fil Line 393  system. The following are installed (fil
393    
394    Commands (bin):    Commands (bin):
395      pcretest      pcretest
396      pcregrep      pcregrep (if 8-bit support is enabled)
397      pcre-config      pcre-config
398    
399    Libraries (lib):    Libraries (lib):
400      libpcre      libpcre16     (if 16-bit support is enabled)
401      libpcreposix      libpcre       (if 8-bit support is enabled)
402      libpcrecpp (if C++ support is enabled)      libpcreposix  (if 8-bit support is enabled)
403        libpcrecpp    (if 8-bit and C++ support is enabled)
404    
405    Configuration information (lib/pkgconfig):    Configuration information (lib/pkgconfig):
406        libpcre16.pc
407      libpcre.pc      libpcre.pc
408        libpcreposix.pc
409      libpcrecpp.pc (if C++ support is enabled)      libpcrecpp.pc (if C++ support is enabled)
410    
411    Header files (include):    Header files (include):
# Line 289  system. The following are installed (fil Line 419  system. The following are installed (fil
419    Man pages (share/man/man{1,3}):    Man pages (share/man/man{1,3}):
420      pcregrep.1      pcregrep.1
421      pcretest.1      pcretest.1
422        pcre-config.1
423      pcre.3      pcre.3
424      pcre*.3 (lots more pages, all starting "pcre")      pcre*.3 (lots more pages, all starting "pcre")
425    
# Line 303  system. The following are installed (fil Line 434  system. The following are installed (fil
434      LICENCE      LICENCE
435      NEWS      NEWS
436      README      README
437      pcre.txt       (a concatenation of the man(3) pages)      pcre.txt         (a concatenation of the man(3) pages)
438      pcretest.txt   the pcretest man page      pcretest.txt     the pcretest man page
439      pcregrep.txt   the pcregrep man page      pcregrep.txt     the pcregrep man page
440        pcre-config.txt  the pcre-config man page
 Note that the pcredemo program that is built by "configure" is *not* installed  
 anywhere. It is a demonstration for programmers wanting to use PCRE.  
441    
442  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".
443  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 371  Cross-compiling on Unix-like systems Line 500  Cross-compiling on Unix-like systems
500  ------------------------------------  ------------------------------------
501    
502  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
503  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
504  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
505  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
506  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,
507  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
508  there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)  compiler.
509  when calling the "configure" command. If they are not specified, they default  
510  to the values of CC and CFLAGS.  When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
511    by making a copy of pcre_chartables.c.dist, which is a default set of tables
512    that assumes ASCII code. Cross-compiling with the default tables should not be
513    a problem.
514    
515    If you need to modify the character tables when cross-compiling, you should
516    move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
517    run it on the local host to make a new version of pcre_chartables.c.dist.
518    Then when you cross-compile PCRE this new version of the tables will be used.
519    
520    
521  Using HP's ANSI C++ compiler (aCC)  Using HP's ANSI C++ compiler (aCC)
# Line 397  running the "configure" script: Line 534  running the "configure" script:
534    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
535    
536    
537    Using Sun's compilers for Solaris
538    ---------------------------------
539    
540    A user reports that the following configurations work on Solaris 9 sparcv9 and
541    Solaris 9 x86 (32-bit):
542    
543      Solaris 9 sparcv9: ./configure --disable-cpp CC=/bin/cc CFLAGS="-m64 -g"
544      Solaris 9 x86:     ./configure --disable-cpp CC=/bin/cc CFLAGS="-g"
545    
546    
547    Using PCRE from MySQL
548    ---------------------
549    
550    On systems where both PCRE and MySQL are installed, it is possible to make use
551    of PCRE from within MySQL, as an alternative to the built-in pattern matching.
552    There is a web page that tells you how to do this:
553    
554      http://www.mysqludf.org/lib_mysqludf_preg/index.php
555    
556    
557  Making new tarballs  Making new tarballs
558  -------------------  -------------------
559    
560  The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and  The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
561  zip formats. However, if you have modified any of the man page sources in the  zip formats. The command "make distcheck" does the same, but then does a trial
562  doc directory, you should first run the PrepareRelease script. This re-creates  build of the new distribution to ensure that it works.
563  the .txt and HTML forms of the documentation from the man pages.  
564    If you have modified any of the man page sources in the doc directory, you
565    should first run the PrepareRelease script before making a distribution. This
566    script creates the .txt and HTML forms of the documentation from the man pages.
567    
568    
569  Testing PCRE  Testing PCRE
# Line 413  To test the basic PCRE library on a Unix Line 573  To test the basic PCRE library on a Unix
573  created by the configuring process. There is also a script called RunGrepTest  created by the configuring process. There is also a script called RunGrepTest
574  that tests the options of the pcregrep command. If the C++ wrapper library is  that tests the options of the pcregrep command. If the C++ wrapper library is
575  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
576  pcre_stringpiece_unittest are also built.  pcre_stringpiece_unittest are also built. When JIT support is enabled, another
577    test program called pcre_jit_test is built.
578    
579  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
580  "make test". For other systems, see the instructions in NON-UNIX-USE.  "make test". For other systems, see the instructions in NON-UNIX-USE.
581    
582  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
583  own man page) on each of the testinput files in the testdata directory in  own man page) on each of the relevant testinput files in the testdata
584  turn, and compares the output with the contents of the corresponding testoutput  directory, and compares the output with the contents of the corresponding
585  files. A file called testtry is used to hold the main output from pcretest  testoutput files. Some tests are relevant only when certain build-time options
586  (testsavedregex is also used as a working file). To run pcretest on just one of  were selected. For example, the tests for UTF-8/16 support are run only if
587  the test files, give its number as an argument to RunTest, for example:  --enable-utf was used. RunTest outputs a comment when it skips a test.
588    
589    RunTest 2  Many of the tests that are not skipped are run up to three times. The second
590    run forces pcre_study() to be called for all patterns except for a few in some
591  The first test file can also be fed directly into the perltest.pl script to  tests that are marked "never study" (see the pcretest program for how this is
592  check that Perl gives the same results. The only difference you should see is  done). If JIT support is available, the non-DFA tests are run a third time,
593  in the first few lines, where the Perl version is given instead of the PCRE  this time with a forced pcre_study() with the PCRE_STUDY_JIT_COMPILE option.
594  version.  
595    When both 8-bit and 16-bit support is enabled, the entire set of tests is run
596    twice, once for each library. If you want to run just one set of tests, call
597    RunTest with either the -8 or -16 option.
598    
599    RunTest uses a file called testtry to hold the main output from pcretest
600    (testsavedregex is also used as a working file). To run pcretest on just one or
601    more specific test files, give their numbers as arguments to RunTest, for
602    example:
603    
604      RunTest 2 7 11
605    
606    The first test file can be fed directly into the perltest.pl script to check
607    that Perl gives the same results. The only difference you should see is in the
608    first few lines, where the Perl version is given instead of the PCRE version.
609    
610  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_study(),
611  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
612  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
613  wrapper API. It also uses the debugging flags to check some of the internals of  wrapper API. It also uses the debugging flags to check some of the internals of
# Line 461  is output to say why. If running this te Line 636  is output to say why. If running this te
636  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,
637  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.
638    
639  The fourth test checks the UTF-8 support. It is not run automatically unless  [If you are trying to run this test on Windows, you may be able to get it to
640  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when  work by changing "fr_FR" to "french" everywhere it occurs. Alternatively, use
641  running "configure". This file can be also fed directly to the perltest script,  RunTest.bat. The version of RunTest.bat included with PCRE 7.4 and above uses
642  provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,  Windows versions of test 2. More info on using RunTest.bat is included in the
643  commented in the script, can be be used.)  document entitled NON-UNIX-USE.]
644    
645  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8  The fourth and fifth tests check the UTF-8/16 support and error handling and
646  features of PCRE that are not relevant to Perl.  internal UTF features of PCRE that are not relevant to Perl, respectively. The
647    sixth and seventh tests do the same for Unicode character properties support.
648  The sixth test checks the support for Unicode character properties. It it not  
649  run automatically unless PCRE is built with Unicode property support. To to  The eighth, ninth, and tenth tests check the pcre_dfa_exec() alternative
650  this you must set --enable-unicode-properties when running "configure".  matching function, in non-UTF-8/16 mode, UTF-8/16 mode, and UTF-8/16 mode with
651    Unicode property support, respectively.
652  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  
653  matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode  The eleventh test checks some internal offsets and code size features; it is
654  property support, respectively. The eighth and ninth tests are not run  run only when the default "link size" of 2 is set (in other cases the sizes
655  automatically unless PCRE is build with the relevant support.  change) and when Unicode property support is enabled.
656    
657    The twelfth test is run only when JIT support is available, and the thirteenth
658    test is run only when JIT support is not available. They test some JIT-specific
659    features such as information output from pcretest about JIT compilation.
660    
661    The fourteenth, fifteenth, and sixteenth tests are run only in 8-bit mode, and
662    the seventeenth, eighteenth, and nineteenth tests are run only in 16-bit mode.
663    These are tests that generate different output in the two modes. They are for
664    general cases, UTF-8/16 support, and Unicode property support, respectively.
665    
666    The twentieth test is run only in 16-bit mode. It tests some specific 16-bit
667    features of the DFA matching engine.
668    
669    
670  Character tables  Character tables
# Line 490  concatenated tables. A call to pcre_make Line 677  concatenated tables. A call to pcre_make
677  of tables in the current locale. If the final argument for pcre_compile() is  of tables in the current locale. If the final argument for pcre_compile() is
678  passed as NULL, a set of 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.
679    
680  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
681  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
682  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
683  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
684  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
685  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
686  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
687  take care to ensure that the file does not get automaticaly re-generated.  your system will control the contents of these default tables. You can change
688    the default tables by editing pcre_chartables.c and then re-building PCRE. If
689    you do this, you should take care to ensure that the file does not get
690    automatically re-generated. The best way to do this is to move
691    pcre_chartables.c.dist out of the way and replace it with your customized
692    tables.
693    
694    When the dftables program is run as a result of --enable-rebuild-chartables,
695    it uses the default C locale that is set on your system. It does not pay
696    attention to the LC_xxx environment variables. In other words, it uses the
697    system's default locale rather than whatever the compiling user happens to have
698    set. If you really do want to build a source set of character tables in a
699    locale that is specified by the LC_xxx variables, you can run the dftables
700    program by hand with the -L option. For example:
701    
702      ./dftables -L pcre_chartables.c.special
703    
704  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,
705  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
# Line 522  will cause PCRE to malfunction. Line 724  will cause PCRE to malfunction.
724  File manifest  File manifest
725  -------------  -------------
726    
727  The distribution should contain the following files:  The distribution should contain the files listed below. Where a file name is
728    given as pcre[16]_xxx it means that there are two files, one with the name
729    pcre_xxx and the other with the name pcre16_xxx.
730    
731  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
732    
733    dftables.c             auxiliary program for building chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
734                                when --enable-rebuild-chartables is specified
735    
736    pcreposix.c            )    pcre_chartables.c.dist  a default set of character tables that assume ASCII
737    pcre_compile.c         )                              coding; used, unless --enable-rebuild-chartables is
738    pcre_config.c          )                              specified, by copying to pcre[16]_chartables.c
739    pcre_dfa_exec.c        )  
740    pcre_exec.c            )    pcreposix.c             )
741    pcre_fullinfo.c        )    pcre[16]_byte_order.c   )
742    pcre_get.c             ) sources for the functions in the library,    pcre[16]_compile.c      )
743    pcre_globals.c         )   and some internal functions that they use    pcre[16]_config.c       )
744    pcre_info.c            )    pcre[16]_dfa_exec.c     )
745    pcre_maketables.c      )    pcre[16]_exec.c         )
746    pcre_newline.c         )    pcre[16]_fullinfo.c     )
747    pcre_ord2utf8.c        )    pcre[16]_get.c          ) sources for the functions in the library,
748    pcre_refcount.c        )    pcre[16]_globals.c      )   and some internal functions that they use
749    pcre_study.c           )    pcre[16]_jit_compile.c  )
750    pcre_tables.c          )    pcre[16]_maketables.c   )
751    pcre_try_flipped.c     )    pcre[16]_newline.c      )
752    pcre_ucp_searchfuncs.c )    pcre[16]_refcount.c     )
753    pcre_valid_utf8.c      )    pcre[16]_string_utils.c )
754    pcre_version.c         )    pcre[16]_study.c        )
755    pcre_xclass.c          )    pcre[16]_tables.c       )
756    pcre_printint.src      ) debugging function that is #included in pcretest,    pcre[16]_ucd.c          )
757                           )   and can also be #included in pcre_compile()    pcre[16]_version.c      )
758    pcre.h.in              template for pcre.h when built by "configure"    pcre[16]_xclass.c       )
759    pcreposix.h            header for the external POSIX wrapper API    pcre_ord2utf8.c         )
760    pcre_internal.h        header for internal use    pcre_valid_utf8.c       )
761    ucp.h                  ) headers concerned with    pcre16_ord2utf16.c      )
762    ucpinternal.h          )   Unicode property handling    pcre16_utf16_utils.c    )
763    ucptable.h             ) (this one is the data table)    pcre16_valid_utf16.c    )
764    
765    config.h.in            template for config.h, which is built by "configure"    pcre[16]_printint.c     ) debugging function that is used by pcretest,
766                              )   and can also be #included in pcre_compile()
767    pcrecpp.h              public header file for the C++ wrapper  
768    pcrecpparg.h.in        template for another C++ header file    pcre.h.in               template for pcre.h when built by "configure"
769    pcre_scanner.h         public header file for C++ scanner functions    pcreposix.h             header for the external POSIX wrapper API
770    pcrecpp.cc             )    pcre_internal.h         header for internal use
771    pcre_scanner.cc        ) source for the C++ wrapper library    sljit/*                 16 files that make up the JIT compiler
772      ucp.h                   header for Unicode property handling
773    pcre_stringpiece.h.in  template for pcre_stringpiece.h, the header for the  
774                             C++ stringpiece functions    config.h.in             template for config.h, which is built by "configure"
775    pcre_stringpiece.cc    source for the C++ stringpiece functions  
776      pcrecpp.h               public header file for the C++ wrapper
777      pcrecpparg.h.in         template for another C++ header file
778      pcre_scanner.h          public header file for C++ scanner functions
779      pcrecpp.cc              )
780      pcre_scanner.cc         ) source for the C++ wrapper library
781    
782      pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
783                                C++ stringpiece functions
784      pcre_stringpiece.cc     source for the C++ stringpiece functions
785    
786  (B) Source files for programs that use PCRE:  (B) Source files for programs that use PCRE:
787    
788    pcredemo.c             simple demonstration of coding calls to PCRE    pcredemo.c              simple demonstration of coding calls to PCRE
789    pcregrep.c             source of a grep utility that uses PCRE    pcregrep.c              source of a grep utility that uses PCRE
790    pcretest.c             comprehensive test program    pcretest.c              comprehensive test program
791    
792  (C) Auxiliary files:  (C) Auxiliary files:
793    
794    132html                script to turn "man" pages into HTML    132html                 script to turn "man" pages into HTML
795    AUTHORS                information about the author of PCRE    AUTHORS                 information about the author of PCRE
796    ChangeLog              log of changes to the code    ChangeLog               log of changes to the code
797    CleanTxt               script to clean nroff output for txt man pages    CleanTxt                script to clean nroff output for txt man pages
798    Detrail                script to remove trailing spaces    Detrail                 script to remove trailing spaces
799    Index.html             the base HTML page    HACKING                 some notes about the internals of PCRE
800    INSTALL                generic installation instructions    INSTALL                 generic installation instructions
801    LICENCE                conditions for the use of PCRE    LICENCE                 conditions for the use of PCRE
802    COPYING                the same, using GNU's standard name    COPYING                 the same, using GNU's standard name
803    Makefile.in            ) template for Unix Makefile, which is built by    Makefile.in             ) template for Unix Makefile, which is built by
804                           )   "configure"                            )   "configure"
805    Makefile.am            ) the automake input that was used to create    Makefile.am             ) the automake input that was used to create
806                           )   Makefile.in                            )   Makefile.in
807    NEWS                   important changes in this release    NEWS                    important changes in this release
808    NON-UNIX-USE           notes on building PCRE on non-Unix systems    NON-UNIX-USE            notes on building PCRE on non-Unix systems
809    PrepareRelease         script to make preparations for "make dist"    PrepareRelease          script to make preparations for "make dist"
810    README                 this file    README                  this file
811    RunTest.in             template for a Unix shell script for running tests    RunTest                 a Unix shell script for running tests
812    RunGrepTest.in         template for a Unix shell script for pcregrep tests    RunGrepTest             a Unix shell script for pcregrep tests
813    aclocal.m4             m4 macros (generated by "aclocal")    aclocal.m4              m4 macros (generated by "aclocal")
814    config.guess           ) files used by libtool,    config.guess            ) files used by libtool,
815    config.sub             )   used only when building a shared library    config.sub              )   used only when building a shared library
816    configure              a configuring shell script (built by autoconf)    configure               a configuring shell script (built by autoconf)
817    configure.ac           ) the autoconf input that was used to build    configure.ac            ) the autoconf input that was used to build
818                           )   "configure" and config.h                            )   "configure" and config.h
819    depcomp                ) script to find program dependencies, generated by    depcomp                 ) script to find program dependencies, generated by
820                           )   automake                            )   automake
821    doc/*.3                man page sources for the PCRE functions    doc/*.3                 man page sources for PCRE
822    doc/*.1                man page sources for pcregrep and pcretest    doc/*.1                 man page sources for pcregrep and pcretest
823    doc/html/*             HTML documentation    doc/index.html.src      the base HTML page
824    doc/pcre.txt           plain text version of the man pages    doc/html/*              HTML documentation
825    doc/pcretest.txt       plain text documentation of test program    doc/pcre.txt            plain text version of the man pages
826    doc/perltest.txt       plain text documentation of Perl test program    doc/pcretest.txt        plain text documentation of test program
827    install-sh             a shell script for installing files    doc/perltest.txt        plain text documentation of Perl test program
828    libpcre.pc.in          template for libpcre.pc for pkg-config    install-sh              a shell script for installing files
829    libpcrecpp.pc.in       template for libpcrecpp.pc for pkg-config    libpcre16.pc.in         template for libpcre16.pc for pkg-config
830    ltmain.sh              file used to build a libtool script    libpcre.pc.in           template for libpcre.pc for pkg-config
831    missing                ) common stub for a few missing GNU programs while    libpcreposix.pc.in      template for libpcreposix.pc for pkg-config
832                           )   installing, generated by automake    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
833    mkinstalldirs          script for making install directories    ltmain.sh               file used to build a libtool script
834    perltest.pl            Perl test program    missing                 ) common stub for a few missing GNU programs while
835    pcre-config.in         source of script which retains PCRE information                            )   installing, generated by automake
836      mkinstalldirs           script for making install directories
837      perltest.pl             Perl test program
838      pcre-config.in          source of script which retains PCRE information
839      pcre_jit_test.c         test program for the JIT compiler
840    pcrecpp_unittest.cc          )    pcrecpp_unittest.cc          )
841    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
842    pcre_stringpiece_unittest.cc )    pcre_stringpiece_unittest.cc )
843    testdata/testinput*    test data for main library tests    testdata/testinput*     test data for main library tests
844    testdata/testoutput*   expected test results    testdata/testoutput*    expected test results
845    testdata/grep*         input and output for pcregrep tests    testdata/grep*          input and output for pcregrep tests
846      testdata/*              other supporting test files
847    
848  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
849    
850      cmake/COPYING-CMAKE-SCRIPTS
851      cmake/FindPackageHandleStandardArgs.cmake
852      cmake/FindReadline.cmake
853    CMakeLists.txt    CMakeLists.txt
854    config-cmake.h.in    config-cmake.h.in
855    
856  (E) Auxiliary files for VPASCAL  (E) Auxiliary files for VPASCAL
857    
858    makevp.bat    makevp.bat
859    !compile.txt    makevp_c.txt
860    !linklib.txt    makevp_l.txt
861    pcregexp.pas    pcregexp.pas
862    
863  (F) Auxiliary files for building PCRE "by hand"  (F) Auxiliary files for building PCRE "by hand"
864    
865    pcre.h.generic         ) a version of the public PCRE header file    pcre.h.generic          ) a version of the public PCRE header file
866                           )   for use in non-"configure" environments                            )   for use in non-"configure" environments
867    config.h.generic       ) a version of config.h for use in non-"configure"    config.h.generic        ) a version of config.h for use in non-"configure"
868                           )   environments                            )   environments
869    
870  (F) Miscellaneous  (F) Miscellaneous
871    
# Line 652  The distribution should contain the foll Line 874  The distribution should contain the foll
874  Philip Hazel  Philip Hazel
875  Email local part: ph10  Email local part: ph10
876  Email domain: cam.ac.uk  Email domain: cam.ac.uk
877  Last updated: March 2007  Last updated: 30 December 2011

Legend:
Removed from v.123  
changed lines
  Added in v.840

  ViewVC Help
Powered by ViewVC 1.1.5