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

Diff of /code/trunk/README

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

revision 87 by nigel, Sat Feb 24 21:41:21 2007 UTC revision 836 by ph10, Wed Dec 28 17:16:11 2011 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 systems
22      Building PCRE on Unix-like systems
23      Retrieving configuration information on Unix-like systems
24      Shared libraries on Unix-like systems
25      Cross-compiling on Unix-like systems
26      Using HP's ANSI C++ compiler (aCC)
27      Using PCRE from MySQL
28      Making new tarballs
29      Testing PCRE
30      Character tables
31      File manifest
32    
33    
34  The PCRE APIs  The PCRE APIs
35  -------------  -------------
36    
37  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
38  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
39  for details).  of Google Inc.
40    
41  Also included are a set of C wrapper functions that are based on the POSIX  In addition, there is a set of C wrapper functions that are based on the POSIX
42  API. These end up in the library called libpcreposix. Note that this just  regular expression API (see the pcreposix man page). These end up in the
43  provides a POSIX calling interface to PCRE: the regular expressions themselves  library called libpcreposix. Note that this just provides a POSIX calling
44  still follow Perl syntax and semantics. The header file for the POSIX-style  interface to PCRE; the regular expressions themselves still follow Perl syntax
45  functions is called pcreposix.h. The official POSIX name is regex.h, but I  and semantics. The POSIX API is restricted, and does not give full access to
46  didn't want to risk possible problems with existing files of that name by  all of PCRE's facilities.
47  distributing it that way. To use it with an existing program that uses the  
48  POSIX API, it will have to be renamed or pointed at by a link.  The header file for the POSIX-style functions is called pcreposix.h. The
49    official POSIX name is regex.h, but I did not want to risk possible problems
50    with existing files of that name by distributing it that way. To use PCRE with
51    an existing program that uses the POSIX API, pcreposix.h will have to be
52    renamed or pointed at by a link.
53    
54  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
55  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
56    file (as mentioned above), you must also take care when linking programs to
57  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
58  up the "real" POSIX functions of the same name.  up the POSIX functions of the same name from the other library.
59    
60    One way of avoiding this confusion is to compile PCRE with the addition of
61    -Dregcomp=PCREregcomp (and similarly for the other POSIX functions) to the
62    compiler flags (CFLAGS if you are using "configure" -- see below). This has the
63    effect of renaming the functions so that the names no longer clash. Of course,
64    you have to do the same thing for your applications, or write them using the
65    new names.
66    
67    
68  Documentation for PCRE  Documentation for PCRE
69  ----------------------  ----------------------
70    
71  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
72  man pages whose names all start with "pcre". The one that is called "pcre"  with a set of man pages whose names all start with "pcre". The one that is just
73  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
74  supplied in two other forms; however, as there is no standard place to install  documentation is supplied in two other forms:
75  them, they are left in the doc directory of the unpacked source distribution.  
76  These forms are:    1. There are files called doc/pcre.txt, doc/pcregrep.txt, and
77         doc/pcretest.txt in the source distribution. The first of these is a
78    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
79       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
80       man pages except those that summarize individual functions. The other two       forms of the section 1 man pages for the pcregrep and pcretest commands.
81       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
82       pcretest commands. Text forms are provided for ease of scanning with text       similar tools. They are installed in <prefix>/share/doc/pcre, where
83       editors or similar tools.       <prefix> is the installation prefix (defaulting to /usr/local).
84    
85    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
86       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
87       doc/index.html.       doc/html and installed in <prefix>/share/doc/pcre/html.
88    
89    Users of PCRE have contributed files containing the documentation for various
90    releases in CHM format. These can be found in the Contrib directory of the FTP
91    site (see next section).
92    
93    
94  Contributions by users of PCRE  Contributions by users of PCRE
# Line 59  You can find contributions from PCRE use Line 98  You can find contributions from PCRE use
98    
99    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
100    
101  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
102  Several of them provide support for compiling PCRE on various flavours of  complete in themselves; others are pointers to URLs containing relevant files.
103  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
104  others are pointers to URLs containing relevant files.  contributions provided support for compiling PCRE on various flavours of
105    Windows (I myself do not use Windows). Nowadays there is more Windows support
106    in the standard distribution, so these contibutions have been archived.
107    
108    
109    Building PCRE on non-Unix systems
110    ---------------------------------
111    
112  Building PCRE on a Unix-like system  For a non-Unix system, please read the comments in the file NON-UNIX-USE,
113  -----------------------------------  though if your system supports the use of "configure" and "make" you may be
114    able to build PCRE in the same way as for Unix-like systems. PCRE can also be
115    configured in many platform environments using the GUI facility provided by
116    CMake's cmake-gui command. This creates Makefiles, solution files, etc.
117    
118    PCRE has been compiled on many different operating systems. It should be
119    straightforward to build PCRE on any system that has a Standard C compiler and
120    library, because it uses only Standard C functions.
121    
122    
123    Building PCRE on Unix-like systems
124    ----------------------------------
125    
126  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
127  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
128    
129    The following instructions assume the use of the widely used "configure, make,
130    make install" process. There is also support for CMake in the PCRE
131    distribution; there are some comments about using CMake in the NON-UNIX-USE
132    file, though it can also be used in Unix-like systems.
133    
134  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
135  PCRE distribution directory, with your current directory set to the directory  PCRE distribution directory, with your current directory set to the directory
136  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
137  "autoconf" configuration script, for which generic instructions are supplied in  "autoconf" configuration script, for which generic instructions are supplied in
138  INSTALL.  the file INSTALL.
139    
140  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
141  this case, on many systems, just running "./configure" is sufficient, but the  this case, on many systems, just running "./configure" is sufficient. However,
142  usual methods of changing standard defaults are available. For example:  the usual methods of changing standard defaults are available. For example:
143    
144  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
145    
# Line 99  possible to build it as a C++ library, t Line 159  possible to build it as a C++ library, t
159  does not have any features to support this.  does not have any features to support this.
160    
161  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
162  library. You can read more about them in the pcrebuild man page.  library. They are also documented in the pcrebuild man page.
163    
164    . By default, both shared and static libraries are built. You can change this
165      by adding one of these options to the "configure" command:
166    
167      --disable-shared
168      --disable-static
169    
170      (See also "Shared libraries on Unix-like systems" below.)
171    
172  . 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
173    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
174    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,
175    will try to build the C++ wrapper.    it will try to build the C++ wrapper.
176    
177  . If you want to make use of the support for UTF-8 character strings in PCRE,  . If you want to include support for just-in-time compiling, which can give
178    you must add --enable-utf8 to the "configure" command. Without it, the code    large performance improvements on certain platforms, add --enable-jit to the
179    for handling UTF-8 is not included in the library. (Even when included, it    "configure" command. This support is available only for certain hardware
180    still has to be enabled by an option at run time.)    architectures. If you try to enable it on an unsupported architecture, there
181      will be a compile time error.
182    
183    . When JIT support is enabled, pcregrep automatically makes use of it, unless
184      you add --disable-pcregrep-jit to the "configure" command.
185    
186    . If you want to make use of the support for UTF-8 Unicode character strings in
187      PCRE, you must add --enable-utf8 to the "configure" command. Without it, the
188      code for handling UTF-8 is not included in the library. Even when included,
189      it still has to be enabled by an option at run time. When PCRE is compiled
190      with this option, its input can only either be ASCII or UTF-8, even when
191      running on EBCDIC platforms. It is not possible to use both --enable-utf8 and
192      --enable-ebcdic at the same time.
193    
194  . If, in addition to support for UTF-8 character strings, you want to include  . If, in addition to support for UTF-8 character strings, you want to include
195    support for the \P, \p, and \X sequences that recognize Unicode character    support for the \P, \p, and \X sequences that recognize Unicode character
196    properties, you must add --enable-unicode-properties to the "configure"    properties, you must add --enable-unicode-properties to the "configure"
197    command. This adds about 90K to the size of the library (in the form of a    command. This adds about 30K to the size of the library (in the form of a
198    property table); only the basic two-letter properties such as Lu are    property table); only the basic two-letter properties such as Lu are
199    supported.    supported.
200    
201  . You can build PCRE to recognize either CR or LF as the newline character,  . You can build PCRE to recognize either CR or LF or the sequence CRLF or any
202    instead of whatever your compiler uses for "\n", by adding --newline-is-cr or    of the preceding, or any of the Unicode newline sequences as indicating the
203    --newline-is-lf to the "configure" command, respectively. Only do this if you    end of a line. Whatever you specify at build time is the default; the caller
204    really understand what you are doing. On traditional Unix-like systems, the    of PCRE can change the selection at run time. The default newline indicator
205    newline character is LF.    is a single LF character (the Unix standard). You can specify the default
206      newline indicator by adding --enable-newline-is-cr or --enable-newline-is-lf
207      or --enable-newline-is-crlf or --enable-newline-is-anycrlf or
208      --enable-newline-is-any to the "configure" command, respectively.
209    
210      If you specify --enable-newline-is-cr or --enable-newline-is-crlf, some of
211      the standard tests will fail, because the lines in the test files end with
212      LF. Even if the files are edited to change the line endings, there are likely
213      to be some failures. With --enable-newline-is-anycrlf or
214      --enable-newline-is-any, many tests should succeed, but there may be some
215      failures.
216    
217    . By default, the sequence \R in a pattern matches any Unicode line ending
218      sequence. This is independent of the option specifying what PCRE considers to
219      be the end of a line (see above). However, the caller of PCRE can restrict \R
220      to match only CR, LF, or CRLF. You can make this the default by adding
221      --enable-bsr-anycrlf to the "configure" command (bsr = "backslash R").
222    
223  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
224    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
225    them. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
226    
227    --with-posix-malloc-threshold=20    --with-posix-malloc-threshold=20
228    
# Line 139  library. You can read more about them in Line 235  library. You can read more about them in
235    --with-match-limit=500000    --with-match-limit=500000
236    
237    on the "configure" command. This is just the default; individual calls to    on the "configure" command. This is just the default; individual calls to
238    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
239    man page.    pcreapi man page.
240    
241    . There is a separate counter that limits the depth of recursive function calls
242      during a matching process. This also has a default of ten million, which is
243      essentially "unlimited". You can change the default by setting, for example,
244    
245      --with-match-limit-recursion=500000
246    
247      Recursive function calls use up the runtime stack; running out of stack can
248      cause programs to crash in strange ways. There is a discussion about stack
249      sizes in the pcrestack man page.
250    
251  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
252    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
253    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
254    ever to be necessary. If you build PCRE with an increased link size, test 2    ever to be necessary. Increasing the internal link size will reduce
255    (and 5 if you are using UTF-8) will fail. Part of the output of these tests    performance.
   is a representation of the compiled pattern, and this changes with the link  
   size.  
