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

Diff of /code/trunk/README

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

revision 53 by nigel, Sat Feb 24 21:39:42 2007 UTC revision 75 by nigel, Sat Feb 24 21:40:37 2007 UTC
# Line 16  regex.h, but I didn't want to risk possi Line 16  regex.h, but I didn't want to risk possi
16  that name by distributing it that way. To use it with an existing program that  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.  uses the POSIX API, it will have to be renamed or pointed at by a link.
18    
19    If you are using the POSIX interface to PCRE and there is already a POSIX regex
20    library installed on your system, you must take care when linking programs to
21    ensure that they link with PCRE's libpcreposix library. Otherwise they may pick
22    up the "real" POSIX functions of the same name.
23    
24    
25    Documentation for PCRE
26    ----------------------
27    
28    If you install PCRE in the normal way, you will end up with an installed set of
29    man pages whose names all start with "pcre". The one that is called "pcre"
30    lists all the others. In addition to these man pages, the PCRE documentation is
31    supplied in two other forms; however, as there is no standard place to install
32    them, they are left in the doc directory of the unpacked source distribution.
33    These forms are:
34    
35      1. Files called doc/pcre.txt, doc/pcregrep.txt, and doc/pcretest.txt. The
36         first of these is a concatenation of the text forms of all the section 3
37         man pages except those that summarize individual functions. The other two
38         are the text forms of the section 1 man pages for the pcregrep and
39         pcretest commands. Text forms are provided for ease of scanning with text
40         editors or similar tools.
41    
42      2. A subdirectory called doc/html contains all the documentation in HTML
43         form, hyperlinked in various ways, and rooted in a file called
44         doc/index.html.
45    
46    
47  Contributions by users of PCRE  Contributions by users of PCRE
48  ------------------------------  ------------------------------
# Line 30  Windows systems (I myself do not use Win Line 57  Windows systems (I myself do not use Win
57  others are pointers to URLs containing relevant files.  others are pointers to URLs containing relevant files.
58    
59    
60  Building PCRE on a Unix system  Building PCRE on a Unix-like system
61  ------------------------------  -----------------------------------
62    
63  To build PCRE on a Unix system, first run the "configure" command from the PCRE  To build PCRE on a Unix-like system, first run the "configure" command from the
64  distribution directory, with your current directory set to the directory where  PCRE distribution directory, with your current directory set to the directory
65  you want the files to be created. This command is a standard GNU "autoconf"  where you want the files to be created. This command is a standard GNU
66  configuration script, for which generic instructions are supplied in INSTALL.  "autoconf" configuration script, for which generic instructions are supplied in
67    INSTALL.
68    
69  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
70  this case, on many systems, just running "./configure" is sufficient, but the  this case, on many systems, just running "./configure" is sufficient, but the
71  usual methods of changing standard defaults are available. For example,  usual methods of changing standard defaults are available. For example:
72    
73  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
74    
# Line 55  into /source/pcre/pcre-xxx, but you want Line 83  into /source/pcre/pcre-xxx, but you want
83  cd /build/pcre/pcre-xxx  cd /build/pcre/pcre-xxx
84  /source/pcre/pcre-xxx/configure  /source/pcre/pcre-xxx/configure
85    
86  If you want to make use of the experimential, incomplete support for UTF-8  There are some optional features that can be included or omitted from the PCRE
87  character strings in PCRE, you must add --enable-utf8 to the "configure"  library. You can read more about them in the pcrebuild man page.
 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.)  
