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

Diff of /code/trunk/README

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

revision 155 by ph10, Tue Apr 24 13:36:11 2007 UTC revision 1251 by ph10, Wed Feb 20 17:42:03 2013 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 15  The contents of this README file are: Line 18  The contents of this README file are:
18    The PCRE APIs    The PCRE APIs
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-like systems
22    Building PCRE on Unix-like systems    Building PCRE without using autotools
23    Retrieving configuration information on Unix-like systems    Building PCRE using autotools
24    Shared libraries on Unix-like systems    Retrieving configuration information
25    Cross-compiling on Unix-like systems    Shared libraries
26      Cross-compiling using autotools
27    Using HP's ANSI C++ compiler (aCC)    Using HP's ANSI C++ compiler (aCC)
28      Using PCRE from MySQL
29    Making new tarballs    Making new tarballs
30    Testing PCRE    Testing PCRE
31    Character tables    Character tables
# Line 30  The contents of this README file are: Line 35  The contents of this README file are:
35  The PCRE APIs  The PCRE APIs
36  -------------  -------------
37    
38  PCRE is written in C, and it has its own API. The distribution also includes a  PCRE is written in C, and it has its own API. There are three sets of functions,
39  set of C++ wrapper functions (see the pcrecpp man page for details), courtesy  one for the 8-bit library, which processes strings of bytes, one for the
40  of Google Inc.  16-bit library, which processes strings of 16-bit values, and one for the 32-bit
41    library, which processes strings of 32-bit values. The distribution also
42  In addition, there is a set of C wrapper functions that are based on the POSIX  includes a set of C++ wrapper functions (see the pcrecpp man page for details),
43  regular expression API (see the pcreposix man page). These end up in the  courtesy of Google Inc., which can be used to call the 8-bit PCRE library from
44  library called libpcreposix. Note that this just provides a POSIX calling  C++.
45  interface to PCRE; the regular expressions themselves still follow Perl syntax  
46  and semantics. The POSIX API is restricted, and does not give full access to  In addition, there is a set of C wrapper functions (again, just for the 8-bit
47  all of PCRE's facilities.  library) that are based on the POSIX regular expression API (see the pcreposix
48    man page). These end up in the library called libpcreposix. Note that this just
49    provides a POSIX calling interface to PCRE; the regular expressions themselves
50    still follow Perl syntax and semantics. The POSIX API is restricted, and does
51    not give full access to all of PCRE's facilities.
52    
53  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
54  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 82  documentation is supplied in two other f Line 91  documentation is supplied in two other f
91       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
92       doc/html and installed in <prefix>/share/doc/pcre/html.       doc/html and installed in <prefix>/share/doc/pcre/html.
93    
94    Users of PCRE have contributed files containing the documentation for various
95    releases in CHM format. These can be found in the Contrib directory of the FTP
96    site (see next section).
97    
98    
99  Contributions by users of PCRE  Contributions by users of PCRE
100  ------------------------------  ------------------------------
# Line 98  Windows (I myself do not use Windows). N Line 111  Windows (I myself do not use Windows). N
111  in the standard distribution, so these contibutions have been archived.  in the standard distribution, so these contibutions have been archived.
112    
113    
114  Building PCRE on non-Unix systems  Building PCRE on non-Unix-like systems
115  ---------------------------------  --------------------------------------
116    
117  For a non-Unix system, please read the comments in the file NON-UNIX-USE,  For a non-Unix-like system, please read the comments in the file
118  though if your system supports the use of "configure" and "make" you may be  NON-AUTOTOOLS-BUILD, though if your system supports the use of "configure" and
119  able to build PCRE in the same way as for Unix-like systems.  "make" you may be able to build PCRE using autotools in the same way as for
120    many Unix-like systems.
121    
122    PCRE can also be configured using the GUI facility provided by CMake's
123    cmake-gui command. This creates Makefiles, solution files, etc. The file
124    NON-AUTOTOOLS-BUILD has information about CMake.
125    
126  PCRE has been compiled on many different operating systems. It should be  PCRE has been compiled on many different operating systems. It should be
127  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
128  library, because it uses only Standard C functions.  library, because it uses only Standard C functions.
129    
130    
131  Building PCRE on Unix-like systems  Building PCRE without using autotools
132  ----------------------------------  -------------------------------------
133    
134    The use of autotools (in particular, libtool) is problematic in some
135    environments, even some that are Unix or Unix-like. See the NON-AUTOTOOLS-BUILD
136    file for ways of building PCRE without using autotools.
137    
138    
139    Building PCRE using autotools
140    -----------------------------
141    
142  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
143  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
144    
145  The following instructions assume the use of the widely used "configure, make,  The following instructions assume the use of the widely used "configure; make;
146  make install" process. There is also some experimental support for "cmake" in  make install" (autotools) process.
147  the PCRE distribution, but it is incomplete and not documented. However, if you  
148  are a "cmake" user, you might want to try it.  To build PCRE on system that supports autotools, first run the "configure"
149    command from the PCRE distribution directory, with your current directory set
150  To build PCRE on a Unix-like system, first run the "configure" command from the  to the directory where you want the files to be created. This command is a
151  PCRE distribution directory, with your current directory set to the directory  standard GNU "autoconf" configuration script, for which generic instructions
152  where you want the files to be created. This command is a standard GNU  are supplied in the file INSTALL.
 "autoconf" configuration script, for which generic instructions are supplied in  
 the file INSTALL.  
