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

Diff of /code/trunk/README

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

revision 73 by nigel, Sat Feb 24 21:40:30 2007 UTC revision 127 by ph10, Mon Mar 19 11:44:45 2007 UTC
# Line 5  The latest release of PCRE is always ava Line 5  The latest release of PCRE is always ava
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
9    
10      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:
14    
15  PCRE has its own native API, but a set of "wrapper" functions that are based on    The PCRE APIs
16  the POSIX API are also supplied in the library libpcreposix. Note that this    Documentation for PCRE
17  just provides a POSIX calling interface to PCRE: the regular expressions    Contributions by users of PCRE
18  themselves still follow Perl syntax and semantics. The header file    Building PCRE on non-Unix systems
19  for the POSIX-style functions is called pcreposix.h. The official POSIX name is    Building PCRE on Unix-like systems
20  regex.h, but I didn't want to risk possible problems with existing files of    Retrieving configuration information on Unix-like systems
21  that name by distributing it that way. To use it with an existing program that    Shared libraries on Unix-like systems
22  uses the POSIX API, it will have to be renamed or pointed at by a link.    Cross-compiling on Unix-like systems
23      Using HP's ANSI C++ compiler (aCC)
24      Making new tarballs
25      Testing PCRE
26      Character tables
27      File manifest
28    
29    
30    The PCRE APIs
31    -------------
32    
33    PCRE is written in C, and it has its own API. The distribution now includes a
34    set of C++ wrapper functions, courtesy of Google Inc. (see the pcrecpp man page
35    for details).
36    
37    Also included in the distribution are a set of C wrapper functions that are
38    based on the POSIX API. These end up in the library called libpcreposix. Note
39    that this just provides a POSIX calling interface to PCRE; the regular
40    expressions themselves still follow Perl syntax and semantics. The POSIX API is
41    restricted, and does not give full access to all of PCRE's facilities.
42    
43    The header file for the POSIX-style functions is called pcreposix.h. The
44    official POSIX name is regex.h, but I did not want to risk possible problems
45    with existing files of that name by distributing it that way. To use PCRE with
46    an existing program that uses the POSIX API, pcreposix.h will have to be
47    renamed or pointed at by a link.
48    
49  If you are using the POSIX interface to PCRE and there is already a POSIX regex  If you are using the POSIX interface to PCRE and there is already a POSIX regex
50  library installed on your system, you must take care when linking programs to  library installed on your system, as well as worrying about the regex.h header
51    file (as mentioned above), you must also take care when linking programs to
52  ensure that they link with PCRE's libpcreposix library. Otherwise they may pick  ensure that they link with PCRE's libpcreposix library. Otherwise they may pick
53  up the "real" POSIX functions of the same name.  up the POSIX functions of the same name from the other library.
54    
55    One way of avoiding this confusion is to compile PCRE with the addition of
56    -Dregcomp=PCREregcomp (and similarly for the other POSIX functions) to the
57    compiler flags (CFLAGS if you are using "configure" -- see below). This has the
58    effect of renaming the functions so that the names no longer clash. Of course,
59    you have to do the same thing for your applications, or write them using the
60    new names.
61    
62    
63    Documentation for PCRE
64    ----------------------
65    
66    If you install PCRE in the normal way on a Unix-like system, you will end up
67    with a set of man pages whose names all start with "pcre". The one that is just
68    called "pcre" lists all the others. In addition to these man pages, the PCRE
69    documentation is supplied in two other forms:
70    
71      1. There are files called doc/pcre.txt, doc/pcregrep.txt, and
72         doc/pcretest.txt in the source distribution. The first of these is a
73         concatenation of the text forms of all the section 3 man pages except
74         those that summarize individual functions. The other two are the text
75         forms of the section 1 man pages for the pcregrep and pcretest commands.
76         These text forms are provided for ease of scanning with text editors or
77         similar tools. They are installed in <prefix>/share/doc/pcre, where
78         <prefix> is the installation prefix (defaulting to /usr/local).
79    
80      2. A set of files containing all the documentation in HTML form, hyperlinked
81         in various ways, and rooted in a file called index.html, is distributed in
82         doc/html and installed in <prefix>/share/doc/pcre/html.
83    
84    
85  Contributions by users of PCRE  Contributions by users of PCRE
# Line 29  You can find contributions from PCRE use Line 89  You can find contributions from PCRE use
89    
90    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
91    
92  where there is also a README file giving brief descriptions of what they are.  There is a README file giving brief descriptions of what they are. Some are
93  Several of them provide support for compiling PCRE on various flavours of  complete in themselves; others are pointers to URLs containing relevant files.
94  Windows systems (I myself do not use Windows). Some are complete in themselves;  Some of this material is likely to be well out-of-date. In particular, several
95  others are pointers to URLs containing relevant files.  of the contributions provide support for compiling PCRE on various flavours of
96    Windows (I myself do not use Windows), but nowadays there is more Windows
97    support in the standard distribution.
98    
99    
100    Building PCRE on non-Unix systems
101    ---------------------------------
102    
103    For a non-Unix system, please read the comments in the file NON-UNIX-USE,
104    though if your system supports the use of "configure" and "make" you may be
105    able to build PCRE in the same way as for Unix-like systems.
106    
107    PCRE has been compiled on many different operating systems. It should be
108    straightforward to build PCRE on any system that has a Standard C compiler and
109    library, because it uses only Standard C functions.
110    
111    
112    Building PCRE on Unix-like systems
113    ----------------------------------
114    
115  Building PCRE on a Unix-like system  If you are using HP's ANSI C++ compiler (aCC), please see the special note
116  -----------------------------------  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
117    
118  To build PCRE on a Unix-like system, first run the "configure" command from the  To build PCRE on a Unix-like system, first run the "configure" command from the
119  PCRE distribution directory, with your current directory set to the directory  PCRE distribution directory, with your current directory set to the directory
120  where you want the files to be created. This command is a standard GNU  where you want the files to be created. This command is a standard GNU
121  "autoconf" configuration script, for which generic instructions are supplied in  "autoconf" configuration script, for which generic instructions are supplied in
122  INSTALL.  the file INSTALL.
123    
124  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
125  this case, on many systems, just running "./configure" is sufficient, but the  this case, on many systems, just running "./configure" is sufficient. However,
126  usual methods of changing standard defaults are available. For example,  the usual methods of changing standard defaults are available. For example:
127    
128  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
129    
# Line 61  into /source/pcre/pcre-xxx, but you want Line 138  into /source/pcre/pcre-xxx, but you want
138  cd /build/pcre/pcre-xxx  cd /build/pcre/pcre-xxx
139  /source/pcre/pcre-xxx/configure  /source/pcre/pcre-xxx/configure
140    
141    PCRE is written in C and is normally compiled as a C library. However, it is
142    possible to build it as a C++ library, though the provided building apparatus
143    does not have any features to support this.
144    
145  There are some optional features that can be included or omitted from the PCRE  There are some optional features that can be included or omitted from the PCRE
146  library. You can read more about them in the pcrebuild man page.  library. You can read more about them in the pcrebuild man page.
147    
148    . If you want to suppress the building of the C++ wrapper library, you can add
149      --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
150      will try to find a C++ compiler and C++ header files, and if it succeeds, it
151      will try to build the C++ wrapper.
152    
153  . 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,
154    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
155    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
156    still has to be enabled by an option at run time.)    still has to be enabled by an option at run time.)
157    
158  . You can build PCRE to recognized CR or NL as the newline character, instead  . If, in addition to support for UTF-8 character strings, you want to include
159    of whatever your compiler uses for "\n", by adding --newline-is-cr or    support for the \P, \p, and \X sequences that recognize Unicode character
160    --newline-is-nl to the "configure" command, respectively. Only do this if you    properties, you must add --enable-unicode-properties to the "configure"
161    really understand what you are doing. On traditional Unix-like systems, the    command. This adds about 30K to the size of the library (in the form of a
162    newline character is NL.    property table); only the basic two-letter properties such as Lu are
163      supported.
164    
165    . You can build PCRE to recognize either CR or LF or the sequence CRLF or any
166      of the Unicode newline sequences as indicating the end of a line. Whatever
167      you specify at build time is the default; the caller of PCRE can change the
168      selection at run time. The default newline indicator is a single LF character
169      (the Unix standard). You can specify the default newline indicator by adding
170      --newline-is-cr or --newline-is-lf or --newline-is-crlf or --newline-is-any
171      to the "configure" command, respectively.
172    
173      If you specify --newline-is-cr or --newline-is-crlf, some of the standard
174      tests will fail, because the lines in the test files end with LF. Even if
175      the files are edited to change the line endings, there are likely to be some
176      failures. With --newline-is-any, many tests should succeed, but there may be
177      some failures.
178    
179  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
180    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 83  library. You can read more about them in Line 184  library. You can read more about them in
184    
185    on the "configure" command.    on the "configure" command.
186    
187  . PCRE has a counter which can be set to limit the amount of resources it uses.  . PCRE has a counter that can be set to limit the amount of resources it uses.
188    If the limit is exceeded during a match, the match fails. The default is ten    If the limit is exceeded during a match, the match fails. The default is ten
189    million. You can change the default by setting, for example,    million. You can change the default by setting, for example,
190    
191    --with-match-limit=500000    --with-match-limit=500000
192    
193    on the "configure" command. This is just the default; individual calls to    on the "configure" command. This is just the default; individual calls to
194    pcre_exec() can supply their own value. There is discussion on the pcreapi    pcre_exec() can supply their own value. There is more discussion on the
195    man page.    pcreapi man page.
196    
197    . There is a separate counter that limits the depth of recursive function calls
198      during a matching process. This also has a default of ten million, which is
199      essentially "unlimited". You can change the default by setting, for example,
200    
201      --with-match-limit-recursion=500000
202    
203      Recursive function calls use up the runtime stack; running out of stack can
204      cause programs to crash in strange ways. There is a discussion about stack
205      sizes in the pcrestack man page.
206    
207  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
208    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
209    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
210    ever to be necessary. If you build PCRE with an increased link size, test 2    ever to be necessary.
211    (and 5 if you are using UTF-8) will fail. Part of the output of these tests  
212    is a representation of the compiled pattern, and this changes with the link  . You can build PCRE so that its internal match() function that is called from
213    size.    pcre_exec() does not call itself recursively. Instead, it uses memory blocks
214      obtained from the heap via the special functions pcre_stack_malloc() and
215  . You can build PCRE so that its match() function does not call itself    pcre_stack_free() to save data that would otherwise be saved on the stack. To
216    recursively. Instead, it uses blocks of data from the heap via special    build PCRE like this, use
   functions pcre_stack_malloc() and pcre_stack_free() to save data that would  
   otherwise be saved on the stack. To build PCRE like this, use  
