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

Diff of /code/trunk/README

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

revision 122 by ph10, Mon Mar 12 15:10:25 2007 UTC revision 142 by ph10, Fri Mar 30 15:55:18 2007 UTC
# Line 4  README file for PCRE (Perl-compatible re Line 4  README file for PCRE (Perl-compatible re
4  The latest release of PCRE is always available from  The latest release of PCRE is always available from
5    
6    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.gz    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.gz
7    
8  There is a mailing list for discussion about the development of PCRE at  There is a mailing list for discussion about the development of PCRE at
9    
10    pcre-dev@exim.org    pcre-dev@exim.org
11    
12  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.
13  The contents of this README file are:  The contents of this README file are:
# Line 30  The contents of this README file are: Line 30  The contents of this README file are:
30  The PCRE APIs  The PCRE APIs
31  -------------  -------------
32    
33  PCRE is written in C, and it has its own API. The distribution now includes a  PCRE is written in C, and it has its own API. The distribution also includes a
34  set of C++ wrapper functions, courtesy of Google Inc. (see the pcrecpp man page  set of C++ wrapper functions (see the pcrecpp man page for details), courtesy
35  for details).  of Google Inc.
36    
37  Also included in the distribution are a set of C wrapper functions that are  In addition, there is a set of C wrapper functions that are based on the POSIX
38  based on the POSIX API. These end up in the library called libpcreposix. Note  regular expression API (see the pcreposix man page). These end up in the
39  that this just provides a POSIX calling interface to PCRE; the regular  library called libpcreposix. Note that this just provides a POSIX calling
40  expressions themselves still follow Perl syntax and semantics. The POSIX API is  interface to PCRE; the regular expressions themselves still follow Perl syntax
41  restricted, and does not give full access to all of PCRE's facilities.  and semantics. The POSIX API is restricted, and does not give full access to
42    all of PCRE's facilities.
43    
44  The header file for the POSIX-style functions is called pcreposix.h. The  The header file for the POSIX-style functions is called pcreposix.h. The
45  official POSIX name is regex.h, but I did not want to risk possible problems  official POSIX name is regex.h, but I did not want to risk possible problems
# Line 74  documentation is supplied in two other f Line 75  documentation is supplied in two other f
75       those that summarize individual functions. The other two are the text       those that summarize individual functions. The other two are the text
76       forms of the section 1 man pages for the pcregrep and pcretest commands.       forms of the section 1 man pages for the pcregrep and pcretest commands.
77       These text forms are provided for ease of scanning with text editors or       These text forms are provided for ease of scanning with text editors or
78       similar tools. They are installed in <prefix>/share/doc/pcre, where       similar tools. They are installed in <prefix>/share/doc/pcre, where
79       <prefix> is the installation prefix (defaulting to /usr/local).       <prefix> is the installation prefix (defaulting to /usr/local).
80    
81    2. A set of files containing all the documentation in HTML form, hyperlinked    2. A set of files containing all the documentation in HTML form, hyperlinked
82       in various ways, and rooted in a file called index.html, is distributed in       in various ways, and rooted in a file called index.html, is distributed in
83       doc/html and installed in <prefix>/share/doc/pcre/html.       doc/html and installed in <prefix>/share/doc/pcre/html.
84    
85    
# Line 91  You can find contributions from PCRE use Line 92  You can find contributions from PCRE use
92    
93  There is a README file giving brief descriptions of what they are. Some are  There is a README file giving brief descriptions of what they are. Some are
94  complete in themselves; others are pointers to URLs containing relevant files.  complete in themselves; others are pointers to URLs containing relevant files.
95  Some of this material is likely to be well out-of-date. In particular, several  Some of this material is likely to be well out-of-date. Several of the earlier
96  of the contributions provide support for compiling PCRE on various flavours of  contributions provided support for compiling PCRE on various flavours of
97  Windows (I myself do not use Windows), but nowadays there is more Windows  Windows (I myself do not use Windows). Nowadays there is more Windows support
98  support in the standard distribution.  in the standard distribution, so these contibutions have been archived.
99    
100    
101  Building PCRE on non-Unix systems  Building PCRE on non-Unix systems
# Line 147  library. You can read more about them in Line 148  library. You can read more about them in
148    
149  . If you want to suppress the building of the C++ wrapper library, you can add  . If you want to suppress the building of the C++ wrapper library, you can add
150    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
151    will try to find a C++ compiler and C++ header files, and if it succeeds, it    it will try to find a C++ compiler and C++ header files, and if it succeeds,
152    will try to build the C++ wrapper.    it will try to build the C++ wrapper.
153    
154  . If you want to make use of the support for UTF-8 character strings in PCRE,  . If you want to make use of the support for UTF-8 character strings in PCRE,
155    you must add --enable-utf8 to the "configure" command. Without it, the code    you must add --enable-utf8 to the "configure" command. Without it, the code
# Line 178  library. You can read more about them in Line 179  library. You can read more about them in
179    
180  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
181    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
182    them. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
183    
184    --with-posix-malloc-threshold=20    --with-posix-malloc-threshold=20
185    
# Line 207  library. You can read more about them in Line 208  library. You can read more about them in
208  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
209    this by adding --with-link-size=3 to the "configure" command. You can    this by adding --with-link-size=3 to the "configure" command. You can
210    increase it even more by setting --with-link-size=4, but this is unlikely    increase it even more by setting --with-link-size=4, but this is unlikely
211    ever to be necessary.    ever to be necessary. Increasing the internal link size will reduce
212      performance.
213    
214  . You can build PCRE so that its internal match() function that is called from  . You can build PCRE so that its internal match() function that is called from
215    pcre_exec() does not call itself recursively. Instead, it uses memory blocks    pcre_exec() does not call itself recursively. Instead, it uses memory blocks
# Line 223  library. You can read more about them in Line 225  library. You can read more about them in
225    use deeply nested recursion. There is a discussion about stack sizes in the    use deeply nested recursion. There is a discussion about stack sizes in the
226    pcrestack man page.    pcrestack man page.
227    
228    . For speed, PCRE uses four tables for manipulating and identifying characters
229      whose code point values are less than 256. By default, it uses a set of
230      tables for ASCII encoding that is part of the distribution. If you specify
231    
232      --enable-rebuild-chartables
233    
234      a program called dftables is compiled and run in the default C locale when
235      you obey "make". It builds a source file called pcre_chartables.c. If you do
236      not specify this option, pcre_chartables.c is created as a copy of
237      pcre_chartables.c.dist. See "Character tables" below for further information.
238    
239    . It is possible to compile PCRE for use on systems that use EBCDIC as their
240      default character code (as opposed to ASCII) by specifying
241    
242      --enable-ebcdic
243    
244      This automatically implies --enable-rebuild-chartables (see above).
245    
246  The "configure" script builds the following files for the basic C library:  The "configure" script builds the following files for the basic C library:
247    
248  . Makefile is the makefile that builds the library  . Makefile is the makefile that builds the library
# Line 234  The "configure" script builds the follow Line 254  The "configure" script builds the follow
254  . RunTest is a script for running tests on the basic C library  . RunTest is a script for running tests on the basic C library
255  . RunGrepTest is a script for running tests on the pcregrep command  . RunGrepTest is a script for running tests on the pcregrep command
256    
257  Versions of config.h and pcre.h are distributed in the PCRE tarballs under  Versions of config.h and pcre.h are distributed in the PCRE tarballs under
258  the names config.h.generic and pcre.h.generic. These are provided for the  the names config.h.generic and pcre.h.generic. These are provided for the
259  benefit of those who have to built PCRE without the benefit of "configure". If  benefit of those who have to built PCRE without the benefit of "configure". If
260  you use "configure", the .generic versions are not used.  you use "configure", the .generic versions are not used.
# Line 371  Cross-compiling on Unix-like systems Line 391  Cross-compiling on Unix-like systems
391  ------------------------------------  ------------------------------------
392    
393  You can specify CC and CFLAGS in the normal way to the "configure" command, in  You can specify CC and CFLAGS in the normal way to the "configure" command, in
394  order to cross-compile PCRE for some other host. However, during the building  order to cross-compile PCRE for some other host. However, you should NOT
395  process, the dftables.c source file is compiled *and run* on the local host, in  specify --enable-rebuild-chartables, because if you do, the dftables.c source
396  order to generate the default character tables (the chartables.c file). It  file is compiled and run on the local host, in order to generate the inbuilt
397  therefore needs to be compiled with the local compiler, not the cross compiler.  character tables (the pcre_chartables.c file). This will probably not work,
398  You can do this by specifying CC_FOR_BUILD (and if necessary CFLAGS_FOR_BUILD;  because dftables.c needs to be compiled with the local compiler, not the cross
399  there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)  compiler.
400  when calling the "configure" command. If they are not specified, they default  
401  to the values of CC and CFLAGS.  When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
402    by making a copy of pcre_chartables.c.dist, which is a default set of tables
403    that assumes ASCII code. Cross-compiling with the default tables should not be
404    a problem.
405    
406    If you need to modify the character tables when cross-compiling, you should
407    move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
408    run it on the local host to make a new version of pcre_chartables.c.dist.
409    Then when you cross-compile PCRE this new version of the tables will be used.
410    
411    
412  Using HP's ANSI C++ compiler (aCC)  Using HP's ANSI C++ compiler (aCC)
# Line 395  use the workaround of specifying the fol Line 423  use the workaround of specifying the fol
423  running the "configure" script:  running the "configure" script:
424    
425    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
426    
427    
428  Making new tarballs  Making new tarballs
429  -------------------  -------------------
430    
431  The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and  The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
432  zip formats. However, if you have modified any of the man page sources in the  zip formats. However, if you have modified any of the man page sources in the
433  doc directory, you should first run the PrepareRelease script. This re-creates  doc directory, you should first run the PrepareRelease script. This re-creates
434  the .txt and HTML forms of the documentation from the man pages.  the .txt and HTML forms of the documentation from the man pages.
435    
436    
# Line 461  is output to say why. If running this te Line 489  is output to say why. If running this te
489  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,
490  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.
491    
492    [If you are trying to run this test on Windows, you may be able to get it to
493    work by changing "fr_FR" to "french" everywhere it occurs.]
494    
495  The fourth test checks the UTF-8 support. It is not run automatically unless  The fourth test checks the UTF-8 support. It is not run automatically unless
496  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when
497  running "configure". This file can be also fed directly to the perltest script,  running "configure". This file can be also fed directly to the perltest script,
# Line 490  concatenated tables. A call to pcre_make Line 521  concatenated tables. A call to pcre_make
521  of tables in the current locale. If the final argument for pcre_compile() is  of tables in the current locale. If the final argument for pcre_compile() is
522  passed as NULL, a set of default tables that is built into the binary is used.  passed as NULL, a set of default tables that is built into the binary is used.
523    
524  The source file called chartables.c contains the default set of tables. This is  The source file called pcre_chartables.c contains the default set of tables. By
525  not supplied in the distribution, but is built by the program dftables  default, this is created as a copy of pcre_chartables.c.dist, which contains
526  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
527  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
528  sources. This means that the default C locale which is set for your system will  program dftables (compiled from dftables.c), which uses the ANSI C character
529  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
530  by editing chartables.c and then re-building PCRE. If you do this, you should  build the table sources. This means that the default C locale which is set for
531  take care to ensure that the file does not get automaticaly re-generated.  your system will control the contents of these default tables. You can change
532    the default tables by editing pcre_chartables.c and then re-building PCRE. If
533    you do this, you should take care to ensure that the file does not get
534    automatically re-generated. The best way to do this is to move
535    pcre_chartables.c.dist out of the way and replace it with your customized
536    tables.
537    
538    When the dftables program is run as a result of --enable-rebuild-chartables,
539    it uses the default C locale that is set on your system. It does not pay
540    attention to the LC_xxx environment variables. In other words, it uses the
541    system's default locale rather than whatever the compiling user happens to have
542    set. If you really do want to build a source set of character tables in a
543    locale that is specified by the LC_xxx variables, you can run the dftables
544    program by hand with the -L option. For example:
545    
546      ./dftables -L pcre_chartables.c.special
547    
548  The first two 256-byte tables provide lower casing and case flipping functions,  The first two 256-byte tables provide lower casing and case flipping functions,
549  respectively. The next table consists of three 32-byte bit maps which identify  respectively. The next table consists of three 32-byte bit maps which identify
# Line 526  The distribution should contain the foll Line 572  The distribution should contain the foll
572    
573  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
574    
575    dftables.c             auxiliary program for building chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
576                                when --enable-rebuild-chartables is specified
577    
578    pcreposix.c            )    pcre_chartables.c.dist  a default set of character tables that assume ASCII
579    pcre_compile.c         )                              coding; used, unless --enable-rebuild-chartables is
580    pcre_config.c          )                              specified, by copying to pcre_chartables.c
581    pcre_dfa_exec.c        )  
582    pcre_exec.c            )    pcreposix.c             )
583    pcre_fullinfo.c        )    pcre_compile.c          )
584    pcre_get.c             ) sources for the functions in the library,    pcre_config.c           )
585    pcre_globals.c         )   and some internal functions that they use    pcre_dfa_exec.c         )
586    pcre_info.c            )    pcre_exec.c             )
587    pcre_maketables.c      )    pcre_fullinfo.c         )
588    pcre_newline.c         )    pcre_get.c              ) sources for the functions in the library,
589    pcre_ord2utf8.c        )    pcre_globals.c          )   and some internal functions that they use
590    pcre_refcount.c        )    pcre_info.c             )
591    pcre_study.c           )    pcre_maketables.c       )
592    pcre_tables.c          )    pcre_newline.c          )
593    pcre_try_flipped.c     )    pcre_ord2utf8.c         )
594    pcre_ucp_searchfuncs.c )    pcre_refcount.c         )
595    pcre_valid_utf8.c      )    pcre_study.c            )
596    pcre_version.c         )    pcre_tables.c           )
597    pcre_xclass.c          )    pcre_try_flipped.c      )
598    pcre_printint.src      ) debugging function that is #included in pcretest,    pcre_ucp_searchfuncs.c  )
599                           )   and can also be #included in pcre_compile()    pcre_valid_utf8.c       )
600    pcre.h.in              template for pcre.h when built by "configure"    pcre_version.c          )
601    pcreposix.h            header for the external POSIX wrapper API    pcre_xclass.c           )
602    pcre_internal.h        header for internal use    pcre_printint.src       ) debugging function that is #included in pcretest,
603    ucp.h                  ) headers concerned with                            )   and can also be #included in pcre_compile()
604    ucpinternal.h          )   Unicode property handling    pcre.h.in               template for pcre.h when built by "configure"
605    ucptable.h             ) (this one is the data table)    pcreposix.h             header for the external POSIX wrapper API
606      pcre_internal.h         header for internal use
607    config.h.in            template for config.h, which is built by "configure"    ucp.h                   ) headers concerned with
608      ucpinternal.h           )   Unicode property handling
609    pcrecpp.h              public header file for the C++ wrapper    ucptable.h              ) (this one is the data table)
610    pcrecpparg.h.in        template for another C++ header file  
611    pcre_scanner.h         public header file for C++ scanner functions    config.h.in             template for config.h, which is built by "configure"
612    pcrecpp.cc             )  
613    pcre_scanner.cc        ) source for the C++ wrapper library    pcrecpp.h               public header file for the C++ wrapper
614      pcrecpparg.h.in         template for another C++ header file
615    pcre_stringpiece.h.in  template for pcre_stringpiece.h, the header for the    pcre_scanner.h          public header file for C++ scanner functions
616                             C++ stringpiece functions    pcrecpp.cc              )
617    pcre_stringpiece.cc    source for the C++ stringpiece functions    pcre_scanner.cc         ) source for the C++ wrapper library
618    
619      pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
620                                C++ stringpiece functions
621      pcre_stringpiece.cc     source for the C++ stringpiece functions
622    
623  (B) Source files for programs that use PCRE:  (B) Source files for programs that use PCRE:
624    
625    pcredemo.c             simple demonstration of coding calls to PCRE    pcredemo.c              simple demonstration of coding calls to PCRE
626    pcregrep.c             source of a grep utility that uses PCRE    pcregrep.c              source of a grep utility that uses PCRE
627    pcretest.c             comprehensive test program    pcretest.c              comprehensive test program
628    
629  (C) Auxiliary files:  (C) Auxiliary files:
630    
631    132html                script to turn "man" pages into HTML    132html                 script to turn "man" pages into HTML
632    AUTHORS                information about the author of PCRE    AUTHORS                 information about the author of PCRE
633    ChangeLog              log of changes to the code    ChangeLog               log of changes to the code
634    CleanTxt               script to clean nroff output for txt man pages    CleanTxt                script to clean nroff output for txt man pages
635    Detrail                script to remove trailing spaces    Detrail                 script to remove trailing spaces
636    Index.html             the base HTML page    HACKING                 some notes about the internals of PCRE
637    INSTALL                generic installation instructions    INSTALL                 generic installation instructions
638    LICENCE                conditions for the use of PCRE    LICENCE                 conditions for the use of PCRE
639    COPYING                the same, using GNU's standard name    COPYING                 the same, using GNU's standard name
640    Makefile.in            ) template for Unix Makefile, which is built by    Makefile.in             ) template for Unix Makefile, which is built by
641                           )   "configure"                            )   "configure"
642    Makefile.am            ) the automake input that was used to create    Makefile.am             ) the automake input that was used to create
643                           )   Makefile.in                            )   Makefile.in
644    NEWS                   important changes in this release    NEWS                    important changes in this release
645    NON-UNIX-USE           notes on building PCRE on non-Unix systems    NON-UNIX-USE            notes on building PCRE on non-Unix systems
646    PrepareRelease         script to make preparations for "make dist"    PrepareRelease          script to make preparations for "make dist"
647    README                 this file    README                  this file
648    RunTest.in             template for a Unix shell script for running tests    RunTest                 a Unix shell script for running tests
649    RunGrepTest.in         template for a Unix shell script for pcregrep tests    RunGrepTest             a Unix shell script for pcregrep tests
650    aclocal.m4             m4 macros (generated by "aclocal")    aclocal.m4              m4 macros (generated by "aclocal")
651    config.guess           ) files used by libtool,    config.guess            ) files used by libtool,
652    config.sub             )   used only when building a shared library    config.sub              )   used only when building a shared library
653    configure              a configuring shell script (built by autoconf)    configure               a configuring shell script (built by autoconf)
654    configure.ac           ) the autoconf input that was used to build    configure.ac            ) the autoconf input that was used to build
655                           )   "configure" and config.h                            )   "configure" and config.h
656    depcomp                ) script to find program dependencies, generated by    depcomp                 ) script to find program dependencies, generated by
657                           )   automake                            )   automake
658    doc/*.3                man page sources for the PCRE functions    doc/*.3                 man page sources for the PCRE functions
659    doc/*.1                man page sources for pcregrep and pcretest    doc/*.1                 man page sources for pcregrep and pcretest
660    doc/html/*             HTML documentation    doc/index.html.src      the base HTML page
661    doc/pcre.txt           plain text version of the man pages    doc/html/*              HTML documentation
662    doc/pcretest.txt       plain text documentation of test program    doc/pcre.txt            plain text version of the man pages
663    doc/perltest.txt       plain text documentation of Perl test program    doc/pcretest.txt        plain text documentation of test program
664    install-sh             a shell script for installing files    doc/perltest.txt        plain text documentation of Perl test program
665    libpcre.pc.in          template for libpcre.pc for pkg-config    install-sh              a shell script for installing files
666    libpcrecpp.pc.in       template for libpcrecpp.pc for pkg-config    libpcre.pc.in           template for libpcre.pc for pkg-config
667    ltmain.sh              file used to build a libtool script    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
668    missing                ) common stub for a few missing GNU programs while    ltmain.sh               file used to build a libtool script
669                           )   installing, generated by automake    missing                 ) common stub for a few missing GNU programs while
670    mkinstalldirs          script for making install directories                            )   installing, generated by automake
671    perltest.pl            Perl test program    mkinstalldirs           script for making install directories
672    pcre-config.in         source of script which retains PCRE information    perltest.pl             Perl test program
673      pcre-config.in          source of script which retains PCRE information
674    pcrecpp_unittest.cc          )    pcrecpp_unittest.cc          )
675    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
676    pcre_stringpiece_unittest.cc )    pcre_stringpiece_unittest.cc )
677    testdata/testinput*    test data for main library tests    testdata/testinput*     test data for main library tests
678    testdata/testoutput*   expected test results    testdata/testoutput*    expected test results
679    testdata/grep*         input and output for pcregrep tests    testdata/grep*          input and output for pcregrep tests
680    
681  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
682    
# Line 634  The distribution should contain the foll Line 686  The distribution should contain the foll
686  (E) Auxiliary files for VPASCAL  (E) Auxiliary files for VPASCAL
687    
688    makevp.bat    makevp.bat
689    !compile.txt    makevp_c.txt
690    !linklib.txt    makevp_l.txt
691    pcregexp.pas    pcregexp.pas
692    
693  (F) Auxiliary files for building PCRE "by hand"  (F) Auxiliary files for building PCRE "by hand"
694    
695    pcre.h.generic         ) a version of the public PCRE header file    pcre.h.generic          ) a version of the public PCRE header file
696                           )   for use in non-"configure" environments                            )   for use in non-"configure" environments
697    config.h.generic       ) a version of config.h for use in non-"configure"    config.h.generic        ) a version of config.h for use in non-"configure"
698                           )   environments                            )   environments
699    
700  (F) Miscellaneous  (F) Miscellaneous
701    
# Line 652  The distribution should contain the foll Line 704  The distribution should contain the foll
704  Philip Hazel  Philip Hazel
705  Email local part: ph10  Email local part: ph10
706  Email domain: cam.ac.uk  Email domain: cam.ac.uk
707  Last updated: March 2007  Last updated: 29 March 2007

Legend:
Removed from v.122  
changed lines
  Added in v.142

  ViewVC Help
Powered by ViewVC 1.1.5