/[pcre]/code/trunk/README

Diff of /code/trunk/README

Parent Directory | Revision Log | View Patch Patch

-revision 99 by ph10,
Tue Mar  6 12:27:42 2007 UTC
+revision 489 by ph10,
Tue Jan 19 16:42:21 2010 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
+   pcre-dev@exim.org
  Please read the NEWS file if you are upgrading from a previous release.
+ The contents of this README file are:
+   The PCRE APIs
+   Documentation for PCRE
+   Contributions by users of PCRE
+   Building PCRE on non-Unix systems
+   Building PCRE on Unix-like systems
+   Retrieving configuration information on Unix-like systems
+   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
+   File manifest
  The PCRE APIs
  -------------
- PCRE is written in C, and it has its own API. The distribution now includes a
+ PCRE is written in C, and it has its own API. The distribution also includes a
- set of C++ wrapper functions, courtesy of Google Inc. (see the pcrecpp man page
+ set of C++ wrapper functions (see the pcrecpp man page for details), courtesy
- for details).
+ of Google Inc.
- Also included are a set of C wrapper functions that are based on the POSIX
+ In addition, there is a set of C wrapper functions that are based on the POSIX
- API. These end up in the library called libpcreposix. Note that this just
+ regular expression API (see the pcreposix man page). These end up in the
- provides a POSIX calling interface to PCRE: the regular expressions themselves
+ library called libpcreposix. Note that this just provides a POSIX calling
- still follow Perl syntax and semantics. The header file for the POSIX-style
+ interface to PCRE; the regular expressions themselves still follow Perl syntax
- functions is called pcreposix.h. The official POSIX name is regex.h, but I
+ and semantics. The POSIX API is restricted, and does not give full access to
- didn't want to risk possible problems with existing files of that name by
+ all of PCRE's facilities.
- distributing it that way. To use it with an existing program that uses the
- POSIX API, it will have to be renamed or pointed at by a link.
+ The header file for the POSIX-style functions is called pcreposix.h. The
+ official POSIX name is regex.h, but I did not want to risk possible problems
+ with existing files of that name by distributing it that way. To use PCRE with
+ an existing program that uses the POSIX API, pcreposix.h will have to be
+ renamed or pointed at by a link.
  If you are using the POSIX interface to PCRE and there is already a POSIX regex
- library installed on your system, you must take care when linking programs to
+ library installed on your system, as well as worrying about the regex.h header
+ file (as mentioned above), you must also take care when linking programs to
  ensure that they link with PCRE's libpcreposix library. Otherwise they may pick
- up the "real" POSIX functions of the same name.
+ up the POSIX functions of the same name from the other library.
+ One way of avoiding this confusion is to compile PCRE with the addition of
+ -Dregcomp=PCREregcomp (and similarly for the other POSIX functions) to the
+ compiler flags (CFLAGS if you are using "configure" -- see below). This has the
+ effect of renaming the functions so that the names no longer clash. Of course,
+ you have to do the same thing for your applications, or write them using the
+ new names.
  Documentation for PCRE
  ----------------------
- If you install PCRE in the normal way, you will end up with an installed set of
+ If you install PCRE in the normal way on a Unix-like system, you will end up
- man pages whose names all start with "pcre". The one that is just called "pcre"
+ with a set of man pages whose names all start with "pcre". The one that is just
- lists all the others. In addition to these man pages, the PCRE documentation is
+ called "pcre" lists all the others. In addition to these man pages, the PCRE
- supplied in two other forms; however, as there is no standard place to install
+ documentation is supplied in two other forms:
- them, they are left in the doc directory of the unpacked source distribution.
- These forms are:
+. There are files called doc/pcre.txt, doc/pcregrep.txt, and
+      doc/pcretest.txt in the source distribution. The first of these is a
-. Files called doc/pcre.txt, doc/pcregrep.txt, and doc/pcretest.txt. The
+      concatenation of the text forms of all the section 3 man pages except
-      first of these is a concatenation of the text forms of all the section 3
+      those that summarize individual functions. The other two are the text
-      man pages except those that summarize individual functions. The other two
+      forms of the section 1 man pages for the pcregrep and pcretest commands.
-      are the text forms of the section 1 man pages for the pcregrep and
+      These text forms are provided for ease of scanning with text editors or
-      pcretest commands. Text forms are provided for ease of scanning with text
+      similar tools. They are installed in <prefix>/share/doc/pcre, where
-      editors or similar tools.
+      <prefix> is the installation prefix (defaulting to /usr/local).
-. A subdirectory called doc/html contains all the documentation in HTML
+. A set of files containing all the documentation in HTML form, hyperlinked
-      form, hyperlinked in various ways, and rooted in a file called
+      in various ways, and rooted in a file called index.html, is distributed in
-      doc/index.html.
+      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 59 
 You can find contributions from PCRE use