217    
218    --disable-stack-for-recursion    --disable-stack-for-recursion
219    
220    on the "configure" command. PCRE runs more slowly in this mode, but it may be    on the "configure" command. PCRE runs more slowly in this mode, but it may be
221    necessary in environments with limited stack sizes.    necessary in environments with limited stack sizes. This applies only to the
222      pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not
223      use deeply nested recursion. There is a discussion about stack sizes in the
224      pcrestack man page.
225    
226    The "configure" script builds the following files for the basic C library:
227    
228    . Makefile is the makefile that builds the library
229    . config.h contains build-time configuration options for the library
230    . pcre.h is the public PCRE header file
231    . pcre-config is a script that shows the settings of "configure" options
232    . libpcre.pc is data for the pkg-config command
233    . libtool is a script that builds shared and/or static libraries
234    . RunTest is a script for running tests on the basic C library
235    . RunGrepTest is a script for running tests on the pcregrep command
236    
237  The "configure" script builds five files:  Versions of config.h and pcre.h are distributed in the PCRE tarballs under
238    the names config.h.generic and pcre.h.generic. These are provided for the
239    benefit of those who have to built PCRE without the benefit of "configure". If
240    you use "configure", the .generic versions are not used.
241    
242    If a C++ compiler is found, the following files are also built:
243    
244    . libpcrecpp.pc is data for the pkg-config command
245    . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper
246    . pcre_stringpiece.h is the header for the C++ "stringpiece" functions
247    
248    The "configure" script also creates config.status, which is an executable
249    script that can be run to recreate the configuration, and config.log, which
250    contains compiler output from tests that "configure" runs.
251    
252    Once "configure" has run, you can run "make". It builds two libraries, called
253    libpcre and libpcreposix, a test program called pcretest, a demonstration
254    program called pcredemo, and the pcregrep command. If a C++ compiler was found
255    on your system, "make" also builds the C++ wrapper library, which is called
256    libpcrecpp, and some test programs called pcrecpp_unittest,
257    pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper
258    can be disabled by adding --disable-cpp to the "configure" command.
259    
260    The command "make check" runs all the appropriate tests. Details of the PCRE
261    tests are given below in a separate section of this document.
262    
263    You can use "make install" to install PCRE into live directories on your
264    system. The following are installed (file names are all relative to the
265    <prefix> that is set when "configure" is run):
266    
267      Commands (bin):
268        pcretest
269        pcregrep
270        pcre-config
271    
272      Libraries (lib):
273        libpcre
274        libpcreposix
275        libpcrecpp (if C++ support is enabled)
276    
277      Configuration information (lib/pkgconfig):
278        libpcre.pc
279        libpcrecpp.pc (if C++ support is enabled)
280    
281      Header files (include):
282        pcre.h
283        pcreposix.h
284        pcre_scanner.h      )
285        pcre_stringpiece.h  ) if C++ support is enabled
286        pcrecpp.h           )
287        pcrecpparg.h        )
288    
289      Man pages (share/man/man{1,3}):
290        pcregrep.1
291        pcretest.1
292        pcre.3
293        pcre*.3 (lots more pages, all starting "pcre")
294    
295      HTML documentation (share/doc/pcre/html):
296        index.html
297        *.html (lots more pages, hyperlinked from index.html)
298    
299      Text file documentation (share/doc/pcre):
300        AUTHORS
301        COPYING
302        ChangeLog
303        LICENCE
304        NEWS
305        README
306        pcre.txt       (a concatenation of the man(3) pages)
307        pcretest.txt   the pcretest man page
308        pcregrep.txt   the pcregrep man page
309    
310    Note that the pcredemo program that is built by "configure" is *not* installed
311    anywhere. It is a demonstration for programmers wanting to use PCRE.
312    
313    If you want to remove PCRE from your system, you can run "make uninstall".
314    This removes all the files that "make install" installed. However, it does not
315    remove any directories, because these are often shared with other programs.
316    
317  . libtool is a script that builds shared and/or static libraries  
318  . Makefile is built by copying Makefile.in and making substitutions.  Retrieving configuration information on Unix-like systems
319  . config.h is built by copying config.in and making substitutions.  ---------------------------------------------------------
320  . pcre-config is built by copying pcre-config.in and making substitutions.  
321  . RunTest is a script for running tests  Running "make install" installs the command pcre-config, which can be used to
322    recall information about the PCRE configuration and installation. For example:
 Once "configure" has run, you can run "make". It builds two libraries called  
 libpcre and libpcreposix, a test program called pcretest, and the pcregrep  
 command. You can use "make install" to copy these, the public header files  
 pcre.h and pcreposix.h, and the man pages to appropriate live directories on  
 your system, in the normal way.  
   
 Running "make install" also installs the command pcre-config, which can be used  
 to recall information about the PCRE configuration and installation. For  
 example,  
