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

Diff of /code/trunk/README

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

revision 49 by nigel, Sat Feb 24 21:39:33 2007 UTC revision 65 by nigel, Sat Feb 24 21:40:08 2007 UTC
# Line 17  that name by distributing it that way. T Line 17  that name by distributing it that way. T
17  uses the POSIX API, it will have to be renamed or pointed at by a link.  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    
# Line 32  specifies that the C compiler should be Line 49  specifies that the C compiler should be
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.  instead of the default /usr/local.
51    
52  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
53  character strings in PCRE, you must add --enable-utf8 to the "configure"  directory as current. For example, suppose you have unpacked the PCRE source
54  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:
55  library. (Even when included, it still has to be enabled by an option at run  
56  time.)  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  The "configure" script builds four files:    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.
# Line 47  The "configure" script builds four files Line 106  The "configure" script builds four files
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 pcregrep  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 65  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  Cross-compiling PCRE on a Unix-like system
129  --------------------------------  ------------------------------------------
130    
131  The default distribution builds PCRE as two shared libraries. This support is  PCRE needs to compile and run an auxiliary program as part of the building
132  new and experimental and may not work on all systems. It relies on the  process. Obviously, if the real compilation is for some other system, it can't
133  "libtool" scripts - these are distributed with PCRE. It should build a  use the same CC and CFLAGS values when it is doing this. For cross compilation,
134  "libtool" script and use this to compile and link shared libraries, which are  therefore, you must set CC_FOR_BUILD to the local host's compiler, and you can
135  placed in a subdirectory called .libs. The programs pcretest and pcregrep are  set flags in CFLAGS_FOR_BUILD if you need to.
136  built to use these uninstalled libraries by means of wrapper scripts. When you  
137  use "make install" to install shared libraries, pcregrep and pcretest are  
138  automatically re-built to use the newly installed libraries. However, only  Shared libraries on Unix-like systems
139  pcregrep is installed, as pcretest is really just a test program.  -------------------------------------
140    
141    The default distribution builds PCRE as two shared libraries and two static
142    libraries, as long as the operating system supports shared libraries. Shared
143    library support relies on the "libtool" script which is built as part of the
144    "configure" process.
145    
146    The libtool script is used to compile and link both shared and static
147    libraries. They are placed in a subdirectory called .libs when they are newly
148    built. The programs pcretest and pcregrep are built to use these uninstalled
149    libraries (by means of wrapper scripts in the case of shared libraries). When
150    you use "make install" to install shared libraries, pcregrep and pcretest are
151    automatically re-built to use the newly installed shared libraries before being
152    installed themselves. However, the versions left in the source directory still
153    use the uninstalled libraries.
154    
155  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
156  configuring it. For example  configuring it. For example
157    
158  ./configure --prefix=/usr/gnu --disable-shared  ./configure --prefix=/usr/gnu --disable-shared
159    
160  Then run "make" in the usual way.  Then run "make" in the usual way. Similarly, you can use --disable-static to
161    build only shared libraries.
162    
163    
164    Cross-compiling on a Unix-like system
165    -------------------------------------
166    
167    You can specify CC and CFLAGS in the normal way to the "configure" command, in
168    order to cross-compile PCRE for some other host. However, during the building
169    process, the dftables.c source file is compiled *and run* on the local host, in
170    order to generate the default character tables (the chartables.c file). It
171    therefore needs to be compiled with the local compiler, not the cross compiler.
172    You can do this by specifying HOST_CC (and if necessary HOST_CFLAGS) when
173    calling the "configure" command. If they are not specified, they default to the
174    values of CC and CFLAGS.
175    
176    
177  Building on non-Unix systems  Building on non-Unix systems
# Line 99  Standard C functions. Line 187  Standard C functions.
187  Testing PCRE  Testing PCRE
188  ------------  ------------
189    
190  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
191  (This can also be run by "make runtest", "make check", or "make test".) For  configuring process. (This can also be run by "make runtest", "make check", or
192  other systems, see the instruction in NON-UNIX-USE.  "make test".) For other systems, see the instruction in NON-UNIX-USE.
193    
194  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
195  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,
196  turn, and compares the output with the contents of the corresponding testoutput  and compares the output with the contents of the corresponding testoutput file.
197  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
198  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
199  RunTest, for example:  example:
200    
201    RunTest 3    RunTest 2
202    
203  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
204  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
205  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.
 main test input, which needs only Perl 5.004. In the long run, when 5.005 (or  
 higher) is widespread, these two test files may get amalgamated.  
