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

Diff of /code/trunk/README

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

revision 65 by nigel, Sat Feb 24 21:40:08 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 41  INSTALL. Line 68  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 64  library. You can read more about them in Line 91  library. You can read more about them in
91    for handling UTF-8 is not included in the library. (Even when included, it    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.)    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  . 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    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    --newline-is-nl to the "configure" command, respectively. Only do this if you
# Line 96  library. You can read more about them in Line 130  library. You can read more about them in
130    is a representation of the compiled pattern, and this changes with the link    is a representation of the compiled pattern, and this changes with the link
131    size.    size.
132    
133  The "configure" script builds five files:  . 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 110  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    The pkg-config command is another system for saving and retrieving information
178    about installed libraries. Instead of separate commands for each library, a
179    single command is used. For example:
180    
181  Cross-compiling PCRE on a Unix-like system    pkg-config --cflags pcre
 ------------------------------------------  
182    
183  PCRE needs to compile and run an auxiliary program as part of the building  The data is held in *.pc files that are installed in a directory called
184  process. Obviously, if the real compilation is for some other system, it can't  pkgconfig.
 use the same CC and CFLAGS values when it is doing this. For cross compilation,  
 therefore, you must set CC_FOR_BUILD to the local host's compiler, and you can  
 set flags in CFLAGS_FOR_BUILD if you need to.  
185    
186    
187  Shared libraries on Unix-like systems  Shared libraries on Unix-like systems
# Line 153  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 169  order to cross-compile PCRE for some oth Line 218  order to cross-compile PCRE for some oth
218  process, the dftables.c source file is compiled *and run* on the local host, in  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  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.  therefore needs to be compiled with the local compiler, not the cross compiler.
221  You can do this by specifying HOST_CC (and if necessary HOST_CFLAGS) when  You can do this by specifying CC_FOR_BUILD (and if necessary CFLAGS_FOR_BUILD)
222  calling the "configure" command. If they are not specified, they default to the  when calling the "configure" command. If they are not specified, they default
223  values of CC and CFLAGS.  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 189  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 its own man  The script runs the pcretest test program (which is documented in its own man
247  page) 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 2    RunTest 2
254    
# Line 222  bug in PCRE. Line 274  bug in PCRE.
274    
275  The third 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 third 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.
# Line 239  running "configure". This file can be al Line 291  running "configure". This file can be al
291  provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,  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.)  commented in the script, can be be used.)
293    
294  The fifth and final file tests error handling with UTF-8 encoding, and internal  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8
295  UTF-8 features of PCRE that are not relevant to Perl.  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 291  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            )    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 327  The distribution should contain the foll Line 391  The distribution should contain the foll
391    doc/pcretest.txt      plain text documentation of test program    doc/pcretest.txt      plain text documentation of test program
392    doc/perltest.txt      plain text documentation of Perl test program    doc/perltest.txt      plain text documentation of Perl test program
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
# Line 338  The distribution should contain the foll Line 404  The distribution should contain the foll
404    testdata/testinput3   test data for locale-specific tests    testdata/testinput3   test data for locale-specific tests
405    testdata/testinput4   test data for UTF-8 tests compatible with Perl    testdata/testinput4   test data for UTF-8 tests compatible with Perl
406    testdata/testinput5   test data for other UTF-8 tests    testdata/testinput5   test data for other UTF-8 tests
407      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
411    testdata/testoutput4  test results corresponding to testinput4    testdata/testoutput4  test results corresponding to testinput4
412    testdata/testoutput5  test results corresponding to testinput5    testdata/testoutput5  test results corresponding to testinput5
413      testdata/testoutput6  test results corresponding to testinput6
414    
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  (D) Auxiliary file for VPASCAL
# Line 354  The distribution should contain the foll Line 424  The distribution should contain the foll
424    makevp.bat    makevp.bat
425    
426  Philip Hazel <ph10@cam.ac.uk>  Philip Hazel <ph10@cam.ac.uk>
427  February 2003  September 2004

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

  ViewVC Help
Powered by ViewVC 1.1.5