256    
257  . 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
258    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
259    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
260    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
261    this, use    build PCRE like this, use
262    
263    --disable-stack-for-recursion    --disable-stack-for-recursion
264    
265    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
266    necessary in environments with limited stack sizes. This applies only to the    necessary in environments with limited stack sizes. This applies only to the
267    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
268    use deeply nested recursion.    successfully used, it is not relevant. Equally, it does not apply to
269      pcre_dfa_exec(), which does not use deeply nested recursion. There is a
270  The "configure" script builds eight files for the basic C library:    discussion about stack sizes in the pcrestack man page.
271    
272  . pcre.h is the header file for C programs that call PCRE  . For speed, PCRE uses four tables for manipulating and identifying characters
273  . Makefile is the makefile that builds the library    whose code point values are less than 256. By default, it uses a set of
274  . config.h contains build-time configuration options for the library    tables for ASCII encoding that is part of the distribution. If you specify
275  . pcre-config is a script that shows the settings of "configure" options  
276  . libpcre.pc is data for the pkg-config command    --enable-rebuild-chartables
277  . libtool is a script that builds shared and/or static libraries  
278  . RunTest is a script for running tests on the library    a program called dftables is compiled and run in the default C locale when
279  . RunGrepTest is a script for running tests on the pcregrep command    you obey "make". It builds a source file called pcre_chartables.c. If you do
280      not specify this option, pcre_chartables.c is created as a copy of
281  In addition, if a C++ compiler is found, the following are also built:    pcre_chartables.c.dist. See "Character tables" below for further information.
282    
283  . pcrecpp.h is the header file for programs that call PCRE via the C++ wrapper  . It is possible to compile PCRE for use on systems that use EBCDIC as their
284  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions    character code (as opposed to ASCII) by specifying
285    
286      --enable-ebcdic
287    
288      This automatically implies --enable-rebuild-chartables (see above). However,
289      when PCRE is built this way, it always operates in EBCDIC. It cannot support
290      both EBCDIC and UTF-8.
291    
292    . It is possible to compile pcregrep to use libz and/or libbz2, in order to
293      read .gz and .bz2 files (respectively), by specifying one or both of
294    
295      --enable-pcregrep-libz
296      --enable-pcregrep-libbz2
297    
298      Of course, the relevant libraries must be installed on your system.
299    
300    . The default size of internal buffer used by pcregrep can be set by, for
301      example:
302    
303      --with-pcregrep-bufsize=50K
304    
305      The default value is 20K.
306    
307    . It is possible to compile pcretest so that it links with the libreadline
308      library, by specifying
309    
310      --enable-pcretest-libreadline
311    
312      If this is done, when pcretest's input is from a terminal, it reads it using
313      the readline() function. This provides line-editing and history facilities.
314      Note that libreadline is GPL-licenced, so if you distribute a binary of
315      pcretest linked in this way, there may be licensing issues.
316    
317      Setting this option causes the -lreadline option to be added to the pcretest
318      build. In many operating environments with a sytem-installed readline
319      library this is sufficient. However, in some environments (e.g. if an
320      unmodified distribution version of readline is in use), it may be necessary
321      to specify something like LIBS="-lncurses" as well. This is because, to quote
322      the readline INSTALL, "Readline uses the termcap functions, but does not link
323      with the termcap or curses library itself, allowing applications which link
324      with readline the to choose an appropriate library." If you get error
325      messages about missing functions tgetstr, tgetent, tputs, tgetflag, or tgoto,
326      this is the problem, and linking with the ncurses library should fix it.
327    
328    The "configure" script builds the following files for the basic C library:
329    
330    . Makefile             the makefile that builds the library
331    . config.h             build-time configuration options for the library
332    . pcre.h               the public PCRE header file
333    . pcre-config          script that shows the building settings such as CFLAGS
334                             that were set for "configure"
335    . libpcre.pc         ) data for the pkg-config command
336    . libpcreposix.pc    )
337    . libtool              script that builds shared and/or static libraries
338    . RunTest              script for running tests on the basic C library
339    . RunGrepTest          script for running tests on the pcregrep command
340    
341    Versions of config.h and pcre.h are distributed in the PCRE tarballs under the
342    names config.h.generic and pcre.h.generic. These are provided for those who
343    have to built PCRE without using "configure" or CMake. If you use "configure"
344    or CMake, the .generic versions are not used.
345    
346    If a C++ compiler is found, the following files are also built:
347    
348    . libpcrecpp.pc        data for the pkg-config command
349    . pcrecpparg.h         header file for calling PCRE via the C++ wrapper
350    . pcre_stringpiece.h   header for the C++ "stringpiece" functions
351    
352  The "configure" script also creates config.status, which is an executable  The "configure" script also creates config.status, which is an executable
353  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
# Line 185  contains compiler output from tests that Line 355  contains compiler output from tests that
355    
356  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
357  libpcre and libpcreposix, a test program called pcretest, and the pcregrep  libpcre and libpcreposix, a test program called pcretest, and the pcregrep
358  command. If a C++ compiler was found on your system, it also builds the C++  command. If a C++ compiler was found on your system, and you did not disable it
359  wrapper library, which is called libpcrecpp, and some test programs called  with --disable-cpp, "make" also builds the C++ wrapper library, which is called
360  pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.  libpcrecpp, and some test programs called pcrecpp_unittest,
361    pcre_scanner_unittest, and pcre_stringpiece_unittest. If you enabled JIT
362  The command "make test" runs all the appropriate tests. Details of the PCRE  support with --enable-jit, a test program called pcre_jit_test is also built.
363  tests are given in a separate section of this document, below.  
364    The command "make check" runs all the appropriate tests. Details of the PCRE
365  You can use "make install" to copy the libraries, the public header files  tests are given below in a separate section of this document.
366  pcre.h, pcreposix.h, pcrecpp.h, and pcre_stringpiece.h (the last two only if  
367  the C++ wrapper was built), and the man pages to appropriate live directories  You can use "make install" to install PCRE into live directories on your
368  on your system, in the normal way.  system. The following are installed (file names are all relative to the
369    <prefix> that is set when "configure" is run):
370    
371      Commands (bin):
372        pcretest
373        pcregrep
374        pcre-config
375    
376      Libraries (lib):
377        libpcre
378        libpcreposix
379        libpcrecpp (if C++ support is enabled)
380    
381      Configuration information (lib/pkgconfig):
382        libpcre.pc
383        libpcreposix.pc
384        libpcrecpp.pc (if C++ support is enabled)
385    
386      Header files (include):
387        pcre.h
388        pcreposix.h
389        pcre_scanner.h      )
390        pcre_stringpiece.h  ) if C++ support is enabled
391        pcrecpp.h           )
392        pcrecpparg.h        )
393    
394      Man pages (share/man/man{1,3}):
395        pcregrep.1
396        pcretest.1
397        pcre-config.1
398        pcre.3
399        pcre*.3 (lots more pages, all starting "pcre")
400    
401      HTML documentation (share/doc/pcre/html):
402        index.html
403        *.html (lots more pages, hyperlinked from index.html)
404    
405      Text file documentation (share/doc/pcre):
406        AUTHORS
407        COPYING
408        ChangeLog
409        LICENCE
410        NEWS
411        README
412        pcre.txt         (a concatenation of the man(3) pages)
413        pcretest.txt     the pcretest man page
414        pcregrep.txt     the pcregrep man page
415        pcre-config.txt  the pcre-config man page
416    
417  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".
418  This removes all the files that "make install" installed. However, it does not  This removes all the files that "make install" installed. However, it does not
# Line 205  remove any directories, because these ar Line 422  remove any directories, because these ar
422  Retrieving configuration information on Unix-like systems  Retrieving configuration information on Unix-like systems
423  ---------------------------------------------------------  ---------------------------------------------------------
424    
425  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
426  to recall information about the PCRE configuration and installation. For  recall information about the PCRE configuration and installation. For example:
 example:  