206    
207  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
208  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
# Line 134  listed for checking. Where the compariso Line 220  listed for checking. Where the compariso
220  test will contain [\x00-\xff], and similarly in some other cases. This is not a  test will contain [\x00-\xff], and similarly in some other cases. This is not a
221  bug in PCRE.  bug in PCRE.
222    
223  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
224  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
225  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
226  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
227  "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
228  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
229  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
230    
231    ** Failed to set locale "fr"    ** Failed to set locale "fr"
# Line 147  output to say why. If running this test Line 233  output to say why. If running this test
233  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,
234  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.
235    
236  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
237  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
238  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,
239  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,
240    commented in the script, can be be used.)
241    
242    The fifth and final file tests error handling with UTF-8 encoding, and internal
243    UTF-8 features of PCRE that are not relevant to Perl.
244    
245    
246  Character tables  Character tables
# Line 206  The distribution should contain the foll Line 296  The distribution should contain the foll
296    study.c               ) source of    study.c               ) source of
297    pcre.c                )   the functions    pcre.c                )   the functions
298    pcreposix.c           )    pcreposix.c           )
299      printint.c            )
300    pcre.in               "source" for the header for the external API; pcre.h    pcre.in               "source" for the header for the external API; pcre.h
301                            is built from this by "configure"                            is built from this by "configure"
302    pcreposix.h           header for the external POSIX wrapper API    pcreposix.h           header for the external POSIX wrapper API
# Line 229  The distribution should contain the foll Line 320  The distribution should contain the foll
320    configure             a configuring shell script (built by autoconf)    configure             a configuring shell script (built by autoconf)
321    configure.in          the autoconf input used to build configure    configure.in          the autoconf input used to build configure
322    doc/Tech.Notes        notes on the encoding    doc/Tech.Notes        notes on the encoding
323    doc/pcre.3            man page source for the PCRE functions    doc/*.3               man page sources for the PCRE functions
324    doc/pcre.html         HTML version    doc/*.1               man page sources for pcregrep and pcretest
325    doc/pcre.txt          plain text version    doc/html/*            HTML documentation
326    doc/pcreposix.3       man page source for the POSIX wrapper API    doc/pcre.txt          plain text version of the man pages
327    doc/pcreposix.html    HTML version    doc/pcretest.txt      plain text documentation of test program
328    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/pcregrep.1        man page source for the pcregrep utility  
   doc/pcregrep.html     HTML version  
   doc/pcregrep.txt      plain text version  
329    install-sh            a shell script for installing files    install-sh            a shell script for installing files
330    ltconfig              ) files used to build "libtool",    ltmain.sh             file used to build a libtool script
331    ltmain.sh             )   used only when building a shared library    pcretest.c            comprehensive test program
332    pcretest.c            test program    pcredemo.c            simple demonstration of coding calls to PCRE
333    perltest              Perl test program    perltest              Perl test program
   perltest8             Perl test program for UTF-8 tests  
334    pcregrep.c            source of a grep utility that uses PCRE    pcregrep.c            source of a grep utility that uses PCRE
335    pcre-config.in        source of script which retains PCRE information    pcre-config.in        source of script which retains PCRE information
336    testdata/testinput1   test data, compatible with Perl 5.004 and 5.005    testdata/testinput1   test data, compatible with Perl
337    testdata/testinput2   test data for error messages and non-Perl things    testdata/testinput2   test data for error messages and non-Perl things
338    testdata/testinput3   test data, compatible with Perl 5.005    testdata/testinput3   test data for locale-specific tests
339    testdata/testinput4   test data for locale-specific tests    testdata/testinput4   test data for UTF-8 tests compatible with Perl
340    testdata/testinput5   test data for UTF-8 tests compatible with Perl 5.6    testdata/testinput5   test data for other UTF-8 tests
   testdata/testinput6   test data for other UTF-8 tests  
341    testdata/testoutput1  test results corresponding to testinput1    testdata/testoutput1  test results corresponding to testinput1
342    testdata/testoutput2  test results corresponding to testinput2    testdata/testoutput2  test results corresponding to testinput2
343    testdata/testoutput3  test results corresponding to testinput3    testdata/testoutput3  test results corresponding to testinput3
344    testdata/testoutput4  test results corresponding to testinput4    testdata/testoutput4  test results corresponding to testinput4
345    testdata/testoutput5  test results corresponding to testinput5    testdata/testoutput5  test results corresponding to testinput5
   testdata/testoutput6  test results corresponding to testinput6  
346    
347  (C) Auxiliary files for Win32 DLL  (C) Auxiliary files for Win32 DLL
348    
349    dll.mk    dll.mk
350    pcre.def    pcre.def
351    
352    (D) Auxiliary file for VPASCAL
353    
354      makevp.bat
355    
356  Philip Hazel <ph10@cam.ac.uk>  Philip Hazel <ph10@cam.ac.uk>
357  August 2000  February 2003

Legend:
Removed from v.49  
changed lines
  Added in v.65

  ViewVC Help
Powered by ViewVC 1.1.5