+Line 98 
 You can find contributions from PCRE use
    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
- where there is also a README file giving brief descriptions of what they are.
+ There is a README file giving brief descriptions of what they are. Some are
- Several of them provide support for compiling PCRE on various flavours of
+ complete in themselves; others are pointers to URLs containing relevant files.
- Windows systems (I myself do not use Windows). Some are complete in themselves;
+ Some of this material is likely to be well out-of-date. Several of the earlier
- others are pointers to URLs containing relevant files.
+ contributions provided support for compiling PCRE on various flavours of
+ Windows (I myself do not use Windows). Nowadays there is more Windows support
+ in the standard distribution, so these contibutions have been archived.
+ 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. 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.
- Building PCRE on a Unix-like system
+ 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
+ library, because it uses only Standard C functions.
+ 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
  "autoconf" configuration script, for which generic instructions are supplied in
- INSTALL.
+ the file INSTALL.
  Most commonly, people build PCRE within its own distribution directory, and in
- this case, on many systems, just running "./configure" is sufficient, but the
+ this case, on many systems, just running "./configure" is sufficient. However,
- usual methods of changing standard defaults are available. For example:
+ the usual methods of changing standard defaults are available. For example:
  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
-Line 103 
 library. You can read more about them in
+Line 163 
 library. You can read more about them in
  . 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,
-   will try to find a C++ compiler and C++ header files, and if it succeeds, it
+   it will try to find a C++ compiler and C++ header files, and if it succeeds,
-   will try to build the C++ wrapper.
+   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 make use of the support for UTF-8 Unicode character strings in
-   you must add --enable-utf8 to the "configure" command. Without it, the code
+   PCRE, you must add --enable-utf8 to the "configure" command. Without it, the
-   for handling UTF-8 is not included in the library. (Even when included, it
+   code for handling UTF-8 is not included in the library. Even when included,
-   still has to be enabled by an option at run time.)
+   it still has to be enabled by an option at run time. When PCRE is compiled
+   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 119 
 library. You can read more about them in
+Line 182 
 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
-   them. You can increase this threshold by setting, for example,
+   them in a pattern. You can increase this threshold by setting, for example,
    --with-posix-malloc-threshold=20
-Line 147 
 library. You can read more about them in
+Line 218 
 library. You can read more about them in
    --with-match-limit=500000
    on the "configure" command. This is just the default; individual calls to
-   pcre_exec() can supply their own value. There is discussion on the pcreapi
+   pcre_exec() can supply their own value. There is more discussion on the
-   man page.
+   pcreapi man page.
  . There is a separate counter that limits the depth of recursive function calls
    during a matching process. This also has a default of ten million, which is
-Line 163 
 library. You can read more about them in
+Line 234 
 library. You can read more about them in
  . The default maximum compiled pattern size is around 64K. You can increase
    this by adding --with-link-size=3 to the "configure" command. You can
    increase it even more by setting --with-link-size=4, but this is unlikely
-   ever to be necessary. If you build PCRE with an increased link size, test 2
+   ever to be necessary. Increasing the internal link size will reduce
-   (and 5 if you are using UTF-8) will fail. Part of the output of these tests
+   performance.
-   is a representation of the compiled pattern, and this changes with the link
-   size.
  . You can build PCRE so that its internal match() function that is called from
-   pcre_exec() does not call itself recursively. Instead, it uses blocks of data
+   pcre_exec() does not call itself recursively. Instead, it uses memory blocks
-   from the heap via special functions pcre_stack_malloc() and pcre_stack_free()
+   obtained from the heap via the special functions pcre_stack_malloc() and
-   to save data that would otherwise be saved on the stack. To build PCRE like
+   pcre_stack_free() to save data that would otherwise be saved on the stack. To
-   this, use
+   build PCRE like this, use
    --disable-stack-for-recursion
    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
