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

Diff of /code/trunk/README

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

revision 87 by nigel, Sat Feb 24 21:41:21 2007 UTC revision 91 by nigel, Sat Feb 24 21:41:34 2007 UTC
# Line 34  Documentation for PCRE Line 34  Documentation for PCRE
34  ----------------------  ----------------------
35    
36  If you install PCRE in the normal way, you will end up with an installed set of  If you install PCRE in the normal way, you will end up with an installed set of
37  man pages whose names all start with "pcre". The one that is called "pcre"  man pages whose names all start with "pcre". The one that is just called "pcre"
38  lists all the others. In addition to these man pages, the PCRE documentation is  lists all the others. In addition to these man pages, the PCRE documentation is
39  supplied in two other forms; however, as there is no standard place to install  supplied in two other forms; however, as there is no standard place to install
40  them, they are left in the doc directory of the unpacked source distribution.  them, they are left in the doc directory of the unpacked source distribution.
# Line 114  library. You can read more about them in Line 114  library. You can read more about them in
114  . If, in addition to support for UTF-8 character strings, you want to include  . If, in addition to support for UTF-8 character strings, you want to include
115    support for the \P, \p, and \X sequences that recognize Unicode character    support for the \P, \p, and \X sequences that recognize Unicode character
116    properties, you must add --enable-unicode-properties to the "configure"    properties, you must add --enable-unicode-properties to the "configure"
117    command. This adds about 90K to the size of the library (in the form of a    command. This adds about 30K to the size of the library (in the form of a
118    property table); only the basic two-letter properties such as Lu are    property table); only the basic two-letter properties such as Lu are
119    supported.    supported.
120    
121  . You can build PCRE to recognize either CR or LF as the newline character,  . You can build PCRE to recognize either CR or LF or the sequence CRLF as
122    instead of whatever your compiler uses for "\n", by adding --newline-is-cr or    indicating the end of a line. Whatever you specify at build time is the
123    --newline-is-lf to the "configure" command, respectively. Only do this if you    default; the caller of PCRE can change the selection at run time. The default
124    really understand what you are doing. On traditional Unix-like systems, the    newline indicator is a single LF character (the Unix standard). You can
125    newline character is LF.    specify the default newline indicator by adding --newline-is-cr or
126      --newline-is-lf or --newline-is-crlf to the "configure" command,
127      respectively.
128    
129  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
130    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
# Line 142  library. You can read more about them in Line 144  library. You can read more about them in
144    pcre_exec() can supply their own value. There is discussion on the pcreapi    pcre_exec() can supply their own value. There is discussion on the pcreapi
145    man page.    man page.
146    
147    . There is a separate counter that limits the depth of recursive function calls
148      during a matching process. This also has a default of ten million, which is
149      essentially "unlimited". You can change the default by setting, for example,
150    
151      --with-match-limit-recursion=500000
152    
153      Recursive function calls use up the runtime stack; running out of stack can
154      cause programs to crash in strange ways. There is a discussion about stack
155      sizes in the pcrestack man page.
156    
157  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
158    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
159    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
# Line 165  library. You can read more about them in Line 177  library. You can read more about them in
177    
178  The "configure" script builds eight files for the basic C library:  The "configure" script builds eight files for the basic C library:
179    
 . pcre.h is the header file for C programs that call PCRE  
180  . Makefile is the makefile that builds the library  . Makefile is the makefile that builds the library
181  . config.h contains build-time configuration options for the library  . config.h contains build-time configuration options for the library
182  . pcre-config is a script that shows the settings of "configure" options  . pcre-config is a script that shows the settings of "configure" options
# Line 432  The distribution should contain the foll Line 443  The distribution should contain the foll
443    pcre_info.c           )    pcre_info.c           )
444    pcre_maketables.c     )    pcre_maketables.c     )
445    pcre_ord2utf8.c       )    pcre_ord2utf8.c       )
446    pcre_printint.c       )    pcre_refcount.c       )
447    pcre_study.c          )    pcre_study.c          )
448    pcre_tables.c         )    pcre_tables.c         )
449    pcre_try_flipped.c    )    pcre_try_flipped.c    )
450    pcre_ucp_findchar.c   )    pcre_ucp_searchfuncs.c)
451    pcre_valid_utf8.c     )    pcre_valid_utf8.c     )
452    pcre_version.c        )    pcre_version.c        )
453    pcre_xclass.c         )    pcre_xclass.c         )
   
   ucp_findchar.c        )  
   ucp.h                 ) source for the code that is used for  
   ucpinternal.h         )   Unicode property handling  
454    ucptable.c            )    ucptable.c            )
   ucptypetable.c        )  
455    
456    pcre.in               "source" for the header for the external API; pcre.h    pcre_printint.src     ) debugging function that is #included in pcretest, and
457                            is built from this by "configure"                          )   can also be #included in pcre_compile()
458    
459      pcre.h                the public PCRE header file
460    pcreposix.h           header for the external POSIX wrapper API    pcreposix.h           header for the external POSIX wrapper API
461    pcre_internal.h       header for internal use    pcre_internal.h       header for internal use
462      ucp.h                 ) headers concerned with
463      ucpinternal.h         )   Unicode property handling
464    config.in             template for config.h, which is built by configure    config.in             template for config.h, which is built by configure
465    
466    pcrecpp.h             the header file for the C++ wrapper    pcrecpp.h             the header file for the C++ wrapper
# Line 477  The distribution should contain the foll Line 487  The distribution should contain the foll
487    RunGrepTest.in        template for a Unix shell script for pcregrep tests    RunGrepTest.in        template for a Unix shell script for pcregrep tests
488    config.guess          ) files used by libtool,    config.guess          ) files used by libtool,
489    config.sub            )   used only when building a shared library    config.sub            )   used only when building a shared library
490      config.h.in           "source" for the config.h header file
491    configure             a configuring shell script (built by autoconf)    configure             a configuring shell script (built by autoconf)
492    configure.in          the autoconf input used to build configure    configure.ac          the autoconf input used to build configure
493    doc/Tech.Notes        notes on the encoding    doc/Tech.Notes        notes on the encoding
494    doc/*.3               man page sources for the PCRE functions    doc/*.3               man page sources for the PCRE functions
495    doc/*.1               man page sources for pcregrep and pcretest    doc/*.1               man page sources for pcregrep and pcretest
# Line 506  The distribution should contain the foll Line 517  The distribution should contain the foll
517    
518    libpcre.def    libpcre.def
519    libpcreposix.def    libpcreposix.def
   pcre.def  
520    
521  (D) Auxiliary file for VPASCAL  (D) Auxiliary file for VPASCAL
522    
# Line 515  The distribution should contain the foll Line 525  The distribution should contain the foll
525  Philip Hazel  Philip Hazel
526  Email local part: ph10  Email local part: ph10
527  Email domain: cam.ac.uk  Email domain: cam.ac.uk
528  January 2006  June 2006
Legend:
Removed from v.87  
changed lines
  Added in v.91
  ViewVC Help
Powered by ViewVC 1.1.5