/[pcre]/code/trunk/README

Diff of /code/trunk/README

Parent Directory | Revision Log | View Patch Patch

-revision 49 by nigel,
Sat Feb 24 21:39:33 2007 UTC
+revision 122 by ph10,
Mon Mar 12 15:10:25 2007 UTC
 Line 4 
 README file for PCRE (Perl-compatible re
  The latest release of PCRE is always available from
    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.gz
+ 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:
- PCRE has its own native API, but a set of "wrapper" functions that are based on
+   The PCRE APIs
- the POSIX API are also supplied in the library libpcreposix. Note that this
+   Documentation for PCRE
- just provides a POSIX calling interface to PCRE: the regular expressions
+   Contributions by users of PCRE
- themselves still follow Perl syntax and semantics. The header file
+   Building PCRE on non-Unix systems
- for the POSIX-style functions is called pcreposix.h. The official POSIX name is
+   Building PCRE on Unix-like systems
- regex.h, but I didn't want to risk possible problems with existing files of
+   Retrieving configuration information on Unix-like systems
- that name by distributing it that way. To use it with an existing program that
+   Shared libraries on Unix-like systems
- uses the POSIX API, it will have to be renamed or pointed at by a link.
+   Cross-compiling on Unix-like systems
+   Using HP's ANSI C++ compiler (aCC)
+   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
+ set of C++ wrapper functions, courtesy of Google Inc. (see the pcrecpp man page
+ for details).
+ Also included in the distribution are 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 provides a POSIX calling interface to PCRE; the regular
+ expressions themselves still follow Perl syntax and semantics. The POSIX API is
+ restricted, and does not give full access to all of PCRE's facilities.
+ 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, 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 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 on a Unix-like system, you will end up
+ with a set of man pages whose names all start with "pcre". The one that is just
+ called "pcre" lists all the others. In addition to these man pages, the PCRE
+ documentation is supplied in two other forms:
+. There are files called doc/pcre.txt, doc/pcregrep.txt, and
+      doc/pcretest.txt in the source distribution. The first of these is a
+      concatenation of the text forms of all the section 3 man pages except
+      those that summarize individual functions. The other two are the text
+      forms of the section 1 man pages for the pcregrep and pcretest commands.
+      These text forms are provided for ease of scanning with text editors or
+      similar tools. They are installed in <prefix>/share/doc/pcre, where
+      <prefix> is the installation prefix (defaulting to /usr/local).
+. A set of files containing all the documentation in HTML form, hyperlinked
+      in various ways, and rooted in a file called index.html, is distributed in
+      doc/html and installed in <prefix>/share/doc/pcre/html.
- Building PCRE on a Unix system
+ Contributions by users of PCRE
  ------------------------------
- To build PCRE on a Unix system, run the "configure" command in the PCRE
+ You can find contributions from PCRE users in the directory
- distribution directory. This is a standard GNU "autoconf" configuration script,
- for which generic instructions are supplied in INSTALL. On many systems just
+   ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
- running "./configure" is sufficient, but the usual methods of changing standard
- defaults are available. For example,
+ There is a README file giving brief descriptions of what they are. Some are
+ complete in themselves; others are pointers to URLs containing relevant files.
+ Some of this material is likely to be well out-of-date. In particular, several
+ of the contributions provide support for compiling PCRE on various flavours of
+ Windows (I myself do not use Windows), but nowadays there is more Windows
+ support in the standard distribution.
+ 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 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.
+ 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
+ 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. However,
+ the usual methods of changing standard defaults are available. For example:
  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
-Line 32 
 specifies that the C compiler should be
+Line 131 
 specifies that the C compiler should be
  of the default, and that "make install" should install PCRE under /opt/local
  instead of the default /usr/local.
- If you want to make use of the experimential, incomplete support for UTF-8
+ If you want to build in a different directory, just run "configure" with that
- character strings in PCRE, you must add --enable-utf8 to the "configure"
+ directory as current. For example, suppose you have unpacked the PCRE source
- command. Without it, the code for handling UTF-8 is not included in the
+ into /source/pcre/pcre-xxx, but you want to build it in /build/pcre/pcre-xxx:
- library. (Even when included, it still has to be enabled by an option at run
- time.)
+ cd /build/pcre/pcre-xxx
+ /source/pcre/pcre-xxx/configure
- The "configure" script builds four files:
+ PCRE is written in C and is normally compiled as a C library. However, it is
- . Makefile is built by copying Makefile.in and making substitutions.
+ possible to build it as a C++ library, though the provided building apparatus
- . config.h is built by copying config.in and making substitutions.
+ does not have any features to support this.
- . pcre-config is built by copying pcre-config.in and making substitutions.
- . RunTest is a script for running tests
+ 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.
- Once "configure" has run, you can run "make". It builds two libraries called
- libpcre and libpcreposix, a test program called pcretest, and the pcregrep
+ . If you want to suppress the building of the C++ wrapper library, you can add
- command. You can use "make install" to copy these, and the public header file
+   --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
- pcre.h, to appropriate live directories on your system, in the normal way.
+   will try to find a C++ compiler and C++ header files, and if it succeeds, it
+   will try to build the C++ wrapper.
- Running "make install" also installs the command pcre-config, which can be used
- to recall information about the PCRE configuration and installation. For
+ . If you want to make use of the support for UTF-8 character strings in PCRE,
- example,
+   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.)
+ . 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
+   properties, you must add --enable-unicode-properties to the "configure"
+   command. This adds about 30K to the size of the library (in the form of a
+   property table); only the basic two-letter properties such as Lu are
+   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
+   you specify at build time is the default; the caller of PCRE can change the
+   selection at run time. The default newline indicator is a single LF character
+   (the Unix standard). You can specify the default newline indicator by adding
+   --newline-is-cr or --newline-is-lf or --newline-is-crlf or --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
+   the files are edited to change the line endings, there are likely to be some
+   failures. With --newline-is-any, many tests should succeed, but there may be
+   some failures.
+ . 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,
+   --with-posix-malloc-threshold=20
+   on the "configure" command.
+ . PCRE has a counter that can be set to limit the amount of resources it uses.
+   If the limit is exceeded during a match, the match fails. The default is ten
+   million. You can change the default by setting, for example,
+   --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 more discussion on the
+   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
+   essentially "unlimited". You can change the default by setting, for example,
+   --with-match-limit-recursion=500000
+   Recursive function calls use up the runtime stack; running out of stack can
+   cause programs to crash in strange ways. There is a discussion about stack
+   sizes in the pcrestack man page.
+ . 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.
+ . You can build PCRE so that its internal match() function that is called from
+   pcre_exec() does not call itself recursively. Instead, it uses memory blocks
+   obtained from the heap via the special functions pcre_stack_malloc() and
+   pcre_stack_free() to save data that would otherwise be saved on the stack. To
+   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. There is a discussion about stack sizes in the
+   pcrestack man page.
+ 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 basic C library
+ . RunGrepTest is a script for running tests on the pcregrep command
+ 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 the
+ benefit of those who have to built PCRE without the benefit of "configure". If
+ you use "configure", 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
+ . 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
+ 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
+ program called pcredemo, and the pcregrep 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 check" runs all the appropriate tests. Details of the PCRE
+ tests are given below in a separate section of this document.
+ You can use "make install" to install PCRE into live directories on your
+ system. The following are installed (file names are all relative to the
+ <prefix> that is set when "configure" is run):
+   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
+ 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
+ remove any directories, because these are often shared with other programs.
+ Retrieving configuration information on Unix-like systems
+ ---------------------------------------------------------
+ Running "make install" installs the command pcre-config, which can be used to
+ recall information about the PCRE configuration and installation. For example:
    pcre-config --version
  prints the version number, and