323    
324    pcre-config --version    pcre-config --version
325    
326  prints the version number, and  prints the version number, and
327    
328   pcre-config --libs    pcre-config --libs
329    
330  outputs information about where the library is installed. This command can be  outputs information about where the library is installed. This command can be
331  included in makefiles for programs that use PCRE, saving the programmer from  included in makefiles for programs that use PCRE, saving the programmer from
332  having to remember too many details.  having to remember too many details.
333    
334    The pkg-config command is another system for saving and retrieving information
335    about installed libraries. Instead of separate commands for each library, a
336    single command is used. For example:
337    
338      pkg-config --cflags pcre
339    
340    The data is held in *.pc files that are installed in a directory called
341    <prefix>/lib/pkgconfig.
342    
343    
344  Shared libraries on Unix-like systems  Shared libraries on Unix-like systems
345  -------------------------------------  -------------------------------------
346    
347  The default distribution builds PCRE as two shared libraries and two static  The default distribution builds PCRE as shared libraries and static libraries,
348  libraries, as long as the operating system supports shared libraries. Shared  as long as the operating system supports shared libraries. Shared library
349  library support relies on the "libtool" script which is built as part of the  support relies on the "libtool" script which is built as part of the
350  "configure" process.  "configure" process.
351    
352  The libtool script is used to compile and link both shared and static  The libtool script is used to compile and link both shared and static
# Line 154  built. The programs pcretest and pcregre Line 355  built. The programs pcretest and pcregre
355  libraries (by means of wrapper scripts in the case of shared libraries). When  libraries (by means of wrapper scripts in the case of shared libraries). When
356  you use "make install" to install shared libraries, pcregrep and pcretest are  you use "make install" to install shared libraries, pcregrep and pcretest are
357  automatically re-built to use the newly installed shared libraries before being  automatically re-built to use the newly installed shared libraries before being
358  installed themselves. However, the versions left in the source directory still  installed themselves. However, the versions left in the build directory still
359  use the uninstalled libraries.  use the uninstalled libraries.
360    
361  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
362  configuring it. For example  configuring it. For example:
363    
364  ./configure --prefix=/usr/gnu --disable-shared  ./configure --prefix=/usr/gnu --disable-shared
365    
# Line 166  Then run "make" in the usual way. Simila Line 367  Then run "make" in the usual way. Simila
367  build only shared libraries.  build only shared libraries.
368    
369    
370  Cross-compiling on a Unix-like system  Cross-compiling on Unix-like systems
371  -------------------------------------  ------------------------------------
372    
373  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
374  order to cross-compile PCRE for some other host. However, during the building  order to cross-compile PCRE for some other host. However, during the building
375  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
376  order to generate the default character tables (the chartables.c file). It  order to generate the default character tables (the chartables.c file). It
377  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.
378  You can do this by specifying CC_FOR_BUILD (and if necessary CFLAGS_FOR_BUILD)  You can do this by specifying CC_FOR_BUILD (and if necessary CFLAGS_FOR_BUILD;
379    there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)
380  when calling the "configure" command. If they are not specified, they default  when calling the "configure" command. If they are not specified, they default
381  to the values of CC and CFLAGS.  to the values of CC and CFLAGS.
382    
383    
384  Building on non-Unix systems  Using HP's ANSI C++ compiler (aCC)
385  ----------------------------  ----------------------------------
386    
387    Unless C++ support is disabled by specifying the "--disable-cpp" option of the
388    "configure" script, you must include the "-AA" option in the CXXFLAGS
389    environment variable in order for the C++ components to compile correctly.
390    
391    Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby
392    needed libraries fail to get included when specifying the "-AA" compiler
393    option. If you experience unresolved symbols when linking the C++ programs,
394    use the workaround of specifying the following environment variable prior to
395    running the "configure" script:
396    
397      CXXLDFLAGS="-lstd_v2 -lCsup_v2"
398    
399    
400  For a non-Unix system, read the comments in the file NON-UNIX-USE, though if  Making new tarballs
401  the system supports the use of "configure" and "make" you may be able to build  -------------------
402  PCRE in the same way as for Unix systems.  
403    The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
404  PCRE has been compiled on Windows systems and on Macintoshes, but I don't know  zip formats. However, if you have modified any of the man page sources in the
405  the details because I don't use those systems. It should be straightforward to  doc directory, you should first run the PrepareRelease script. This re-creates
406  build PCRE on any system that has a Standard C compiler, because it uses only  the .txt and HTML forms of the documentation from the man pages.
 Standard C functions.  
