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

Diff of /code/trunk/README

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.5