-   use deeply nested recursion.
+   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
+   tables for ASCII encoding that is part of the distribution. If you specify
+   --enable-rebuild-chartables
+   a program called dftables is compiled and run in the default C locale when
+   you obey "make". It builds a source file called pcre_chartables.c. If you do
+   not specify this option, pcre_chartables.c is created as a copy of
+   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
+   character code (as opposed to ASCII) by specifying
+   --enable-ebcdic
+   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.
+ . 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.
- The "configure" script builds eight files for the basic C library:
+   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
  . config.h contains build-time configuration options for the library
+ . pcre.h is the public PCRE header file
  . pcre-config is a script that shows the settings of "configure" options
  . libpcre.pc is data for the pkg-config command
  . libtool is a script that builds shared and/or static libraries
- . RunTest is a script for running tests on the library
+ . RunTest is a script for running tests on the basic C library
  . RunGrepTest is a script for running tests on the pcregrep command
- In addition, if a C++ compiler is found, the following are also built:
+ Versions of config.h and pcre.h are distributed in the PCRE tarballs under the
+ 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:
- . pcrecpp.h is the header file for programs that call PCRE via the C++ wrapper
+ . libpcrecpp.pc is data for the pkg-config command
+ . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper
  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions
  The "configure" script also creates config.status, which is an executable
-Line 202 
 contains compiler output from tests that
+Line 328 
 contains compiler output from tests that
  Once "configure" has run, you can run "make". It builds two libraries, called
  libpcre and libpcreposix, a test program called pcretest, and the pcregrep
- command. If a C++ compiler was found on your system, it also builds the C++
+ command. If a C++ compiler was found on your system, "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 can be disabled by adding --disable-cpp to the
+ "configure" command.
- The command "make test" runs all the appropriate tests. Details of the PCRE
+ The command "make check" runs all the appropriate tests. Details of the PCRE
- tests are given in a separate section of this document, below.
+ tests are given below in a separate section of this document.
- You can use "make install" to copy the libraries, the public header files
+ You can use "make install" to install PCRE into live directories on your
- pcre.h, pcreposix.h, pcrecpp.h, and pcre_stringpiece.h (the last two only if
+ system. The following are installed (file names are all relative to the
- the C++ wrapper was built), and the man pages to appropriate live directories
+ <prefix> that is set when "configure" is run):
- on your system, in the normal way.
+   Commands (bin):
+     pcretest
+     pcregrep
+     pcre-config
+   Libraries (lib):
+     libpcre
+     libpcreposix
+     libpcrecpp (if C++ support is enabled)
+   Configuration information (lib/pkgconfig):
+     libpcre.pc
+     libpcrecpp.pc (if C++ support is enabled)
+   Header files (include):
+     pcre.h
+     pcreposix.h
+     pcre_scanner.h      )
+     pcre_stringpiece.h  ) if C++ support is enabled
+     pcrecpp.h           )
+     pcrecpparg.h        )
+   Man pages (share/man/man{1,3}):
+     pcregrep.1
+     pcretest.1
+     pcre.3
+     pcre*.3 (lots more pages, all starting "pcre")
+   HTML documentation (share/doc/pcre/html):
+     index.html
+     *.html (lots more pages, hyperlinked from index.html)
+   Text file documentation (share/doc/pcre):
+     AUTHORS
+     COPYING
+     ChangeLog
+     LICENCE
+     NEWS
+     README
+     pcre.txt       (a concatenation of the man(3) pages)
+     pcretest.txt   the pcretest man page
+     pcregrep.txt   the pcregrep man page
  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 222 
 remove any directories, because these ar
+Line 392 
 remove any directories, because these ar
  Retrieving configuration information on Unix-like systems
  ---------------------------------------------------------
- Running "make install" also installs the command pcre-config, which can be used
+ Running "make install" installs the command pcre-config, which can be used to
- to recall information about the PCRE configuration and installation. For
+ recall information about the PCRE configuration and installation. For example:
- example:
    pcre-config --version
-Line 243 
 single command is used. For example:
+Line 412 
 single command is used. For example:
    pkg-config --cflags pcre
  The data is held in *.pc files that are installed in a directory called
- pkgconfig.
+ <prefix>/lib/pkgconfig.
  Shared libraries on Unix-like systems
-Line 260 
 built. The programs pcretest and pcregre
