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

Diff of /code/trunk/README

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

revision 87 by nigel, Sat Feb 24 21:41:21 2007 UTC revision 111 by ph10, Thu Mar 8 16:53:09 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 a Unix-like system
20      Retrieving configuration information on a Unix-like system
21      Shared libraries on Unix-like systems
22      Cross-compiling on a Unix-like system
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 functions) to the compiler
57    flags (CFLAGS if you are using "configure" -- see below). This has the effect
58    of renaming the functions so that the names no longer clash. Of course, you
59    have to do the same thing for your applications, or write them using the new
60    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, you will end up with an installed set of
67  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"
68  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
69  supplied in two other forms; however, as there is no standard place to install  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 installed in
82       doc/index.html.       the directory <prefix>/share/doc/pcre/html.
83    
84    
85  Contributions by users of PCRE  Contributions by users of PCRE
# Line 60  You can find contributions from PCRE use Line 90  You can find contributions from PCRE use
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.  where there is also a README file giving brief descriptions of what they are.
93  Several of them provide support for compiling PCRE on various flavours of  Some are complete in themselves; others are pointers to URLs containing
94  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
95  others are pointers to URLs containing relevant files.  particular, several of the contributions provide support for compiling PCRE on
96    various flavours of Windows (I myself do not use Windows), but it is hoped that
97    more Windows support will find its way into the standard distribution.
98    
99    
100    Building PCRE on non-Unix systems
101    ---------------------------------
102    
103    For a non-Unix system, read the comments in the file NON-UNIX-USE, though if
104    the system supports the use of "configure" and "make" you may be able to build
105    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 a Unix-like system  Building PCRE on a Unix-like system
# Line 78  where you want the files to be created. Line 122  where you want the files to be created.
122  INSTALL.  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 114  library. You can read more about them in Line 158  library. You can read more about them in
158  . 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
159    support for the \P, \p, and \X sequences that recognize Unicode character    support for the \P, \p, and \X sequences that recognize Unicode character
160    properties, you must add --enable-unicode-properties to the "configure"    properties, you must add --enable-unicode-properties to the "configure"
161    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
162    property table); only the basic two-letter properties such as Lu are    property table); only the basic two-letter properties such as Lu are
163    supported.    supported.
164    
165  . You can build PCRE to recognize either CR or LF as the newline character,  . You can build PCRE to recognize either CR or LF or the sequence CRLF or any
166    instead 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
167    --newline-is-lf 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
168    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
169    newline character is LF.    (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 142  library. You can read more about them in Line 194  library. You can read more about them in
194    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
195    man page.    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
# Line 163  library. You can read more about them in Line 225  library. You can read more about them in
225    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
226    use deeply nested recursion.    use deeply nested recursion.
227    
228  The "configure" script builds eight files for the basic C library:  The "configure" script builds the following files for the basic C library:
229    
 . pcre.h is the header file for C programs that call PCRE  
230  . Makefile is the makefile that builds the library  . Makefile is the makefile that builds the library
231  . config.h contains build-time configuration options for the library  . config.h contains build-time configuration options for the library
232    . pcre.h is the public PCRE header file
233  . pcre-config is a script that shows the settings of "configure" options  . pcre-config is a script that shows the settings of "configure" options
234  . libpcre.pc is data for the pkg-config command  . libpcre.pc is data for the pkg-config command
235  . libtool is a script that builds shared and/or static libraries  . libtool is a script that builds shared and/or static libraries
236  . RunTest is a script for running tests on the library  . RunTest is a script for running tests on the basic C library
237  . RunGrepTest is a script for running tests on the pcregrep command  . RunGrepTest is a script for running tests on the pcregrep command
238    
239  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. These are
240    provided for the benefit of those who have to compile PCRE without the benefit
241    of "configure". If you use "configure", the distributed copies are replaced.
242    
243    If a C++ compiler is found, the following files are also built:
244    
245  . pcrecpp.h is the header file for programs that call PCRE via the C++ wrapper  . libpcrecpp.pc is data for the pkg-config command
246    . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper
247  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions
248    
249  The "configure" script also creates config.status, which is an executable  The "configure" script also creates config.status, which is an executable
# Line 184  script that can be run to recreate the c Line 251  script that can be run to recreate the c
251  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
252    
253  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
254  libpcre and libpcreposix, a test program called pcretest, and the pcregrep  libpcre and libpcreposix, a test program called pcretest, a demonstration
255  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
256  wrapper library, which is called libpcrecpp, and some test programs called  on your system, it also builds the C++ wrapper library, which is called
257  pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.  libpcrecpp, and some test programs called pcrecpp_unittest,
258    pcre_scanner_unittest, and pcre_stringpiece_unittest.
259  The command "make test" runs all the appropriate tests. Details of the PCRE  
260  tests are given in a separate section of this document, below.  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  You can use "make install" to copy the libraries, the public header files  
263  pcre.h, pcreposix.h, pcrecpp.h, and pcre_stringpiece.h (the last two only if  You can use "make install" to install PCRE into live directories on your
264  the C++ wrapper was built), and the man pages to appropriate live directories  system. The following are installed (file names are all relative to the
265  on your system, in the normal way.  <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.ps (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
315  remove any directories, because these are often shared with other programs.  remove any directories, because these are often shared with other programs.
316    
317    
318  Retrieving configuration information on Unix-like systems  Retrieving configuration information on a Unix-like system
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 226  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 272  to the values of CC and CFLAGS. Line 384  to the values of CC and CFLAGS.
384  Using HP's ANSI C++ compiler (aCC)  Using HP's ANSI C++ compiler (aCC)
385  ----------------------------------  ----------------------------------
386    
387  Unless C++ support is disabled by specifiying 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    
# Line 283  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, because it uses only  
 Standard C functions.  
407    
408    
409  Testing PCRE  Testing PCRE
# Line 305  To test PCRE on a Unix system, run the R Line 413  To test PCRE on a Unix system, run the R
413  configuring process. There is also a script called RunGrepTest that tests the  configuring process. There is also a script called RunGrepTest that tests the
414  options of the pcregrep command. If the C++ wrapper library is build, three  options of the pcregrep command. If the C++ wrapper library is build, three
415  test programs called pcrecpp_unittest, pcre_scanner_unittest, and  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  file. 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
426  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:
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
# Line 395  re-generated. Line 503  re-generated.
503  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,
504  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
505  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
506  building 32-byte bit maps that represent character classes.  building 32-byte bit maps that represent character classes for code points less
507    than 256.
508    
509  The final 256-byte table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
510  follows:  follows:
# Line 411  You should not alter the set of characte Line 520  You should not alter the set of characte
520  will cause PCRE to malfunction.  will cause PCRE to malfunction.
521    
522    
523  Manifest  File manifest
524  --------  -------------
525    
526  The distribution should contain the following files:  The distribution should contain the following files:
527    
528  (A) The actual source files of the PCRE library functions and their  (A) Source files of the PCRE library functions and their headers:
529      headers:  
530      dftables.c             auxiliary program for building chartables.c
531    
532    dftables.c            auxiliary program for building chartables.c    pcreposix.c            )
533      pcre_compile.c         )
534      pcre_config.c          )
535      pcre_dfa_exec.c        )
536      pcre_exec.c            )
537      pcre_fullinfo.c        )
538      pcre_get.c             ) sources for the functions in the library,
539      pcre_globals.c         )   and some internal functions that they use
540      pcre_info.c            )
541      pcre_maketables.c      )
542      pcre_newline.c         )
543      pcre_ord2utf8.c        )
544      pcre_refcount.c        )
545      pcre_study.c           )
546      pcre_tables.c          )
547      pcre_try_flipped.c     )
548      pcre_ucp_searchfuncs.c )
549      pcre_valid_utf8.c      )
550      pcre_version.c         )
551      pcre_xclass.c          )
552      pcre_printint.src      ) debugging function that is #included in pcretest,
553                             )   and can also be #included in pcre_compile()
554      pcre.h.in              template for pcre.h when built by "configure"
555      pcreposix.h            header for the external POSIX wrapper API
556      pcre_internal.h        header for internal use
557      ucp.h                  ) headers concerned with
558      ucpinternal.h          )   Unicode property handling
559      ucptable.h             ) (this one is the data table)
560    
561      config.h.in            template for config.h, which is built by "configure"
562    
563      pcrecpp.h              public header file for the C++ wrapper
564      pcrecpparg.h.in        template for another C++ header file
565      pcre_scanner.h         public header file for C++ scanner functions
566      pcrecpp.cc             )
567      pcre_scanner.cc        ) source for the C++ wrapper library
568    
569      pcre_stringpiece.h.in  template for pcre_stringpiece.h, the header for the
570                               C++ stringpiece functions
571      pcre_stringpiece.cc    source for the C++ stringpiece functions
572    
573    (B) Source files for programs that use PCRE:
574    
575      pcredemo.c             simple demonstration of coding calls to PCRE
576      pcregrep.c             source of a grep utility that uses PCRE
577      pcretest.c             comprehensive test program
578    
579    (C) Auxiliary files:
580    
581      132html                script to turn "man" pages into HTML
582      AUTHORS                information about the author of PCRE
583      ChangeLog              log of changes to the code
584      CleanTxt               script to clean nroff output for txt man pages
585      Detrail                script to remove trailing spaces
586      Index.html             the base HTML page
587      INSTALL                generic installation instructions
588      LICENCE                conditions for the use of PCRE
589      COPYING                the same, using GNU's standard name
590      Makefile.in            ) template for Unix Makefile, which is built by
591                             )   "configure"
592      Makefile.am            ) the automake input that was used to create
593                             )   Makefile.in
594      NEWS                   important changes in this release
595      NON-UNIX-USE           notes on building PCRE on non-Unix systems
596      PrepareRelease         script to make preparations for "make dist"
597      README                 this file
598      RunTest.in             template for a Unix shell script for running tests
599      RunGrepTest.in         template for a Unix shell script for pcregrep tests
600      aclocal.m4             m4 macros (generated by "aclocal")
601      config.guess           ) files used by libtool,
602      config.sub             )   used only when building a shared library
603      configure              a configuring shell script (built by autoconf)
604      configure.ac           ) the autoconf input that was used to build
605                             )   "configure" and config.h
606      depcomp                ) script to find program dependencies, generated by
607                             )   automake
608      doc/*.3                man page sources for the PCRE functions
609      doc/*.1                man page sources for pcregrep and pcretest
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    pcreposix.c           )  (D) Auxiliary files for cmake support
   pcre_compile.c        )  
   pcre_config.c         )  
   pcre_dfa_exec.c       )  
   pcre_exec.c           )  
   pcre_fullinfo.c       )  
   pcre_get.c            ) sources for the functions in the library,  
   pcre_globals.c        )   and some internal functions that they use  
   pcre_info.c           )  
   pcre_maketables.c     )  
   pcre_ord2utf8.c       )  
   pcre_printint.c       )  
   pcre_study.c          )  
   pcre_tables.c         )  
   pcre_try_flipped.c    )  
   pcre_ucp_findchar.c   )  
   pcre_valid_utf8.c     )  
   pcre_version.c        )  
   pcre_xclass.c         )  
   
   ucp_findchar.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  
   pcre_internal.h       header for internal use  
   config.in             template for config.h, which is built by configure  
   
   pcrecpp.h             the header file for the C++ wrapper  
   pcrecpparg.h.in       "source" for another C++ header file  
   pcrecpp.cc            )  
   pcre_scanner.cc       ) source for the C++ wrapper library  
   
   pcre_stringpiece.h.in "source" for pcre_stringpiece.h, the header for the  
                           C++ stringpiece functions  
   pcre_stringpiece.cc   source for the C++ stringpiece functions  
   
 (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  
   RunGrepTest.in        template for a Unix shell script for pcregrep 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  
   pcrecpp_unittest.c           )  
   pcre_scanner_unittest.c      ) test programs for the C++ wrapper  
   pcre_stringpiece_unittest.c  )  
   testdata/testinput*   test data for main library tests  
   testdata/testoutput*  expected test results  
   testdata/grep*        input and output for pcregrep tests  
   
 (C) Auxiliary files for Win32 DLL  
   
   libpcre.def  
   libpcreposix.def  
   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      !compile.txt
639      !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  Philip Hazel
654  Email local part: ph10  Email local part: ph10
655  Email domain: cam.ac.uk  Email domain: cam.ac.uk
656  January 2006  Last updated: March 2007

Legend:
Removed from v.87  
changed lines
  Added in v.111

  ViewVC Help
Powered by ViewVC 1.1.5