-  pcre-config --libs
+   pcre-config --libs
  outputs information about where the library is installed. This command can be
  included in makefiles for programs that use PCRE, saving the programmer from
  having to remember too many details.
+ The pkg-config command is another system for saving and retrieving information
+ about installed libraries. Instead of separate commands for each library, a
+ single command is used. For example:
+   pkg-config --cflags pcre
+ The data is held in *.pc files that are installed in a directory called
+ <prefix>/lib/pkgconfig.
+ Shared libraries on Unix-like systems
+ -------------------------------------
+ The default distribution builds PCRE as shared libraries and static libraries,
+ as long as the operating system supports shared libraries. Shared library
+ support relies on the "libtool" script which is built as part of the
+ "configure" process.
+ The libtool script is used to compile and link both shared and static
+ libraries. They are placed in a subdirectory called .libs when they are newly
+ built. The programs pcretest and pcregrep are built to use these uninstalled
+ 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 build directory still
+ use the uninstalled libraries.
- Shared libraries on Unix systems
+ To build PCRE using static libraries only you must use --disable-shared when
- --------------------------------
+ configuring it. For example:
- The default distribution builds PCRE as two shared libraries. This support is
- new and experimental and may not work on all systems. It relies on the
- "libtool" scripts - these are distributed with PCRE. It should build a
- "libtool" script and use this to compile and link shared libraries, which are
- placed in a subdirectory called .libs. The programs pcretest and pcregrep are
- built to use these uninstalled libraries by means of wrapper scripts. When you
- use "make install" to install shared libraries, pcregrep and pcretest are
- automatically re-built to use the newly installed libraries. However, only
- pcregrep is installed, as pcretest is really just a test program.
- To build PCRE using static libraries you must use --disable-shared when
- configuring it. For example
  ./configure --prefix=/usr/gnu --disable-shared
