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

Diff of /code/trunk/README

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

revision 43 by nigel, Sat Feb 24 21:39:21 2007 UTC revision 53 by nigel, Sat Feb 24 21:39:42 2007 UTC
# Line 7  The latest release of PCRE is always ava Line 7  The latest release of PCRE is always ava
7    
8  Please read the NEWS file if you are upgrading from a previous release.  Please read the NEWS file if you are upgrading from a previous release.
9    
10    PCRE has its own native API, but a set of "wrapper" functions that are based on
11    the POSIX API are also supplied in the library libpcreposix. Note that this
12    just provides a POSIX calling interface to PCRE: the regular expressions
13    themselves still follow Perl syntax and semantics. The header file
14    for the POSIX-style functions is called pcreposix.h. The official POSIX name is
15    regex.h, but I didn't want to risk possible problems with existing files of
16    that name by distributing it that way. To use it with an existing program that
17    uses the POSIX API, it will have to be renamed or pointed at by a link.
18    
19    
20    Contributions by users of PCRE
21    ------------------------------
22    
23    You can find contributions from PCRE users in the directory
24    
25      ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
26    
27    where there is also a README file giving brief descriptions of what they are.
28    Several of them provide support for compiling PCRE on various flavours of
29    Windows systems (I myself do not use Windows). Some are complete in themselves;
30    others are pointers to URLs containing relevant files.
31    
32    
33  Building PCRE on a Unix system  Building PCRE on a Unix system
34  ------------------------------  ------------------------------
35    
36  To build PCRE on a Unix system, run the "configure" command in the PCRE  To build PCRE on a Unix system, first run the "configure" command from the PCRE
37  distribution directory. This is a standard GNU "autoconf" configuration script,  distribution directory, with your current directory set to the directory where
38  for which generic instructions are supplied in INSTALL. On many systems just  you want the files to be created. This command is a standard GNU "autoconf"
39  running "./configure" is sufficient, but the usual methods of changing standard  configuration script, for which generic instructions are supplied in INSTALL.
40  defaults are available. For example  
41    Most commonly, people build PCRE within its own distribution directory, and in
42    this case, on many systems, just running "./configure" is sufficient, but the
43    usual methods of changing standard defaults are available. For example,
44    
45  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
46    
47  specifies that the C compiler should be run with the flags '-O2 -Wall' instead  specifies that the C compiler should be run with the flags '-O2 -Wall' instead
48  of the default, and that "make install" should install PCRE under /opt/local  of the default, and that "make install" should install PCRE under /opt/local
49  instead of the default /usr/local. The "configure" script builds thre files:  instead of the default /usr/local.
50    
51    If you want to build in a different directory, just run "configure" with that
52    directory as current. For example, suppose you have unpacked the PCRE source
53    into /source/pcre/pcre-xxx, but you want to build it in /build/pcre/pcre-xxx:
54    
55    cd /build/pcre/pcre-xxx
56    /source/pcre/pcre-xxx/configure
57    
58    If you want to make use of the experimential, incomplete support for UTF-8
59    character strings in PCRE, you must add --enable-utf8 to the "configure"
60    command. Without it, the code for handling UTF-8 is not included in the
61    library. (Even when included, it still has to be enabled by an option at run
62    time.)
63    
64    The "configure" script builds five files:
65    
66    . libtool is a script that builds shared and/or static libraries
67  . Makefile is built by copying Makefile.in and making substitutions.  . Makefile is built by copying Makefile.in and making substitutions.
68  . config.h is built by copying config.in and making substitutions.  . config.h is built by copying config.in and making substitutions.
69  . pcre-config is built by copying pcre-config.in and making substitutions.  . pcre-config is built by copying pcre-config.in and making substitutions.
70    . RunTest is a script for running tests
71    
72  Once "configure" has run, you can run "make". It builds two libraries called  Once "configure" has run, you can run "make". It builds two libraries called
73  libpcre and libpcreposix, a test program called pcretest, and the pgrep  libpcre and libpcreposix, a test program called pcretest, and the pcregrep
74  command. You can use "make install" to copy these, and the public header file  command. You can use "make install" to copy these, the public header files
75  pcre.h, to appropriate live directories on your system, in the normal way.  pcre.h and pcreposix.h, and the man pages to appropriate live directories on
76    your system, in the normal way.
77    
78  Running "make install" also installs the command pcre-config, which can be used  Running "make install" also installs the command pcre-config, which can be used
79  to recall information about the PCRE configuration and installation. For  to recall information about the PCRE configuration and installation. For
# Line 46  outputs information about where the libr Line 89  outputs information about where the libr
89  included in makefiles for programs that use PCRE, saving the programmer from  included in makefiles for programs that use PCRE, saving the programmer from
90  having to remember too many details.  having to remember too many details.
91    
92    There is one esoteric feature that is controlled by "configure". It concerns
93    the character value used for "newline", and is something that you probably do
94    not want to change on a Unix system. The default is to use whatever value your
95    compiler gives to '\n'. By using --enable-newline-is-cr or
96    --enable-newline-is-lf you can force the value to be CR (13) or LF (10) if you
97    really want to.
98    
99    
100  Shared libraries on Unix systems  Shared libraries on Unix systems
101  --------------------------------  --------------------------------
102    
103  The default distribution builds PCRE as two shared libraries. This support is  The default distribution builds PCRE as two shared libraries and two static
104  new and experimental and may not work on all systems. It relies on the  libraries, as long as the operating system supports shared libraries. Shared
105  "libtool" scripts - these are distributed with PCRE. It should build a  library support relies on the "libtool" script which is built as part of the
106  "libtool" script and use this to compile and link shared libraries, which are  "configure" process.
107  placed in a subdirectory called .libs. The programs pcretest and pgrep are  
108  built to use these uninstalled libraries by means of wrapper scripts. When you  The libtool script is used to compile and link both shared and static
109  use "make install" to install shared libraries, pgrep and pcretest are  libraries. They are placed in a subdirectory called .libs when they are newly
110  automatically re-built to use the newly installed libraries. However, only  built. The programs pcretest and pcregrep are built to use these uninstalled
111  pgrep is installed, as pcretest is really just a test program.  libraries (by means of wrapper scripts in the case of shared libraries). When
112    you use "make install" to install shared libraries, pcregrep and pcretest are
113    automatically re-built to use the newly installed shared libraries before being
114    installed themselves. However, the versions left in the source directory still
115    use the uninstalled libraries.
116    
117  To build PCRE using static libraries you must use --disable-shared when  To build PCRE using static libraries only you must use --disable-shared when
118  configuring it. For example  configuring it. For example
119    
120  ./configure --prefix=/usr/gnu --disable-shared  ./configure --prefix=/usr/gnu --disable-shared
121    
122  Then run "make" in the usual way.  Then run "make" in the usual way. Similarly, you can use --disable-static to
123    build only shared libraries.
124    
125    
126  Building on non-Unix systems  Building on non-Unix systems
# Line 81  Standard C functions. Line 136  Standard C functions.
136  Testing PCRE  Testing PCRE
137  ------------  ------------
138    
139  To test PCRE on a Unix system, run the RunTest script in the pcre directory.  To test PCRE on a Unix system, run the RunTest script that is created by the
140  (This can also be run by "make runtest" or "make check".) For other systems,  configuring process. (This can also be run by "make runtest", "make check", or
141  see the instruction in NON-UNIX-USE.  "make test".) For other systems, see the instruction in NON-UNIX-USE.
142    
143  The script runs the pcretest test program (which is documented in  The script runs the pcretest test program (which is documented in the doc
144  doc/pcretest.txt) on each of the testinput files (in the testdata directory) in  directory) on each of the testinput files (in the testdata directory) in turn,
145  turn, and compares the output with the contents of the corresponding testoutput  and compares the output with the contents of the corresponding testoutput file.
146  file. A file called testtry is used to hold the output from pcretest. To run  A file called testtry is used to hold the output from pcretest. To run pcretest
147  pcretest on just one of the test files, give its number as an argument to  on just one of the test files, give its number as an argument to RunTest, for
148  RunTest, for example:  example:
149    
150    RunTest 3    RunTest 3
151    
152  The first and third test files can also be fed directly into the perltest  The first and third test files can also be fed directly into the perltest
153  script to check that Perl gives the same results. The third file requires the  script to check that Perl gives the same results. The third file requires the
154  additional features of release 5.005, which is why it is kept separate from the  additional features of release 5.005, which is why it is kept separate from the
155  main test input, which needs only Perl 5.004. In the long run, when 5.005 is  main test input, which needs only Perl 5.004. In the long run, when 5.005 (or
156  widespread, these two test files may get amalgamated.  higher) is widespread, these two test files may get amalgamated.
157    
158  The second set of tests check pcre_info(), pcre_study(), pcre_copy_substring(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
159  pcre_get_substring(), pcre_get_substring_list(), error detection and run-time  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
160  flags that are specific to PCRE, as well as the POSIX wrapper API.  detection, and run-time flags that are specific to PCRE, as well as the POSIX
161    wrapper API. It also uses the debugging flag to check some of the internals of
162    pcre_compile().
163    
164    If you build PCRE with a locale setting that is not the standard C locale, the
165    character tables may be different (see next paragraph). In some cases, this may
166    cause failures in the second set of tests. For example, in a locale where the
167    isprint() function yields TRUE for characters in the range 128-255, the use of
168    [:isascii:] inside a character class defines a different set of characters, and
169    this shows up in this test as a difference in the compiled code, which is being
170    listed for checking. Where the comparison test output contains [\x00-\x7f] the
171    test will contain [\x00-\xff], and similarly in some other cases. This is not a
172    bug in PCRE.
173    
174  The fourth set of tests checks pcre_maketables(), the facility for building a  The fourth set of tests checks pcre_maketables(), the facility for building a
175  set of character tables for a specific locale and using them instead of the  set of character tables for a specific locale and using them instead of the
# Line 117  output to say why. If running this test Line 184  output to say why. If running this test
184  in the comparison output, it means that locale is not available on your system,  in the comparison output, it means that locale is not available on your system,
185  despite being listed by "locale". This does not mean that PCRE is broken.  despite being listed by "locale". This does not mean that PCRE is broken.
186    
187  PCRE has its own native API, but a set of "wrapper" functions that are based on  The fifth test checks the experimental, incomplete UTF-8 support. It is not run
188  the POSIX API are also supplied in the library libpcreposix.a. Note that this  automatically unless PCRE is built with UTF-8 support. This file can be fed
189  just provides a POSIX calling interface to PCRE: the regular expressions  directly to the perltest8 script, which requires Perl 5.6 or higher. The sixth
190  themselves still follow Perl syntax and semantics. The header file  file tests internal UTF-8 features of PCRE that are not relevant to Perl.
 for the POSIX-style functions is called pcreposix.h. The official POSIX name is  
 regex.h, but I didn't want to risk possible problems with existing files of  
 that name by 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.  
191    
192    
193  Character tables  Character tables
# Line 197  The distribution should contain the foll Line 260  The distribution should contain the foll
260    NEWS                  important changes in this release    NEWS                  important changes in this release
261    NON-UNIX-USE          notes on building PCRE on non-Unix systems    NON-UNIX-USE          notes on building PCRE on non-Unix systems
262    README                this file    README                this file
263    RunTest               a Unix shell script for running tests    RunTest.in            template for a Unix shell script for running tests
264    config.guess          ) files used by libtool,    config.guess          ) files used by libtool,
265    config.sub            )   used only when building a shared library    config.sub            )   used only when building a shared library
266    configure             a configuring shell script (built by autoconf)    configure             a configuring shell script (built by autoconf)
# Line 211  The distribution should contain the foll Line 274  The distribution should contain the foll
274    doc/pcreposix.txt     plain text version    doc/pcreposix.txt     plain text version
275    doc/pcretest.txt      documentation of test program    doc/pcretest.txt      documentation of test program
276    doc/perltest.txt      documentation of Perl test program    doc/perltest.txt      documentation of Perl test program
277    doc/pgrep.1           man page source for the pgrep utility    doc/pcregrep.1        man page source for the pcregrep utility
278    doc/pgrep.html        HTML version    doc/pcregrep.html     HTML version
279    doc/pgrep.txt         plain text version    doc/pcregrep.txt      plain text version
280    install-sh            a shell script for installing files    install-sh            a shell script for installing files
281    ltconfig              ) files used to build "libtool",    ltmain.sh             file used to build a libtool script
282    ltmain.sh             )   used only when building a shared library    pcretest.c            comprehensive test program
283    pcretest.c            test program    pcredemo.c            simple demonstration of coding calls to PCRE
284    perltest              Perl test program    perltest              Perl test program
285    pgrep.c               source of a grep utility that uses PCRE    perltest8             Perl test program for UTF-8 tests
286      pcregrep.c            source of a grep utility that uses PCRE
287    pcre-config.in        source of script which retains PCRE information    pcre-config.in        source of script which retains PCRE information
288    testdata/testinput1   test data, compatible with Perl 5.004 and 5.005    testdata/testinput1   test data, compatible with Perl 5.004 and 5.005
289    testdata/testinput2   test data for error messages and non-Perl things    testdata/testinput2   test data for error messages and non-Perl things
290    testdata/testinput3   test data, compatible with Perl 5.005    testdata/testinput3   test data, compatible with Perl 5.005
291    testdata/testinput4   test data for locale-specific tests    testdata/testinput4   test data for locale-specific tests
292      testdata/testinput5   test data for UTF-8 tests compatible with Perl 5.6
293      testdata/testinput6   test data for other UTF-8 tests
294    testdata/testoutput1  test results corresponding to testinput1    testdata/testoutput1  test results corresponding to testinput1
295    testdata/testoutput2  test results corresponding to testinput2    testdata/testoutput2  test results corresponding to testinput2
296    testdata/testoutput3  test results corresponding to testinput3    testdata/testoutput3  test results corresponding to testinput3
297    testdata/testoutput4  test results corresponding to testinput4    testdata/testoutput4  test results corresponding to testinput4
298      testdata/testoutput5  test results corresponding to testinput5
299      testdata/testoutput6  test results corresponding to testinput6
300    
301  (C) Auxiliary files for Win32 DLL  (C) Auxiliary files for Win32 DLL
302    
# Line 236  The distribution should contain the foll Line 304  The distribution should contain the foll
304    pcre.def    pcre.def
305    
306  Philip Hazel <ph10@cam.ac.uk>  Philip Hazel <ph10@cam.ac.uk>
307  February 2000  August 2001

Legend:
Removed from v.43  
changed lines
  Added in v.53

  ViewVC Help
Powered by ViewVC 1.1.5