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

Diff of /code/trunk/README

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

revision 122 by ph10, Mon Mar 12 15:10:25 2007 UTC revision 374 by ph10, Fri Sep 5 16:42:28 2008 UTC
# Line 1  Line 1 
1  README file for PCRE (Perl-compatible regular expression library)  README file for PCRE (Perl-compatible regular expression library)
2  -----------------------------------------------------------------  -----------------------------------------------------------------
3    
4  The latest release of PCRE is always available from  The latest release of PCRE is always available in three alternative formats
5    from:
6    
7    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
8      ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.bz2
9      ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.zip
10    
11  There is a mailing list for discussion about the development of PCRE at  There is a mailing list for discussion about the development of PCRE at
12    
13    pcre-dev@exim.org    pcre-dev@exim.org
14    
15  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.
16  The contents of this README file are:  The contents of this README file are:
# Line 30  The contents of this README file are: Line 33  The contents of this README file are:
33  The PCRE APIs  The PCRE APIs
34  -------------  -------------
35    
36  PCRE is written in C, and it has its own API. The distribution now includes a  PCRE is written in C, and it has its own API. The distribution also includes a
37  set of C++ wrapper functions, courtesy of Google Inc. (see the pcrecpp man page  set of C++ wrapper functions (see the pcrecpp man page for details), courtesy
38  for details).  of Google Inc.
39    
40  Also included in the distribution are a set of C wrapper functions that are  In addition, there is a set of C wrapper functions that are based on the POSIX
41  based on the POSIX API. These end up in the library called libpcreposix. Note  regular expression API (see the pcreposix man page). These end up in the
42  that this just provides a POSIX calling interface to PCRE; the regular  library called libpcreposix. Note that this just provides a POSIX calling
43  expressions themselves still follow Perl syntax and semantics. The POSIX API is  interface to PCRE; the regular expressions themselves still follow Perl syntax
44  restricted, and does not give full access to all of PCRE's facilities.  and semantics. The POSIX API is restricted, and does not give full access to
45    all of PCRE's facilities.
46    
47  The header file for the POSIX-style functions is called pcreposix.h. The  The header file for the POSIX-style functions is called pcreposix.h. The
48  official POSIX name is regex.h, but I did not want to risk possible problems  official POSIX name is regex.h, but I did not want to risk possible problems
# Line 74  documentation is supplied in two other f Line 78  documentation is supplied in two other f
78       those that summarize individual functions. The other two are the text       those that summarize individual functions. The other two are the text
79       forms of the section 1 man pages for the pcregrep and pcretest commands.       forms of the section 1 man pages for the pcregrep and pcretest commands.
80       These text forms are provided for ease of scanning with text editors or       These text forms are provided for ease of scanning with text editors or
81       similar tools. They are installed in <prefix>/share/doc/pcre, where       similar tools. They are installed in <prefix>/share/doc/pcre, where
82       <prefix> is the installation prefix (defaulting to /usr/local).       <prefix> is the installation prefix (defaulting to /usr/local).
83    
84    2. A set of files containing all the documentation in HTML form, hyperlinked    2. A set of files containing all the documentation in HTML form, hyperlinked
85       in various ways, and rooted in a file called index.html, is distributed in       in various ways, and rooted in a file called index.html, is distributed in
86       doc/html and installed in <prefix>/share/doc/pcre/html.       doc/html and installed in <prefix>/share/doc/pcre/html.
87    
88    
# Line 91  You can find contributions from PCRE use Line 95  You can find contributions from PCRE use
95    
96  There is a README file giving brief descriptions of what they are. Some are  There is a README file giving brief descriptions of what they are. Some are
97  complete in themselves; others are pointers to URLs containing relevant files.  complete in themselves; others are pointers to URLs containing relevant files.
98  Some of this material is likely to be well out-of-date. In particular, several  Some of this material is likely to be well out-of-date. Several of the earlier
99  of the contributions provide support for compiling PCRE on various flavours of  contributions provided support for compiling PCRE on various flavours of
100  Windows (I myself do not use Windows), but nowadays there is more Windows  Windows (I myself do not use Windows). Nowadays there is more Windows support
101  support in the standard distribution.  in the standard distribution, so these contibutions have been archived.
102    
103    
104  Building PCRE on non-Unix systems  Building PCRE on non-Unix systems
# Line 102  Building PCRE on non-Unix systems Line 106  Building PCRE on non-Unix systems
106    
107  For a non-Unix system, please read the comments in the file NON-UNIX-USE,  For a non-Unix system, please read the comments in the file NON-UNIX-USE,
108  though if your system supports the use of "configure" and "make" you may be  though if your system supports the use of "configure" and "make" you may be
109  able to build PCRE in the same way as for Unix-like systems.  able to build PCRE in the same way as for Unix-like systems. PCRE can also be
110    configured in many platform environments using the GUI facility of CMake's
111    CMakeSetup. It creates Makefiles, solution files, etc.
112    
113  PCRE has been compiled on many different operating systems. It should be  PCRE has been compiled on many different operating systems. It should be
114  straightforward to build PCRE on any system that has a Standard C compiler and  straightforward to build PCRE on any system that has a Standard C compiler and
# Line 115  Building PCRE on Unix-like systems Line 121  Building PCRE on Unix-like systems
121  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
122  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
123    
124    The following instructions assume the use of the widely used "configure, make,
125    make install" process. There is also support for CMake in the PCRE
126    distribution; there are some comments about using CMake in the NON-UNIX-USE
127    file, though it can also be used in Unix-like systems.
128    
129  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
130  PCRE distribution directory, with your current directory set to the directory  PCRE distribution directory, with your current directory set to the directory
131  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 147  library. You can read more about them in Line 158  library. You can read more about them in
158    
159  . If you want to suppress the building of the C++ wrapper library, you can add  . If you want to suppress the building of the C++ wrapper library, you can add
160    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
161    will try to find a C++ compiler and C++ header files, and if it succeeds, it    it will try to find a C++ compiler and C++ header files, and if it succeeds,
162    will try to build the C++ wrapper.    it will try to build the C++ wrapper.
163    
164  . 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,
165    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
# Line 163  library. You can read more about them in Line 174  library. You can read more about them in
174    supported.    supported.
175    
176  . You can build PCRE to recognize either CR or LF or the sequence CRLF or any  . You can build PCRE to recognize either CR or LF or the sequence CRLF or any
177    of the Unicode newline sequences as indicating the end of a line. Whatever    of the preceding, or any of the Unicode newline sequences as indicating the
178    you specify at build time is the default; the caller of PCRE can change the    end of a line. Whatever you specify at build time is the default; the caller
179    selection at run time. The default newline indicator is a single LF character    of PCRE can change the selection at run time. The default newline indicator
180    (the Unix standard). You can specify the default newline indicator by adding    is a single LF character (the Unix standard). You can specify the default
181    --newline-is-cr or --newline-is-lf or --newline-is-crlf or --newline-is-any    newline indicator by adding --enable-newline-is-cr or --enable-newline-is-lf
182    to the "configure" command, respectively.    or --enable-newline-is-crlf or --enable-newline-is-anycrlf or
183      --enable-newline-is-any to the "configure" command, respectively.
184    If you specify --newline-is-cr or --newline-is-crlf, some of the standard  
185    tests will fail, because the lines in the test files end with LF. Even if    If you specify --enable-newline-is-cr or --enable-newline-is-crlf, some of
186    the files are edited to change the line endings, there are likely to be some    the standard tests will fail, because the lines in the test files end with
187    failures. With --newline-is-any, many tests should succeed, but there may be    LF. Even if the files are edited to change the line endings, there are likely
188    some failures.    to be some failures. With --enable-newline-is-anycrlf or
189      --enable-newline-is-any, many tests should succeed, but there may be some
190      failures.
191    
192    . By default, the sequence \R in a pattern matches any Unicode line ending
193      sequence. This is independent of the option specifying what PCRE considers to
194      be the end of a line (see above). However, the caller of PCRE can restrict \R
195      to match only CR, LF, or CRLF. You can make this the default by adding
196      --enable-bsr-anycrlf to the "configure" command (bsr = "backslash R").
197    
198  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
199    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
200    them. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
201    
202    --with-posix-malloc-threshold=20    --with-posix-malloc-threshold=20
203    
# Line 207  library. You can read more about them in Line 226  library. You can read more about them in
226  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
227    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
228    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
229    ever to be necessary.    ever to be necessary. Increasing the internal link size will reduce
230      performance.
231    
232  . 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
233    pcre_exec() does not call itself recursively. Instead, it uses memory blocks    pcre_exec() does not call itself recursively. Instead, it uses memory blocks
# Line 223  library. You can read more about them in Line 243  library. You can read more about them in
243    use deeply nested recursion. There is a discussion about stack sizes in the    use deeply nested recursion. There is a discussion about stack sizes in the
244    pcrestack man page.    pcrestack man page.
245    
246    . For speed, PCRE uses four tables for manipulating and identifying characters
247      whose code point values are less than 256. By default, it uses a set of
248      tables for ASCII encoding that is part of the distribution. If you specify
249    
250      --enable-rebuild-chartables
251    
252      a program called dftables is compiled and run in the default C locale when
253      you obey "make". It builds a source file called pcre_chartables.c. If you do
254      not specify this option, pcre_chartables.c is created as a copy of
255      pcre_chartables.c.dist. See "Character tables" below for further information.
256    
257    . It is possible to compile PCRE for use on systems that use EBCDIC as their
258      default character code (as opposed to ASCII) by specifying
259    
260      --enable-ebcdic
261    
262      This automatically implies --enable-rebuild-chartables (see above).
263    
264    . It is possible to compile pcregrep to use libz and/or libbz2, in order to
265      read .gz and .bz2 files (respectively), by specifying one or both of
266    
267      --enable-pcregrep-libz
268      --enable-pcregrep-libbz2
269    
270      Of course, the relevant libraries must be installed on your system.
271    
272    . It is possible to compile pcretest so that it links with the libreadline
273      library, by specifying
274    
275      --enable-pcretest-libreadline
276    
277      If this is done, when pcretest's input is from a terminal, it reads it using
278      the readline() function. This provides line-editing and history facilities.
279      Note that libreadline is GPL-licenced, so if you distribute a binary of
280      pcretest linked in this way, there may be licensing issues.
281    
282      Setting this option causes the -lreadline option to be added to the pcretest
283      build. In many operating environments with a sytem-installed readline
284      library this is sufficient. However, in some environments (e.g. if an
285      unmodified distribution version of readline is in use), it may be necessary
286      to specify something like LIBS="-lncurses" as well. This is because, to quote
287      the readline INSTALL, "Readline uses the termcap functions, but does not link
288      with the termcap or curses library itself, allowing applications which link
289      with readline the to choose an appropriate library."
290    
291  The "configure" script builds the following files for the basic C library:  The "configure" script builds the following files for the basic C library:
292    
293  . Makefile is the makefile that builds the library  . Makefile is the makefile that builds the library
# Line 234  The "configure" script builds the follow Line 299  The "configure" script builds the follow
299  . RunTest is a script for running tests on the basic C library  . RunTest is a script for running tests on the basic C library
300  . RunGrepTest is a script for running tests on the pcregrep command  . RunGrepTest is a script for running tests on the pcregrep command
301    
302  Versions of config.h and pcre.h are distributed in the PCRE tarballs under  Versions of config.h and pcre.h are distributed in the PCRE tarballs under
303  the names config.h.generic and pcre.h.generic. These are provided for the  the names config.h.generic and pcre.h.generic. These are provided for the
304  benefit of those who have to built PCRE without the benefit of "configure". If  benefit of those who have to built PCRE without the benefit of "configure". If
305  you use "configure", the .generic versions are not used.  you use "configure", the .generic versions are not used.
# Line 250  script that can be run to recreate the c Line 315  script that can be run to recreate the c
315  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
316    
317  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
318  libpcre and libpcreposix, a test program called pcretest, a demonstration  libpcre and libpcreposix, a test program called pcretest, and the pcregrep
319  program called pcredemo, and the pcregrep command. If a C++ compiler was found  command. If a C++ compiler was found on your system, "make" also builds the C++
320  on your system, "make" also builds the C++ wrapper library, which is called  wrapper library, which is called libpcrecpp, and some test programs called
321  libpcrecpp, and some test programs called pcrecpp_unittest,  pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.
322  pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper  Building the C++ wrapper can be disabled by adding --disable-cpp to the
323  can be disabled by adding --disable-cpp to the "configure" command.  "configure" command.
324    
325  The command "make check" runs all the appropriate tests. Details of the PCRE  The command "make check" runs all the appropriate tests. Details of the PCRE
326  tests are given below in a separate section of this document.  tests are given below in a separate section of this document.
# Line 307  system. The following are installed (fil Line 372  system. The following are installed (fil
372      pcretest.txt   the pcretest man page      pcretest.txt   the pcretest man page
373      pcregrep.txt   the pcregrep man page      pcregrep.txt   the pcregrep man page
374    
 Note that the pcredemo program that is built by "configure" is *not* installed  
 anywhere. It is a demonstration for programmers wanting to use PCRE.  
   