- Then run "make" in the usual way.
+ Then run "make" in the usual way. Similarly, you can use --disable-static to
+ build only shared libraries.
- Building on non-Unix systems
+ Cross-compiling on Unix-like systems
- ----------------------------
+ ------------------------------------
- For a non-Unix system, read the comments in the file NON-UNIX-USE. PCRE has
+ You can specify CC and CFLAGS in the normal way to the "configure" command, in
- been compiled on Windows systems and on Macintoshes, but I don't know the
+ order to cross-compile PCRE for some other host. However, during the building
- details because I don't use those systems. It should be straightforward to
+ process, the dftables.c source file is compiled *and run* on the local host, in
- build PCRE on any system that has a Standard C compiler, because it uses only
+ order to generate the default character tables (the chartables.c file). It
- Standard C functions.
+ therefore needs to be compiled with the local compiler, not the cross compiler.
+ You can do this by specifying CC_FOR_BUILD (and if necessary CFLAGS_FOR_BUILD;
+ there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)
+ when calling the "configure" command. If they are not specified, they default
+ to the values of CC and CFLAGS.
+ 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
+ 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
+ needed libraries fail to get included when specifying the "-AA" compiler
+ option. If you experience unresolved symbols when linking the C++ programs,
+ use the workaround of specifying the following environment variable prior to
+ running the "configure" script:
+   CXXLDFLAGS="-lstd_v2 -lCsup_v2"
+ 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
+ doc directory, you should first run the PrepareRelease script. This re-creates
+ the .txt and HTML forms of the documentation from the man pages.
  Testing PCRE
  ------------