407    
408    
409  Testing PCRE  Testing PCRE
410  ------------  ------------
411    
412  To test PCRE on a Unix system, run the RunTest script that is created by the  To test the basic PCRE library on a Unix system, run the RunTest script that is
413  configuring process. (This can also be run by "make runtest", "make check", or  created by the configuring process. There is also a script called RunGrepTest
414  "make test".) For other systems, see the instructions in NON-UNIX-USE.  that tests the options of the pcregrep command. If the C++ wrapper library is
415    built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
416  The script runs the pcretest test program (which is documented in its own man  pcre_stringpiece_unittest are also built.
417  page) on each of the testinput files (in the testdata directory) in turn,  
418  and compares the output with the contents of the corresponding testoutput file.  Both the scripts and all the program tests are run if you obey "make check" or
419  A file called testtry is used to hold the output from pcretest. To run pcretest  "make test". For other systems, see the instructions in NON-UNIX-USE.
420  on just one of the test files, give its number as an argument to RunTest, for  
421  example:  The RunTest script runs the pcretest test program (which is documented in its
422    own man page) on each of the testinput files in the testdata directory in
423    turn, and compares the output with the contents of the corresponding testoutput
424    files. A file called testtry is used to hold the main output from pcretest
425    (testsavedregex is also used as a working file). To run pcretest on just one of
426    the test files, give its number as an argument to RunTest, for example:
427    
428    RunTest 2    RunTest 2
429    
430  The first file can also be fed directly into the perltest script to check that  The first test file can also be fed directly into the perltest.pl script to
431  Perl gives the same results. The only difference you should see is in the first  check that Perl gives the same results. The only difference you should see is
432  few lines, where the Perl version is given instead of the PCRE version.  in the first few lines, where the Perl version is given instead of the PCRE
433    version.
434    
435  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
436  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
437  detection, and run-time flags that are specific to PCRE, as well as the POSIX  detection, and run-time flags that are specific to PCRE, as well as the POSIX
438  wrapper API. It also uses the debugging flag to check some of the internals of  wrapper API. It also uses the debugging flags to check some of the internals of
439  pcre_compile().  pcre_compile().
440    
441  If you build PCRE with a locale setting that is not the standard C locale, the  If you build PCRE with a locale setting that is not the standard C locale, the
# Line 247  running "configure". This file can be al Line 467  running "configure". This file can be al
467  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,
468  commented in the script, can be be used.)  commented in the script, can be be used.)
469    
470  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
471  UTF-8 features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
472    
473    The sixth test checks the support for Unicode character properties. It it not
474    run automatically unless PCRE is built with Unicode property support. To to
475    this you must set --enable-unicode-properties when running "configure".
476    
477    The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative
478    matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode
479    property support, respectively. The eighth and ninth tests are not run
480    automatically unless PCRE is build with the relevant support.
481    
482    
483  Character tables  Character tables
484  ----------------  ----------------
485    
486  PCRE uses four tables for manipulating and identifying characters. The final  For speed, PCRE uses four tables for manipulating and identifying characters
487  argument of the pcre_compile() function is a pointer to a block of memory  whose code point values are less than 256. The final argument of the
488  containing the concatenated tables. A call to pcre_maketables() can be used to  pcre_compile() function is a pointer to a block of memory containing the
489  generate a set of tables in the current locale. If the final argument for  concatenated tables. A call to pcre_maketables() can be used to generate a set
490  pcre_compile() is passed as NULL, a set of default tables that is built into  of tables in the current locale. If the final argument for pcre_compile() is
491  the binary is used.  passed as NULL, a set of default tables that is built into the binary is used.
492    
493  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
494  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 268  such as isalnum(), isalpha(), isupper(), Line 497  such as isalnum(), isalpha(), isupper(),
497  sources. This means that the default C locale which is set for your system will  sources. This means that the default C locale which is set for your system will
498  control the contents of these default tables. You can change the default tables  control the contents of these default tables. You can change the default tables
499  by editing chartables.c and then re-building PCRE. If you do this, you should  by editing chartables.c and then re-building PCRE. If you do this, you should
500  probably also edit Makefile to ensure that the file doesn't ever get  take care to ensure that the file does not get automaticaly re-generated.
 re-generated.  