88    
89  The "configure" script builds five files:  . If you want to make use of the support for UTF-8 character strings in PCRE,
90      you must add --enable-utf8 to the "configure" command. Without it, the code
91      for handling UTF-8 is not included in the library. (Even when included, it
92      still has to be enabled by an option at run time.)
93    
94    . If, in addition to support for UTF-8 character strings, you want to include
95      support for the \P, \p, and \X sequences that recognize Unicode character
96      properties, you must add --enable-unicode-properties to the "configure"
97      command. This adds about 90K to the size of the library (in the form of a
98      property table); only the basic two-letter properties such as Lu are
99      supported.
100    
101    . You can build PCRE to recognized CR or NL as the newline character, instead
102      of whatever your compiler uses for "\n", by adding --newline-is-cr or
103      --newline-is-nl to the "configure" command, respectively. Only do this if you
104      really understand what you are doing. On traditional Unix-like systems, the
105      newline character is NL.
106    
107    . When called via the POSIX interface, PCRE uses malloc() to get additional
108      storage for processing capturing parentheses if there are more than 10 of
109      them. You can increase this threshold by setting, for example,
110    
111      --with-posix-malloc-threshold=20
112    
113      on the "configure" command.
114    
115    . PCRE has a counter which can be set to limit the amount of resources it uses.
116      If the limit is exceeded during a match, the match fails. The default is ten
117      million. You can change the default by setting, for example,
118    
119      --with-match-limit=500000
120    
121      on the "configure" command. This is just the default; individual calls to
122      pcre_exec() can supply their own value. There is discussion on the pcreapi
123      man page.
124    
125    . The default maximum compiled pattern size is around 64K. You can increase
126      this by adding --with-link-size=3 to the "configure" command. You can
127      increase it even more by setting --with-link-size=4, but this is unlikely
128      ever to be necessary. If you build PCRE with an increased link size, test 2
129      (and 5 if you are using UTF-8) will fail. Part of the output of these tests
130      is a representation of the compiled pattern, and this changes with the link
131      size.
132    
133    . You can build PCRE so that its match() function does not call itself
134      recursively. Instead, it uses blocks of data from the heap via special
135      functions pcre_stack_malloc() and pcre_stack_free() to save data that would
136      otherwise be saved on the stack. To build PCRE like this, use
137    
138  . libtool is a script that builds shared and/or static libraries    --disable-stack-for-recursion
139    
140      on the "configure" command. PCRE runs more slowly in this mode, but it may be
141      necessary in environments with limited stack sizes.
142    
143    The "configure" script builds seven files:
144    
145    . pcre.h is build by copying pcre.in and making substitutions
146  . Makefile is built by copying Makefile.in and making substitutions.  . Makefile is built by copying Makefile.in and making substitutions.
147  . config.h is built by copying config.in and making substitutions.  . config.h is built by copying config.in and making substitutions.
148  . pcre-config is built by copying pcre-config.in and making substitutions.  . pcre-config is built by copying pcre-config.in and making substitutions.
149    . libpcre.pc is data for the pkg-config command, built from libpcre.pc.in
150    . libtool is a script that builds shared and/or static libraries
151  . RunTest is a script for running tests  . RunTest is a script for running tests
152    
153  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
# Line 75  command. You can use "make install" to c Line 156  command. You can use "make install" to c
156  pcre.h and pcreposix.h, and the man pages to appropriate live directories on  pcre.h and pcreposix.h, and the man pages to appropriate live directories on
157  your system, in the normal way.  your system, in the normal way.
158    
159    
160    Retrieving configuration information on Unix-like systems
161    ---------------------------------------------------------
162    
163  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
164  to recall information about the PCRE configuration and installation. For  to recall information about the PCRE configuration and installation. For
165  example,  example:
166    
167    pcre-config --version    pcre-config --version
168    
169  prints the version number, and  prints the version number, and
170    
171   pcre-config --libs    pcre-config --libs
172    
173  outputs information about where the library is installed. This command can be  outputs information about where the library is installed. This command can be
174  included in makefiles for programs that use PCRE, saving the programmer from  included in makefiles for programs that use PCRE, saving the programmer from
175  having to remember too many details.  having to remember too many details.
176    
177  There is one esoteric feature that is controlled by "configure". It concerns  The pkg-config command is another system for saving and retrieving information
178  the character value used for "newline", and is something that you probably do  about installed libraries. Instead of separate commands for each library, a
179  not want to change on a Unix system. The default is to use whatever value your  single command is used. For example:
180  compiler gives to '\n'. By using --enable-newline-is-cr or  
181  --enable-newline-is-lf you can force the value to be CR (13) or LF (10) if you    pkg-config --cflags pcre
182  really want to.  
183    The data is held in *.pc files that are installed in a directory called
184    pkgconfig.
185    
186    
187  Shared libraries on Unix systems  Shared libraries on Unix-like systems
188  --------------------------------  -------------------------------------
189    
190  The default distribution builds PCRE as two shared libraries and two static  The default distribution builds PCRE as two shared libraries and two static
191  libraries, as long as the operating system supports shared libraries. Shared  libraries, as long as the operating system supports shared libraries. Shared
# Line 115  installed themselves. However, the versi Line 202  installed themselves. However, the versi
202  use the uninstalled libraries.  use the uninstalled libraries.
203    
204  To build PCRE using static libraries only you must use --disable-shared when  To build PCRE using static libraries only you must use --disable-shared when
205  configuring it. For example  configuring it. For example:
206    
207  ./configure --prefix=/usr/gnu --disable-shared  ./configure --prefix=/usr/gnu --disable-shared
208    
# Line 123  Then run "make" in the usual way. Simila Line 210  Then run "make" in the usual way. Simila
210  build only shared libraries.  build only shared libraries.
211    
212    
213    Cross-compiling on a Unix-like system
214    -------------------------------------
215    
216    You can specify CC and CFLAGS in the normal way to the "configure" command, in
217    order to cross-compile PCRE for some other host. However, during the building
218    process, the dftables.c source file is compiled *and run* on the local host, in
219    order to generate the default character tables (the chartables.c file). It
220    therefore needs to be compiled with the local compiler, not the cross compiler.
221    You can do this by specifying CC_FOR_BUILD (and if necessary CFLAGS_FOR_BUILD)
222    when calling the "configure" command. If they are not specified, they default
223    to the values of CC and CFLAGS.
224    
225    
226  Building on non-Unix systems  Building on non-Unix systems
227  ----------------------------  ----------------------------
228    
229  For a non-Unix system, read the comments in the file NON-UNIX-USE. PCRE has  For a non-Unix system, read the comments in the file NON-UNIX-USE, though if
230  been compiled on Windows systems and on Macintoshes, but I don't know the  the system supports the use of "configure" and "make" you may be able to build
231  details because I don't use those systems. It should be straightforward to  PCRE in the same way as for Unix systems.
232    
233    PCRE has been compiled on Windows systems and on Macintoshes, but I don't know
234    the details because I don't use those systems. It should be straightforward to
235  build PCRE on any system that has a Standard C compiler, because it uses only  build PCRE on any system that has a Standard C compiler, because it uses only
236  Standard C functions.  Standard C functions.
237    
# Line 138  Testing PCRE Line 241  Testing PCRE
241    
242  To test PCRE on a Unix system, run the RunTest script that is created by the  To test PCRE on a Unix system, run the RunTest script that is created by the
243  configuring process. (This can also be run by "make runtest", "make check", or  configuring process. (This can also be run by "make runtest", "make check", or
244  "make test".) For other systems, see the instruction in NON-UNIX-USE.  "make test".) For other systems, see the instructions in NON-UNIX-USE.
245    
246  The script runs the pcretest test program (which is documented in the doc  The script runs the pcretest test program (which is documented in its own man
247  directory) on each of the testinput files (in the testdata directory) in turn,  page) on each of the testinput files (in the testdata directory) in turn,
248  and compares the output with the contents of the corresponding testoutput file.  and compares the output with the contents of the corresponding testoutput file.
249  A file called testtry is used to hold the output from pcretest. To run pcretest  A file called testtry is used to hold the main output from pcretest
250  on just one of the test files, give its number as an argument to RunTest, for  (testsavedregex is also used as a working file). To run pcretest on just one of
251  example:  the test files, give its number as an argument to RunTest, for example:
252    
253    RunTest 3    RunTest 2
254    
255  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
256  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
257  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.  
258    
259  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
260  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
# Line 171  listed for checking. Where the compariso Line 272  listed for checking. Where the compariso
272  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
273  bug in PCRE.  bug in PCRE.
274    
275  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
276  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
277  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
278  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
279  "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"
280  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
281  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
282    
283    ** Failed to set locale "fr"    ** Failed to set locale "fr_FR"
284    
285  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,
286  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.
287    
288  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
289  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
290  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,
291  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,
292    commented in the script, can be be used.)
293    
294    The fifth test checks error handling with UTF-8 encoding, and internal UTF-8
295    features of PCRE that are not relevant to Perl.
296    
297    The sixth and final test checks the support for Unicode character properties.
298    It it not run automatically unless PCRE is built with Unicode property support.
299    To to this you must set --enable-unicode-properties when running "configure".
300    
301    
302  Character tables  Character tables
303  ----------------  ----------------
304    
305  PCRE uses four tables for manipulating and identifying characters. The final  PCRE uses four tables for manipulating and identifying characters whose values
306  argument of the pcre_compile() function is a pointer to a block of memory  are less than 256. The final argument of the pcre_compile() function is a
307  containing the concatenated tables. A call to pcre_maketables() can be used to  pointer to a block of memory containing the concatenated tables. A call to
308  generate a set of tables in the current locale. If the final argument for  pcre_maketables() can be used to generate a set of tables in the current
309  pcre_compile() is passed as NULL, a set of default tables that is built into  locale. If the final argument for pcre_compile() is passed as NULL, a set of
310  the binary is used.  default tables that is built into the binary is used.
311    
312  The source file called chartables.c contains the default set of tables. This is  The source file called chartables.c contains the default set of tables. This is
313  not supplied in the distribution, but is built by the program dftables  not supplied in the distribution, but is built by the program dftables
# Line 238  The distribution should contain the foll Line 347  The distribution should contain the foll
347      headers:      headers:
348    
349    dftables.c            auxiliary program for building chartables.c    dftables.c            auxiliary program for building chartables.c
350    
351    get.c                 )    get.c                 )
352    maketables.c          )    maketables.c          )
353    study.c               ) source of    study.c               ) source of the functions
354    pcre.c                )   the functions    pcre.c                )   in the library
355    pcreposix.c           )    pcreposix.c           )
356      printint.c            )
357    
358      ucp.c                 )
359      ucp.h                 ) source for the code that is used for
360      ucpinternal.h         )   Unicode property handling
361      ucptable.c            )
362      ucptypetable.c        )
363    
364    pcre.in               "source" for the header for the external API; pcre.h    pcre.in               "source" for the header for the external API; pcre.h
365                            is built from this by "configure"                            is built from this by "configure"
366    pcreposix.h           header for the external POSIX wrapper API    pcreposix.h           header for the external POSIX wrapper API
# Line 266  The distribution should contain the foll Line 384  The distribution should contain the foll
384    configure             a configuring shell script (built by autoconf)    configure             a configuring shell script (built by autoconf)
385    configure.in          the autoconf input used to build configure    configure.in          the autoconf input used to build configure
386    doc/Tech.Notes        notes on the encoding    doc/Tech.Notes        notes on the encoding
387    doc/pcre.3            man page source for the PCRE functions    doc/*.3               man page sources for the PCRE functions
388    doc/pcre.html         HTML version    doc/*.1               man page sources for pcregrep and pcretest
389    doc/pcre.txt          plain text version    doc/html/*            HTML documentation
390    doc/pcreposix.3       man page source for the POSIX wrapper API    doc/pcre.txt          plain text version of the man pages
391    doc/pcreposix.html    HTML version    doc/pcretest.txt      plain text documentation of test program
392    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  
393    install-sh            a shell script for installing files    install-sh            a shell script for installing files
394      libpcre.pc.in         "source" for libpcre.pc for pkg-config
395    ltmain.sh             file used to build a libtool script    ltmain.sh             file used to build a libtool script
396      mkinstalldirs         script for making install directories
397    pcretest.c            comprehensive test program    pcretest.c            comprehensive test program
398    pcredemo.c            simple demonstration of coding calls to PCRE    pcredemo.c            simple demonstration of coding calls to PCRE
399    perltest              Perl test program    perltest              Perl test program
   perltest8             Perl test program for UTF-8 tests  
400    pcregrep.c            source of a grep utility that uses PCRE    pcregrep.c            source of a grep utility that uses PCRE
401    pcre-config.in        source of script which retains PCRE information    pcre-config.in        source of script which retains PCRE information
402    testdata/testinput1   test data, compatible with Perl 5.004 and 5.005    testdata/testinput1   test data, compatible with Perl
403    testdata/testinput2   test data for error messages and non-Perl things    testdata/testinput2   test data for error messages and non-Perl things
404    testdata/testinput3   test data, compatible with Perl 5.005    testdata/testinput3   test data for locale-specific tests
405    testdata/testinput4   test data for locale-specific tests    testdata/testinput4   test data for UTF-8 tests compatible with Perl
406    testdata/testinput5   test data for UTF-8 tests compatible with Perl 5.6    testdata/testinput5   test data for other UTF-8 tests
407    testdata/testinput6   test data for other UTF-8 tests    testdata/testinput6   test data for Unicode property support tests
408    testdata/testoutput1  test results corresponding to testinput1    testdata/testoutput1  test results corresponding to testinput1
409    testdata/testoutput2  test results corresponding to testinput2    testdata/testoutput2  test results corresponding to testinput2
410    testdata/testoutput3  test results corresponding to testinput3    testdata/testoutput3  test results corresponding to testinput3
# Line 301  The distribution should contain the foll Line 415  The distribution should contain the foll
415  (C) Auxiliary files for Win32 DLL  (C) Auxiliary files for Win32 DLL
416    
417    dll.mk    dll.mk
418      libpcre.def
419      libpcreposix.def
420    pcre.def    pcre.def
421    
422    (D) Auxiliary file for VPASCAL
423    
424      makevp.bat
425    
426  Philip Hazel <ph10@cam.ac.uk>  Philip Hazel <ph10@cam.ac.uk>
427  August 2001  September 2004

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

  ViewVC Help
Powered by ViewVC 1.1.5