- To test PCRE on a Unix system, run the RunTest script in the pcre directory.
+ To test the basic PCRE library on a Unix system, run the RunTest script that is
- (This can also be run by "make runtest", "make check", or "make test".) For
+ created by the configuring process. There is also a script called RunGrepTest
- other systems, see the instruction in NON-UNIX-USE.
+ 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.
+ 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 script runs the pcretest test program (which is documented in
+ The RunTest script runs the pcretest test program (which is documented in its
- doc/pcretest.txt) 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
- file. A file called testtry is used to hold the output from pcretest. To run
+ files. A file called testtry is used to hold the main output from pcretest
- pcretest on just one of the test files, give its number as an argument to
+ (testsavedregex is also used as a working file). To run pcretest on just one of
- RunTest, for example:
+ the test files, give its number as an argument to RunTest, for example:
-   RunTest 3
+   RunTest 2
- The first and third test files can also be fed directly into the perltest
+ The first test file can also be fed directly into the perltest.pl script to
- script to check that Perl gives the same results. The third file requires the
+ check that Perl gives the same results. The only difference you should see is
- additional features of release 5.005, which is why it is kept separate from the
+ in the first few lines, where the Perl version is given instead of the PCRE
- main test input, which needs only Perl 5.004. In the long run, when 5.005 (or
+ version.
- higher) is widespread, these two test files may get amalgamated.
  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 134 
 listed for checking. Where the compariso
+Line 448 
 listed for checking. Where the compariso
  test will contain [\x00-\xff], and similarly in some other cases. This is not a
  bug in PCRE.
- The fourth set of tests checks pcre_maketables(), the facility for building a
+ The third set of tests checks pcre_maketables(), the facility for building a
  set of character tables for a specific locale and using them instead of the
- default tables. The tests make use of the "fr" (French) locale. Before running
+ default tables. The tests make use of the "fr_FR" (French) locale. Before
- the test, the script checks for the presence of this locale by running the
+ running the test, the script checks for the presence of this locale by running
- "locale" command. If that command fails, or if it doesn't include "fr" in the
+ the "locale" command. If that command fails, or if it doesn't include "fr_FR"
- list of available locales, the fourth test cannot be run, and a comment is
+ in the list of available locales, the third test cannot be run, and a comment
- output to say why. If running this test produces instances of the error
+ is output to say why. If running this test produces instances of the error
-   ** Failed to set locale "fr"
+   ** Failed to set locale "fr_FR"
  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 fifth test checks the experimental, incomplete UTF-8 support. It is not run
+ The fourth test checks the UTF-8 support. It is not run automatically unless
- automatically unless PCRE is built with UTF-8 support. This file can be fed
+ PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when
- directly to the perltest8 script, which requires Perl 5.6 or higher. The sixth
+ running "configure". This file can be also fed directly to the perltest script,
- file tests internal UTF-8 features of PCRE that are not relevant to Perl.
+ 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.
  Character tables
  ----------------
- PCRE uses four tables for manipulating and identifying characters. The final
+ For speed, PCRE uses four tables for manipulating and identifying characters
- argument of the pcre_compile() function is a pointer to a block of memory
+ whose code point values are less than 256. The final argument of the
- containing the concatenated tables. A call to pcre_maketables() can be used to
+ pcre_compile() function is a pointer to a block of memory containing the
- generate a set of tables in the current locale. If the final argument for
+ concatenated tables. A call to pcre_maketables() can be used to generate a set
- pcre_compile() is passed as NULL, a set of default tables that is built into
+ of tables in the current locale. If the final argument for pcre_compile() is
- 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
  not supplied in the distribution, but is built by the program dftables
-Line 170 
 such as isalnum(), isalpha(), isupper(),
+Line 497 
 such as isalnum(), isalpha(), isupper(),
  sources. This means that the default C locale which is set for your system will
  control the contents of these default tables. You can change the default tables
  by editing chartables.c and then re-building PCRE. If you do this, you should
- probably also edit Makefile to ensure that the file doesn't ever get
+ take care to ensure that the file does not get automaticaly re-generated.
- re-generated.
  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 192 
 You should not alter the set of characte
+Line 519 
 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
-   get.c                 )
-   maketables.c          )
-   study.c               ) source of
-   pcre.c                )   the functions
-   pcreposix.c           )
-   pcre.in               "source" for the header for the external API; pcre.h
-                           is built from this by "configure"
-   pcreposix.h           header for the external POSIX wrapper API
-   internal.h            header for internal use
-   config.in             template for config.h, which is built by configure
- (B) Auxiliary files:
-   AUTHORS               information about the author of PCRE
-   ChangeLog             log of changes to the code
-   INSTALL               generic installation instructions
-   LICENCE               conditions for the use of PCRE
-   COPYING               the same, using GNU's standard name
-   Makefile.in           template for Unix Makefile, which is built by configure
-   NEWS                  important changes in this release
-   NON-UNIX-USE          notes on building PCRE on non-Unix systems
-   README                this file
-   RunTest.in            template for a Unix shell script for running tests
-   config.guess          ) files used by libtool,
-   config.sub            )   used only when building a shared library
-   configure             a configuring shell script (built by autoconf)
-   configure.in          the autoconf input used to build configure
-   doc/Tech.Notes        notes on the encoding
-   doc/pcre.3            man page source for the PCRE functions
-   doc/pcre.html         HTML version
-   doc/pcre.txt          plain text version
-   doc/pcreposix.3       man page source for the POSIX wrapper API
-   doc/pcreposix.html    HTML version
-   doc/pcreposix.txt     plain text version
-   doc/pcretest.txt      documentation of test program
-   doc/perltest.txt      documentation of Perl test program
-   doc/pcregrep.1        man page source for the pcregrep utility
-   doc/pcregrep.html     HTML version
-   doc/pcregrep.txt      plain text version
-   install-sh            a shell script for installing files
-   ltconfig              ) files used to build "libtool",
-   ltmain.sh             )   used only when building a shared library
-   pcretest.c            test program
-   perltest              Perl test program
-   perltest8             Perl test program for UTF-8 tests
-   pcregrep.c            source of a grep utility that uses PCRE
-   pcre-config.in        source of script which retains PCRE information
-   testdata/testinput1   test data, compatible with Perl 5.004 and 5.005
-   testdata/testinput2   test data for error messages and non-Perl things
-   testdata/testinput3   test data, compatible with Perl 5.005
-   testdata/testinput4   test data for locale-specific tests
-   testdata/testinput5   test data for UTF-8 tests compatible with Perl 5.6
-   testdata/testinput6   test data for other UTF-8 tests
-   testdata/testoutput1  test results corresponding to testinput1
-   testdata/testoutput2  test results corresponding to testinput2
-   testdata/testoutput3  test results corresponding to testinput3
-   testdata/testoutput4  test results corresponding to testinput4
-   testdata/testoutput5  test results corresponding to testinput5
-   testdata/testoutput6  test results corresponding to testinput6
- (C) Auxiliary files for Win32 DLL
-   dll.mk
+   dftables.c             auxiliary program for building chartables.c
-   pcre.def
- Philip Hazel <ph10@cam.ac.uk>
+   pcreposix.c            )
- August 2000
+   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()
+   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
+   ucpinternal.h          )   Unicode property handling
+   ucptable.h             ) (this one is the data table)
+   config.h.in            template for config.h, which is built by "configure"
+   pcrecpp.h              public header file for the C++ wrapper
+   pcrecpparg.h.in        template for another C++ header file
+   pcre_scanner.h         public header file for C++ scanner functions
+   pcrecpp.cc             )
+   pcre_scanner.cc        ) source for the C++ wrapper library
+   pcre_stringpiece.h.in  template for pcre_stringpiece.h, the header for the
+                            C++ stringpiece functions
+   pcre_stringpiece.cc    source for the C++ stringpiece functions
+ (B) Source files for programs that use PCRE:
+   pcredemo.c             simple demonstration of coding calls to PCRE
+   pcregrep.c             source of a grep utility that uses PCRE
+   pcretest.c             comprehensive test program
+ (C) Auxiliary files:
+html                script to turn "man" pages into HTML
+   AUTHORS                information about the author of PCRE
+   ChangeLog              log of changes to the code
+   CleanTxt               script to clean nroff output for txt man pages
+   Detrail                script to remove trailing spaces
+   Index.html             the base HTML page
+   INSTALL                generic installation instructions
+   LICENCE                conditions for the use of PCRE
+   COPYING                the same, using GNU's standard name
+   Makefile.in            ) template for Unix Makefile, which is built by
+                          )   "configure"
+   Makefile.am            ) the automake input that was used to create
+                          )   Makefile.in
+   NEWS                   important changes in this release
+   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
+   RunGrepTest.in         template for 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
+   configure              a configuring shell script (built by autoconf)
+   configure.ac           ) the autoconf input that was used to build
+                          )   "configure" and config.h
+   depcomp                ) script to find program dependencies, generated by
+                          )   automake
+   doc/*.3                man page sources for the PCRE functions
+   doc/*.1                man page sources for pcregrep and pcretest
+   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
+   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
+   CMakeLists.txt
+   config-cmake.h.in
+ (E) Auxiliary files for VPASCAL
+   makevp.bat
+   !compile.txt
+   !linklib.txt
+   pcregexp.pas
+ (F) Auxiliary files for building PCRE "by hand"
+   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
+ Last updated: March 2007

 Legend:



Removed from v.49
 


changed lines


 
Added in v.122
 Legend:



Removed from v.49
 


changed lines


 
Added in v.122
-Removed from v.49
+Added in v.122

	ViewVC Help
Powered by ViewVC 1.1.5