+Line 429 
 built. The programs pcretest and pcregre
  libraries (by means of wrapper scripts in the case of shared libraries). When
  you use "make install" to install shared libraries, pcregrep and pcretest are
  automatically re-built to use the newly installed shared libraries before being
- installed themselves. However, the versions left in the source directory still
+ installed themselves. However, the versions left in the build directory still
  use the uninstalled libraries.
  To build PCRE using static libraries only you must use --disable-shared when
-Line 272 
 Then run "make" in the usual way. Simila
+Line 441 
 Then run "make" in the usual way. Simila
  build only shared libraries.
- Cross-compiling on a Unix-like system
+ Cross-compiling on Unix-like systems
- -------------------------------------
+ ------------------------------------
  You can specify CC and CFLAGS in the normal way to the "configure" command, in
- 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
- 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
- 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
- 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,
- 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
- there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)
+ compiler.
- when calling the "configure" command. If they are not specified, they default
- to the values of CC and CFLAGS.
+ When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
+ by making a copy of pcre_chartables.c.dist, which is a default set of tables
+ that assumes ASCII code. Cross-compiling with the default tables should not be
+ a problem.
+ If you need to modify the character tables when cross-compiling, you should
+ move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
+ run it on the local host to make a new version of pcre_chartables.c.dist.
+ Then when you cross-compile PCRE this new version of the tables will be used.
  Using HP's ANSI C++ compiler (aCC)
  ----------------------------------
  Unless C++ support is disabled by specifying the "--disable-cpp" option of the
- "configure" script, you *must* include the "-AA" option in the CXXFLAGS
+ "configure" script, you must include the "-AA" option in the CXXFLAGS
  environment variable in order for the C++ components to compile correctly.
  Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby
-Line 302 
 running the "configure" script:
+Line 479 
 running the "configure" script:
    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
- Building on non-Unix systems
+ 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
+ -------------------
- For a non-Unix system, read the comments in the file NON-UNIX-USE, though if
+ The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
- the system supports the use of "configure" and "make" you may be able to build
+ zip formats. The command "make distcheck" does the same, but then does a trial
- PCRE in the same way as for Unix systems.
+ build of the new distribution to ensure that it works.
- PCRE has been compiled on Windows systems and on Macintoshes, but I don't know
+ If you have modified any of the man page sources in the doc directory, you
- the details because I don't use those systems. It should be straightforward to
+ should first run the PrepareRelease script before making a distribution. This
- build PCRE on any system that has a Standard C compiler and library, because it
+ script creates the .txt and HTML forms of the documentation from the man pages.
- uses only Standard C functions.
  Testing PCRE
  ------------
- To test PCRE on a Unix system, run the RunTest script that is created by the
+ To test the basic PCRE library on a Unix system, run the RunTest script that is
- configuring process. There is also a script called RunGrepTest that tests the
+ created by the configuring process. There is also a script called RunGrepTest
- options of the pcregrep command. If the C++ wrapper library is build, three
+ that tests the options of the pcregrep command. If the C++ wrapper library is
- test programs called pcrecpp_unittest, pcre_scanner_unittest, and
+ built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
- pcre_stringpiece_unittest are provided.
+ pcre_stringpiece_unittest are also built.
- Both the scripts and all the program tests are run if you obey "make runtest",
+ Both the scripts and all the program tests are run if you obey "make check" or
- "make check", or "make test". For other systems, see the instructions in
+ "make test". For other systems, see the instructions in NON-UNIX-USE.
- NON-UNIX-USE.
  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 testinput files in the testdata directory in
  turn, and compares the output with the contents of the corresponding testoutput
  files. A file called testtry is used to hold the main output from pcretest
  (testsavedregex is also used as a working file). To run pcretest on just one of
-Line 337 
 the test files, give its number as an ar
+Line 532 
 the test files, give its number as an ar
    RunTest 2
- The first test file can also be fed directly into the perltest script to check
+ The first test file can also be fed directly into the perltest.pl script to
- that Perl gives the same results. The only difference you should see is in the
+ check that Perl gives the same results. The only difference you should see is
- first few lines, where the Perl version is given instead of the PCRE version.
+ in the first few lines, where the Perl version is given instead of the PCRE
+ version.
  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
  detection, and run-time flags that are specific to PCRE, as well as the POSIX
- wrapper API. It also uses the debugging flag to check some of the internals of
+ wrapper API. It also uses the debugging flags to check some of the internals of
  pcre_compile().
  If you build PCRE with a locale setting that is not the standard C locale, the