501    
502  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,
503  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
504  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
505  building 32-byte bit maps that represent character classes.  building 32-byte bit maps that represent character classes for code points less
506    than 256.
507    
508  The final 256-byte table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
509  follows:  follows:
# Line 290  You should not alter the set of characte Line 519  You should not alter the set of characte
519  will cause PCRE to malfunction.  will cause PCRE to malfunction.
520    
521    
522  Manifest  File manifest
523  --------  -------------
524    
525  The distribution should contain the following files:  The distribution should contain the following files:
526    
527  (A) The actual source files of the PCRE library functions and their  (A) Source files of the PCRE library functions and their headers:
     headers:  
528    
529    dftables.c            auxiliary program for building chartables.c    dftables.c             auxiliary program for building chartables.c
   get.c                 )  
   maketables.c          )  
   study.c               ) source of  
   pcre.c                )   the functions  
   pcreposix.c           )  
   printint.c            )  
   pcre.in               "source" for the header for the external API; pcre.h  
                           is built from this by "configure"  
   pcreposix.h           header for the external POSIX wrapper API  
   internal.h            header for internal use  
   config.in             template for config.h, which is built by configure  
   
 (B) Auxiliary files:  
   
   AUTHORS               information about the author of PCRE  
   ChangeLog             log of changes to the code  
   INSTALL               generic installation instructions  
   LICENCE               conditions for the use of PCRE  
   COPYING               the same, using GNU's standard name  
   Makefile.in           template for Unix Makefile, which is built by configure  
   NEWS                  important changes in this release  
   NON-UNIX-USE          notes on building PCRE on non-Unix systems  
   README                this file  
   RunTest.in            template for a Unix shell script for running tests  
   config.guess          ) files used by libtool,  
   config.sub            )   used only when building a shared library  
   configure             a configuring shell script (built by autoconf)  
   configure.in          the autoconf input used to build configure  
   doc/Tech.Notes        notes on the encoding  
   doc/*.3               man page sources for the PCRE functions  
   doc/*.1               man page sources for pcregrep and pcretest  
   doc/html/*            HTML documentation  
   doc/pcre.txt          plain text version of the man pages  
   doc/pcretest.txt      plain text documentation of test program  
   doc/perltest.txt      plain text documentation of Perl test program  
   install-sh            a shell script for installing files  
   ltmain.sh             file used to build a libtool script  
   pcretest.c            comprehensive test program  
   pcredemo.c            simple demonstration of coding calls to PCRE  
   perltest              Perl test program  
   pcregrep.c            source of a grep utility that uses PCRE  
   pcre-config.in        source of script which retains PCRE information  
   testdata/testinput1   test data, compatible with Perl  
   testdata/testinput2   test data for error messages and non-Perl things  
   testdata/testinput3   test data for locale-specific tests  
   testdata/testinput4   test data for UTF-8 tests compatible with Perl  
   testdata/testinput5   test data for other UTF-8 tests  
   testdata/testoutput1  test results corresponding to testinput1  
   testdata/testoutput2  test results corresponding to testinput2  
   testdata/testoutput3  test results corresponding to testinput3  
   testdata/testoutput4  test results corresponding to testinput4  
   testdata/testoutput5  test results corresponding to testinput5  
530    
531  (C) Auxiliary files for Win32 DLL    pcreposix.c            )
532      pcre_compile.c         )
533      pcre_config.c          )
534      pcre_dfa_exec.c        )
535      pcre_exec.c            )
536      pcre_fullinfo.c        )
537      pcre_get.c             ) sources for the functions in the library,
538      pcre_globals.c         )   and some internal functions that they use
539      pcre_info.c            )
540      pcre_maketables.c      )
541      pcre_newline.c         )
542      pcre_ord2utf8.c        )
543      pcre_refcount.c        )
544      pcre_study.c           )
545      pcre_tables.c          )
546      pcre_try_flipped.c     )
547      pcre_ucp_searchfuncs.c )
548      pcre_valid_utf8.c      )
549      pcre_version.c         )
550      pcre_xclass.c          )
551      pcre_printint.src      ) debugging function that is #included in pcretest,
552                             )   and can also be #included in pcre_compile()
553      pcre.h.in              template for pcre.h when built by "configure"
554      pcreposix.h            header for the external POSIX wrapper API
555      pcre_internal.h        header for internal use
556      ucp.h                  ) headers concerned with
557      ucpinternal.h          )   Unicode property handling
558      ucptable.h             ) (this one is the data table)
559    
560      config.h.in            template for config.h, which is built by "configure"
561    
562      pcrecpp.h              public header file for the C++ wrapper
563      pcrecpparg.h.in        template for another C++ header file
564      pcre_scanner.h         public header file for C++ scanner functions
565      pcrecpp.cc             )
566      pcre_scanner.cc        ) source for the C++ wrapper library
567    
568      pcre_stringpiece.h.in  template for pcre_stringpiece.h, the header for the
569                               C++ stringpiece functions
570      pcre_stringpiece.cc    source for the C++ stringpiece functions
571    
572    (B) Source files for programs that use PCRE:
573    
574      pcredemo.c             simple demonstration of coding calls to PCRE
575      pcregrep.c             source of a grep utility that uses PCRE
576      pcretest.c             comprehensive test program
577    
578    (C) Auxiliary files:
579    
580      132html                script to turn "man" pages into HTML
581      AUTHORS                information about the author of PCRE
582      ChangeLog              log of changes to the code
583      CleanTxt               script to clean nroff output for txt man pages
584      Detrail                script to remove trailing spaces
585      HACKING                some notes about the internals of PCRE
586      INSTALL                generic installation instructions
587      LICENCE                conditions for the use of PCRE
588      COPYING                the same, using GNU's standard name
589      Makefile.in            ) template for Unix Makefile, which is built by
590                             )   "configure"
591      Makefile.am            ) the automake input that was used to create
592                             )   Makefile.in
593      NEWS                   important changes in this release
594      NON-UNIX-USE           notes on building PCRE on non-Unix systems
595      PrepareRelease         script to make preparations for "make dist"
596      README                 this file
597      RunTest.in             template for a Unix shell script for running tests
598      RunGrepTest.in         template for a Unix shell script for pcregrep tests
599      aclocal.m4             m4 macros (generated by "aclocal")
600      config.guess           ) files used by libtool,
601      config.sub             )   used only when building a shared library
602      configure              a configuring shell script (built by autoconf)
603      configure.ac           ) the autoconf input that was used to build
604                             )   "configure" and config.h
605      depcomp                ) script to find program dependencies, generated by
606                             )   automake
607      doc/*.3                man page sources for the PCRE functions
608      doc/*.1                man page sources for pcregrep and pcretest
609      doc/index.html.src     the base HTML page
610      doc/html/*             HTML documentation
611      doc/pcre.txt           plain text version of the man pages
612      doc/pcretest.txt       plain text documentation of test program
613      doc/perltest.txt       plain text documentation of Perl test program
614      install-sh             a shell script for installing files
615      libpcre.pc.in          template for libpcre.pc for pkg-config
616      libpcrecpp.pc.in       template for libpcrecpp.pc for pkg-config
617      ltmain.sh              file used to build a libtool script
618      missing                ) common stub for a few missing GNU programs while
619                             )   installing, generated by automake
620      mkinstalldirs          script for making install directories
621      perltest.pl            Perl test program
622      pcre-config.in         source of script which retains PCRE information
623      pcrecpp_unittest.cc          )
624      pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
625      pcre_stringpiece_unittest.cc )
626      testdata/testinput*    test data for main library tests
627      testdata/testoutput*   expected test results
628      testdata/grep*         input and output for pcregrep tests
629    
630    dll.mk  (D) Auxiliary files for cmake support
   pcre.def  
631    
632  (D) Auxiliary file for VPASCAL    CMakeLists.txt
633      config-cmake.h.in
634    
635    (E) Auxiliary files for VPASCAL
636    
637    makevp.bat    makevp.bat
638      makevp-compile.txt
639      makevp-linklib.txt
640      pcregexp.pas
641    
642    (F) Auxiliary files for building PCRE "by hand"
643    
644      pcre.h.generic         ) a version of the public PCRE header file
645                             )   for use in non-"configure" environments
646      config.h.generic       ) a version of config.h for use in non-"configure"
647                             )   environments
648    
649    (F) Miscellaneous
650    
651      RunTest.bat            a script for running tests under Windows
652    
653  Philip Hazel <ph10@cam.ac.uk>  Philip Hazel
654  December 2003  Email local part: ph10
655    Email domain: cam.ac.uk
656    Last updated: March 2007

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

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12