427    
428    pcre-config --version    pcre-config --version
429    
# Line 226  single command is used. For example: Line 442  single command is used. For example:
442    pkg-config --cflags pcre    pkg-config --cflags pcre
443    
444  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
445  pkgconfig.  <prefix>/lib/pkgconfig.
446    
447    
448  Shared libraries on Unix-like systems  Shared libraries on Unix-like systems
# Line 243  built. The programs pcretest and pcregre Line 459  built. The programs pcretest and pcregre
459  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
460  you use "make install" to install shared libraries, pcregrep and pcretest are  you use "make install" to install shared libraries, pcregrep and pcretest are
461  automatically re-built to use the newly installed shared libraries before being  automatically re-built to use the newly installed shared libraries before being
462  installed themselves. However, the versions left in the source directory still  installed themselves. However, the versions left in the build directory still
463  use the uninstalled libraries.  use the uninstalled libraries.
464    
465  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 255  Then run "make" in the usual way. Simila Line 471  Then run "make" in the usual way. Simila
471  build only shared libraries.  build only shared libraries.
472    
473    
474  Cross-compiling on a Unix-like system  Cross-compiling on Unix-like systems
475  -------------------------------------  ------------------------------------
476    
477  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
478  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
479  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
480  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
481  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,
482  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
483  there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)  compiler.
484  when calling the "configure" command. If they are not specified, they default  
485  to the values of CC and CFLAGS.  When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
486    by making a copy of pcre_chartables.c.dist, which is a default set of tables
487    that assumes ASCII code. Cross-compiling with the default tables should not be
488    a problem.
489    
490    If you need to modify the character tables when cross-compiling, you should
491    move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
492    run it on the local host to make a new version of pcre_chartables.c.dist.
493    Then when you cross-compile PCRE this new version of the tables will be used.
494    
495    
496  Using HP's ANSI C++ compiler (aCC)  Using HP's ANSI C++ compiler (aCC)
497  ----------------------------------  ----------------------------------
498    
499  Unless C++ support is disabled by specifiying the "--disable-cpp" option of the  Unless C++ support is disabled by specifying the "--disable-cpp" option of the
500  "configure" script, you *must* include the "-AA" option in the CXXFLAGS  "configure" script, you must include the "-AA" option in the CXXFLAGS
501  environment variable in order for the C++ components to compile correctly.  environment variable in order for the C++ components to compile correctly.
502    
503  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 285  running the "configure" script: Line 509  running the "configure" script:
509    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
510    
511    
512  Building on non-Unix systems  Using Sun's compilers for Solaris
513  ----------------------------  ---------------------------------
514    
515  For a non-Unix system, read the comments in the file NON-UNIX-USE, though if  A user reports that the following configurations work on Solaris 9 sparcv9 and
516  the system supports the use of "configure" and "make" you may be able to build  Solaris 9 x86 (32-bit):
517  PCRE in the same way as for Unix systems.  
518      Solaris 9 sparcv9: ./configure --disable-cpp CC=/bin/cc CFLAGS="-m64 -g"
519  PCRE has been compiled on Windows systems and on Macintoshes, but I don't know    Solaris 9 x86:     ./configure --disable-cpp CC=/bin/cc CFLAGS="-g"
520  the details because I don't use those systems. It should be straightforward to  
521  build PCRE on any system that has a Standard C compiler, because it uses only  
522  Standard C functions.  Using PCRE from MySQL
523    ---------------------
524    
525    On systems where both PCRE and MySQL are installed, it is possible to make use
526    of PCRE from within MySQL, as an alternative to the built-in pattern matching.
527    There is a web page that tells you how to do this:
528    
529      http://www.mysqludf.org/lib_mysqludf_preg/index.php
530    
531    
532    Making new tarballs
533    -------------------
534    
535    The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
536    zip formats. The command "make distcheck" does the same, but then does a trial
537    build of the new distribution to ensure that it works.
538    
539    If you have modified any of the man page sources in the doc directory, you
540    should first run the PrepareRelease script before making a distribution. This
541    script creates the .txt and HTML forms of the documentation from the man pages.
542    
543    
544  Testing PCRE  Testing PCRE
545  ------------  ------------
546    
547  To test PCRE on a Unix system, run the RunTest script that is created by the  To test the basic PCRE library on a Unix system, run the RunTest script that is
548  configuring process. There is also a script called RunGrepTest that tests the  created by the configuring process. There is also a script called RunGrepTest
549  options of the pcregrep command. If the C++ wrapper library is build, three  that tests the options of the pcregrep command. If the C++ wrapper library is
550  test programs called pcrecpp_unittest, pcre_scanner_unittest, and  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
551  pcre_stringpiece_unittest are provided.  pcre_stringpiece_unittest are also built. When JIT support is enabled, another
552    test program called pcre_jit_test is built.
553  Both the scripts and all the program tests are run if you obey "make runtest",  
554  "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
555  NON-UNIX-USE.  "make test". For other systems, see the instructions in NON-UNIX-USE.
556    
557  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
558  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
559  turn, and compares the output with the contents of the corresponding testoutput  directory, and compares the output with the contents of the corresponding
560  file. 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
561    were selected. For example, the tests for UTF-8 support are run only if
562    --enable-utf8 was used. RunTest outputs a comment when it skips a test.
563    
564    Many of the tests that are not skipped are run up to three times. The second
565    run forces pcre_study() to be called for all patterns except for a few in some
566    tests that are marked "never study" (see the pcretest program for how this is
567    done). If JIT support is available, the non-DFA tests are run a third time,
568    this time with a forced pcre_study() with the PCRE_STUDY_JIT_COMPILE option.
569    
570    RunTest uses a file called testtry to hold the main output from pcretest
571  (testsavedregex is also used as a working file). To run pcretest on just one of  (testsavedregex is also used as a working file). To run pcretest on just one of
572  the test files, give its number as an argument to RunTest, for example:  the test files, give its number as an argument to RunTest, for example:
573    
574    RunTest 2    RunTest 2
575    
576  The first file can also be fed directly into the perltest script to check that  The first test file can be fed directly into the perltest.pl script to check
577  Perl gives the same results. The only difference you should see is in the first  that Perl gives the same results. The only difference you should see is in the
578  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.
579    
580  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
581  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
582  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
583  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
584  pcre_compile().  pcre_compile().
585    
586  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 353  is output to say why. If running this te Line 606  is output to say why. If running this te
606  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,
607  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.
608    
609  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
610  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
611  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
612  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
613  commented in the script, can be be used.)  document entitled NON-UNIX-USE.]
614    
615    The fourth test checks the UTF-8 support. This file can be also fed directly to
616    the perltest.pl script, provided you are running Perl 5.8 or higher.
617    
618  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8
619  features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
620    
621  The sixth and test checks the support for Unicode character properties. It it  The sixth test (which is Perl-5.10 compatible) checks the support for Unicode
622  not run automatically unless PCRE is built with Unicode property support. To to  character properties. This file can be also fed directly to the perltest.pl
623  this you must set --enable-unicode-properties when running "configure".  script, provided you are running Perl 5.10 or higher.
624    
625  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative
626  matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode  matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode
627  property support, respectively. The eighth and ninth tests are not run  property support, respectively.
628  automatically unless PCRE is build with the relevant support.  
629    The tenth test checks some internal offsets and code size features; it is run
630    only when the default "link size" of 2 is set (in other cases the sizes
631    change) and when Unicode property support is enabled.
632    
633    The eleventh and twelfth tests check out features that are new in Perl 5.10,
634    without and with UTF-8 support, respectively. This file can be also fed
635    directly to the perltest.pl script, provided you are running Perl 5.10 or
636    higher.
637    
638    The thirteenth test checks a number internals and non-Perl features concerned
639    with Unicode property support.
640    
641    The fourteenth test is run only when JIT support is available, and the
642    fifteenth test is run only when JIT support is not available. They test some
643    JIT-specific features such as information output from pcretest about JIT
644    compilation.
645    
646    
647  Character tables  Character tables
648  ----------------  ----------------
649    
650  PCRE uses four tables for manipulating and identifying characters whose values  For speed, PCRE uses four tables for manipulating and identifying characters
651  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
652  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
653  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
654  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
655  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.
656    
657  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
658  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
659  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
660  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
661  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
662  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
663  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
664  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
665  re-generated.  the default tables by editing pcre_chartables.c and then re-building PCRE. If
666    you do this, you should take care to ensure that the file does not get
667    automatically re-generated. The best way to do this is to move
668    pcre_chartables.c.dist out of the way and replace it with your customized
669    tables.
670    
671    When the dftables program is run as a result of --enable-rebuild-chartables,
672    it uses the default C locale that is set on your system. It does not pay
673    attention to the LC_xxx environment variables. In other words, it uses the
674    system's default locale rather than whatever the compiling user happens to have
675    set. If you really do want to build a source set of character tables in a
676    locale that is specified by the LC_xxx variables, you can run the dftables
677    program by hand with the -L option. For example:
678    
679      ./dftables -L pcre_chartables.c.special
680    
681  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,
682  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
683  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
684  building 32-byte bit maps that represent character classes.  building 32-byte bit maps that represent character classes for code points less
685    than 256.
686    
687  The final 256-byte table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
688  follows:  follows:
# Line 411  You should not alter the set of characte Line 698  You should not alter the set of characte
698  will cause PCRE to malfunction.  will cause PCRE to malfunction.
699    
700    
701  Manifest  File manifest
702  --------  -------------
703    
704  The distribution should contain the following files:  The distribution should contain the following files:
705    
706  (A) The actual source files of the PCRE library functions and their  (A) Source files of the PCRE library functions and their headers:
     headers:  