-Line 370 
 is output to say why. If running this te
+Line 566 
 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.
+ [If you are trying to run this test on Windows, you may be able to get it to
+ work by changing "fr_FR" to "french" everywhere it occurs. Alternatively, use
+ RunTest.bat. The version of RunTest.bat included with PCRE 7.4 and above uses
+ Windows versions of test 2. More info on using RunTest.bat is included in the
+ document entitled NON-UNIX-USE.]
  The fourth test checks the UTF-8 support. It is not run automatically unless
  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when
- running "configure". This file can be also fed directly to the perltest script,
+ running "configure". This file can be also fed directly to the perltest.pl
- provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,
+ script, provided you are running Perl 5.8 or higher.
- 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 and test checks the support for Unicode character properties. It it
+ The sixth test (which is Perl-5.10 compatible) checks the support for Unicode
- not run automatically unless PCRE is built with Unicode property support. To to
+ character properties. It it not run automatically unless PCRE is built with
- this you must set --enable-unicode-properties when running "configure".
+ 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.
+ 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).
+ The eleventh test checks out features that are new in Perl 5.10, and the
+ twelfth test checks a number internals and non-Perl features concerned with
+ Unicode property support. 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".
  Character tables
  ----------------
- PCRE uses four tables for manipulating and identifying characters whose values
+ For speed, PCRE uses four tables for manipulating and identifying characters
- are less than 256. The final argument of the pcre_compile() function is a
+ whose code point values are less than 256. The final argument of the
- pointer to a block of memory containing the concatenated tables. A call to
+ pcre_compile() function is a pointer to a block of memory containing the
- pcre_maketables() can be used to generate a set of tables in the current
+ concatenated tables. A call to pcre_maketables() can be used to generate a set
- locale. If the final argument for pcre_compile() is passed as NULL, a set of
+ of tables in the current locale. If the final argument for pcre_compile() is
- 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.
- 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
- 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
- (compiled from dftables.c), which uses the ANSI C character handling functions
+ tables for ASCII coding. However, if --enable-rebuild-chartables is specified
- such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table
+ for ./configure, a different version of pcre_chartables.c is built by the
- 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
- control the contents of these default tables. You can change the default tables
+ handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
- 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
- probably also edit Makefile to ensure that the file doesn't ever get
+ your system will control the contents of these default tables. You can change
- re-generated.
+ the default tables by editing pcre_chartables.c and then re-building PCRE. If
+ you do this, you should take care to ensure that the file does not get
+ automatically re-generated. The best way to do this is to move
+ pcre_chartables.c.dist out of the way and replace it with your customized
+ tables.
+ When the dftables program is run as a result of --enable-rebuild-chartables,
+ it uses the default C locale that is set on your system. It does not pay
+ attention to the LC_xxx environment variables. In other words, it uses the
+ system's default locale rather than whatever the compiling user happens to have
+ set. If you really do want to build a source set of character tables in a
+ locale that is specified by the LC_xxx variables, you can run the dftables
+ program by hand with the -L option. For example:
+   ./dftables -L pcre_chartables.c.special
  The first two 256-byte tables provide lower casing and case flipping functions,
  respectively. The next table consists of three 32-byte bit maps which identify
  digits, "word" characters, and white space, respectively. These are used when
- building 32-byte bit maps that represent character classes.
+ building 32-byte bit maps that represent character classes for code points less
+ than 256.
  The final 256-byte table has bits indicating various character types, as
  follows:
-Line 428 
 You should not alter the set of characte
+Line 655 
 You should not alter the set of characte
  will cause PCRE to malfunction.
- Manifest
+ File manifest
- --------
+ -------------
  The distribution should contain the following files:
