/[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 73 by nigel, Sat Feb 24 21:40:30 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  Contributions by users of PCRE  Contributions by users of PCRE
26  ------------------------------  ------------------------------
# Line 30  Windows systems (I myself do not use Win Line 35  Windows systems (I myself do not use Win
35  others are pointers to URLs containing relevant files.  others are pointers to URLs containing relevant files.
36    
37    
38  Building PCRE on a Unix system  Building PCRE on a Unix-like system
39  ------------------------------  -----------------------------------
40    
41  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
42  distribution directory, with your current directory set to the directory where  PCRE distribution directory, with your current directory set to the directory
43  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
44  configuration script, for which generic instructions are supplied in INSTALL.  "autoconf" configuration script, for which generic instructions are supplied in
45    INSTALL.
46    
47  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
48  this case, on many systems, just running "./configure" is sufficient, but the  this case, on many systems, just running "./configure" is sufficient, but the
# Line 55  into /source/pcre/pcre-xxx, but you want Line 61  into /source/pcre/pcre-xxx, but you want
61  cd /build/pcre/pcre-xxx  cd /build/pcre/pcre-xxx
62  /source/pcre/pcre-xxx/configure  /source/pcre/pcre-xxx/configure
63    
64  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
65  character strings in PCRE, you must add --enable-utf8 to the "configure"  library. You can read more about them in the pcrebuild man page.
66  command. Without it, the code for handling UTF-8 is not included in the  
67  library. (Even when included, it still has to be enabled by an option at run  . If you want to make use of the support for UTF-8 character strings in PCRE,
68  time.)    you must add --enable-utf8 to the "configure" command. Without it, the code
69      for handling UTF-8 is not included in the library. (Even when included, it
70      still has to be enabled by an option at run time.)
71    
72    . You can build PCRE to recognized CR or NL as the newline character, instead
73      of whatever your compiler uses for "\n", by adding --newline-is-cr or
74      --newline-is-nl to the "configure" command, respectively. Only do this if you
75      really understand what you are doing. On traditional Unix-like systems, the
76      newline character is NL.
77    
78    . When called via the POSIX interface, PCRE uses malloc() to get additional
79      storage for processing capturing parentheses if there are more than 10 of
80      them. You can increase this threshold by setting, for example,
81    
82      --with-posix-malloc-threshold=20
83    
84      on the "configure" command.
85    
86    . PCRE has a counter which can be set to limit the amount of resources it uses.
87      If the limit is exceeded during a match, the match fails. The default is ten
88      million. You can change the default by setting, for example,
89    
90      --with-match-limit=500000
91    
92      on the "configure" command. This is just the default; individual calls to
93      pcre_exec() can supply their own value. There is discussion on the pcreapi
94      man page.
95    
96    . The default maximum compiled pattern size is around 64K. You can increase
97      this by adding --with-link-size=3 to the "configure" command. You can
98      increase it even more by setting --with-link-size=4, but this is unlikely
99      ever to be necessary. If you build PCRE with an increased link size, test 2
100      (and 5 if you are using UTF-8) will fail. Part of the output of these tests
101      is a representation of the compiled pattern, and this changes with the link
102      size.
103    
104    . You can build PCRE so that its match() function does not call itself
105      recursively. Instead, it uses blocks of data from the heap via special
106      functions pcre_stack_malloc() and pcre_stack_free() to save data that would
107      otherwise be saved on the stack. To build PCRE like this, use
108    
109      --disable-stack-for-recursion
110    
111      on the "configure" command. PCRE runs more slowly in this mode, but it may be
112      necessary in environments with limited stack sizes.
113    
114  The "configure" script builds five files:  The "configure" script builds five files:
115    
# Line 89  outputs information about where the libr Line 139  outputs information about where the libr
139  included in makefiles for programs that use PCRE, saving the programmer from  included in makefiles for programs that use PCRE, saving the programmer from
140  having to remember too many details.  having to remember too many details.
141    
 There is one esoteric feature that is controlled by "configure". It concerns  
 the character value used for "newline", and is something that you probably do  
 not want to change on a Unix system. The default is to use whatever value your  
 compiler gives to '\n'. By using --enable-newline-is-cr or  
 --enable-newline-is-lf you can force the value to be CR (13) or LF (10) if you  
 really want to.  
   
142    
143  Shared libraries on Unix systems  Shared libraries on Unix-like systems
144  --------------------------------  -------------------------------------
145    
146  The default distribution builds PCRE as two shared libraries and two static  The default distribution builds PCRE as two shared libraries and two static
147  libraries, as long as the operating system supports shared libraries. Shared  libraries, as long as the operating system supports shared libraries. Shared
# Line 123  Then run "make" in the usual way. Simila Line 166  Then run "make" in the usual way. Simila
166  build only shared libraries.  build only shared libraries.
167    
168    
169    Cross-compiling on a Unix-like system
170    -------------------------------------
171    
172    You can specify CC and CFLAGS in the normal way to the "configure" command, in
173    order to cross-compile PCRE for some other host. However, during the building
174    process, the dftables.c source file is compiled *and run* on the local host, in
175    order to generate the default character tables (the chartables.c file). It
176    therefore needs to be compiled with the local compiler, not the cross compiler.
177    You can do this by specifying CC_FOR_BUILD (and if necessary CFLAGS_FOR_BUILD)
178    when calling the "configure" command. If they are not specified, they default
179    to the values of CC and CFLAGS.
180    
181    
182  Building on non-Unix systems  Building on non-Unix systems
183  ----------------------------  ----------------------------
184    
185  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
186  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
187  details because I don't use those systems. It should be straightforward to  PCRE in the same way as for Unix systems.
188    
189    PCRE has been compiled on Windows systems and on Macintoshes, but I don't know
190    the details because I don't use those systems. It should be straightforward to
191  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
192  Standard C functions.  Standard C functions.
193    
# Line 138  Testing PCRE Line 197  Testing PCRE
197    
198  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
199  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
200  "make test".) For other systems, see the instruction in NON-UNIX-USE.  "make test".) For other systems, see the instructions in NON-UNIX-USE.
201    
202  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
203  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,
204  and compares the output with the contents of the corresponding testoutput file.  and compares the output with the contents of the corresponding testoutput file.
205  A file called testtry is used to hold the output from pcretest. To run pcretest  A file called testtry is used to hold the output from pcretest. To run pcretest
206  on just one of the test files, give its number as an argument to RunTest, for  on just one of the test files, give its number as an argument to RunTest, for
207  example:  example:
208    
209    RunTest 3    RunTest 2
210    
211  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
212  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
213  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.  
214    
215  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
216  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 228  listed for checking. Where the compariso
228  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
229  bug in PCRE.  bug in PCRE.
230    
231  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
232  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
233  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
234  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
235  "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"
236  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
237  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
238    
239    ** Failed to set locale "fr"    ** Failed to set locale "fr_FR"
240    
241  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,
242  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.
243    
244  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
245  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
246  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,
247  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,
248    commented in the script, can be be used.)
249    
250    The fifth and final file tests error handling with UTF-8 encoding, and internal
251    UTF-8 features of PCRE that are not relevant to Perl.
252    
253    
254  Character tables  Character tables
# Line 243  The distribution should contain the foll Line 304  The distribution should contain the foll
304    study.c               ) source of    study.c               ) source of
305    pcre.c                )   the functions    pcre.c                )   the functions
306    pcreposix.c           )    pcreposix.c           )
307      printint.c            )
308    pcre.in               "source" for the header for the external API; pcre.h    pcre.in               "source" for the header for the external API; pcre.h
309                            is built from this by "configure"                            is built from this by "configure"
310    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 328  The distribution should contain the foll
328    configure             a configuring shell script (built by autoconf)    configure             a configuring shell script (built by autoconf)
329    configure.in          the autoconf input used to build configure    configure.in          the autoconf input used to build configure
330    doc/Tech.Notes        notes on the encoding    doc/Tech.Notes        notes on the encoding
331    doc/pcre.3            man page source for the PCRE functions    doc/*.3               man page sources for the PCRE functions
332    doc/pcre.html         HTML version    doc/*.1               man page sources for pcregrep and pcretest
333    doc/pcre.txt          plain text version    doc/html/*            HTML documentation
334    doc/pcreposix.3       man page source for the POSIX wrapper API    doc/pcre.txt          plain text version of the man pages
335    doc/pcreposix.html    HTML version    doc/pcretest.txt      plain text documentation of test program
336    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  
337    install-sh            a shell script for installing files    install-sh            a shell script for installing files
338    ltmain.sh             file used to build a libtool script    ltmain.sh             file used to build a libtool script
339    pcretest.c            comprehensive test program    pcretest.c            comprehensive test program
340    pcredemo.c            simple demonstration of coding calls to PCRE    pcredemo.c            simple demonstration of coding calls to PCRE
341    perltest              Perl test program    perltest              Perl test program
   perltest8             Perl test program for UTF-8 tests  
342    pcregrep.c            source of a grep utility that uses PCRE    pcregrep.c            source of a grep utility that uses PCRE
343    pcre-config.in        source of script which retains PCRE information    pcre-config.in        source of script which retains PCRE information
344    testdata/testinput1   test data, compatible with Perl 5.004 and 5.005    testdata/testinput1   test data, compatible with Perl
345    testdata/testinput2   test data for error messages and non-Perl things    testdata/testinput2   test data for error messages and non-Perl things
346    testdata/testinput3   test data, compatible with Perl 5.005    testdata/testinput3   test data for locale-specific tests
347    testdata/testinput4   test data for locale-specific tests    testdata/testinput4   test data for UTF-8 tests compatible with Perl
348    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  
349    testdata/testoutput1  test results corresponding to testinput1    testdata/testoutput1  test results corresponding to testinput1
350    testdata/testoutput2  test results corresponding to testinput2    testdata/testoutput2  test results corresponding to testinput2
351    testdata/testoutput3  test results corresponding to testinput3    testdata/testoutput3  test results corresponding to testinput3
352    testdata/testoutput4  test results corresponding to testinput4    testdata/testoutput4  test results corresponding to testinput4
353    testdata/testoutput5  test results corresponding to testinput5    testdata/testoutput5  test results corresponding to testinput5
   testdata/testoutput6  test results corresponding to testinput6  
354    
355  (C) Auxiliary files for Win32 DLL  (C) Auxiliary files for Win32 DLL
356    
357    dll.mk    dll.mk
358    pcre.def    pcre.def
359    
360    (D) Auxiliary file for VPASCAL
361    
362      makevp.bat
363    
364  Philip Hazel <ph10@cam.ac.uk>  Philip Hazel <ph10@cam.ac.uk>
365  August 2001  December 2003

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

  ViewVC Help
Powered by ViewVC 1.1.5