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

Diff of /code/trunk/README

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

revision 99 by ph10, Tue Mar 6 12:27:42 2007 UTC revision 122 by ph10, Mon Mar 12 15:10:25 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
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      The PCRE APIs
16      Documentation for PCRE
17      Contributions by users of PCRE
18      Building PCRE on non-Unix systems
19      Building PCRE on Unix-like systems
20      Retrieving configuration information on Unix-like systems
21      Shared libraries on Unix-like systems
22      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  The PCRE APIs
# Line 15  PCRE is written in C, and it has its own Line 34  PCRE is written in C, and it has its own
34  set of C++ wrapper functions, courtesy of Google Inc. (see the pcrecpp man page  set of C++ wrapper functions, courtesy of Google Inc. (see the pcrecpp man page
35  for details).  for details).
36    
37  Also included are a set of C wrapper functions that are based on the POSIX  Also included in the distribution are a set of C wrapper functions that are
38  API. These end up in the library called libpcreposix. Note that this just  based on the POSIX API. These end up in the library called libpcreposix. Note
39  provides a POSIX calling interface to PCRE: the regular expressions themselves  that this just provides a POSIX calling interface to PCRE; the regular
40  still follow Perl syntax and semantics. The header file for the POSIX-style  expressions themselves still follow Perl syntax and semantics. The POSIX API is
41  functions is called pcreposix.h. The official POSIX name is regex.h, but I  restricted, and does not give full access to all of PCRE's facilities.
42  didn't want to risk possible problems with existing files of that name by  
43  distributing it that way. To use it with an existing program that uses the  The header file for the POSIX-style functions is called pcreposix.h. The
44  POSIX API, it will have to be renamed or pointed at by a link.  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  Documentation for PCRE
64  ----------------------  ----------------------
65    
66  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 on a Unix-like system, you will end up
67  man pages whose names all start with "pcre". The one that is just called "pcre"  with a set of man pages whose names all start with "pcre". The one that is just
68  lists all the others. In addition to these man pages, the PCRE documentation is  called "pcre" lists all the others. In addition to these man pages, the PCRE
69  supplied in two other forms; however, as there is no standard place to install  documentation is supplied in two other forms:
70  them, they are left in the doc directory of the unpacked source distribution.  
71  These forms are:    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    1. Files called doc/pcre.txt, doc/pcregrep.txt, and doc/pcretest.txt. The       concatenation of the text forms of all the section 3 man pages except
74       first of these is a concatenation of the text forms of all the section 3       those that summarize individual functions. The other two are the text
75       man pages except those that summarize individual functions. The other two       forms of the section 1 man pages for the pcregrep and pcretest commands.
76       are the text forms of the section 1 man pages for the pcregrep and       These text forms are provided for ease of scanning with text editors or
77       pcretest commands. Text forms are provided for ease of scanning with text       similar tools. They are installed in <prefix>/share/doc/pcre, where
78       editors or similar tools.       <prefix> is the installation prefix (defaulting to /usr/local).
79    
80    2. A subdirectory called doc/html contains all the documentation in HTML    2. A set of files containing all the documentation in HTML form, hyperlinked
81       form, hyperlinked in various ways, and rooted in a file called       in various ways, and rooted in a file called index.html, is distributed in
82       doc/index.html.       doc/html and installed in <prefix>/share/doc/pcre/html.
83    
84    
85  Contributions by users of PCRE  Contributions by users of PCRE
# Line 59  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  Building PCRE on a Unix-like system  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  If you are using HP's ANSI C++ compiler (aCC), please see the special note  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.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
# Line 75  To build PCRE on a Unix-like system, fir Line 119  To build PCRE on a Unix-like system, fir
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 125  library. You can read more about them in Line 169  library. You can read more about them in
169    (the Unix standard). You can specify the default newline indicator by adding    (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    --newline-is-cr or --newline-is-lf or --newline-is-crlf or --newline-is-any
171    to the "configure" command, respectively.    to the "configure" command, respectively.
172    
173    If you specify --newline-is-cr or --newline-is-crlf, some of the standard    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    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    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    failures. With --newline-is-any, many tests should succeed, but there may be
177    some failures.    some failures.
# Line 147  library. You can read more about them in Line 191  library. You can read more about them in
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  . 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    during a matching process. This also has a default of ten million, which is
# Line 163  library. You can read more about them in Line 207  library. You can read more about them in
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.
   (and 5 if you are using UTF-8) will fail. Part of the output of these tests  
   is a representation of the compiled pattern, and this changes with the link  
   size.  
211    
212  . 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
213    pcre_exec() does not call itself recursively. Instead, it uses blocks of data    pcre_exec() does not call itself recursively. Instead, it uses memory blocks
214    from the heap via special functions pcre_stack_malloc() and pcre_stack_free()    obtained from the heap via the special functions pcre_stack_malloc() and
215    to save data that would otherwise be saved on the stack. To build PCRE like    pcre_stack_free() to save data that would otherwise be saved on the stack. To
216    this, use    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. This applies only to the    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    pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not
223    use deeply nested recursion.    use deeply nested recursion. There is a discussion about stack sizes in the
224      pcrestack man page.
225    
226  The "configure" script builds eight files for the basic C library:  The "configure" script builds the following files for the basic C library:
227    
228  . Makefile is the makefile that builds the library  . Makefile is the makefile that builds the library
229  . config.h contains build-time configuration options for the library  . 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  . pcre-config is a script that shows the settings of "configure" options
232  . libpcre.pc is data for the pkg-config command  . libpcre.pc is data for the pkg-config command
233  . libtool is a script that builds shared and/or static libraries  . libtool is a script that builds shared and/or static libraries
234  . RunTest is a script for running tests on the library  . RunTest is a script for running tests on the basic C library
235  . RunGrepTest is a script for running tests on the pcregrep command  . RunGrepTest is a script for running tests on the pcregrep command
236    
237  In addition, if a C++ compiler is found, the following are also built:  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  . pcrecpp.h is the header file for programs that call PCRE via the C++ wrapper  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  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions
247    
248  The "configure" script also creates config.status, which is an executable  The "configure" script also creates config.status, which is an executable
# Line 201  script that can be run to recreate the c Line 250  script that can be run to recreate the c
250  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
251    
252  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
253  libpcre and libpcreposix, a test program called pcretest, and the pcregrep  libpcre and libpcreposix, a test program called pcretest, a demonstration
254  command. If a C++ compiler was found on your system, it also builds the C++  program called pcredemo, and the pcregrep command. If a C++ compiler was found
255  wrapper library, which is called libpcrecpp, and some test programs called  on your system, "make" also builds the C++ wrapper library, which is called
256  pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.  libpcrecpp, and some test programs called pcrecpp_unittest,
257    pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper
258  The command "make test" runs all the appropriate tests. Details of the PCRE  can be disabled by adding --disable-cpp to the "configure" command.
259  tests are given in a separate section of this document, below.  
260    The command "make check" runs all the appropriate tests. Details of the PCRE
261  You can use "make install" to copy the libraries, the public header files  tests are given below in a separate section of this document.
262  pcre.h, pcreposix.h, pcrecpp.h, and pcre_stringpiece.h (the last two only if  
263  the C++ wrapper was built), and the man pages to appropriate live directories  You can use "make install" to install PCRE into live directories on your
264  on your system, in the normal way.  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".  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  This removes all the files that "make install" installed. However, it does not
# Line 222  remove any directories, because these ar Line 318  remove any directories, because these ar
318  Retrieving configuration information on Unix-like systems  Retrieving configuration information on Unix-like systems
319  ---------------------------------------------------------  ---------------------------------------------------------
320    
321  Running "make install" also installs the command pcre-config, which can be used  Running "make install" installs the command pcre-config, which can be used to
322  to recall information about the PCRE configuration and installation. For  recall information about the PCRE configuration and installation. For example:
 example:  
323    
324    pcre-config --version    pcre-config --version
325    
# Line 243  single command is used. For example: Line 338  single command is used. For example:
338    pkg-config --cflags pcre    pkg-config --cflags pcre
339    
340  The data is held in *.pc files that are installed in a directory called  The data is held in *.pc files that are installed in a directory called
341  pkgconfig.  <prefix>/lib/pkgconfig.
342    
343    
344  Shared libraries on Unix-like systems  Shared libraries on Unix-like systems
# Line 260  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
# Line 272  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
# Line 290  Using HP's ANSI C++ compiler (aCC) Line 385  Using HP's ANSI C++ compiler (aCC)
385  ----------------------------------  ----------------------------------
386    
387  Unless C++ support is disabled by specifying the "--disable-cpp" option of the  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  "configure" script, you must include the "-AA" option in the CXXFLAGS
389  environment variable in order for the C++ components to compile correctly.  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  Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby
# Line 300  use the workaround of specifying the fol Line 395  use the workaround of specifying the fol
395  running the "configure" script:  running the "configure" script:
396    
397    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
398    
399    
400    Making new tarballs
401    -------------------
402    
403  Building on non-Unix systems  The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
404  ----------------------------  zip formats. However, if you have modified any of the man page sources in the
405    doc directory, you should first run the PrepareRelease script. This re-creates
406  For a non-Unix system, read the comments in the file NON-UNIX-USE, though if  the .txt and HTML forms of the documentation from the man pages.
 the system supports the use of "configure" and "make" you may be able to build  
 PCRE in the same way as for Unix systems.  
   
 PCRE has been compiled on Windows systems and on Macintoshes, but I don't know  
 the details because I don't use those systems. It should be straightforward to  
 build PCRE on any system that has a Standard C compiler and library, because it  
 uses only 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. There is also a script called RunGrepTest that tests the  created by the configuring process. There is also a script called RunGrepTest
414  options of the pcregrep command. If the C++ wrapper library is build, three  that tests the options of the pcregrep command. If the C++ wrapper library is
415  test programs called pcrecpp_unittest, pcre_scanner_unittest, and  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
416  pcre_stringpiece_unittest are provided.  pcre_stringpiece_unittest are also built.
417    
418  Both the scripts and all the program tests are run if you obey "make runtest",  Both the scripts and all the program tests are run if you obey "make check" or
419  "make check", or "make test". For other systems, see the instructions in  "make test". For other systems, see the instructions in NON-UNIX-USE.
 NON-UNIX-USE.  
420    
421  The RunTest script runs the pcretest test program (which is documented in its  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  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  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  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  (testsavedregex is also used as a working file). To run pcretest on just one of
# Line 337  the test files, give its number as an ar Line 427  the test files, give its number as an ar
427    
428    RunTest 2    RunTest 2
429    
430  The first test file can also be fed directly into the perltest script to check  The first test file can also be fed directly into the perltest.pl script to
431  that Perl gives the same results. The only difference you should see is in the  check that Perl gives the same results. The only difference you should see is
432  first 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 379  commented in the script, can be be used. Line 470  commented in the script, can be be used.
470  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8
471  features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
472    
473  The sixth and test checks the support for Unicode character properties. It it  The sixth test checks the support for Unicode character properties. It it not
474  not run automatically unless PCRE is built with Unicode property support. To to  run automatically unless PCRE is built with Unicode property support. To to
475  this you must set --enable-unicode-properties when running "configure".  this you must set --enable-unicode-properties when running "configure".
476    
477  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative
# Line 392  automatically unless PCRE is build with Line 483  automatically unless PCRE is build with
483  Character tables  Character tables
484  ----------------  ----------------
485    
486  PCRE uses four tables for manipulating and identifying characters whose values  For speed, PCRE uses four tables for manipulating and identifying characters
487  are less than 256. The final argument of the pcre_compile() function is a  whose code point values are less than 256. The final argument of the
488  pointer to a block of memory containing the concatenated tables. A call to  pcre_compile() function is a pointer to a block of memory containing the
489  pcre_maketables() can be used to generate a set of tables in the current  concatenated tables. A call to pcre_maketables() can be used to generate a set
490  locale. If the final argument for pcre_compile() is passed as NULL, a set of  of tables in the current locale. If the final argument for pcre_compile() is
491  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.
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 406  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 428  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
530    
531    pcreposix.c           )    pcreposix.c            )
532    pcre_compile.c        )    pcre_compile.c         )
533    pcre_config.c         )    pcre_config.c          )
534    pcre_dfa_exec.c       )    pcre_dfa_exec.c        )
535    pcre_exec.c           )    pcre_exec.c            )
536    pcre_fullinfo.c       )    pcre_fullinfo.c        )
537    pcre_get.c            ) sources for the functions in the library,    pcre_get.c             ) sources for the functions in the library,
538    pcre_globals.c        )   and some internal functions that they use    pcre_globals.c         )   and some internal functions that they use
539    pcre_info.c           )    pcre_info.c            )
540    pcre_maketables.c     )    pcre_maketables.c      )
541    pcre_newline.c        )    pcre_newline.c         )
542    pcre_ord2utf8.c       )    pcre_ord2utf8.c        )
543    pcre_refcount.c       )    pcre_refcount.c        )
544    pcre_study.c          )    pcre_study.c           )
545    pcre_tables.c         )    pcre_tables.c          )
546    pcre_try_flipped.c    )    pcre_try_flipped.c     )
547    pcre_ucp_searchfuncs.c)    pcre_ucp_searchfuncs.c )
548    pcre_valid_utf8.c     )    pcre_valid_utf8.c      )
549    pcre_version.c        )    pcre_version.c         )
550    pcre_xclass.c         )    pcre_xclass.c          )
551      pcre_printint.src      ) debugging function that is #included in pcretest,
552    pcre_printint.src     ) debugging function that is #included in pcretest, and                           )   and can also be #included in pcre_compile()
553                          )   can also be #included in pcre_compile()    pcre.h.in              template for pcre.h when built by "configure"
554      pcreposix.h            header for the external POSIX wrapper API
555    pcre.h                the public PCRE header file    pcre_internal.h        header for internal use
556    pcreposix.h           header for the external POSIX wrapper API    ucp.h                  ) headers concerned with
557    pcre_internal.h       header for internal use    ucpinternal.h          )   Unicode property handling
558    ucp.h                 ) headers concerned with    ucptable.h             ) (this one is the data table)
559    ucpinternal.h         )   Unicode property handling  
560    ucptable.h            ) (this one is the data table)    config.h.in            template for config.h, which is built by "configure"
561    config.in             template for config.h, which is built by configure  
562      pcrecpp.h              public header file for the C++ wrapper
563    pcrecpp.h             the header file for the C++ wrapper    pcrecpparg.h.in        template for another C++ header file
564    pcrecpparg.h.in       "source" for another C++ header file    pcre_scanner.h         public header file for C++ scanner functions
565    pcrecpp.cc            )    pcrecpp.cc             )
566    pcre_scanner.cc       ) source for the C++ wrapper library    pcre_scanner.cc        ) source for the C++ wrapper library
567    
568    pcre_stringpiece.h.in "source" for pcre_stringpiece.h, the header for the    pcre_stringpiece.h.in  template for pcre_stringpiece.h, the header for the
569                            C++ stringpiece functions                             C++ stringpiece functions
570    pcre_stringpiece.cc   source for the C++ stringpiece functions    pcre_stringpiece.cc    source for the C++ stringpiece functions
571    
572  (B) Auxiliary files:  (B) Source files for programs that use PCRE:
573    
574    AUTHORS               information about the author of PCRE    pcredemo.c             simple demonstration of coding calls to PCRE
575    ChangeLog             log of changes to the code    pcregrep.c             source of a grep utility that uses PCRE
576    INSTALL               generic installation instructions    pcretest.c             comprehensive test program
577    LICENCE               conditions for the use of PCRE  
578    COPYING               the same, using GNU's standard name  (C) Auxiliary files:
579    Makefile.in           template for Unix Makefile, which is built by configure  
580    NEWS                  important changes in this release    132html                script to turn "man" pages into HTML
581    NON-UNIX-USE          notes on building PCRE on non-Unix systems    AUTHORS                information about the author of PCRE
582    README                this file    ChangeLog              log of changes to the code
583    RunTest.in            template for a Unix shell script for running tests    CleanTxt               script to clean nroff output for txt man pages
584    RunGrepTest.in        template for a Unix shell script for pcregrep tests    Detrail                script to remove trailing spaces
585    config.guess          ) files used by libtool,    Index.html             the base HTML page
586    config.sub            )   used only when building a shared library    INSTALL                generic installation instructions
587    config.h.in           "source" for the config.h header file    LICENCE                conditions for the use of PCRE
588    configure             a configuring shell script (built by autoconf)    COPYING                the same, using GNU's standard name
589    configure.ac          the autoconf input used to build configure    Makefile.in            ) template for Unix Makefile, which is built by
590    doc/Tech.Notes        notes on the encoding                           )   "configure"
591    doc/*.3               man page sources for the PCRE functions    Makefile.am            ) the automake input that was used to create
592    doc/*.1               man page sources for pcregrep and pcretest                           )   Makefile.in
593    doc/html/*            HTML documentation    NEWS                   important changes in this release
594    doc/pcre.txt          plain text version of the man pages    NON-UNIX-USE           notes on building PCRE on non-Unix systems
595    doc/pcretest.txt      plain text documentation of test program    PrepareRelease         script to make preparations for "make dist"
596    doc/perltest.txt      plain text documentation of Perl test program    README                 this file
597    install-sh            a shell script for installing files    RunTest.in             template for a Unix shell script for running tests
598    libpcre.pc.in         "source" for libpcre.pc for pkg-config    RunGrepTest.in         template for a Unix shell script for pcregrep tests
599    ltmain.sh             file used to build a libtool script    aclocal.m4             m4 macros (generated by "aclocal")
600    mkinstalldirs         script for making install directories    config.guess           ) files used by libtool,
601    pcretest.c            comprehensive test program    config.sub             )   used only when building a shared library
602    pcredemo.c            simple demonstration of coding calls to PCRE    configure              a configuring shell script (built by autoconf)
603    perltest.pl           Perl test program    configure.ac           ) the autoconf input that was used to build
604    pcregrep.c            source of a grep utility that uses PCRE                           )   "configure" and config.h
605    pcre-config.in        source of script which retains PCRE information    depcomp                ) script to find program dependencies, generated by
606    pcrecpp_unittest.c           )                           )   automake
607    pcre_scanner_unittest.c      ) test programs for the C++ wrapper    doc/*.3                man page sources for the PCRE functions
608    pcre_stringpiece_unittest.c  )    doc/*.1                man page sources for pcregrep and pcretest
609    testdata/testinput*   test data for main library tests    doc/html/*             HTML documentation
610    testdata/testoutput*  expected test results    doc/pcre.txt           plain text version of the man pages
611    testdata/grep*        input and output for pcregrep tests    doc/pcretest.txt       plain text documentation of test program
612      doc/perltest.txt       plain text documentation of Perl test program
613      install-sh             a shell script for installing files
614      libpcre.pc.in          template for libpcre.pc for pkg-config
615      libpcrecpp.pc.in       template for libpcrecpp.pc for pkg-config
616      ltmain.sh              file used to build a libtool script
617      missing                ) common stub for a few missing GNU programs while
618                             )   installing, generated by automake
619      mkinstalldirs          script for making install directories
620      perltest.pl            Perl test program
621      pcre-config.in         source of script which retains PCRE information
622      pcrecpp_unittest.cc          )
623      pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
624      pcre_stringpiece_unittest.cc )
625      testdata/testinput*    test data for main library tests
626      testdata/testoutput*   expected test results
627      testdata/grep*         input and output for pcregrep tests
628    
629  (C) Auxiliary files for Win32 DLL  (D) Auxiliary files for cmake support
630    
631    libpcre.def    CMakeLists.txt
632    libpcreposix.def    config-cmake.h.in
633    
634  (D) Auxiliary file for VPASCAL  (E) Auxiliary files for VPASCAL
635    
636    makevp.bat    makevp.bat
637      !compile.txt
638      !linklib.txt
639      pcregexp.pas
640    
641    (F) Auxiliary files for building PCRE "by hand"
642    
643      pcre.h.generic         ) a version of the public PCRE header file
644                             )   for use in non-"configure" environments
645      config.h.generic       ) a version of config.h for use in non-"configure"
646                             )   environments
647    
648    (F) Miscellaneous
649    
650      RunTest.bat            a script for running tests under Windows
651    
652  Philip Hazel  Philip Hazel
653  Email local part: ph10  Email local part: ph10
654  Email domain: cam.ac.uk  Email domain: cam.ac.uk
655  March 2007  Last updated: March 2007

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

  ViewVC Help
Powered by ViewVC 1.1.5