153    
154  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
155  this case, on many systems, just running "./configure" is sufficient. However,  this case, on many systems, just running "./configure" is sufficient. However,
# Line 133  the usual methods of changing standard d Line 157  the usual methods of changing standard d
157    
158  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
159    
160  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
161  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
162  instead of the default /usr/local.  under /opt/local instead of the default /usr/local.
163    
164  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
165  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 149  possible to build it as a C++ library, t Line 173  possible to build it as a C++ library, t
173  does not have any features to support this.  does not have any features to support this.
174    
175  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
176  library. You can read more about them in the pcrebuild man page.  library. They are also documented in the pcrebuild man page.
177    
178    . By default, both shared and static libraries are built. You can change this
179      by adding one of these options to the "configure" command:
180    
181  . If you want to suppress the building of the C++ wrapper library, you can add    --disable-shared
182    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-static
183    it will try to find a C++ compiler and C++ header files, and if it succeeds,  
184    it will try to build the C++ wrapper.    (See also "Shared libraries on Unix-like systems" below.)
185    
186  . 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
187    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 add
188    for handling UTF-8 is not included in the library. (Even when included, it    --enable-pcre32 to the "configure" command, the 32-bit library is also built.
189    still has to be enabled by an option at run time.)    If you want only the 16-bit or 32-bit library, use --disable-pcre8 to disable
190      building the 8-bit library.
191  . If, in addition to support for UTF-8 character strings, you want to include  
192    support for the \P, \p, and \X sequences that recognize Unicode character  . If you are building the 8-bit library and want to suppress the building of
193    properties, you must add --enable-unicode-properties to the "configure"    the C++ wrapper library, you can add --disable-cpp to the "configure"
194    command. This adds about 30K to the size of the library (in the form of a    command. Otherwise, when "configure" is run without --disable-pcre8, it will
195    property table); only the basic two-letter properties such as Lu are    try to find a C++ compiler and C++ header files, and if it succeeds, it will
196    supported.    try to build the C++ wrapper.
197    
198    . If you want to include support for just-in-time compiling, which can give
199      large performance improvements on certain platforms, add --enable-jit to the
200      "configure" command. This support is available only for certain hardware
201      architectures. If you try to enable it on an unsupported architecture, there
202      will be a compile time error.
203    
204    . When JIT support is enabled, pcregrep automatically makes use of it, unless
205      you add --disable-pcregrep-jit to the "configure" command.
206    
207    . If you want to make use of the support for UTF-8 Unicode character strings in
208      the 8-bit library, or UTF-16 Unicode character strings in the 16-bit library,
209      or UTF-32 Unicode character strings in the 32-bit library, you must add
210      --enable-utf to the "configure" command. Without it, the code for handling
211      UTF-8, UTF-16 and UTF-8 is not included in the relevant library. Even
212      when --enable-utf is included, the use of a UTF encoding still has to be
213      enabled by an option at run time. When PCRE is compiled with this option, its
214      input can only either be ASCII or UTF-8/16/32, even when running on EBCDIC
215      platforms. It is not possible to use both --enable-utf and --enable-ebcdic at
216      the same time.
217    
218    . There are no separate options for enabling UTF-8, UTF-16 and UTF-32
219      independently because that would allow ridiculous settings such as requesting
220      UTF-16 support while building only the 8-bit library. However, the option
221      --enable-utf8 is retained for backwards compatibility with earlier releases
222      that did not support 16-bit or 32-bit character strings. It is synonymous with
223      --enable-utf. It is not possible to configure one library with UTF support
224      and the other without in the same configuration.
225    
226    . If, in addition to support for UTF-8/16/32 character strings, you want to
227      include support for the \P, \p, and \X sequences that recognize Unicode
228      character properties, you must add --enable-unicode-properties to the
229      "configure" command. This adds about 30K to the size of the library (in the
230      form of a property table); only the basic two-letter properties such as Lu
231      are supported.
232    
233  . 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
234    of the preceding, or any of the Unicode newline sequences as indicating the    of the preceding, or any of the Unicode newline sequences as indicating the
# Line 184  library. You can read more about them in Line 246  library. You can read more about them in
246    --enable-newline-is-any, many tests should succeed, but there may be some    --enable-newline-is-any, many tests should succeed, but there may be some
247    failures.    failures.
248    
249    . By default, the sequence \R in a pattern matches any Unicode line ending
250      sequence. This is independent of the option specifying what PCRE considers to
251      be the end of a line (see above). However, the caller of PCRE can restrict \R
252      to match only CR, LF, or CRLF. You can make this the default by adding
253      --enable-bsr-anycrlf to the "configure" command (bsr = "backslash R").
254    
255  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
256    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
257    them in a pattern. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
# Line 213  library. You can read more about them in Line 281  library. You can read more about them in
281    sizes in the pcrestack man page.    sizes in the pcrestack man page.
282    
283  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
284    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
285    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
286    ever to be necessary. Increasing the internal link size will reduce    parts of the compiled pattern. In the 16-bit library, --with-link-size=3 is
287    performance.    the same as --with-link-size=4, which (in both libraries) uses four-byte
288      offsets. Increasing the internal link size reduces performance. In the 32-bit
289      library, the only supported link size is 4.
290    
291  . 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
292    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 228  library. You can read more about them in Line 298  library. You can read more about them in
298    
299    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
300    necessary in environments with limited stack sizes. This applies only to the    necessary in environments with limited stack sizes. This applies only to the
301    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
302    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
303    pcrestack man page.    pcre_dfa_exec(), which does not use deeply nested recursion. There is a
304      discussion about stack sizes in the pcrestack man page.
305    
306  . For speed, PCRE uses four tables for manipulating and identifying characters  . For speed, PCRE uses four tables for manipulating and identifying characters
307    whose code point values are less than 256. By default, it uses a set of    whose code point values are less than 256. By default, it uses a set of
# Line 244  library. You can read more about them in Line 315  library. You can read more about them in
315    pcre_chartables.c.dist. See "Character tables" below for further information.    pcre_chartables.c.dist. See "Character tables" below for further information.
316    
317  . It is possible to compile PCRE for use on systems that use EBCDIC as their  . It is possible to compile PCRE for use on systems that use EBCDIC as their
318    default character code (as opposed to ASCII) by specifying    character code (as opposed to ASCII/Unicode) by specifying
319    
320    --enable-ebcdic    --enable-ebcdic
321    
322    This automatically implies --enable-rebuild-chartables (see above).    This automatically implies --enable-rebuild-chartables (see above). However,
323      when PCRE is built this way, it always operates in EBCDIC. It cannot support
324      both EBCDIC and UTF-8/16/32. There is a second option, --enable-ebcdic-nl25,
325      which specifies that the code value for the EBCDIC NL character is 0x25
326      instead of the default 0x15.
327    
328    . In environments where valgrind is installed, if you specify
329    
330      --enable-valgrind
331    
332      PCRE will use valgrind annotations to mark certain memory regions as
333      unaddressable. This allows it to detect invalid memory accesses, and is
334      mostly useful for debugging PCRE itself.
335    
336    . In environments where the gcc compiler is used and lcov version 1.6 or above
337      is installed, if you specify
338    
339      --enable-coverage
340    
341      the build process implements a code coverage report for the test suite. The
342      report is generated by running "make coverage". If ccache is installed on
343      your system, it must be disabled when building PCRE for coverage reporting.
344      You can do this by setting the environment variable CCACHE_DISABLE=1 before
345      running "make" to build PCRE.
346    
347    . The pcregrep program currently supports only 8-bit data files, and so
348      requires the 8-bit PCRE library. It is possible to compile pcregrep to use
349      libz and/or libbz2, in order to read .gz and .bz2 files (respectively), by
350      specifying one or both of
351    
352      --enable-pcregrep-libz
353      --enable-pcregrep-libbz2
354    
355      Of course, the relevant libraries must be installed on your system.
356    
357    . The default size of internal buffer used by pcregrep can be set by, for
358      example:
359    
360      --with-pcregrep-bufsize=50K
361    
362      The default value is 20K.
363    
364    . It is possible to compile pcretest so that it links with the libreadline
365      or libedit libraries, by specifying, respectively,
366    
367      --enable-pcretest-libreadline or --enable-pcretest-libedit
368    
369      If this is done, when pcretest's input is from a terminal, it reads it using
370      the readline() function. This provides line-editing and history facilities.
371      Note that libreadline is GPL-licenced, so if you distribute a binary of
372      pcretest linked in this way, there may be licensing issues. These can be
373      avoided by linking with libedit (which has a BSD licence) instead.
374    
375      Enabling libreadline causes the -lreadline option to be added to the pcretest
376      build. In many operating environments with a sytem-installed readline
377      library this is sufficient. However, in some environments (e.g. if an
378      unmodified distribution version of readline is in use), it may be necessary
379      to specify something like LIBS="-lncurses" as well. This is because, to quote
380      the readline INSTALL, "Readline uses the termcap functions, but does not link
381      with the termcap or curses library itself, allowing applications which link
382      with readline the to choose an appropriate library." If you get error
383      messages about missing functions tgetstr, tgetent, tputs, tgetflag, or tgoto,
384      this is the problem, and linking with the ncurses library should fix it.
385    
386  The "configure" script builds the following files for the basic C library:  The "configure" script builds the following files for the basic C library:
387    
388  . Makefile is the makefile that builds the library  . Makefile             the makefile that builds the library
389  . config.h contains build-time configuration options for the library  . config.h             build-time configuration options for the library
390  . pcre.h is the public PCRE header file  . pcre.h               the public PCRE header file
391  . pcre-config is a script that shows the settings of "configure" options  . pcre-config          script that shows the building settings such as CFLAGS
392  . libpcre.pc is data for the pkg-config command                           that were set for "configure"
393  . libtool is a script that builds shared and/or static libraries  . libpcre.pc         ) data for the pkg-config command
394  . RunTest is a script for running tests on the basic C library  . libpcre16.pc       )
395  . RunGrepTest is a script for running tests on the pcregrep command  . libpcre32.pc       )
396    . libpcreposix.pc    )
397  Versions of config.h and pcre.h are distributed in the PCRE tarballs under  . libtool              script that builds shared and/or static libraries
398  the names config.h.generic and pcre.h.generic. These are provided for the  
399  benefit of those who have to built PCRE without the benefit of "configure". If  Versions of config.h and pcre.h are distributed in the PCRE tarballs under the
400  you use "configure", the .generic versions are not used.  names config.h.generic and pcre.h.generic. These are provided for those who
401    have to built PCRE without using "configure" or CMake. If you use "configure"
402  If a C++ compiler is found, the following files are also built:  or CMake, the .generic versions are not used.
403    
404  . libpcrecpp.pc is data for the pkg-config command  When building the 8-bit library, if a C++ compiler is found, the following
405  . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper  files are also built:
406  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions  
407    . libpcrecpp.pc        data for the pkg-config command
408    . pcrecpparg.h         header file for calling PCRE via the C++ wrapper
409    . pcre_stringpiece.h   header for the C++ "stringpiece" functions
410    
411  The "configure" script also creates config.status, which is an executable  The "configure" script also creates config.status, which is an executable
412  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
413  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
414    
415  Once "configure" has run, you can run "make". It builds two libraries, called  Once "configure" has run, you can run "make". This builds the the libraries
416  libpcre and libpcreposix, a test program called pcretest, a demonstration  libpcre, libpcre16 and/or libpcre32, and a test program called pcretest. If you
417  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
418  on your system, "make" also builds the C++ wrapper library, which is called  built as well.
419  libpcrecpp, and some test programs called pcrecpp_unittest,  
420  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
421  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
422    it with --disable-cpp, "make" builds the C++ wrapper library, which is called
423    libpcrecpp, as well as some test programs called pcrecpp_unittest,
424    pcre_scanner_unittest, and pcre_stringpiece_unittest.
425    
426  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
427  tests are given below in a separate section of this document.  tests are given below in a separate section of this document.
# Line 293  system. The following are installed (fil Line 432  system. The following are installed (fil
432    
433    Commands (bin):    Commands (bin):
434      pcretest      pcretest
435      pcregrep      pcregrep (if 8-bit support is enabled)
436      pcre-config      pcre-config
437    
438    Libraries (lib):    Libraries (lib):
439      libpcre      libpcre16     (if 16-bit support is enabled)
440      libpcreposix      libpcre32     (if 32-bit support is enabled)
441      libpcrecpp (if C++ support is enabled)      libpcre       (if 8-bit support is enabled)
442        libpcreposix  (if 8-bit support is enabled)
443        libpcrecpp    (if 8-bit and C++ support is enabled)
444    
445    Configuration information (lib/pkgconfig):    Configuration information (lib/pkgconfig):
446        libpcre16.pc
447        libpcre32.pc
448      libpcre.pc      libpcre.pc
449        libpcreposix.pc
450      libpcrecpp.pc (if C++ support is enabled)      libpcrecpp.pc (if C++ support is enabled)
451    
452    Header files (include):    Header files (include):
# Line 316  system. The following are installed (fil Line 460  system. The following are installed (fil
460    Man pages (share/man/man{1,3}):    Man pages (share/man/man{1,3}):
461      pcregrep.1      pcregrep.1
462      pcretest.1      pcretest.1
463        pcre-config.1
464      pcre.3      pcre.3
465      pcre*.3 (lots more pages, all starting "pcre")      pcre*.3 (lots more pages, all starting "pcre")
466    
# Line 330  system. The following are installed (fil Line 475  system. The following are installed (fil
475      LICENCE      LICENCE
476      NEWS      NEWS
477      README      README
478      pcre.txt       (a concatenation of the man(3) pages)      pcre.txt         (a concatenation of the man(3) pages)
479      pcretest.txt   the pcretest man page      pcretest.txt     the pcretest man page
480      pcregrep.txt   the pcregrep man page      pcregrep.txt     the pcregrep man page
481        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.  
482    
483  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".
484  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
485  remove any directories, because these are often shared with other programs.  remove any directories, because these are often shared with other programs.
486    
487    
488  Retrieving configuration information on Unix-like systems  Retrieving configuration information
489  ---------------------------------------------------------  ------------------------------------
490    
491  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
492  recall information about the PCRE configuration and installation. For example:  recall information about the PCRE configuration and installation. For example:
# Line 368  The data is held in *.pc files that are Line 511  The data is held in *.pc files that are
511  <prefix>/lib/pkgconfig.  <prefix>/lib/pkgconfig.
512    
513    
514  Shared libraries on Unix-like systems  Shared libraries
515  -------------------------------------  ----------------
516    
517  The default distribution builds PCRE as shared libraries and static libraries,  The default distribution builds PCRE as shared libraries and static libraries,
518  as long as the operating system supports shared libraries. Shared library  as long as the operating system supports shared libraries. Shared library
# Line 394  Then run "make" in the usual way. Simila Line 537  Then run "make" in the usual way. Simila
537  build only shared libraries.  build only shared libraries.
538    
539    
540  Cross-compiling on Unix-like systems  Cross-compiling using autotools
541  ------------------------------------  -------------------------------
542    
543  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
544  order to cross-compile PCRE for some other host. However, you should NOT  order to cross-compile PCRE for some other host. However, you should NOT
# Line 432  running the "configure" script: Line 575  running the "configure" script:
575    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
576    
577    
578    Using Sun's compilers for Solaris
579    ---------------------------------
580    
581    A user reports that the following configurations work on Solaris 9 sparcv9 and
582    Solaris 9 x86 (32-bit):
583    
584      Solaris 9 sparcv9: ./configure --disable-cpp CC=/bin/cc CFLAGS="-m64 -g"
585      Solaris 9 x86:     ./configure --disable-cpp CC=/bin/cc CFLAGS="-g"
586    
587    
588    Using PCRE from MySQL
589    ---------------------
590    
591    On systems where both PCRE and MySQL are installed, it is possible to make use
592    of PCRE from within MySQL, as an alternative to the built-in pattern matching.
593    There is a web page that tells you how to do this:
594    
595      http://www.mysqludf.org/lib_mysqludf_preg/index.php
596    
597    
598  Making new tarballs  Making new tarballs
599  -------------------  -------------------
600    
# Line 447  script creates the .txt and HTML forms o Line 610  script creates the .txt and HTML forms o
610  Testing PCRE  Testing PCRE
611  ------------  ------------
612    
613  To test the basic PCRE library on a Unix system, run the RunTest script that is  To test the basic PCRE library on a Unix-like system, run the RunTest script.
614  created by the configuring process. There is also a script called RunGrepTest  There is another script called RunGrepTest that tests the options of the
615  that tests the options of the pcregrep command. If the C++ wrapper library is  pcregrep command. If the C++ wrapper library is built, three test programs
616  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and  called pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest
617  pcre_stringpiece_unittest are also built.  are also built. When JIT support is enabled, another test program called
618    pcre_jit_test is built.
619    
620  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
621  "make test". For other systems, see the instructions in NON-UNIX-USE.  "make test". For other environments, see the instructions in
622    NON-AUTOTOOLS-BUILD.
623    
624  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
625  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
626  turn, and compares the output with the contents of the corresponding testoutput  directory, and compares the output with the contents of the corresponding
627  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
628  (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/32 support are run only if
629  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.
630    
631    RunTest 2  Many of the tests that are not skipped are run up to three times. The second
632    run forces pcre_study() to be called for all patterns except for a few in some
633  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
634  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,
635  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.
636  version.  This testing can be suppressed by putting "nojit" on the RunTest command line.
637    
638    The entire set of tests is run once for each of the 8-bit, 16-bit and 32-bit
639    libraries that are enabled. If you want to run just one set of tests, call
640    RunTest with either the -8, -16 or -32 option.
641    
642    If valgrind is installed, you can run the tests under it by putting "valgrind"
643    on the RunTest command line.
644    
645    RunTest uses a file called testtry to hold the main output from pcretest.
646    Other files whose names begin with "test" are used as working files in some
647    tests. To run pcretest on just one or more specific test files, give their
648    numbers as arguments to RunTest, for example:
649    
650      RunTest 2 7 11
651    
652    You can also call RunTest with the single argument "list" to cause it to output
653    a list of tests.
654    
655    The first test file can be fed directly into the perltest.pl script to check
656    that Perl gives the same results. The only difference you should see is in the
657    first few lines, where the Perl version is given instead of the PCRE version.
658    
659  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_study(),
660  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
661  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
662  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 500  in the comparison output, it means that Line 686  in the comparison output, it means that
686  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.
687    
688  [If you are trying to run this test on Windows, you may be able to get it to  [If you are trying to run this test on Windows, you may be able to get it to
689  work by changing "fr_FR" to "french" everywhere it occurs.]  work by changing "fr_FR" to "french" everywhere it occurs. Alternatively, use
690    RunTest.bat. The version of RunTest.bat included with PCRE 7.4 and above uses
691    Windows versions of test 2. More info on using RunTest.bat is included in the
692    document entitled NON-UNIX-USE.]
693    
694    The fourth and fifth tests check the UTF-8/16/32 support and error handling and
695    internal UTF features of PCRE that are not relevant to Perl, respectively. The
696    sixth and seventh tests do the same for Unicode character properties support.
697    
698    The eighth, ninth, and tenth tests check the pcre_dfa_exec() alternative
699    matching function, in non-UTF-8/16/32 mode, UTF-8/16/32 mode, and UTF-8/16/32
700    mode with Unicode property support, respectively.
701    
702    The eleventh test checks some internal offsets and code size features; it is
703    run only when the default "link size" of 2 is set (in other cases the sizes
704    change) and when Unicode property support is enabled.
705    
706    The twelfth test is run only when JIT support is available, and the thirteenth
707    test is run only when JIT support is not available. They test some JIT-specific
708    features such as information output from pcretest about JIT compilation.
709    
710    The fourteenth, fifteenth, and sixteenth tests are run only in 8-bit mode, and
711    the seventeenth, eighteenth, and nineteenth tests are run only in 16/32-bit mode.
712    These are tests that generate different output in the two modes. They are for
713    general cases, UTF-8/16/32 support, and Unicode property support, respectively.
714    
715    The twentieth test is run only in 16/32-bit mode. It tests some specific
716    16/32-bit features of the DFA matching engine.
717    
718    The twenty-first and twenty-second tests are run only in 16/32-bit mode, when the
719    link size is set to 2 for the 16-bit library. They test reloading pre-compiled patterns.
720    
721  The fourth test checks the UTF-8 support. It is not run automatically unless  The twenty-third and twenty-fourth tests are run only in 16-bit mode. They are for
722  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when  general cases, and UTF-16 support, respectively.
 running "configure". This file can be also fed directly to the perltest script,  
 provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,  
 commented in the script, can be be used.)  
   
 The fifth test checks error handling with UTF-8 encoding, and internal UTF-8  
 features of PCRE that are not relevant to Perl.  
   
 The sixth test checks the support for Unicode character properties. It it not  
 run automatically unless PCRE is built with Unicode property support. To to  
 this you must set --enable-unicode-properties when running "configure".  
   
 The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  
 matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode  
 property support, respectively. The eighth and ninth tests are not run  
 automatically unless PCRE is build with the relevant support.  