- (A) The actual source files of the PCRE library functions and their
+ (A) Source files of the PCRE library functions and their headers:
-     headers:
-   dftables.c            auxiliary program for building chartables.c
+   dftables.c              auxiliary program for building pcre_chartables.c
+                             when --enable-rebuild-chartables is specified
-   pcreposix.c           )
+   pcre_chartables.c.dist  a default set of character tables that assume ASCII
-   pcre_compile.c        )
+                             coding; used, unless --enable-rebuild-chartables is
-   pcre_config.c         )
+                             specified, by copying to pcre_chartables.c
-   pcre_dfa_exec.c       )
-   pcre_exec.c           )
+   pcreposix.c             )
-   pcre_fullinfo.c       )
+   pcre_compile.c          )
-   pcre_get.c            ) sources for the functions in the library,
+   pcre_config.c           )
-   pcre_globals.c        )   and some internal functions that they use
+   pcre_dfa_exec.c         )
-   pcre_info.c           )
+   pcre_exec.c             )
-   pcre_maketables.c     )
+   pcre_fullinfo.c         )
-   pcre_newline.c        )
+   pcre_get.c              ) sources for the functions in the library,
-   pcre_ord2utf8.c       )
+   pcre_globals.c          )   and some internal functions that they use
-   pcre_refcount.c       )
+   pcre_info.c             )
-   pcre_study.c          )
+   pcre_maketables.c       )
-   pcre_tables.c         )
+   pcre_newline.c          )
-   pcre_try_flipped.c    )
+   pcre_ord2utf8.c         )
-   pcre_ucp_searchfuncs.c)
+   pcre_refcount.c         )
-   pcre_valid_utf8.c     )
+   pcre_study.c            )
-   pcre_version.c        )
+   pcre_tables.c           )
-   pcre_xclass.c         )
+   pcre_try_flipped.c      )
+   pcre_ucd.c              )
-   pcre_printint.src     ) debugging function that is #included in pcretest, and
+   pcre_valid_utf8.c       )
-                         )   can also be #included in pcre_compile()
+   pcre_version.c          )
+   pcre_xclass.c           )
-   pcre.h                the public PCRE header file
+   pcre_printint.src       ) debugging function that is #included in pcretest,
-   pcreposix.h           header for the external POSIX wrapper API
+                           )   and can also be #included in pcre_compile()
-   pcre_internal.h       header for internal use
+   pcre.h.in               template for pcre.h when built by "configure"
-   ucp.h                 ) headers concerned with
+   pcreposix.h             header for the external POSIX wrapper API
-   ucpinternal.h         )   Unicode property handling
+   pcre_internal.h         header for internal use
-   ucptable.h            ) (this one is the data table)
+   ucp.h                   header for Unicode property handling
-   config.in             template for config.h, which is built by configure
+   config.h.in             template for config.h, which is built by "configure"
-   pcrecpp.h             the header file for the C++ wrapper
-   pcrecpparg.h.in       "source" for another C++ header file
+   pcrecpp.h               public header file for the C++ wrapper
-   pcrecpp.cc            )
+   pcrecpparg.h.in         template for another C++ header file
-   pcre_scanner.cc       ) source for the C++ wrapper library
+   pcre_scanner.h          public header file for C++ scanner functions
+   pcrecpp.cc              )
-   pcre_stringpiece.h.in "source" for pcre_stringpiece.h, the header for the
+   pcre_scanner.cc         ) source for the C++ wrapper library
-                           C++ stringpiece functions
-   pcre_stringpiece.cc   source for the C++ stringpiece functions
+   pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
+                             C++ stringpiece functions
- (B) Auxiliary files:
+   pcre_stringpiece.cc     source for the C++ stringpiece functions
-   AUTHORS               information about the author of PCRE
+ (B) Source files for programs that use PCRE:
-   ChangeLog             log of changes to the code
-   INSTALL               generic installation instructions
+   pcredemo.c              simple demonstration of coding calls to PCRE
-   LICENCE               conditions for the use of PCRE
+   pcregrep.c              source of a grep utility that uses PCRE
-   COPYING               the same, using GNU's standard name
+   pcretest.c              comprehensive test program
-   Makefile.in           template for Unix Makefile, which is built by configure
-   NEWS                  important changes in this release
+ (C) Auxiliary files:
-   NON-UNIX-USE          notes on building PCRE on non-Unix systems
-   README                this file
+html                 script to turn "man" pages into HTML
-   RunTest.in            template for a Unix shell script for running tests
+   AUTHORS                 information about the author of PCRE
-   RunGrepTest.in        template for a Unix shell script for pcregrep tests
+   ChangeLog               log of changes to the code
-   config.guess          ) files used by libtool,
+   CleanTxt                script to clean nroff output for txt man pages
-   config.sub            )   used only when building a shared library
+   Detrail                 script to remove trailing spaces
-   config.h.in           "source" for the config.h header file
+   HACKING                 some notes about the internals of PCRE
-   configure             a configuring shell script (built by autoconf)
+   INSTALL                 generic installation instructions
-   configure.ac          the autoconf input used to build configure
+   LICENCE                 conditions for the use of PCRE
-   doc/Tech.Notes        notes on the encoding
+   COPYING                 the same, using GNU's standard name
-   doc/*.3               man page sources for the PCRE functions
+   Makefile.in             ) template for Unix Makefile, which is built by
-   doc/*.1               man page sources for pcregrep and pcretest
+                           )   "configure"
-   doc/html/*            HTML documentation
+   Makefile.am             ) the automake input that was used to create
-   doc/pcre.txt          plain text version of the man pages
+                           )   Makefile.in
-   doc/pcretest.txt      plain text documentation of test program
+   NEWS                    important changes in this release
-   doc/perltest.txt      plain text documentation of Perl test program
+   NON-UNIX-USE            notes on building PCRE on non-Unix systems
-   install-sh            a shell script for installing files
+   PrepareRelease          script to make preparations for "make dist"
-   libpcre.pc.in         "source" for libpcre.pc for pkg-config
+   README                  this file
-   ltmain.sh             file used to build a libtool script
+   RunTest                 a Unix shell script for running tests
-   mkinstalldirs         script for making install directories
+   RunGrepTest             a Unix shell script for pcregrep tests
-   pcretest.c            comprehensive test program
+   aclocal.m4              m4 macros (generated by "aclocal")
-   pcredemo.c            simple demonstration of coding calls to PCRE
+   config.guess            ) files used by libtool,
-   perltest.pl           Perl test program
+   config.sub              )   used only when building a shared library
-   pcregrep.c            source of a grep utility that uses PCRE
+   configure               a configuring shell script (built by autoconf)
-   pcre-config.in        source of script which retains PCRE information
+   configure.ac            ) the autoconf input that was used to build
-   pcrecpp_unittest.c           )
+                           )   "configure" and config.h
-   pcre_scanner_unittest.c      ) test programs for the C++ wrapper
+   depcomp                 ) script to find program dependencies, generated by
-   pcre_stringpiece_unittest.c  )
+                           )   automake
-   testdata/testinput*   test data for main library tests
+   doc/*.3                 man page sources for PCRE
-   testdata/testoutput*  expected test results
+   doc/*.1                 man page sources for pcregrep and pcretest
-   testdata/grep*        input and output for pcregrep tests
+   doc/index.html.src      the base HTML page
+   doc/html/*              HTML documentation
+   doc/pcre.txt            plain text version of the man pages
+   doc/pcretest.txt        plain text documentation of test program
+   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
+                           )   installing, generated by automake
+   mkinstalldirs           script for making install directories
+   perltest.pl             Perl test program
+   pcre-config.in          source of script which retains PCRE information
+   pcrecpp_unittest.cc          )
+   pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
+   pcre_stringpiece_unittest.cc )
+   testdata/testinput*     test data for main library tests
+   testdata/testoutput*    expected test results
+   testdata/grep*          input and output for pcregrep tests
+ (D) Auxiliary files for cmake support
+   cmake/COPYING-CMAKE-SCRIPTS
+   cmake/FindPackageHandleStandardArgs.cmake
+   cmake/FindReadline.cmake
+   CMakeLists.txt
+   config-cmake.h.in
- (C) Auxiliary files for Win32 DLL
+ (E) Auxiliary files for VPASCAL
-   libpcre.def
+   makevp.bat
-   libpcreposix.def
+   makevp_c.txt
+   makevp_l.txt
+   pcregexp.pas
- (D) Auxiliary file for VPASCAL
+ (F) Auxiliary files for building PCRE "by hand"
-   makevp.bat
+   pcre.h.generic          ) a version of the public PCRE header file
+                           )   for use in non-"configure" environments
+   config.h.generic        ) a version of config.h for use in non-"configure"
+                           )   environments
+ (F) Miscellaneous
+   RunTest.bat            a script for running tests under Windows
  Philip Hazel
  Email local part: ph10
  Email domain: cam.ac.uk
- March 2007
+ Last updated: 19 January 2010

 Legend:



Removed from v.99
 


changed lines


 
Added in v.489
 Legend:



Removed from v.99
 


changed lines


 
Added in v.489
-Removed from v.99
+Added in v.489

webmaster@exim.org	ViewVC Help
Powered by ViewVC 1.1.12