/[pcre]/code/trunk/README

Diff of /code/trunk/README

Parent Directory | Revision Log | View Patch Patch

-revision 128 by ph10,
Tue Mar 20 11:46:50 2007 UTC
+revision 672 by ph10,
Tue Aug 23 16:45:55 2011 UTC
 Line 1
  README file for PCRE (Perl-compatible regular expression library)
  -----------------------------------------------------------------
- The latest release of PCRE is always available from
+ The latest release of PCRE is always available in three alternative formats
+ from:
    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.bz2
+   ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.zip
  There is a mailing list for discussion about the development of PCRE at
-Line 21 
 The contents of this README file are:
+Line 24 
 The contents of this README file are:
    Shared libraries on Unix-like systems
    Cross-compiling on Unix-like systems
    Using HP's ANSI C++ compiler (aCC)
+   Using PCRE from MySQL
    Making new tarballs
    Testing PCRE
    Character tables
-Line 82 
 documentation is supplied in two other f
+Line 86 
 documentation is supplied in two other f
       in various ways, and rooted in a file called index.html, is distributed in
       doc/html and installed in <prefix>/share/doc/pcre/html.
+ Users of PCRE have contributed files containing the documentation for various
+ releases in CHM format. These can be found in the Contrib directory of the FTP
+ site (see next section).
  Contributions by users of PCRE
  ------------------------------
-Line 103 
 Building PCRE on non-Unix systems
+Line 111 
 Building PCRE on non-Unix systems
  For a non-Unix system, please read the comments in the file NON-UNIX-USE,
  though if your system supports the use of "configure" and "make" you may be
- 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
+ configured in many platform environments using the GUI facility provided by
+ CMake's cmake-gui command. This creates Makefiles, solution files, etc.
  PCRE has been compiled on many different operating systems. It should be
  straightforward to build PCRE on any system that has a Standard C compiler and
-Line 116 
 Building PCRE on Unix-like systems
+Line 126 
 Building PCRE on Unix-like systems
  If you are using HP's ANSI C++ compiler (aCC), please see the special note
  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
+ The following instructions assume the use of the widely used "configure, make,
+ make install" process. There is also support for CMake in the PCRE
+ distribution; there are some comments about using CMake in the NON-UNIX-USE
+ file, though it can also be used in Unix-like systems.
  To build PCRE on a Unix-like system, first run the "configure" command from the
  PCRE distribution directory, with your current directory set to the directory
  where you want the files to be created. This command is a standard GNU
-Line 144 
 possible to build it as a C++ library, t
+Line 159 
 possible to build it as a C++ library, t
  does not have any features to support this.
  There are some optional features that can be included or omitted from the PCRE
- library. You can read more about them in the pcrebuild man page.
+ library. They are also documented in the pcrebuild man page.
+ . By default, both shared and static libraries are built. You can change this
+   by adding one of these options to the "configure" command:
+   --disable-shared
+   --disable-static
+   (See also "Shared libraries on Unix-like systems" below.)
  . If you want to suppress the building of the C++ wrapper library, you can add
    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
    it will try to find a C++ compiler and C++ header files, and if it succeeds,
    it will try to build the C++ wrapper.
- . If you want to make use of the support for UTF-8 character strings in PCRE,
+ . If you want to include support for just-in-time compiling, which can give
-   you must add --enable-utf8 to the "configure" command. Without it, the code
+   large performance improvements on certain platforms, add --enable-jit to the
-   for handling UTF-8 is not included in the library. (Even when included, it
+   "configure" command.
-   still has to be enabled by an option at run time.)
+ . If you want to make use of the support for UTF-8 Unicode character strings in
+   PCRE, you must add --enable-utf8 to the "configure" command. Without it, the
+   code for handling UTF-8 is not included in the library. Even when included,
+   it still has to be enabled by an option at run time. When PCRE is compiled
+   with this option, its input can only either be ASCII or UTF-8, even when
+   running on EBCDIC platforms. It is not possible to use both --enable-utf8 and
+   --enable-ebcdic at the same time.
  . If, in addition to support for UTF-8 character strings, you want to include
    support for the \P, \p, and \X sequences that recognize Unicode character
-Line 164 
 library. You can read more about them in