375  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".
376  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
377  remove any directories, because these are often shared with other programs.  remove any directories, because these are often shared with other programs.
# Line 371  Cross-compiling on Unix-like systems Line 433  Cross-compiling on Unix-like systems
433  ------------------------------------  ------------------------------------
434    
435  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
436  order to cross-compile PCRE for some other host. However, during the building  order to cross-compile PCRE for some other host. However, you should NOT
437  process, the dftables.c source file is compiled *and run* on the local host, in  specify --enable-rebuild-chartables, because if you do, the dftables.c source
438  order to generate the default character tables (the chartables.c file). It  file is compiled and run on the local host, in order to generate the inbuilt
439  therefore needs to be compiled with the local compiler, not the cross compiler.  character tables (the pcre_chartables.c file). This will probably not work,
440  You can do this by specifying CC_FOR_BUILD (and if necessary CFLAGS_FOR_BUILD;  because dftables.c needs to be compiled with the local compiler, not the cross
441  there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)  compiler.
442  when calling the "configure" command. If they are not specified, they default  
443  to the values of CC and CFLAGS.  When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
444    by making a copy of pcre_chartables.c.dist, which is a default set of tables
445    that assumes ASCII code. Cross-compiling with the default tables should not be
446    a problem.
447    
448    If you need to modify the character tables when cross-compiling, you should
449    move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
450    run it on the local host to make a new version of pcre_chartables.c.dist.
451    Then when you cross-compile PCRE this new version of the tables will be used.
452    
453    
454  Using HP's ANSI C++ compiler (aCC)  Using HP's ANSI C++ compiler (aCC)
# Line 395  use the workaround of specifying the fol Line 465  use the workaround of specifying the fol
465  running the "configure" script:  running the "configure" script:
466    
467    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
468    
469    
470  Making new tarballs  Making new tarballs
471  -------------------  -------------------
472    
473  The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and  The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
474  zip formats. However, if you have modified any of the man page sources in the  zip formats. The command "make distcheck" does the same, but then does a trial
475  doc directory, you should first run the PrepareRelease script. This re-creates  build of the new distribution to ensure that it works.
476  the .txt and HTML forms of the documentation from the man pages.  
477    If you have modified any of the man page sources in the doc directory, you
478    should first run the PrepareRelease script before making a distribution. This
479    script creates the .txt and HTML forms of the documentation from the man pages.
480    
481    
482  Testing PCRE  Testing PCRE
# Line 461  is output to say why. If running this te Line 534  is output to say why. If running this te
534  in the comparison output, it means that locale is not available on your system,  in the comparison output, it means that locale is not available on your system,
535  despite being listed by "locale". This does not mean that PCRE is broken.  despite being listed by "locale". This does not mean that PCRE is broken.
536    
537    [If you are trying to run this test on Windows, you may be able to get it to
538    work by changing "fr_FR" to "french" everywhere it occurs. Alternatively, use
539    RunTest.bat. The version of RunTest.bat included with PCRE 7.4 and above uses
540    Windows versions of test 2. More info on using RunTest.bat is included in the
541    document entitled NON-UNIX-USE.]
542    
543  The fourth test checks the UTF-8 support. It is not run automatically unless  The fourth test checks the UTF-8 support. It is not run automatically unless
544  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when
545  running "configure". This file can be also fed directly to the perltest script,  running "configure". This file can be also fed directly to the perltest script,
# Line 490  concatenated tables. A call to pcre_make Line 569  concatenated tables. A call to pcre_make
569  of tables in the current locale. If the final argument for pcre_compile() is  of tables in the current locale. If the final argument for pcre_compile() is
570  passed as NULL, a set of 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.
571    
572  The source file called chartables.c contains the default set of tables. This is  The source file called pcre_chartables.c contains the default set of tables. By
573  not supplied in the distribution, but is built by the program dftables  default, this is created as a copy of pcre_chartables.c.dist, which contains
574  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
575  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
576  sources. This means that the default C locale which is set for your system will  program dftables (compiled from dftables.c), which uses the ANSI C character
577  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
578  by editing chartables.c and then re-building PCRE. If you do this, you should  build the table sources. This means that the default C locale which is set for
579  take care to ensure that the file does not get automaticaly re-generated.  your system will control the contents of these default tables. You can change
580    the default tables by editing pcre_chartables.c and then re-building PCRE. If
581    you do this, you should take care to ensure that the file does not get
582    automatically re-generated. The best way to do this is to move
583    pcre_chartables.c.dist out of the way and replace it with your customized
584    tables.
585    
586    When the dftables program is run as a result of --enable-rebuild-chartables,
587    it uses the default C locale that is set on your system. It does not pay
588    attention to the LC_xxx environment variables. In other words, it uses the
589    system's default locale rather than whatever the compiling user happens to have
590    set. If you really do want to build a source set of character tables in a
591    locale that is specified by the LC_xxx variables, you can run the dftables
592    program by hand with the -L option. For example:
593    
594      ./dftables -L pcre_chartables.c.special
595    
596  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,
597  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
# Line 526  The distribution should contain the foll Line 620  The distribution should contain the foll
620    
621  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
622    
623    dftables.c             auxiliary program for building chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
624                                when --enable-rebuild-chartables is specified
625    
626    pcreposix.c            )    pcre_chartables.c.dist  a default set of character tables that assume ASCII
627    pcre_compile.c         )                              coding; used, unless --enable-rebuild-chartables is
628    pcre_config.c          )                              specified, by copying to pcre_chartables.c
629    pcre_dfa_exec.c        )  
630    pcre_exec.c            )    pcreposix.c             )
631    pcre_fullinfo.c        )    pcre_compile.c          )
632    pcre_get.c             ) sources for the functions in the library,    pcre_config.c           )
633    pcre_globals.c         )   and some internal functions that they use    pcre_dfa_exec.c         )
634    pcre_info.c            )    pcre_exec.c             )
635    pcre_maketables.c      )    pcre_fullinfo.c         )
636    pcre_newline.c         )    pcre_get.c              ) sources for the functions in the library,
637    pcre_ord2utf8.c        )    pcre_globals.c          )   and some internal functions that they use
638    pcre_refcount.c        )    pcre_info.c             )
639    pcre_study.c           )    pcre_maketables.c       )
640    pcre_tables.c          )    pcre_newline.c          )
641    pcre_try_flipped.c     )    pcre_ord2utf8.c         )
642    pcre_ucp_searchfuncs.c )    pcre_refcount.c         )
643    pcre_valid_utf8.c      )    pcre_study.c            )
644    pcre_version.c         )    pcre_tables.c           )
645    pcre_xclass.c          )    pcre_try_flipped.c      )
646    pcre_printint.src      ) debugging function that is #included in pcretest,    pcre_ucd.c              )
647                           )   and can also be #included in pcre_compile()    pcre_valid_utf8.c       )
648    pcre.h.in              template for pcre.h when built by "configure"    pcre_version.c          )
649    pcreposix.h            header for the external POSIX wrapper API    pcre_xclass.c           )
650    pcre_internal.h        header for internal use    pcre_printint.src       ) debugging function that is #included in pcretest,
651    ucp.h                  ) headers concerned with                            )   and can also be #included in pcre_compile()
652    ucpinternal.h          )   Unicode property handling    pcre.h.in               template for pcre.h when built by "configure"
653    ucptable.h             ) (this one is the data table)    pcreposix.h             header for the external POSIX wrapper API
654      pcre_internal.h         header for internal use
655    config.h.in            template for config.h, which is built by "configure"    ucp.h                   header for Unicode property handling
656    
657    pcrecpp.h              public header file for the C++ wrapper    config.h.in             template for config.h, which is built by "configure"
658    pcrecpparg.h.in        template for another C++ header file  
659    pcre_scanner.h         public header file for C++ scanner functions    pcrecpp.h               public header file for the C++ wrapper
660    pcrecpp.cc             )    pcrecpparg.h.in         template for another C++ header file
661    pcre_scanner.cc        ) source for the C++ wrapper library    pcre_scanner.h          public header file for C++ scanner functions
662      pcrecpp.cc              )
663    pcre_stringpiece.h.in  template for pcre_stringpiece.h, the header for the    pcre_scanner.cc         ) source for the C++ wrapper library
664                             C++ stringpiece functions  
665    pcre_stringpiece.cc    source for the C++ stringpiece functions    pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
666                                C++ stringpiece functions
667      pcre_stringpiece.cc     source for the C++ stringpiece functions
668    
669  (B) Source files for programs that use PCRE:  (B) Source files for programs that use PCRE:
670    
671    pcredemo.c             simple demonstration of coding calls to PCRE    pcredemo.c              simple demonstration of coding calls to PCRE
672    pcregrep.c             source of a grep utility that uses PCRE    pcregrep.c              source of a grep utility that uses PCRE
673    pcretest.c             comprehensive test program    pcretest.c              comprehensive test program
674    
675  (C) Auxiliary files:  (C) Auxiliary files:
676    
677    132html                script to turn "man" pages into HTML    132html                 script to turn "man" pages into HTML
678    AUTHORS                information about the author of PCRE    AUTHORS                 information about the author of PCRE
679    ChangeLog              log of changes to the code    ChangeLog               log of changes to the code
680    CleanTxt               script to clean nroff output for txt man pages    CleanTxt                script to clean nroff output for txt man pages
681    Detrail                script to remove trailing spaces    Detrail                 script to remove trailing spaces
682    Index.html             the base HTML page    HACKING                 some notes about the internals of PCRE
683    INSTALL                generic installation instructions    INSTALL                 generic installation instructions
684    LICENCE                conditions for the use of PCRE    LICENCE                 conditions for the use of PCRE
685    COPYING                the same, using GNU's standard name    COPYING                 the same, using GNU's standard name
686    Makefile.in            ) template for Unix Makefile, which is built by    Makefile.in             ) template for Unix Makefile, which is built by
687                           )   "configure"                            )   "configure"
688    Makefile.am            ) the automake input that was used to create    Makefile.am             ) the automake input that was used to create
689                           )   Makefile.in                            )   Makefile.in
690    NEWS                   important changes in this release    NEWS                    important changes in this release
691    NON-UNIX-USE           notes on building PCRE on non-Unix systems    NON-UNIX-USE            notes on building PCRE on non-Unix systems
692    PrepareRelease         script to make preparations for "make dist"    PrepareRelease          script to make preparations for "make dist"
693    README                 this file    README                  this file
694    RunTest.in             template for a Unix shell script for running tests    RunTest                 a Unix shell script for running tests
695    RunGrepTest.in         template for a Unix shell script for pcregrep tests    RunGrepTest             a Unix shell script for pcregrep tests
696    aclocal.m4             m4 macros (generated by "aclocal")    aclocal.m4              m4 macros (generated by "aclocal")
697    config.guess           ) files used by libtool,    config.guess            ) files used by libtool,
698    config.sub             )   used only when building a shared library    config.sub              )   used only when building a shared library
699    configure              a configuring shell script (built by autoconf)    configure               a configuring shell script (built by autoconf)
700    configure.ac           ) the autoconf input that was used to build    configure.ac            ) the autoconf input that was used to build
701                           )   "configure" and config.h                            )   "configure" and config.h
702    depcomp                ) script to find program dependencies, generated by    depcomp                 ) script to find program dependencies, generated by
703                           )   automake                            )   automake
704    doc/*.3                man page sources for the PCRE functions    doc/*.3                 man page sources for the PCRE functions
705    doc/*.1                man page sources for pcregrep and pcretest    doc/*.1                 man page sources for pcregrep and pcretest
706    doc/html/*             HTML documentation    doc/index.html.src      the base HTML page
707    doc/pcre.txt           plain text version of the man pages    doc/html/*              HTML documentation
708    doc/pcretest.txt       plain text documentation of test program    doc/pcre.txt            plain text version of the man pages
709    doc/perltest.txt       plain text documentation of Perl test program    doc/pcretest.txt        plain text documentation of test program
710    install-sh             a shell script for installing files    doc/perltest.txt        plain text documentation of Perl test program
711    libpcre.pc.in          template for libpcre.pc for pkg-config    install-sh              a shell script for installing files
712    libpcrecpp.pc.in       template for libpcrecpp.pc for pkg-config    libpcre.pc.in           template for libpcre.pc for pkg-config
713    ltmain.sh              file used to build a libtool script    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
714    missing                ) common stub for a few missing GNU programs while    ltmain.sh               file used to build a libtool script
715                           )   installing, generated by automake    missing                 ) common stub for a few missing GNU programs while
716    mkinstalldirs          script for making install directories                            )   installing, generated by automake
717    perltest.pl            Perl test program    mkinstalldirs           script for making install directories
718    pcre-config.in         source of script which retains PCRE information    perltest.pl             Perl test program
719      pcre-config.in          source of script which retains PCRE information
720    pcrecpp_unittest.cc          )    pcrecpp_unittest.cc          )
721    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
722    pcre_stringpiece_unittest.cc )    pcre_stringpiece_unittest.cc )
723    testdata/testinput*    test data for main library tests    testdata/testinput*     test data for main library tests
724    testdata/testoutput*   expected test results    testdata/testoutput*    expected test results
725    testdata/grep*         input and output for pcregrep tests    testdata/grep*          input and output for pcregrep tests
726    
727  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
728    
729      cmake/COPYING-CMAKE-SCRIPTS
730      cmake/FindPackageHandleStandardArgs.cmake
731      cmake/FindReadline.cmake
732    CMakeLists.txt    CMakeLists.txt
733    config-cmake.h.in    config-cmake.h.in
734    
735  (E) Auxiliary files for VPASCAL  (E) Auxiliary files for VPASCAL
736    
737    makevp.bat    makevp.bat
738    !compile.txt    makevp_c.txt
739    !linklib.txt    makevp_l.txt
740    pcregexp.pas    pcregexp.pas
741    
742  (F) Auxiliary files for building PCRE "by hand"  (F) Auxiliary files for building PCRE "by hand"
743    
744    pcre.h.generic         ) a version of the public PCRE header file    pcre.h.generic          ) a version of the public PCRE header file
745                           )   for use in non-"configure" environments                            )   for use in non-"configure" environments
746    config.h.generic       ) a version of config.h for use in non-"configure"    config.h.generic        ) a version of config.h for use in non-"configure"
747                           )   environments                            )   environments
748    
749  (F) Miscellaneous  (F) Miscellaneous
750    
# Line 652  The distribution should contain the foll Line 753  The distribution should contain the foll
753  Philip Hazel  Philip Hazel
754  Email local part: ph10  Email local part: ph10
755  Email domain: cam.ac.uk  Email domain: cam.ac.uk
756  Last updated: March 2007  Last updated: 05 September 2008

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

  ViewVC Help
Powered by ViewVC 1.1.5