723    
724    The twenty-fifth and twenty-sixth tests are run only in 32-bit mode. They are for
725    general cases, and UTF-32 support, respectively.
726    
727  Character tables  Character tables
728  ----------------  ----------------
# Line 578  will cause PCRE to malfunction. Line 781  will cause PCRE to malfunction.
781  File manifest  File manifest
782  -------------  -------------
783    
784  The distribution should contain the following files:  The distribution should contain the files listed below. Where a file name is
785    given as pcre[16|32]_xxx it means that there are three files, one with the name
786    pcre_xxx, one with the name pcre16_xx, and a third with the name pcre32_xxx.
787    
788  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
789    
# Line 587  The distribution should contain the foll Line 792  The distribution should contain the foll
792    
793    pcre_chartables.c.dist  a default set of character tables that assume ASCII    pcre_chartables.c.dist  a default set of character tables that assume ASCII
794                              coding; used, unless --enable-rebuild-chartables is                              coding; used, unless --enable-rebuild-chartables is
795                              specified, by copying to pcre_chartables.c                              specified, by copying to pcre[16]_chartables.c
796    
797      pcreposix.c                )
798      pcre[16|32]_byte_order.c   )
799      pcre[16|32]_compile.c      )
800      pcre[16|32]_config.c       )
801      pcre[16|32]_dfa_exec.c     )
802      pcre[16|32]_exec.c         )
803      pcre[16|32]_fullinfo.c     )
804      pcre[16|32]_get.c          ) sources for the functions in the library,
805      pcre[16|32]_globals.c      )   and some internal functions that they use
806      pcre[16|32]_jit_compile.c  )
807      pcre[16|32]_maketables.c   )
808      pcre[16|32]_newline.c      )
809      pcre[16|32]_refcount.c     )
810      pcre[16|32]_string_utils.c )
811      pcre[16|32]_study.c        )
812      pcre[16|32]_tables.c       )
813      pcre[16|32]_ucd.c          )
814      pcre[16|32]_version.c      )
815      pcre[16|32]_xclass.c       )
816      pcre_ord2utf8.c            )
817      pcre_valid_utf8.c          )
818      pcre16_ord2utf16.c         )
819      pcre16_utf16_utils.c       )
820      pcre16_valid_utf16.c       )
821      pcre32_utf32_utils.c       )
822      pcre32_valid_utf32.c       )
823    
824      pcre[16|32]_printint.c     ) debugging function that is used by pcretest,
825                                 )   and can also be #included in pcre_compile()
826    
   pcreposix.c             )  
   pcre_compile.c          )  
   pcre_config.c           )  
   pcre_dfa_exec.c         )  
   pcre_exec.c             )  
   pcre_fullinfo.c         )  
   pcre_get.c              ) sources for the functions in the library,  
   pcre_globals.c          )   and some internal functions that they use  
   pcre_info.c             )  
   pcre_maketables.c       )  
   pcre_newline.c          )  
   pcre_ord2utf8.c         )  
   pcre_refcount.c         )  
   pcre_study.c            )  
   pcre_tables.c           )  
   pcre_try_flipped.c      )  
   pcre_ucp_searchfuncs.c  )  
   pcre_valid_utf8.c       )  
   pcre_version.c          )  
   pcre_xclass.c           )  
   pcre_printint.src       ) debugging function that is #included in pcretest,  
                           )   and can also be #included in pcre_compile()  