+Line 194 
 library. You can read more about them in
    supported.
  . You can build PCRE to recognize either CR or LF or the sequence CRLF or any
-   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
-   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
-   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
-   (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
-   --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
-   to the "configure" command, respectively.
+   or --enable-newline-is-crlf or --enable-newline-is-anycrlf or
+   --enable-newline-is-any to the "configure" command, respectively.
-   If you specify --newline-is-cr or --newline-is-crlf, some of the standard
-   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
-   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
-   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
-   some failures.
+   to be some failures. With --enable-newline-is-anycrlf or
+   --enable-newline-is-any, many tests should succeed, but there may be some
+   failures.
+ . By default, the sequence \R in a pattern matches any Unicode line ending
+   sequence. This is independent of the option specifying what PCRE considers to
+   be the end of a line (see above). However, the caller of PCRE can restrict \R
+   to match only CR, LF, or CRLF. You can make this the default by adding
+   --enable-bsr-anycrlf to the "configure" command (bsr = "backslash R").
  . When called via the POSIX interface, PCRE uses malloc() to get additional
    storage for processing capturing parentheses if there are more than 10 of
-Line 221 
 library. You can read more about them in
+Line 259 
 library. You can read more about them in
    on the "configure" command. PCRE runs more slowly in this mode, but it may be
    necessary in environments with limited stack sizes. This applies only to the
-   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
-   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
-   pcrestack man page.
+   pcre_dfa_exec(), which does not use deeply nested recursion. There is a
+   discussion about stack sizes in the pcrestack man page.
  . For speed, PCRE uses four tables for manipulating and identifying characters
    whose code point values are less than 256. By default, it uses a set of
-Line 237 
 library. You can read more about them in
+Line 276 
 library. You can read more about them in
    pcre_chartables.c.dist. See "Character tables" below for further information.
  . It is possible to compile PCRE for use on systems that use EBCDIC as their
-   default character code (as opposed to ASCII) by specifying
+   character code (as opposed to ASCII) by specifying
    --enable-ebcdic
-   This automatically implies --enable-rebuild-chartables (see above).
+   This automatically implies --enable-rebuild-chartables (see above). However,
+   when PCRE is built this way, it always operates in EBCDIC. It cannot support
+   both EBCDIC and UTF-8.
+ . It is possible to compile pcregrep to use libz and/or libbz2, in order to
+   read .gz and .bz2 files (respectively), by specifying one or both of
+   --enable-pcregrep-libz
+   --enable-pcregrep-libbz2
+   Of course, the relevant libraries must be installed on your system.
+ . The default size of internal buffer used by pcregrep can be set by, for
+   example:
+   --with-pcregrep-bufsize=50K
+   The default value is 20K.
+ . It is possible to compile pcretest so that it links with the libreadline
+   library, by specifying
+   --enable-pcretest-libreadline
+   If this is done, when pcretest's input is from a terminal, it reads it using
+   the readline() function. This provides line-editing and history facilities.
+   Note that libreadline is GPL-licenced, so if you distribute a binary of
+   pcretest linked in this way, there may be licensing issues.
+   Setting this option causes the -lreadline option to be added to the pcretest
+   build. In many operating environments with a sytem-installed readline
+   library this is sufficient. However, in some environments (e.g. if an
+   unmodified distribution version of readline is in use), it may be necessary
+   to specify something like LIBS="-lncurses" as well. This is because, to quote
+   the readline INSTALL, "Readline uses the termcap functions, but does not link
+   with the termcap or curses library itself, allowing applications which link
+   with readline the to choose an appropriate library." If you get error
+   messages about missing functions tgetstr, tgetent, tputs, tgetflag, or tgoto,
+   this is the problem, and linking with the ncurses library should fix it.
  The "configure" script builds the following files for the basic C library:
- . Makefile is the makefile that builds the library
+ . Makefile             the makefile that builds the library
- . config.h contains build-time configuration options for the library
+ . config.h             build-time configuration options for the library
- . pcre.h is the public PCRE header file
+ . pcre.h               the public PCRE header file
- . pcre-config is a script that shows the settings of "configure" options
+ . pcre-config          script that shows the building settings such as CFLAGS
- . libpcre.pc is data for the pkg-config command
+                          that were set for "configure"
- . libtool is a script that builds shared and/or static libraries
+ . libpcre.pc         ) data for the pkg-config command
- . RunTest is a script for running tests on the basic C library
+ . libpcreposix.pc    )
- . RunGrepTest is a script for running tests on the pcregrep command
+ . libtool              script that builds shared and/or static libraries
+ . RunTest              script for running tests on the basic C library
- Versions of config.h and pcre.h are distributed in the PCRE tarballs under
+ . RunGrepTest          script for running tests on the pcregrep command
- the names config.h.generic and pcre.h.generic. These are provided for the
- 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
- you use "configure", the .generic versions are not used.
+ names config.h.generic and pcre.h.generic. These are provided for those who
+ have to built PCRE without using "configure" or CMake. If you use "configure"
+ or CMake, the .generic versions are not used.
  If a C++ compiler is found, the following files are also built:
