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

Diff of /code/trunk/README

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

revision 96 by nigel, Fri Mar 2 13:10:43 2007 UTC revision 1031 by ph10, Sat Sep 8 15:59:01 2012 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
12    
13      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:
17    
18      The PCRE APIs
19      Documentation for PCRE
20      Contributions by users of PCRE
21      Building PCRE on non-Unix-like systems
22      Building PCRE without using autotools
23      Building PCRE using autotools
24      Retrieving configuration information
25      Shared libraries
26      Cross-compiling using autotools
27      Using HP's ANSI C++ compiler (aCC)
28      Using PCRE from MySQL
29      Making new tarballs
30      Testing PCRE
31      Character tables
32      File manifest
33    
34    
35  The PCRE APIs  The PCRE APIs
36  -------------  -------------
37    
38  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. There are two sets of functions,
39  set of C++ wrapper functions, courtesy of Google Inc. (see the pcrecpp man page  one for the 8-bit library, which processes strings of bytes, and one for the
40  for details).  16-bit library, which processes strings of 16-bit values. The distribution also
41    includes a set of C++ wrapper functions (see the pcrecpp man page for details),
42  Also included are a set of C wrapper functions that are based on the POSIX  courtesy of Google Inc., which can be used to call the 8-bit PCRE library from
43  API. These end up in the library called libpcreposix. Note that this just  C++.
44  provides a POSIX calling interface to PCRE: the regular expressions themselves  
45  still follow Perl syntax and semantics. The header file for the POSIX-style  In addition, there is a set of C wrapper functions (again, just for the 8-bit
46  functions is called pcreposix.h. The official POSIX name is regex.h, but I  library) that are based on the POSIX regular expression API (see the pcreposix
47  didn't want to risk possible problems with existing files of that name by  man page). These end up in the library called libpcreposix. Note that this just
48  distributing it that way. To use it with an existing program that uses the  provides a POSIX calling interface to PCRE; the regular expressions themselves
49  POSIX API, it will have to be renamed or pointed at by a link.  still follow Perl syntax and semantics. The POSIX API is restricted, and does
50    not give full access to all of PCRE's facilities.
51    
52    The header file for the POSIX-style functions is called pcreposix.h. The
53    official POSIX name is regex.h, but I did not want to risk possible problems
54    with existing files of that name by distributing it that way. To use PCRE with
55    an existing program that uses the POSIX API, pcreposix.h will have to be
56    renamed or pointed at by a link.
57    
58  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
59  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
60    file (as mentioned above), you must also take care when linking programs to
61  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
62  up the "real" POSIX functions of the same name.  up the POSIX functions of the same name from the other library.
63    
64    One way of avoiding this confusion is to compile PCRE with the addition of
65    -Dregcomp=PCREregcomp (and similarly for the other POSIX functions) to the
66    compiler flags (CFLAGS if you are using "configure" -- see below). This has the
67    effect of renaming the functions so that the names no longer clash. Of course,
68    you have to do the same thing for your applications, or write them using the
69    new names.
70    
71    
72  Documentation for PCRE  Documentation for PCRE
73  ----------------------  ----------------------
74    
75  If you install PCRE in the normal way, you will end up with an installed set of  If you install PCRE in the normal way on a Unix-like system, you will end up
76  man pages whose names all start with "pcre". The one that is just called "pcre"  with a set of man pages whose names all start with "pcre". The one that is just
77  lists all the others. In addition to these man pages, the PCRE documentation is  called "pcre" lists all the others. In addition to these man pages, the PCRE
78  supplied in two other forms; however, as there is no standard place to install  documentation is supplied in two other forms:
79  them, they are left in the doc directory of the unpacked source distribution.  
80  These forms are:    1. There are files called doc/pcre.txt, doc/pcregrep.txt, and
81         doc/pcretest.txt in the source distribution. The first of these is a
82    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
83       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
84       man pages except those that summarize individual functions. The other two       forms of the section 1 man pages for the pcregrep and pcretest commands.
85       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
86       pcretest commands. Text forms are provided for ease of scanning with text       similar tools. They are installed in <prefix>/share/doc/pcre, where
87       editors or similar tools.       <prefix> is the installation prefix (defaulting to /usr/local).
88    
89    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
90       form, hyperlinked in various ways, and rooted in a file called       in various ways, and rooted in a file called index.html, is distributed in
91       doc/index.html.       doc/html and installed in <prefix>/share/doc/pcre/html.
92    
93    Users of PCRE have contributed files containing the documentation for various
94    releases in CHM format. These can be found in the Contrib directory of the FTP
95    site (see next section).
96    
97    
98  Contributions by users of PCRE  Contributions by users of PCRE
# Line 59  You can find contributions from PCRE use Line 102  You can find contributions from PCRE use
102    
103    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
104    
105  where there is also a README file giving brief descriptions of what they are.  There is a README file giving brief descriptions of what they are. Some are
106  Several of them provide support for compiling PCRE on various flavours of  complete in themselves; others are pointers to URLs containing relevant files.
107  Windows systems (I myself do not use Windows). Some are complete in themselves;  Some of this material is likely to be well out-of-date. Several of the earlier
108  others are pointers to URLs containing relevant files.  contributions provided support for compiling PCRE on various flavours of
109    Windows (I myself do not use Windows). Nowadays there is more Windows support
110    in the standard distribution, so these contibutions have been archived.
111    
112    
113    Building PCRE on non-Unix-like systems
114    --------------------------------------
115    
116    For a non-Unix-like system, please read the comments in the file
117    NON-AUTOTOOLS-BUILD, though if your system supports the use of "configure" and
118    "make" you may be able to build PCRE using autotools in the same way as for
119    many Unix-like systems.
120    
121    PCRE can also be configured using the GUI facility provided by CMake's
122    cmake-gui command. This creates Makefiles, solution files, etc. The file
123    NON-AUTOTOOLS-BUILD has information about CMake.
124    
125    PCRE has been compiled on many different operating systems. It should be
126    straightforward to build PCRE on any system that has a Standard C compiler and
127    library, because it uses only Standard C functions.
128    
129    
130    Building PCRE without using autotools
131    -------------------------------------
132    
133    The use of autotools (in particular, libtool) is problematic in some
134    environments, even some that are Unix or Unix-like. See the NON-AUTOTOOLS-BUILD
135    file for ways of building PCRE without using autotools.
136    
137    
138  Building PCRE on a Unix-like system  Building PCRE using autotools
139  -----------------------------------  -----------------------------
140    
141  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
142  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
143    
144  To build PCRE on a Unix-like system, first run the "configure" command from the  The following instructions assume the use of the widely used "configure; make;
145  PCRE distribution directory, with your current directory set to the directory  make install" (autotools) process.
146  where you want the files to be created. This command is a standard GNU  
147  "autoconf" configuration script, for which generic instructions are supplied in  To build PCRE on system that supports autotools, first run the "configure"
148  INSTALL.  command from the PCRE distribution directory, with your current directory set
149    to the directory where you want the files to be created. This command is a
150    standard GNU "autoconf" configuration script, for which generic instructions
151    are supplied in the file INSTALL.
152    
153  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
154  this case, on many systems, just running "./configure" is sufficient, but the  this case, on many systems, just running "./configure" is sufficient. However,
155  usual methods of changing standard defaults are available. For example:  the usual methods of changing standard defaults are available. For example:
156    
157  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
158    
159  specifies that the C compiler should be run with the flags '-O2 -Wall' instead  This command specifies that the C compiler should be run with the flags '-O2
160  of the default, and that "make install" should install PCRE under /opt/local  -Wall' instead of the default, and that "make install" should install PCRE
161  instead of the default /usr/local.  under /opt/local instead of the default /usr/local.
162    
163  If you want to build in a different directory, just run "configure" with that  If you want to build in a different directory, just run "configure" with that
164  directory as current. For example, suppose you have unpacked the PCRE source  directory as current. For example, suppose you have unpacked the PCRE source
# Line 99  possible to build it as a C++ library, t Line 172  possible to build it as a C++ library, t
172  does not have any features to support this.  does not have any features to support this.
173    
174  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
175  library. You can read more about them in the pcrebuild man page.  library. They are also documented in the pcrebuild man page.
176    
177    . By default, both shared and static libraries are built. You can change this
178      by adding one of these options to the "configure" command:
179    
180  . If you want to suppress the building of the C++ wrapper library, you can add    --disable-shared
181    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-static
182    will try to find a C++ compiler and C++ header files, and if it succeeds, it  
183    will try to build the C++ wrapper.    (See also "Shared libraries on Unix-like systems" below.)
184    
185  . If you want to make use of the support for UTF-8 character strings in PCRE,  . By default, only the 8-bit library is built. If you add --enable-pcre16 to
186    you must add --enable-utf8 to the "configure" command. Without it, the code    the "configure" command, the 16-bit library is also built. If you want only
187    for handling UTF-8 is not included in the library. (Even when included, it    the 16-bit library, use "./configure --enable-pcre16 --disable-pcre8".
188    still has to be enabled by an option at run time.)  
189    . If you are building the 8-bit library and want to suppress the building of
190  . If, in addition to support for UTF-8 character strings, you want to include    the C++ wrapper library, you can add --disable-cpp to the "configure"
191    support for the \P, \p, and \X sequences that recognize Unicode character    command. Otherwise, when "configure" is run without --disable-pcre8, it will
192    properties, you must add --enable-unicode-properties to the "configure"    try to find a C++ compiler and C++ header files, and if it succeeds, it will
193    command. This adds about 30K to the size of the library (in the form of a    try to build the C++ wrapper.
194    property table); only the basic two-letter properties such as Lu are  
195    supported.  . If you want to include support for just-in-time compiling, which can give
196      large performance improvements on certain platforms, add --enable-jit to the
197      "configure" command. This support is available only for certain hardware
198      architectures. If you try to enable it on an unsupported architecture, there
199      will be a compile time error.
200    
201    . When JIT support is enabled, pcregrep automatically makes use of it, unless
202      you add --disable-pcregrep-jit to the "configure" command.
203    
204    . If you want to make use of the support for UTF-8 Unicode character strings in
205      the 8-bit library, or UTF-16 Unicode character strings in the 16-bit library,
206      you must add --enable-utf to the "configure" command. Without it, the code
207      for handling UTF-8 and UTF-16 is not included in the relevant library. Even
208      when --enable-utf is included, the use of a UTF encoding still has to be
209      enabled by an option at run time. When PCRE is compiled with this option, its
210      input can only either be ASCII or UTF-8/16, even when running on EBCDIC
211      platforms. It is not possible to use both --enable-utf and --enable-ebcdic at
212      the same time.
213    
214    . There are no separate options for enabling UTF-8 and UTF-16 independently
215      because that would allow ridiculous settings such as requesting UTF-16
216      support while building only the 8-bit library. However, the option
217      --enable-utf8 is retained for backwards compatibility with earlier releases
218      that did not support 16-bit character strings. It is synonymous with
219      --enable-utf. It is not possible to configure one library with UTF support
220      and the other without in the same configuration.
221    
222    . If, in addition to support for UTF-8/16 character strings, you want to
223      include support for the \P, \p, and \X sequences that recognize Unicode
224      character properties, you must add --enable-unicode-properties to the
225      "configure" command. This adds about 30K to the size of the library (in the
226      form of a property table); only the basic two-letter properties such as Lu
227      are supported.
228    
229  . 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
230    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
231    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
232    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
233    (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
234    --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
235    to the "configure" command, respectively.    or --enable-newline-is-crlf or --enable-newline-is-anycrlf or
236      --enable-newline-is-any to the "configure" command, respectively.
237    
238      If you specify --enable-newline-is-cr or --enable-newline-is-crlf, some of
239      the standard tests will fail, because the lines in the test files end with
240      LF. Even if the files are edited to change the line endings, there are likely
241      to be some failures. With --enable-newline-is-anycrlf or
242      --enable-newline-is-any, many tests should succeed, but there may be some
243      failures.
244    
245    . By default, the sequence \R in a pattern matches any Unicode line ending
246      sequence. This is independent of the option specifying what PCRE considers to
247      be the end of a line (see above). However, the caller of PCRE can restrict \R
248      to match only CR, LF, or CRLF. You can make this the default by adding
249      --enable-bsr-anycrlf to the "configure" command (bsr = "backslash R").
250    
251  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
252    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
253    them. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
254    
255    --with-posix-malloc-threshold=20    --with-posix-malloc-threshold=20
256    
# Line 141  library. You can read more about them in Line 263  library. You can read more about them in
263    --with-match-limit=500000    --with-match-limit=500000
264    
265    on the "configure" command. This is just the default; individual calls to    on the "configure" command. This is just the default; individual calls to
266    pcre_exec() can supply their own value. There is discussion on the pcreapi    pcre_exec() can supply their own value. There is more discussion on the
267    man page.    pcreapi man page.
268    
269  . There is a separate counter that limits the depth of recursive function calls  . There is a separate counter that limits the depth of recursive function calls
270    during a matching process. This also has a default of ten million, which is    during a matching process. This also has a default of ten million, which is
# Line 155  library. You can read more about them in Line 277  library. You can read more about them in
277    sizes in the pcrestack man page.    sizes in the pcrestack man page.
278    
279  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
280    this by adding --with-link-size=3 to the "configure" command. You can    this by adding --with-link-size=3 to the "configure" command. In the 8-bit
281    increase it even more by setting --with-link-size=4, but this is unlikely    library, PCRE then uses three bytes instead of two for offsets to different
282    ever to be necessary. If you build PCRE with an increased link size, test 2    parts of the compiled pattern. In the 16-bit library, --with-link-size=3 is
283    (and 5 if you are using UTF-8) will fail. Part of the output of these tests    the same as --with-link-size=4, which (in both libraries) uses four-byte
284    is a representation of the compiled pattern, and this changes with the link    offsets. Increasing the internal link size reduces performance.
   size.  
285    
286  . 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
287    pcre_exec() does not call itself recursively. Instead, it uses blocks of data    pcre_exec() does not call itself recursively. Instead, it uses memory blocks
288    from the heap via special functions pcre_stack_malloc() and pcre_stack_free()    obtained from the heap via the special functions pcre_stack_malloc() and
289    to save data that would otherwise be saved on the stack. To build PCRE like    pcre_stack_free() to save data that would otherwise be saved on the stack. To
290    this, use    build PCRE like this, use
291    
292    --disable-stack-for-recursion    --disable-stack-for-recursion
293    
294    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
295    necessary in environments with limited stack sizes. This applies only to the    necessary in environments with limited stack sizes. This applies only to the
296    pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not    normal execution of the pcre_exec() function; if JIT support is being
297    use deeply nested recursion.    successfully used, it is not relevant. Equally, it does not apply to
298      pcre_dfa_exec(), which does not use deeply nested recursion. There is a
299  The "configure" script builds eight files for the basic C library:    discussion about stack sizes in the pcrestack man page.
300    
301  . Makefile is the makefile that builds the library  . For speed, PCRE uses four tables for manipulating and identifying characters
302  . config.h contains build-time configuration options for the library    whose code point values are less than 256. By default, it uses a set of
303  . pcre-config is a script that shows the settings of "configure" options    tables for ASCII encoding that is part of the distribution. If you specify
304  . libpcre.pc is data for the pkg-config command  
305  . libtool is a script that builds shared and/or static libraries    --enable-rebuild-chartables
306  . RunTest is a script for running tests on the library  
307  . RunGrepTest is a script for running tests on the pcregrep command    a program called dftables is compiled and run in the default C locale when
308      you obey "make". It builds a source file called pcre_chartables.c. If you do
309  In addition, if a C++ compiler is found, the following are also built:    not specify this option, pcre_chartables.c is created as a copy of
310      pcre_chartables.c.dist. See "Character tables" below for further information.
311  . pcrecpp.h is the header file for programs that call PCRE via the C++ wrapper  
312  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions  . It is possible to compile PCRE for use on systems that use EBCDIC as their
313      character code (as opposed to ASCII/Unicode) by specifying
314    
315      --enable-ebcdic
316    
317      This automatically implies --enable-rebuild-chartables (see above). However,
318      when PCRE is built this way, it always operates in EBCDIC. It cannot support
319      both EBCDIC and UTF-8/16. There is a second option, --enable-ebcdic-nl25,
320      which specifies that the code value for the EBCDIC NL character is 0x25
321      instead of the default 0x15.
322    
323    . The pcregrep program currently supports only 8-bit data files, and so
324      requires the 8-bit PCRE library. It is possible to compile pcregrep to use
325      libz and/or libbz2, in order to read .gz and .bz2 files (respectively), by
326      specifying one or both of
327    
328      --enable-pcregrep-libz
329      --enable-pcregrep-libbz2
330    
331      Of course, the relevant libraries must be installed on your system.
332    
333    . The default size of internal buffer used by pcregrep can be set by, for
334      example:
335    
336      --with-pcregrep-bufsize=50K
337    
338      The default value is 20K.
339    
340    . It is possible to compile pcretest so that it links with the libreadline
341      or libedit libraries, by specifying, respectively,
342    
343      --enable-pcretest-libreadline or --enable-pcretest-libedit
344    
345      If this is done, when pcretest's input is from a terminal, it reads it using
346      the readline() function. This provides line-editing and history facilities.
347      Note that libreadline is GPL-licenced, so if you distribute a binary of
348      pcretest linked in this way, there may be licensing issues. These can be
349      avoided by linking with libedit (which has a BSD licence) instead.
350    
351      Enabling libreadline causes the -lreadline option to be added to the pcretest
352      build. In many operating environments with a sytem-installed readline
353      library this is sufficient. However, in some environments (e.g. if an
354      unmodified distribution version of readline is in use), it may be necessary
355      to specify something like LIBS="-lncurses" as well. This is because, to quote
356      the readline INSTALL, "Readline uses the termcap functions, but does not link
357      with the termcap or curses library itself, allowing applications which link
358      with readline the to choose an appropriate library." If you get error
359      messages about missing functions tgetstr, tgetent, tputs, tgetflag, or tgoto,
360      this is the problem, and linking with the ncurses library should fix it.
361    
362    The "configure" script builds the following files for the basic C library:
363    
364    . Makefile             the makefile that builds the library
365    . config.h             build-time configuration options for the library
366    . pcre.h               the public PCRE header file
367    . pcre-config          script that shows the building settings such as CFLAGS
368                             that were set for "configure"
369    . libpcre.pc         ) data for the pkg-config command
370    . libpcre16.pc       )
371    . libpcreposix.pc    )
372    . libtool              script that builds shared and/or static libraries
373    
374    Versions of config.h and pcre.h are distributed in the PCRE tarballs under the
375    names config.h.generic and pcre.h.generic. These are provided for those who
376    have to built PCRE without using "configure" or CMake. If you use "configure"
377    or CMake, the .generic versions are not used.
378    
379    When building the 8-bit library, if a C++ compiler is found, the following
380    files are also built:
381    
382    . libpcrecpp.pc        data for the pkg-config command
383    . pcrecpparg.h         header file for calling PCRE via the C++ wrapper
384    . pcre_stringpiece.h   header for the C++ "stringpiece" functions
385    
386  The "configure" script also creates config.status, which is an executable  The "configure" script also creates config.status, which is an executable
387  script that can be run to recreate the configuration, and config.log, which  script that can be run to recreate the configuration, and config.log, which
388  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
389    
390  Once "configure" has run, you can run "make". It builds two libraries, called  Once "configure" has run, you can run "make". This builds either or both of the
391  libpcre and libpcreposix, a test program called pcretest, and the pcregrep  libraries libpcre and libpcre16, and a test program called pcretest. If you
392  command. If a C++ compiler was found on your system, it also builds the C++  enabled JIT support with --enable-jit, a test program called pcre_jit_test is
393  wrapper library, which is called libpcrecpp, and some test programs called  built as well.
394  pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.  
395    If the 8-bit library is built, libpcreposix and the pcregrep command are also
396  The command "make test" runs all the appropriate tests. Details of the PCRE  built, and if a C++ compiler was found on your system, and you did not disable
397  tests are given in a separate section of this document, below.  it with --disable-cpp, "make" builds the C++ wrapper library, which is called
398    libpcrecpp, as well as some test programs called pcrecpp_unittest,
399  You can use "make install" to copy the libraries, the public header files  pcre_scanner_unittest, and pcre_stringpiece_unittest.
400  pcre.h, pcreposix.h, pcrecpp.h, and pcre_stringpiece.h (the last two only if  
401  the C++ wrapper was built), and the man pages to appropriate live directories  The command "make check" runs all the appropriate tests. Details of the PCRE
402  on your system, in the normal way.  tests are given below in a separate section of this document.
403    
404    You can use "make install" to install PCRE into live directories on your
405    system. The following are installed (file names are all relative to the
406    <prefix> that is set when "configure" is run):
407    
408      Commands (bin):
409        pcretest
410        pcregrep (if 8-bit support is enabled)
411        pcre-config
412    
413      Libraries (lib):
414        libpcre16     (if 16-bit support is enabled)
415        libpcre       (if 8-bit support is enabled)
416        libpcreposix  (if 8-bit support is enabled)
417        libpcrecpp    (if 8-bit and C++ support is enabled)
418    
419      Configuration information (lib/pkgconfig):
420        libpcre16.pc
421        libpcre.pc
422        libpcreposix.pc
423        libpcrecpp.pc (if C++ support is enabled)
424    
425      Header files (include):
426        pcre.h
427        pcreposix.h
428        pcre_scanner.h      )
429        pcre_stringpiece.h  ) if C++ support is enabled
430        pcrecpp.h           )
431        pcrecpparg.h        )
432    
433      Man pages (share/man/man{1,3}):
434        pcregrep.1
435        pcretest.1
436        pcre-config.1
437        pcre.3
438        pcre*.3 (lots more pages, all starting "pcre")
439    
440      HTML documentation (share/doc/pcre/html):
441        index.html
442        *.html (lots more pages, hyperlinked from index.html)
443    
444      Text file documentation (share/doc/pcre):
445        AUTHORS
446        COPYING
447        ChangeLog
448        LICENCE
449        NEWS
450        README
451        pcre.txt         (a concatenation of the man(3) pages)
452        pcretest.txt     the pcretest man page
453        pcregrep.txt     the pcregrep man page
454        pcre-config.txt  the pcre-config man page
455    
456  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".
457  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
458  remove any directories, because these are often shared with other programs.  remove any directories, because these are often shared with other programs.
459    
460    
461  Retrieving configuration information on Unix-like systems  Retrieving configuration information
462  ---------------------------------------------------------  ------------------------------------
463    
464  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
465  to recall information about the PCRE configuration and installation. For  recall information about the PCRE configuration and installation. For example:
 example:  