827    pcre.h.in               template for pcre.h when built by "configure"    pcre.h.in               template for pcre.h when built by "configure"
828    pcreposix.h             header for the external POSIX wrapper API    pcreposix.h             header for the external POSIX wrapper API
829    pcre_internal.h         header for internal use    pcre_internal.h         header for internal use
830    ucp.h                   ) headers concerned with    sljit/*                 16 files that make up the JIT compiler
831    ucpinternal.h           )   Unicode property handling    ucp.h                   header for Unicode property handling
   ucptable.h              ) (this one is the data table)  
832    
833    config.h.in             template for config.h, which is built by "configure"    config.h.in             template for config.h, which is built by "configure"
834    
# Line 652  The distribution should contain the foll Line 864  The distribution should contain the foll
864    Makefile.am             ) the automake input that was used to create    Makefile.am             ) the automake input that was used to create
865                            )   Makefile.in                            )   Makefile.in
866    NEWS                    important changes in this release    NEWS                    important changes in this release
867    NON-UNIX-USE            notes on building PCRE on non-Unix systems    NON-UNIX-USE            the previous name for NON-AUTOTOOLS-BUILD
868      NON-AUTOTOOLS-BUILD     notes on building PCRE without using autotools
869    PrepareRelease          script to make preparations for "make dist"    PrepareRelease          script to make preparations for "make dist"
870    README                  this file    README                  this file
871    RunTest                 a Unix shell script for running tests    RunTest                 a Unix shell script for running tests
# Line 665  The distribution should contain the foll Line 878  The distribution should contain the foll
878                            )   "configure" and config.h                            )   "configure" and config.h
879    depcomp                 ) script to find program dependencies, generated by    depcomp                 ) script to find program dependencies, generated by
880                            )   automake                            )   automake
881    doc/*.3                 man page sources for the PCRE functions    doc/*.3                 man page sources for PCRE
882    doc/*.1                 man page sources for pcregrep and pcretest    doc/*.1                 man page sources for pcregrep and pcretest
883    doc/index.html.src      the base HTML page    doc/index.html.src      the base HTML page
884    doc/html/*              HTML documentation    doc/html/*              HTML documentation
# Line 673  The distribution should contain the foll Line 886  The distribution should contain the foll
886    doc/pcretest.txt        plain text documentation of test program    doc/pcretest.txt        plain text documentation of test program
887    doc/perltest.txt        plain text documentation of Perl test program    doc/perltest.txt        plain text documentation of Perl test program
888    install-sh              a shell script for installing files    install-sh              a shell script for installing files
889      libpcre16.pc.in         template for libpcre16.pc for pkg-config
890      libpcre32.pc.in         template for libpcre32.pc for pkg-config
891    libpcre.pc.in           template for libpcre.pc for pkg-config    libpcre.pc.in           template for libpcre.pc for pkg-config
892      libpcreposix.pc.in      template for libpcreposix.pc for pkg-config
893    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
894    ltmain.sh               file used to build a libtool script    ltmain.sh               file used to build a libtool script
895    missing                 ) common stub for a few missing GNU programs while    missing                 ) common stub for a few missing GNU programs while
# Line 681  The distribution should contain the foll Line 897  The distribution should contain the foll
897    mkinstalldirs           script for making install directories    mkinstalldirs           script for making install directories
898    perltest.pl             Perl test program    perltest.pl             Perl test program
899    pcre-config.in          source of script which retains PCRE information    pcre-config.in          source of script which retains PCRE information
900      pcre_jit_test.c         test program for the JIT compiler
901    pcrecpp_unittest.cc          )    pcrecpp_unittest.cc          )
902    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
903    pcre_stringpiece_unittest.cc )    pcre_stringpiece_unittest.cc )
904    testdata/testinput*     test data for main library tests    testdata/testinput*     test data for main library tests
905    testdata/testoutput*    expected test results    testdata/testoutput*    expected test results
906    testdata/grep*          input and output for pcregrep tests    testdata/grep*          input and output for pcregrep tests
907      testdata/*              other supporting test files
908    
909  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
910    
911      cmake/COPYING-CMAKE-SCRIPTS
912      cmake/FindPackageHandleStandardArgs.cmake
913      cmake/FindEditline.cmake
914      cmake/FindReadline.cmake
915    CMakeLists.txt    CMakeLists.txt
916    config-cmake.h.in    config-cmake.h.in
917    
# Line 714  The distribution should contain the foll Line 936  The distribution should contain the foll
936  Philip Hazel  Philip Hazel
937  Email local part: ph10  Email local part: ph10
938  Email domain: cam.ac.uk  Email domain: cam.ac.uk
939  Last updated: 24 April 2007  Last updated: 20 February 2013

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

  ViewVC Help
Powered by ViewVC 1.1.5