707    
708    dftables.c            auxiliary program for building chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
709                                when --enable-rebuild-chartables is specified
710    
711    pcreposix.c           )    pcre_chartables.c.dist  a default set of character tables that assume ASCII
712    pcre_compile.c        )                              coding; used, unless --enable-rebuild-chartables is
713    pcre_config.c         )                              specified, by copying to pcre_chartables.c
714    pcre_dfa_exec.c       )  
715    pcre_exec.c           )    pcreposix.c             )
716    pcre_fullinfo.c       )    pcre_byte_order.c       )
717    pcre_get.c            ) sources for the functions in the library,    pcre_compile.c          )
718    pcre_globals.c        )   and some internal functions that they use    pcre_config.c           )
719    pcre_info.c           )    pcre_dfa_exec.c         )
720    pcre_maketables.c     )    pcre_exec.c             )
721    pcre_ord2utf8.c       )    pcre_fullinfo.c         )
722    pcre_printint.c       )    pcre_get.c              ) sources for the functions in the library,
723    pcre_study.c          )    pcre_globals.c          )   and some internal functions that they use
724    pcre_tables.c         )    pcre_info.c             )
725    pcre_try_flipped.c    )    pcre_jit_compile.c      )
726    pcre_ucp_findchar.c   )    pcre_maketables.c       )
727    pcre_valid_utf8.c     )    pcre_newline.c          )
728    pcre_version.c        )    pcre_ord2utf8.c         )
729    pcre_xclass.c         )    pcre_refcount.c         )
730      pcre_study.c            )
731    ucp_findchar.c        )    pcre_tables.c           )
732    ucp.h                 ) source for the code that is used for    pcre_ucd.c              )
733    ucpinternal.h         )   Unicode property handling    pcre_valid_utf8.c       )
734    ucptable.c            )    pcre_version.c          )
735    ucptypetable.c        )    pcre_xclass.c           )
736      pcre_printint.src       ) debugging function that is #included in pcretest,
737    pcre.in               "source" for the header for the external API; pcre.h                            )   and can also be #included in pcre_compile()
738                            is built from this by "configure"    pcre.h.in               template for pcre.h when built by "configure"
739    pcreposix.h           header for the external POSIX wrapper API    pcreposix.h             header for the external POSIX wrapper API
740    pcre_internal.h       header for internal use    pcre_internal.h         header for internal use
741    config.in             template for config.h, which is built by configure    sljit/*                 16 files that make up the JIT compiler
742      ucp.h                   header for Unicode property handling
743    pcrecpp.h             the header file for the C++ wrapper  
744    pcrecpparg.h.in       "source" for another C++ header file    config.h.in             template for config.h, which is built by "configure"
745    pcrecpp.cc            )  
746    pcre_scanner.cc       ) source for the C++ wrapper library    pcrecpp.h               public header file for the C++ wrapper
747      pcrecpparg.h.in         template for another C++ header file
748    pcre_stringpiece.h.in "source" for pcre_stringpiece.h, the header for the    pcre_scanner.h          public header file for C++ scanner functions
749                            C++ stringpiece functions    pcrecpp.cc              )
750    pcre_stringpiece.cc   source for the C++ stringpiece functions    pcre_scanner.cc         ) source for the C++ wrapper library
751    
752  (B) Auxiliary files:    pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
753                                C++ stringpiece functions
754    AUTHORS               information about the author of PCRE    pcre_stringpiece.cc     source for the C++ stringpiece functions
755    ChangeLog             log of changes to the code  
756    INSTALL               generic installation instructions  (B) Source files for programs that use PCRE:
757    LICENCE               conditions for the use of PCRE  
758    COPYING               the same, using GNU's standard name    pcredemo.c              simple demonstration of coding calls to PCRE
759    Makefile.in           template for Unix Makefile, which is built by configure    pcregrep.c              source of a grep utility that uses PCRE
760    NEWS                  important changes in this release    pcretest.c              comprehensive test program
761    NON-UNIX-USE          notes on building PCRE on non-Unix systems  
762    README                this file  (C) Auxiliary files:
763    RunTest.in            template for a Unix shell script for running tests  
764    RunGrepTest.in        template for a Unix shell script for pcregrep tests    132html                 script to turn "man" pages into HTML
765    config.guess          ) files used by libtool,    AUTHORS                 information about the author of PCRE
766    config.sub            )   used only when building a shared library    ChangeLog               log of changes to the code
767    configure             a configuring shell script (built by autoconf)    CleanTxt                script to clean nroff output for txt man pages
768    configure.in          the autoconf input used to build configure    Detrail                 script to remove trailing spaces
769    doc/Tech.Notes        notes on the encoding    HACKING                 some notes about the internals of PCRE
770    doc/*.3               man page sources for the PCRE functions    INSTALL                 generic installation instructions
771    doc/*.1               man page sources for pcregrep and pcretest    LICENCE                 conditions for the use of PCRE
772    doc/html/*            HTML documentation    COPYING                 the same, using GNU's standard name
773    doc/pcre.txt          plain text version of the man pages    Makefile.in             ) template for Unix Makefile, which is built by
774    doc/pcretest.txt      plain text documentation of test program                            )   "configure"
775    doc/perltest.txt      plain text documentation of Perl test program    Makefile.am             ) the automake input that was used to create
776    install-sh            a shell script for installing files                            )   Makefile.in
777    libpcre.pc.in         "source" for libpcre.pc for pkg-config    NEWS                    important changes in this release
778    ltmain.sh             file used to build a libtool script    NON-UNIX-USE            notes on building PCRE on non-Unix systems
779    mkinstalldirs         script for making install directories    PrepareRelease          script to make preparations for "make dist"
780    pcretest.c            comprehensive test program    README                  this file
781    pcredemo.c            simple demonstration of coding calls to PCRE    RunTest                 a Unix shell script for running tests
782    perltest              Perl test program    RunGrepTest             a Unix shell script for pcregrep tests
783    pcregrep.c            source of a grep utility that uses PCRE    aclocal.m4              m4 macros (generated by "aclocal")
784    pcre-config.in        source of script which retains PCRE information    config.guess            ) files used by libtool,
785    pcrecpp_unittest.c           )    config.sub              )   used only when building a shared library
786    pcre_scanner_unittest.c      ) test programs for the C++ wrapper    configure               a configuring shell script (built by autoconf)
787    pcre_stringpiece_unittest.c  )    configure.ac            ) the autoconf input that was used to build
788    testdata/testinput*   test data for main library tests                            )   "configure" and config.h
789    testdata/testoutput*  expected test results    depcomp                 ) script to find program dependencies, generated by
790    testdata/grep*        input and output for pcregrep tests                            )   automake
791      doc/*.3                 man page sources for PCRE
792  (C) Auxiliary files for Win32 DLL    doc/*.1                 man page sources for pcregrep and pcretest
793      doc/index.html.src      the base HTML page
794    libpcre.def    doc/html/*              HTML documentation
795    libpcreposix.def    doc/pcre.txt            plain text version of the man pages
796    pcre.def    doc/pcretest.txt        plain text documentation of test program
797      doc/perltest.txt        plain text documentation of Perl test program
798      install-sh              a shell script for installing files
799      libpcre.pc.in           template for libpcre.pc for pkg-config
800      libpcreposix.pc.in      template for libpcreposix.pc for pkg-config
801      libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
802      ltmain.sh               file used to build a libtool script
803      missing                 ) common stub for a few missing GNU programs while
804                              )   installing, generated by automake
805      mkinstalldirs           script for making install directories
806      perltest.pl             Perl test program
807      pcre-config.in          source of script which retains PCRE information
808      pcre_jit_test.c         test program for the JIT compiler
809      pcrecpp_unittest.cc          )
810      pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
811      pcre_stringpiece_unittest.cc )
812      testdata/testinput*     test data for main library tests
813      testdata/testoutput*    expected test results
814      testdata/grep*          input and output for pcregrep tests
815    
816    (D) Auxiliary files for cmake support
817    
818      cmake/COPYING-CMAKE-SCRIPTS
819      cmake/FindPackageHandleStandardArgs.cmake
820      cmake/FindReadline.cmake
821      CMakeLists.txt
822      config-cmake.h.in
823    
824  (D) Auxiliary file for VPASCAL  (E) Auxiliary files for VPASCAL
825    
826    makevp.bat    makevp.bat
827      makevp_c.txt
828      makevp_l.txt
829      pcregexp.pas
830    
831    (F) Auxiliary files for building PCRE "by hand"
832    
833      pcre.h.generic          ) a version of the public PCRE header file
834                              )   for use in non-"configure" environments
835      config.h.generic        ) a version of config.h for use in non-"configure"
836                              )   environments
837    
838    (F) Miscellaneous
839    
840      RunTest.bat            a script for running tests under Windows
841    
842  Philip Hazel  Philip Hazel
843  Email local part: ph10  Email local part: ph10
844  Email domain: cam.ac.uk  Email domain: cam.ac.uk
845  January 2006  Last updated: 06 September 2011

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

  ViewVC Help
Powered by ViewVC 1.1.5