- . libpcrecpp.pc is data for the pkg-config command
+ . libpcrecpp.pc        data for the pkg-config command
- . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper
+ . pcrecpparg.h         header file for calling PCRE via the C++ wrapper
- . pcre_stringpiece.h is the header for the C++ "stringpiece" functions
+ . pcre_stringpiece.h   header for the C++ "stringpiece" functions
  The "configure" script also creates config.status, which is an executable
  script that can be run to recreate the configuration, and config.log, which
  contains compiler output from tests that "configure" runs.
  Once "configure" has run, you can run "make". It builds two libraries, called
- libpcre and libpcreposix, a test program called pcretest, a demonstration
+ libpcre and libpcreposix, a test program called pcretest, and the pcregrep
- program called pcredemo, and the pcregrep command. If a C++ compiler was found
+ command. If a C++ compiler was found on your system, and you did not disable it
- on your system, "make" also builds the C++ wrapper library, which is called
+ with --disable-cpp, "make" also builds the C++ wrapper library, which is called
  libpcrecpp, and some test programs called pcrecpp_unittest,
- pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper
+ pcre_scanner_unittest, and pcre_stringpiece_unittest. If you enabled JIT
- can be disabled by adding --disable-cpp to the "configure" command.
+ support with --enable-jit, a test program called pcre_jit_test is also built.
  The command "make check" runs all the appropriate tests. Details of the PCRE
  tests are given below in a separate section of this document.
