/[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 63 by nigel, Sat Feb 24 21:40:03 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  Building PCRE on a Unix system  Contributions by users of PCRE
21  ------------------------------  ------------------------------
22    
23  To build PCRE on a Unix system, run the "configure" command in the PCRE  You can find contributions from PCRE users in the directory
24  distribution directory. This is a standard GNU "autoconf" configuration script,  
25  for which generic instructions are supplied in INSTALL. On many systems just    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
26  running "./configure" is sufficient, but the usual methods of changing standard  
27  defaults are available. For example  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-like system
34    -----------------------------------
35    
36    To build PCRE on a Unix-like system, first run the "configure" command from the
37    PCRE distribution directory, with your current directory set to the directory
38    where you want the files to be created. This command is a standard GNU
39    "autoconf" configuration script, for which generic instructions are supplied in
40    INSTALL.
41    
42    Most commonly, people build PCRE within its own distribution directory, and in
43    this case, on many systems, just running "./configure" is sufficient, but the
44    usual methods of changing standard defaults are available. For example,
45    
46  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
47    
48  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
49  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
50  instead of the default /usr/local. The "configure" script builds thre files:  instead of the default /usr/local.
51    
52    If you want to build in a different directory, just run "configure" with that
53    directory as current. For example, suppose you have unpacked the PCRE source
54    into /source/pcre/pcre-xxx, but you want to build it in /build/pcre/pcre-xxx:
55    
56    cd /build/pcre/pcre-xxx
57    /source/pcre/pcre-xxx/configure
58    
59    There are some optional features that can be included or omitted from the PCRE
60    library. You can read more about them in the pcrebuild man page.
61    
62    . If you want to make use of the support for UTF-8 character strings in PCRE,
63      you must add --enable-utf8 to the "configure" command. Without it, the code
64      for handling UTF-8 is not included in the library. (Even when included, it
65      still has to be enabled by an option at run time.)
66    
67    . You can build PCRE to recognized CR or NL as the newline character, instead
68      of whatever your compiler uses for "\n", by adding --newline-is-cr or
69      --newline-is-nl to the "configure" command, respectively. Only do this if you
70      really understand what you are doing. On traditional Unix-like systems, the
71      newline character is NL.
72    
73    . When called via the POSIX interface, PCRE uses malloc() to get additional
74      storage for processing capturing parentheses if there are more than 10 of
75      them. You can increase this threshold by setting, for example,
76    
77      --with-posix-malloc-threshold=20
78    
79      on the "configure" command.
80    
81    . PCRE has a counter which can be set to limit the amount of resources it uses.
82      If the limit is exceeded during a match, the match fails. The default is ten
83      million. You can change the default by setting, for example,
84    
85      --with-match-limit=500000
86    
87      on the "configure" command. This is just the default; individual calls to
88      pcre_exec() can supply their own value. There is discussion on the pcreapi
89      man page.
90    
91    . The default maximum compiled pattern size is around 64K. You can increase
92      this by adding --with-link-size=3 to the "configure" command. You can
93      increase it even more by setting --with-link-size=4, but this is unlikely
94      ever to be necessary. If you build PCRE with an increased link size, test 2
95      (and 5 if you are using UTF-8) will fail. Part of the output of these tests
96      is a representation of the compiled pattern, and this changes with the link
97      size.
98    
99    The "configure" script builds five files:
100    
101    . libtool is a script that builds shared and/or static libraries
102  . Makefile is built by copying Makefile.in and making substitutions.  . Makefile is built by copying Makefile.in and making substitutions.
103  . config.h is built by copying config.in and making substitutions.  . config.h is built by copying config.in and making substitutions.
104  . pcre-config is built by copying pcre-config.in and making substitutions.  . pcre-config is built by copying pcre-config.in and making substitutions.
105    . RunTest is a script for running tests
106    
107  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
108  libpcre and libpcreposix, a test program called pcretest, and the pgrep  libpcre and libpcreposix, a test program called pcretest, and the pcregrep
109  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
110  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
111    your system, in the normal way.
112    
113  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
114  to recall information about the PCRE configuration and installation. For  to recall information about the PCRE configuration and installation. For
# Line 47  included in makefiles for programs that Line 125  included in makefiles for programs that
125  having to remember too many details.  having to remember too many details.
126    
127    
128  Shared libraries on Unix systems  Shared libraries on Unix-like systems
129  --------------------------------  -------------------------------------
130    
131  The default distribution builds PCRE as two shared libraries. This support is  The default distribution builds PCRE as two shared libraries and two static
132  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
133  "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
134  "libtool" script and use this to compile and link shared libraries, which are  "configure" process.
135  placed in a subdirectory called .libs. The programs pcretest and pgrep are  
136  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
137  use "make install" to install shared libraries, pgrep and pcretest are  libraries. They are placed in a subdirectory called .libs when they are newly
138  automatically re-built to use the newly installed libraries. However, only  built. The programs pcretest and pcregrep are built to use these uninstalled
139  pgrep is installed, as pcretest is really just a test program.  libraries (by means of wrapper scripts in the case of shared libraries). When
140    you use "make install" to install shared libraries, pcregrep and pcretest are
141    automatically re-built to use the newly installed shared libraries before being
142    installed themselves. However, the versions left in the source directory still
143    use the uninstalled libraries.
144    
145  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
146  configuring it. For example  configuring it. For example
147    
148  ./configure --prefix=/usr/gnu --disable-shared  ./configure --prefix=/usr/gnu --disable-shared
149    
150  Then run "make" in the usual way.  Then run "make" in the usual way. Similarly, you can use --disable-static to
151    build only shared libraries.
152    
153    
154    Cross-compiling on a Unix-like system
155    -------------------------------------
156    
157    You can specify CC and CFLAGS in the normal way to the "configure" command, in
158    order to cross-compile PCRE for some other host. However, during the building
159    process, the dftables.c source file is compiled *and run* on the local host, in
160    order to generate the default character tables (the chartables.c file). It
161    therefore needs to be compiled with the local compiler, not the cross compiler.
162    You can do this by specifying HOST_CC (and if necessary HOST_CFLAGS) when
163    calling the "configure" command. If they are not specified, they default to the
164    values of CC and CFLAGS.
165    
166    
167  Building on non-Unix systems  Building on non-Unix systems
# Line 81  Standard C functions. Line 177  Standard C functions.
177  Testing PCRE  Testing PCRE
178  ------------  ------------
179    
180  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
181  (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
182  see the instruction in NON-UNIX-USE.  "make test".) For other systems, see the instruction in NON-UNIX-USE.
183    
184  The script runs the pcretest test program (which is documented in  The script runs the pcretest test program (which is documented in its own man
185  doc/pcretest.txt) on each of the testinput files (in the testdata directory) in  page) on each of the testinput files (in the testdata directory) in turn,
186  turn, and compares the output with the contents of the corresponding testoutput  and compares the output with the contents of the corresponding testoutput file.
187  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
188  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
189  RunTest, for example:  example:
190    
191    RunTest 3    RunTest 2
192    
193  The first and third test files can also be fed directly into the perltest  The first file can also be fed directly into the perltest script to check that
194  script to check that Perl gives the same results. The third file requires the  Perl gives the same results. The only difference you should see is in the first
195  additional features of release 5.005, which is why it is kept separate from the  few lines, where the Perl version is given instead of the PCRE version.
196  main test input, which needs only Perl 5.004. In the long run, when 5.005 is  
197  widespread, these two test files may get amalgamated.  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
198    pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
199  The second set of tests check pcre_info(), pcre_study(), pcre_copy_substring(),  detection, and run-time flags that are specific to PCRE, as well as the POSIX
200  pcre_get_substring(), pcre_get_substring_list(), error detection and run-time  wrapper API. It also uses the debugging flag to check some of the internals of
201  flags that are specific to PCRE, as well as the POSIX wrapper API.  pcre_compile().
202    
203    If you build PCRE with a locale setting that is not the standard C locale, the
204    character tables may be different (see next paragraph). In some cases, this may
205    cause failures in the second set of tests. For example, in a locale where the
206    isprint() function yields TRUE for characters in the range 128-255, the use of
207    [:isascii:] inside a character class defines a different set of characters, and
208    this shows up in this test as a difference in the compiled code, which is being
209    listed for checking. Where the comparison test output contains [\x00-\x7f] the
210    test will contain [\x00-\xff], and similarly in some other cases. This is not a
211    bug in PCRE.
212    
213  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
214  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
215  default tables. The tests make use of the "fr" (French) locale. Before running  default tables. The tests make use of the "fr" (French) locale. Before running
216  the test, the script checks for the presence of this locale by running the  the test, the script checks for the presence of this locale by running the
217  "locale" command. If that command fails, or if it doesn't include "fr" in the  "locale" command. If that command fails, or if it doesn't include "fr" in the
218  list of available locales, the fourth test cannot be run, and a comment is  list of available locales, the third test cannot be run, and a comment is
219  output to say why. If running this test produces instances of the error  output to say why. If running this test produces instances of the error
220    
221    ** Failed to set locale "fr"    ** Failed to set locale "fr"
# Line 117  output to say why. If running this test Line 223  output to say why. If running this test
223  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,
224  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.
225    
226  PCRE has its own native API, but a set of "wrapper" functions that are based on  The fourth test checks the UTF-8 support. It is not run automatically unless
227  the POSIX API are also supplied in the library libpcreposix.a. Note that this  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when
228  just provides a POSIX calling interface to PCRE: the regular expressions  running "configure". This file can be also fed directly to the perltest script,
229  themselves still follow Perl syntax and semantics. The header file  provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,
230  for the POSIX-style functions is called pcreposix.h. The official POSIX name is  commented in the script, can be be used.)
231  regex.h, but I didn't want to risk possible problems with existing files of  
232  that name by distributing it that way. To use it with an existing program that  The fifth and final file tests error handling with UTF-8 encoding, and internal
233  uses the POSIX API, it will have to be renamed or pointed at by a link.  UTF-8 features of PCRE that are not relevant to Perl.
234    
235    
236  Character tables  Character tables
# Line 180  The distribution should contain the foll Line 286  The distribution should contain the foll
286    study.c               ) source of    study.c               ) source of
287    pcre.c                )   the functions    pcre.c                )   the functions
288    pcreposix.c           )    pcreposix.c           )
289      printint.c            )
290    pcre.in               "source" for the header for the external API; pcre.h    pcre.in               "source" for the header for the external API; pcre.h
291                            is built from this by "configure"                            is built from this by "configure"
292    pcreposix.h           header for the external POSIX wrapper API    pcreposix.h           header for the external POSIX wrapper API
# Line 197  The distribution should contain the foll Line 304  The distribution should contain the foll
304    NEWS                  important changes in this release    NEWS                  important changes in this release
305    NON-UNIX-USE          notes on building PCRE on non-Unix systems    NON-UNIX-USE          notes on building PCRE on non-Unix systems
306    README                this file    README                this file
307    RunTest               a Unix shell script for running tests    RunTest.in            template for a Unix shell script for running tests
308    config.guess          ) files used by libtool,    config.guess          ) files used by libtool,
309    config.sub            )   used only when building a shared library    config.sub            )   used only when building a shared library
310    configure             a configuring shell script (built by autoconf)    configure             a configuring shell script (built by autoconf)
311    configure.in          the autoconf input used to build configure    configure.in          the autoconf input used to build configure
312    doc/Tech.Notes        notes on the encoding    doc/Tech.Notes        notes on the encoding
313    doc/pcre.3            man page source for the PCRE functions    doc/*.3               man page sources for the PCRE functions
314    doc/pcre.html         HTML version    doc/*.1               man page sources for pcregrep and pcretest
315    doc/pcre.txt          plain text version    doc/html/*            HTML documentation
316    doc/pcreposix.3       man page source for the POSIX wrapper API    doc/pcre.txt          plain text version of the man pages
317    doc/pcreposix.html    HTML version    doc/pcretest.txt      plain text documentation of test program
318    doc/pcreposix.txt     plain text version    doc/perltest.txt      plain text documentation of Perl test program
   doc/pcretest.txt      documentation of test program  
   doc/perltest.txt      documentation of Perl test program  
   doc/pgrep.1           man page source for the pgrep utility  
   doc/pgrep.html        HTML version  
   doc/pgrep.txt         plain text version  
319    install-sh            a shell script for installing files    install-sh            a shell script for installing files
320    ltconfig              ) files used to build "libtool",    ltmain.sh             file used to build a libtool script
321    ltmain.sh             )   used only when building a shared library    pcretest.c            comprehensive test program
322    pcretest.c            test program    pcredemo.c            simple demonstration of coding calls to PCRE
323    perltest              Perl test program    perltest              Perl test program
324    pgrep.c               source of a grep utility that uses PCRE    pcregrep.c            source of a grep utility that uses PCRE
325    pcre-config.in        source of script which retains PCRE information    pcre-config.in        source of script which retains PCRE information
326    testdata/testinput1   test data, compatible with Perl 5.004 and 5.005    testdata/testinput1   test data, compatible with Perl
327    testdata/testinput2   test data for error messages and non-Perl things    testdata/testinput2   test data for error messages and non-Perl things
328    testdata/testinput3   test data, compatible with Perl 5.005    testdata/testinput3   test data for locale-specific tests
329    testdata/testinput4   test data for locale-specific tests    testdata/testinput4   test data for UTF-8 tests compatible with Perl
330      testdata/testinput5   test data for other UTF-8 tests
331    testdata/testoutput1  test results corresponding to testinput1    testdata/testoutput1  test results corresponding to testinput1
332    testdata/testoutput2  test results corresponding to testinput2    testdata/testoutput2  test results corresponding to testinput2
333    testdata/testoutput3  test results corresponding to testinput3    testdata/testoutput3  test results corresponding to testinput3
334    testdata/testoutput4  test results corresponding to testinput4    testdata/testoutput4  test results corresponding to testinput4
335      testdata/testoutput5  test results corresponding to testinput5
336    
337  (C) Auxiliary files for Win32 DLL  (C) Auxiliary files for Win32 DLL
338    
339    dll.mk    dll.mk
340    pcre.def    pcre.def
341    
342    (D) Auxiliary file for VPASCAL
343    
344      makevp.bat
345    
346  Philip Hazel <ph10@cam.ac.uk>  Philip Hazel <ph10@cam.ac.uk>
347  February 2000  February 2003

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

  ViewVC Help
Powered by ViewVC 1.1.5