/[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 423 by ph10,
Sat Aug 15 18:17:31 2009 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 82 
 documentation is supplied in two other f
+Line 85 
 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 110 
 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 of CMake's
+ CMakeSetup. It 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 125 
 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 151 
 library. You can read more about them in
+Line 165 
 library. You can read more about them in
    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 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 164 
 library. You can read more about them in
+Line 181 
 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 237 
 library. You can read more about them in
+Line 262 
 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.
+ . 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:
-Line 270 
 script that can be run to recreate the c
+Line 326 
 script that can be run to recreate the c
  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, "make" also builds the C++
- on your system, "make" also builds the C++ wrapper library, which is called
+ wrapper library, which is called libpcrecpp, and some test programs called
- libpcrecpp, and some test programs called pcrecpp_unittest,
+ pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.
- pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper
+ Building the C++ wrapper can be disabled by adding --disable-cpp to the
- can be disabled by adding --disable-cpp to the "configure" command.
+ "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.
-Line 327 
 system. The following are installed (fil
+Line 383 
 system. The following are installed (fil
      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.
-Line 429 
 Making new tarballs
+Line 482 
 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 489 
 is output to say why. If running this te
+Line 545 
 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,
-Line 592 
 The distribution should contain the foll
+Line 654 
 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 663 
 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
+   ucp.h                   header for Unicode property handling
-   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"
-Line 642 
 The distribution should contain the foll
+Line 702 
 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 661 
 The distribution should contain the foll
+Line 721 
 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 677 
 The distribution should contain the foll
+Line 738 
 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 765 
 The distribution should contain the foll
  Philip Hazel
  Email local part: ph10
  Email domain: cam.ac.uk
- Last updated: 20 March 2007
+ Last updated: 15 August 2009

 Legend:



Removed from v.128
 


changed lines


 
Added in v.423
 Legend:



Removed from v.128
 


changed lines


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

webmaster@exim.org	ViewVC Help
Powered by ViewVC 1.1.12