-Line 296 
 system. The following are installed (fil
+Line 375 
 system. The following are installed (fil
    Configuration information (lib/pkgconfig):
      libpcre.pc
+     libpcreposix.pc
      libpcrecpp.pc (if C++ support is enabled)
    Header files (include):
-Line 309 
 system. The following are installed (fil
+Line 389 
 system. The following are installed (fil
    Man pages (share/man/man{1,3}):
      pcregrep.1
      pcretest.1
+     pcre-config.1
      pcre.3
      pcre*.3 (lots more pages, all starting "pcre")
-Line 323 
 system. The following are installed (fil
+Line 404 
 system. The following are installed (fil
      LICENCE
      NEWS
      README
-     pcre.txt       (a concatenation of the man(3) pages)
+     pcre.txt         (a concatenation of the man(3) pages)
-     pcretest.txt   the pcretest man page
+     pcretest.txt     the pcretest man page
-     pcregrep.txt   the pcregrep man page
+     pcregrep.txt     the pcregrep man page
+     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.
  If you want to remove PCRE from your system, you can run "make uninstall".
  This removes all the files that "make install" installed. However, it does not
-Line 425 
 running the "configure" script:
+Line 504 
 running the "configure" script:
    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
+ Using Sun's compilers for Solaris
+ ---------------------------------
+ A user reports that the following configurations work on Solaris 9 sparcv9 and
+ Solaris 9 x86 (32-bit):
+   Solaris 9 sparcv9: ./configure --disable-cpp CC=/bin/cc CFLAGS="-m64 -g"
+   Solaris 9 x86:     ./configure --disable-cpp CC=/bin/cc CFLAGS="-g"
+ Using PCRE from MySQL
+ ---------------------
+ On systems where both PCRE and MySQL are installed, it is possible to make use
+ of PCRE from within MySQL, as an alternative to the built-in pattern matching.
+ There is a web page that tells you how to do this:
+   http://www.mysqludf.org/lib_mysqludf_preg/index.php
  Making new tarballs
  -------------------
  The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
- 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
- doc directory, you should first run the PrepareRelease script. This re-creates
+ build of the new distribution to ensure that it works.
- the .txt and HTML forms of the documentation from the man pages.
+ If you have modified any of the man page sources in the doc directory, you
+ should first run the PrepareRelease script before making a distribution. This
+ script creates the .txt and HTML forms of the documentation from the man pages.
  Testing PCRE
-Line 441 
 To test the basic PCRE library on a Unix
+Line 543 
 To test the basic PCRE library on a Unix
  created by the configuring process. There is also a script called RunGrepTest
  that tests the options of the pcregrep command. If the C++ wrapper library is
  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
- pcre_stringpiece_unittest are also built.
+ pcre_stringpiece_unittest are also built. When JIT support is enabled, another
+ test program called pcre_jit_test is built.
  Both the scripts and all the program tests are run if you obey "make check" or
  "make test". For other systems, see the instructions in NON-UNIX-USE.
  The RunTest script runs the pcretest test program (which is documented in its
- 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
- turn, and compares the output with the contents of the corresponding testoutput
+ directory, and compares the output with the contents of the corresponding
- 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
+ were selected. For example, the tests for UTF-8 support are run only if
+ --enable-utf8 was used. RunTest outputs a comment when it skips a test.
+ Many of the tests that are not skipped are run up to three times. The second
+ run forces pcre_study() to be called for all patterns except for a few in some
+ tests that are marked "never study" (see the pcretest program for how this is
+ done). If JIT support is available, the non-DFA tests are run a third time,
+ this time with a forced pcre_study() with the PCRE_STUDY_JIT_COMPILE option.
+ RunTest uses a file called testtry to hold the main output from pcretest
  (testsavedregex is also used as a working file). To run pcretest on just one of
  the test files, give its number as an argument to RunTest, for example:
    RunTest 2
- The first test file can also be fed directly into the perltest.pl script to
+ The first test file can be fed directly into the perltest.pl script to check
- check that Perl gives the same results. The only difference you should see is
+ that Perl gives the same results. The only difference you should see is in the
- in the first few lines, where the Perl version is given instead of the PCRE
+ first few lines, where the Perl version is given instead of the PCRE version.
- version.
  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
-Line 489 
 is output to say why. If running this te
+Line 601 
 is output to say why. If running this te
  in the comparison output, it means that locale is not available on your system,
  despite being listed by "locale". This does not mean that PCRE is broken.
- 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
- 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
- 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
- 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
- commented in the script, can be be used.)
+ document entitled NON-UNIX-USE.]
+ The fourth test checks the UTF-8 support. This file can be also fed directly to
+ the perltest.pl script, provided you are running Perl 5.8 or higher.
  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
+ The sixth test (which is Perl-5.10 compatible) checks the support for Unicode
- run automatically unless PCRE is built with Unicode property support. To to
+ character properties. This file can be also fed directly to the perltest.pl
- this you must set --enable-unicode-properties when running "configure".
+ script, provided you are running Perl 5.10 or higher.
  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
+ property support, respectively.
- automatically unless PCRE is build with the relevant support.
+ The tenth test checks some internal offsets and code size features; it is run
+ only when the default "link size" of 2 is set (in other cases the sizes
+ change) and when Unicode property support is enabled.
+ The eleventh and twelfth tests check out features that are new in Perl 5.10,
+ without and with UTF-8 support, respectively. This file can be also fed
+ directly to the perltest.pl script, provided you are running Perl 5.10 or
+ higher.
+ The thirteenth test checks a number internals and non-Perl features concerned
+ with Unicode property support.
+ The fourteenth test is run only when JIT support is available, and the
+ fifteenth test is run only when JIT support is not available. They test some
+ JIT-specific features such as information output from pcretest about JIT
+ compilation.
  Character tables
-Line 585 
 The distribution should contain the foll
+Line 716 
 The distribution should contain the foll
    pcre_get.c              ) sources for the functions in the library,
    pcre_globals.c          )   and some internal functions that they use
    pcre_info.c             )
+   pcre_jit_compile.c      )
    pcre_maketables.c       )
    pcre_newline.c          )
    pcre_ord2utf8.c         )