466    
467    pcre-config --version    pcre-config --version
468    
# Line 237  single command is used. For example: Line 481  single command is used. For example:
481    pkg-config --cflags pcre    pkg-config --cflags pcre
482    
483  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
484  pkgconfig.  <prefix>/lib/pkgconfig.
485    
486    
487  Shared libraries on Unix-like systems  Shared libraries
488  -------------------------------------  ----------------
489    
490  The default distribution builds PCRE as shared libraries and static libraries,  The default distribution builds PCRE as shared libraries and static libraries,
491  as long as the operating system supports shared libraries. Shared library  as long as the operating system supports shared libraries. Shared library
# Line 254  built. The programs pcretest and pcregre Line 498  built. The programs pcretest and pcregre
498  libraries (by means of wrapper scripts in the case of shared libraries). When  libraries (by means of wrapper scripts in the case of shared libraries). When
499  you use "make install" to install shared libraries, pcregrep and pcretest are  you use "make install" to install shared libraries, pcregrep and pcretest are
500  automatically re-built to use the newly installed shared libraries before being  automatically re-built to use the newly installed shared libraries before being
501  installed themselves. However, the versions left in the source directory still  installed themselves. However, the versions left in the build directory still
502  use the uninstalled libraries.  use the uninstalled libraries.
503    
504  To build PCRE using static libraries only you must use --disable-shared when  To build PCRE using static libraries only you must use --disable-shared when
# Line 266  Then run "make" in the usual way. Simila Line 510  Then run "make" in the usual way. Simila
510  build only shared libraries.  build only shared libraries.
511    
512    
513  Cross-compiling on a Unix-like system  Cross-compiling using autotools
514  -------------------------------------  -------------------------------
515    
516  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
517  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
518  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
519  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
520  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,
521  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
522  there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)  compiler.
523  when calling the "configure" command. If they are not specified, they default  
524  to the values of CC and CFLAGS.  When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
525    by making a copy of pcre_chartables.c.dist, which is a default set of tables
526    that assumes ASCII code. Cross-compiling with the default tables should not be
527    a problem.
528    
529    If you need to modify the character tables when cross-compiling, you should
530    move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
531    run it on the local host to make a new version of pcre_chartables.c.dist.
532    Then when you cross-compile PCRE this new version of the tables will be used.
533    
534    
535  Using HP's ANSI C++ compiler (aCC)  Using HP's ANSI C++ compiler (aCC)
536  ----------------------------------  ----------------------------------
537    
538  Unless C++ support is disabled by specifying the "--disable-cpp" option of the  Unless C++ support is disabled by specifying the "--disable-cpp" option of the
539  "configure" script, you *must* include the "-AA" option in the CXXFLAGS  "configure" script, you must include the "-AA" option in the CXXFLAGS
540  environment variable in order for the C++ components to compile correctly.  environment variable in order for the C++ components to compile correctly.
541    
542  Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby  Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby
# Line 296  running the "configure" script: Line 548  running the "configure" script:
548    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
549    
550    
551  Building on non-Unix systems  Using Sun's compilers for Solaris
552  ----------------------------  ---------------------------------
553    
554    A user reports that the following configurations work on Solaris 9 sparcv9 and
555    Solaris 9 x86 (32-bit):
556    
557      Solaris 9 sparcv9: ./configure --disable-cpp CC=/bin/cc CFLAGS="-m64 -g"
558      Solaris 9 x86:     ./configure --disable-cpp CC=/bin/cc CFLAGS="-g"
559    
560    
561    Using PCRE from MySQL
562    ---------------------
563    
564    On systems where both PCRE and MySQL are installed, it is possible to make use
565    of PCRE from within MySQL, as an alternative to the built-in pattern matching.
566    There is a web page that tells you how to do this:
567    
568      http://www.mysqludf.org/lib_mysqludf_preg/index.php
569    
570    
571  For a non-Unix system, read the comments in the file NON-UNIX-USE, though if  Making new tarballs
572  the system supports the use of "configure" and "make" you may be able to build  -------------------
573  PCRE in the same way as for Unix systems.  
574    The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
575  PCRE has been compiled on Windows systems and on Macintoshes, but I don't know  zip formats. The command "make distcheck" does the same, but then does a trial
576  the details because I don't use those systems. It should be straightforward to  build of the new distribution to ensure that it works.
577  build PCRE on any system that has a Standard C compiler and library, because it  
578  uses only Standard C functions.  If you have modified any of the man page sources in the doc directory, you
579    should first run the PrepareRelease script before making a distribution. This
580    script creates the .txt and HTML forms of the documentation from the man pages.
581    
582    
583  Testing PCRE  Testing PCRE
584  ------------  ------------
585    
586  To test PCRE on a Unix system, run the RunTest script that is created by the  To test the basic PCRE library on a Unix-like system, run the RunTest script.
587  configuring process. There is also a script called RunGrepTest that tests the  There is another script called RunGrepTest that tests the options of the
588  options of the pcregrep command. If the C++ wrapper library is build, three  pcregrep command. If the C++ wrapper library is built, three test programs
589  test programs called pcrecpp_unittest, pcre_scanner_unittest, and  called pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest
590  pcre_stringpiece_unittest are provided.  are also built. When JIT support is enabled, another test program called
591    pcre_jit_test is built.
592  Both the scripts and all the program tests are run if you obey "make runtest",  
593  "make check", or "make test". For other systems, see the instructions in  Both the scripts and all the program tests are run if you obey "make check" or
594  NON-UNIX-USE.  "make test". For other environments, see the instructions in
595    NON-AUTOTOOLS-BUILD.
596    
597  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
598  own man page) on each of the testinput files (in the testdata directory) in  own man page) on each of the relevant testinput files in the testdata
599  turn, and compares the output with the contents of the corresponding testoutput  directory, and compares the output with the contents of the corresponding
600  files. A file called testtry is used to hold the main output from pcretest  testoutput files. Some tests are relevant only when certain build-time options
601  (testsavedregex is also used as a working file). To run pcretest on just one of  were selected. For example, the tests for UTF-8/16 support are run only if
602  the test files, give its number as an argument to RunTest, for example:  --enable-utf was used. RunTest outputs a comment when it skips a test.
603    
604    Many of the tests that are not skipped are run up to three times. The second
605    run forces pcre_study() to be called for all patterns except for a few in some
606    tests that are marked "never study" (see the pcretest program for how this is
607    done). If JIT support is available, the non-DFA tests are run a third time,
608    this time with a forced pcre_study() with the PCRE_STUDY_JIT_COMPILE option.
609    
610    When both 8-bit and 16-bit support is enabled, the entire set of tests is run
611    twice, once for each library. If you want to run just one set of tests, call
612    RunTest with either the -8 or -16 option.
613    
614    RunTest uses a file called testtry to hold the main output from pcretest.
615    Other files whose names begin with "test" are used as working files in some
616    tests. To run pcretest on just one or more specific test files, give their
617    numbers as arguments to RunTest, for example:
618    
619      RunTest 2 7 11
620    
621    RunTest 2  You can also call RunTest with the single argument "list" to cause it to output
622    a list of tests.
623    
624  The first test file can also be fed directly into the perltest script to check  The first test file can be fed directly into the perltest.pl script to check
625  that Perl gives the same results. The only difference you should see is in the  that Perl gives the same results. The only difference you should see is in the
626  first few lines, where the Perl version is given instead of the PCRE version.  first few lines, where the Perl version is given instead of the PCRE version.
627    
628  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_study(),
629  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
630  detection, and run-time flags that are specific to PCRE, as well as the POSIX  detection, and run-time flags that are specific to PCRE, as well as the POSIX
631  wrapper API. It also uses the debugging flag to check some of the internals of  wrapper API. It also uses the debugging flags to check some of the internals of
632  pcre_compile().  pcre_compile().
633    
634  If you build PCRE with a locale setting that is not the standard C locale, the  If you build PCRE with a locale setting that is not the standard C locale, the
# Line 364  is output to say why. If running this te Line 654  is output to say why. If running this te
654  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,
655  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.
656    
657  The fourth test checks the UTF-8 support. It is not run automatically unless  [If you are trying to run this test on Windows, you may be able to get it to
658  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when  work by changing "fr_FR" to "french" everywhere it occurs. Alternatively, use
659  running "configure". This file can be also fed directly to the perltest script,  RunTest.bat. The version of RunTest.bat included with PCRE 7.4 and above uses
660  provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,  Windows versions of test 2. More info on using RunTest.bat is included in the
661  commented in the script, can be be used.)  document entitled NON-UNIX-USE.]
662    
663  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8  The fourth and fifth tests check the UTF-8/16 support and error handling and
664  features of PCRE that are not relevant to Perl.  internal UTF features of PCRE that are not relevant to Perl, respectively. The
665    sixth and seventh tests do the same for Unicode character properties support.
666  The sixth and test checks the support for Unicode character properties. It it  
667  not run automatically unless PCRE is built with Unicode property support. To to  The eighth, ninth, and tenth tests check the pcre_dfa_exec() alternative
668  this you must set --enable-unicode-properties when running "configure".  matching function, in non-UTF-8/16 mode, UTF-8/16 mode, and UTF-8/16 mode with
669    Unicode property support, respectively.
670  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  
671  matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode  The eleventh test checks some internal offsets and code size features; it is
672  property support, respectively. The eighth and ninth tests are not run  run only when the default "link size" of 2 is set (in other cases the sizes
673  automatically unless PCRE is build with the relevant support.  change) and when Unicode property support is enabled.
674    
675    The twelfth test is run only when JIT support is available, and the thirteenth
676    test is run only when JIT support is not available. They test some JIT-specific
677    features such as information output from pcretest about JIT compilation.
678    
679    The fourteenth, fifteenth, and sixteenth tests are run only in 8-bit mode, and
680    the seventeenth, eighteenth, and nineteenth tests are run only in 16-bit mode.
681    These are tests that generate different output in the two modes. They are for
682    general cases, UTF-8/16 support, and Unicode property support, respectively.
683    
684    The twentieth test is run only in 16-bit mode. It tests some specific 16-bit
685    features of the DFA matching engine.
686    
687    The twenty-first and twenty-second tests are run only in 16-bit mode, when the
688    link size is set to 2. They test reloading pre-compiled patterns.
689    
690    
691  Character tables  Character tables
692  ----------------  ----------------
693    
694  PCRE uses four tables for manipulating and identifying characters whose values  For speed, PCRE uses four tables for manipulating and identifying characters
695  are less than 256. The final argument of the pcre_compile() function is a  whose code point values are less than 256. The final argument of the
696  pointer to a block of memory containing the concatenated tables. A call to  pcre_compile() function is a pointer to a block of memory containing the
697  pcre_maketables() can be used to generate a set of tables in the current  concatenated tables. A call to pcre_maketables() can be used to generate a set
698  locale. If the final argument for pcre_compile() is passed as NULL, a set of  of tables in the current locale. If the final argument for pcre_compile() is
699  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.
700    
701  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
702  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
703  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
704  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
705  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
706  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
707  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
708  probably also edit Makefile to ensure that the file doesn't ever get  your system will control the contents of these default tables. You can change
709  re-generated.  the default tables by editing pcre_chartables.c and then re-building PCRE. If
710    you do this, you should take care to ensure that the file does not get
711    automatically re-generated. The best way to do this is to move
712    pcre_chartables.c.dist out of the way and replace it with your customized
713    tables.
714    
715    When the dftables program is run as a result of --enable-rebuild-chartables,
716    it uses the default C locale that is set on your system. It does not pay
717    attention to the LC_xxx environment variables. In other words, it uses the
718    system's default locale rather than whatever the compiling user happens to have
719    set. If you really do want to build a source set of character tables in a
720    locale that is specified by the LC_xxx variables, you can run the dftables
721    program by hand with the -L option. For example:
722    
723      ./dftables -L pcre_chartables.c.special
724    
725  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,
726  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
727  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
728  building 32-byte bit maps that represent character classes.  building 32-byte bit maps that represent character classes for code points less
729    than 256.
730    
731  The final 256-byte table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
732  follows:  follows:
# Line 422  You should not alter the set of characte Line 742  You should not alter the set of characte
742  will cause PCRE to malfunction.  will cause PCRE to malfunction.
743    
744    
745  Manifest  File manifest
746  --------  -------------
747    
748  The distribution should contain the following files:  The distribution should contain the files listed below. Where a file name is
749    given as pcre[16]_xxx it means that there are two files, one with the name
750    pcre_xxx and the other with the name pcre16_xxx.
751    
752    (A) Source files of the PCRE library functions and their headers:
753    
754      dftables.c              auxiliary program for building pcre_chartables.c
755                                when --enable-rebuild-chartables is specified
756    
757      pcre_chartables.c.dist  a default set of character tables that assume ASCII
758                                coding; used, unless --enable-rebuild-chartables is
759                                specified, by copying to pcre[16]_chartables.c
760    
761      pcreposix.c             )
762      pcre[16]_byte_order.c   )
763      pcre[16]_compile.c      )
764      pcre[16]_config.c       )
765      pcre[16]_dfa_exec.c     )
766      pcre[16]_exec.c         )
767      pcre[16]_fullinfo.c     )
768      pcre[16]_get.c          ) sources for the functions in the library,
769      pcre[16]_globals.c      )   and some internal functions that they use
770      pcre[16]_jit_compile.c  )
771      pcre[16]_maketables.c   )
772      pcre[16]_newline.c      )
773      pcre[16]_refcount.c     )
774      pcre[16]_string_utils.c )
775      pcre[16]_study.c        )
776      pcre[16]_tables.c       )
777      pcre[16]_ucd.c          )
778      pcre[16]_version.c      )
779      pcre[16]_xclass.c       )
780      pcre_ord2utf8.c         )
781      pcre_valid_utf8.c       )
782      pcre16_ord2utf16.c      )
783      pcre16_utf16_utils.c    )
784      pcre16_valid_utf16.c    )
785    
786      pcre[16]_printint.c     ) debugging function that is used by pcretest,
787                              )   and can also be #included in pcre_compile()
788    
789      pcre.h.in               template for pcre.h when built by "configure"
790      pcreposix.h             header for the external POSIX wrapper API
791      pcre_internal.h         header for internal use
792      sljit/*                 16 files that make up the JIT compiler
793      ucp.h                   header for Unicode property handling
794    
795      config.h.in             template for config.h, which is built by "configure"
796    
797      pcrecpp.h               public header file for the C++ wrapper
798      pcrecpparg.h.in         template for another C++ header file
799      pcre_scanner.h          public header file for C++ scanner functions
800      pcrecpp.cc              )
801      pcre_scanner.cc         ) source for the C++ wrapper library
802    
803      pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
804                                C++ stringpiece functions
805      pcre_stringpiece.cc     source for the C++ stringpiece functions
806    
807    (B) Source files for programs that use PCRE:
808    
809      pcredemo.c              simple demonstration of coding calls to PCRE
810      pcregrep.c              source of a grep utility that uses PCRE
811      pcretest.c              comprehensive test program
812    
813    (C) Auxiliary files:
814    
815      132html                 script to turn "man" pages into HTML
816      AUTHORS                 information about the author of PCRE
817      ChangeLog               log of changes to the code
818      CleanTxt                script to clean nroff output for txt man pages
819      Detrail                 script to remove trailing spaces
820      HACKING                 some notes about the internals of PCRE
821      INSTALL                 generic installation instructions
822      LICENCE                 conditions for the use of PCRE
823      COPYING                 the same, using GNU's standard name
824      Makefile.in             ) template for Unix Makefile, which is built by
825                              )   "configure"
826      Makefile.am             ) the automake input that was used to create
827                              )   Makefile.in
828      NEWS                    important changes in this release
829      NON-UNIX-USE            the previous name for NON-AUTOTOOLS-BUILD
830      NON-AUTOTOOLS-BUILD     notes on building PCRE without using autotools
831      PrepareRelease          script to make preparations for "make dist"
832      README                  this file
833      RunTest                 a Unix shell script for running tests
834      RunGrepTest             a Unix shell script for pcregrep tests
835      aclocal.m4              m4 macros (generated by "aclocal")
836      config.guess            ) files used by libtool,
837      config.sub              )   used only when building a shared library
838      configure               a configuring shell script (built by autoconf)
839      configure.ac            ) the autoconf input that was used to build
840                              )   "configure" and config.h
841      depcomp                 ) script to find program dependencies, generated by
842                              )   automake
843      doc/*.3                 man page sources for PCRE
844      doc/*.1                 man page sources for pcregrep and pcretest
845      doc/index.html.src      the base HTML page
846      doc/html/*              HTML documentation
847      doc/pcre.txt            plain text version of the man pages
848      doc/pcretest.txt        plain text documentation of test program
849      doc/perltest.txt        plain text documentation of Perl test program
850      install-sh              a shell script for installing files
851      libpcre16.pc.in         template for libpcre16.pc for pkg-config
852      libpcre.pc.in           template for libpcre.pc for pkg-config
853      libpcreposix.pc.in      template for libpcreposix.pc for pkg-config
854      libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
855      ltmain.sh               file used to build a libtool script
856      missing                 ) common stub for a few missing GNU programs while
857                              )   installing, generated by automake
858      mkinstalldirs           script for making install directories
859      perltest.pl             Perl test program
860      pcre-config.in          source of script which retains PCRE information
861      pcre_jit_test.c         test program for the JIT compiler
862      pcrecpp_unittest.cc          )
863      pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
864      pcre_stringpiece_unittest.cc )
865      testdata/testinput*     test data for main library tests
866      testdata/testoutput*    expected test results
867      testdata/grep*          input and output for pcregrep tests
868      testdata/*              other supporting test files
869    
870    (D) Auxiliary files for cmake support
871    
872      cmake/COPYING-CMAKE-SCRIPTS
873      cmake/FindPackageHandleStandardArgs.cmake
874      cmake/FindEditline.cmake
875      cmake/FindReadline.cmake
876      CMakeLists.txt
877      config-cmake.h.in
878    
879  (A) The actual source files of the PCRE library functions and their  (E) Auxiliary files for VPASCAL
     headers:  
880    
881    dftables.c            auxiliary program for building chartables.c    makevp.bat
882      makevp_c.txt
883    pcreposix.c           )    makevp_l.txt
884    pcre_compile.c        )    pcregexp.pas
   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_newline.c        )  
   pcre_ord2utf8.c       )  
   pcre_refcount.c       )  
   pcre_study.c          )  
   pcre_tables.c         )  
   pcre_try_flipped.c    )  
   pcre_ucp_searchfuncs.c)  
   pcre_valid_utf8.c     )  
   pcre_version.c        )  
   pcre_xclass.c         )  
   ucptable.c            )  
   
   pcre_printint.src     ) debugging function that is #included in pcretest, and  
                         )   can also be #included in pcre_compile()  
   
   pcre.h                the public PCRE header file  
   pcreposix.h           header for the external POSIX wrapper API  
   pcre_internal.h       header for internal use  
   ucp.h                 ) headers concerned with  
   ucpinternal.h         )   Unicode property handling  
   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  
   config.h.in           "source" for the config.h header file  
   configure             a configuring shell script (built by autoconf)  
   configure.ac          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  
885    
886  (C) Auxiliary files for Win32 DLL  (F) Auxiliary files for building PCRE "by hand"
887    
888    libpcre.def    pcre.h.generic          ) a version of the public PCRE header file
889    libpcreposix.def                            )   for use in non-"configure" environments
890      config.h.generic        ) a version of config.h for use in non-"configure"
891                              )   environments
892    
893  (D) Auxiliary file for VPASCAL  (F) Miscellaneous
894    
895    makevp.bat    RunTest.bat            a script for running tests under Windows
896    
897  Philip Hazel  Philip Hazel
898  Email local part: ph10  Email local part: ph10
899  Email domain: cam.ac.uk  Email domain: cam.ac.uk
900  November 2006  Last updated: 07 September 2012

Legend:
Removed from v.96  
changed lines
  Added in v.1031

  ViewVC Help
Powered by ViewVC 1.1.5