-Line 592 
 The distribution should contain the foll
+Line 724 
 The distribution should contain the foll
    pcre_study.c            )
    pcre_tables.c           )
    pcre_try_flipped.c      )
-   pcre_ucp_searchfuncs.c  )
+   pcre_ucd.c              )
    pcre_valid_utf8.c       )
    pcre_version.c          )
    pcre_xclass.c           )
-Line 601 
 The distribution should contain the foll
+Line 733 
 The distribution should contain the foll
    pcre.h.in               template for pcre.h when built by "configure"
    pcreposix.h             header for the external POSIX wrapper API
    pcre_internal.h         header for internal use
-   ucp.h                   ) headers concerned with
+   sljit/*                 16 files that make up the JIT compiler
-   ucpinternal.h           )   Unicode property handling
+   ucp.h                   header for Unicode property handling
-   ucptable.h              ) (this one is the data table)
    config.h.in             template for config.h, which is built by "configure"
-Line 642 
 The distribution should contain the foll
+Line 773 
 The distribution should contain the foll
    NON-UNIX-USE            notes on building PCRE on non-Unix systems
    PrepareRelease          script to make preparations for "make dist"
    README                  this file
-   RunTest.in              template for a Unix shell script for running tests
+   RunTest                 a Unix shell script for running tests
-   RunGrepTest.in          template for a Unix shell script for pcregrep tests
+   RunGrepTest             a Unix shell script for pcregrep tests
    aclocal.m4              m4 macros (generated by "aclocal")
    config.guess            ) files used by libtool,
    config.sub              )   used only when building a shared library
-Line 652 
 The distribution should contain the foll
+Line 783 
 The distribution should contain the foll
                            )   "configure" and config.h
    depcomp                 ) script to find program dependencies, generated by
                            )   automake
-   doc/*.3                 man page sources for the PCRE functions
+   doc/*.3                 man page sources for PCRE
    doc/*.1                 man page sources for pcregrep and pcretest
    doc/index.html.src      the base HTML page
    doc/html/*              HTML documentation
-Line 661 
 The distribution should contain the foll
+Line 792 
 The distribution should contain the foll
    doc/perltest.txt        plain text documentation of Perl test program
    install-sh              a shell script for installing files
    libpcre.pc.in           template for libpcre.pc for pkg-config
+   libpcreposix.pc.in      template for libpcreposix.pc for pkg-config
    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
    ltmain.sh               file used to build a libtool script
    missing                 ) common stub for a few missing GNU programs while
-Line 668 
 The distribution should contain the foll
+Line 800 
 The distribution should contain the foll
    mkinstalldirs           script for making install directories
    perltest.pl             Perl test program
    pcre-config.in          source of script which retains PCRE information
+   pcre_jit_test.c         test program for the JIT compiler
    pcrecpp_unittest.cc          )
    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
    pcre_stringpiece_unittest.cc )
-Line 677 
 The distribution should contain the foll
+Line 810 
 The distribution should contain the foll
  (D) Auxiliary files for cmake support
+   cmake/COPYING-CMAKE-SCRIPTS
+   cmake/FindPackageHandleStandardArgs.cmake
+   cmake/FindReadline.cmake
    CMakeLists.txt
    config-cmake.h.in
  (E) Auxiliary files for VPASCAL
    makevp.bat
-   makevp-compile.txt
+   makevp_c.txt
-   makevp-linklib.txt
+   makevp_l.txt
    pcregexp.pas
  (F) Auxiliary files for building PCRE "by hand"
-Line 701 
 The distribution should contain the foll
+Line 837 
 The distribution should contain the foll
  Philip Hazel
  Email local part: ph10
  Email domain: cam.ac.uk
- Last updated: 20 March 2007
+ Last updated: 23 August 2011

 Legend:



Removed from v.128
 


changed lines


 
Added in v.672
 Legend:



Removed from v.128
 


changed lines


 
Added in v.672
-Removed from v.128
+Added in v.672

webmaster@exim.org	ViewVC Help
Powered by ViewVC 1.1.12