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

Diff of /code/trunk/README

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

revision 99 by ph10, Tue Mar 6 12:27:42 2007 UTC revision 489 by ph10, Tue Jan 19 16:42:21 2010 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 just 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    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  Building PCRE on a Unix-like system  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 103  library. You can read more about them in Line 163  library. You can read more about them in
163    
164  . 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
165    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
166    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,
167    will try to build the C++ wrapper.    it will try to build the C++ wrapper.
168    
169  . If you want to make use of the support for UTF-8 character strings in PCRE,  . If you want to make use of the support for UTF-8 Unicode character strings in
170    you must add --enable-utf8 to the "configure" command. Without it, the code    PCRE, you must add --enable-utf8 to the "configure" command. Without it, the
171    for handling UTF-8 is not included in the library. (Even when included, it    code for handling UTF-8 is not included in the library. Even when included,
172    still has to be enabled by an option at run time.)    it still has to be enabled by an option at run time. When PCRE is compiled
173      with this option, its input can only either be ASCII or UTF-8, even when
174      running on EBCDIC platforms. It is not possible to use both --enable-utf8 and
175      --enable-ebcdic at the same time.
176    
177  . 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
178    support for the \P, \p, and \X sequences that recognize Unicode character    support for the \P, \p, and \X sequences that recognize Unicode character
# Line 119  library. You can read more about them in Line 182  library. You can read more about them in
182    supported.    supported.
183    
184  . 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
185    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
186    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
187    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
188    (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
189    --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
190    to the "configure" command, respectively.    or --enable-newline-is-crlf or --enable-newline-is-anycrlf or
191      --enable-newline-is-any to the "configure" command, respectively.
192    If you specify --newline-is-cr or --newline-is-crlf, some of the standard  
193    tests will fail, because the lines in the test files end with LF. Even if    If you specify --enable-newline-is-cr or --enable-newline-is-crlf, some of
194    the files are edited to change the line endings, there are likely to be some    the standard tests will fail, because the lines in the test files end with
195    failures. With --newline-is-any, many tests should succeed, but there may be    LF. Even if the files are edited to change the line endings, there are likely
196    some failures.    to be some failures. With --enable-newline-is-anycrlf or
197      --enable-newline-is-any, many tests should succeed, but there may be some
198      failures.
199    
200    . By default, the sequence \R in a pattern matches any Unicode line ending
201      sequence. This is independent of the option specifying what PCRE considers to
202      be the end of a line (see above). However, the caller of PCRE can restrict \R
203      to match only CR, LF, or CRLF. You can make this the default by adding
204      --enable-bsr-anycrlf to the "configure" command (bsr = "backslash R").
205    
206  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
207    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
208    them. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
209    
210    --with-posix-malloc-threshold=20    --with-posix-malloc-threshold=20
211    
# Line 147  library. You can read more about them in Line 218  library. You can read more about them in
218    --with-match-limit=500000    --with-match-limit=500000
219    
220    on the "configure" command. This is just the default; individual calls to    on the "configure" command. This is just the default; individual calls to
221    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
222    man page.    pcreapi man page.
223    
224  . 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
225    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 163  library. You can read more about them in Line 234  library. You can read more about them in
234  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
235    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
236    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
237    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
238    (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.  
239    
240  . 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
241    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
242    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
243    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
244    this, use    build PCRE like this, use
245    
246    --disable-stack-for-recursion    --disable-stack-for-recursion
247    
248    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
249    necessary in environments with limited stack sizes. This applies only to the    necessary in environments with limited stack sizes. This applies only to the
250    pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not    pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not
251    use deeply nested recursion.    use deeply nested recursion. There is a discussion about stack sizes in the
252      pcrestack man page.
253    
254    . For speed, PCRE uses four tables for manipulating and identifying characters
255      whose code point values are less than 256. By default, it uses a set of
256      tables for ASCII encoding that is part of the distribution. If you specify
257    
258      --enable-rebuild-chartables
259    
260      a program called dftables is compiled and run in the default C locale when
261      you obey "make". It builds a source file called pcre_chartables.c. If you do
262      not specify this option, pcre_chartables.c is created as a copy of
263      pcre_chartables.c.dist. See "Character tables" below for further information.
264    
265    . It is possible to compile PCRE for use on systems that use EBCDIC as their
266      character code (as opposed to ASCII) by specifying
267    
268      --enable-ebcdic
269    
270      This automatically implies --enable-rebuild-chartables (see above). However,
271      when PCRE is built this way, it always operates in EBCDIC. It cannot support
272      both EBCDIC and UTF-8.
273    
274    . It is possible to compile pcregrep to use libz and/or libbz2, in order to
275      read .gz and .bz2 files (respectively), by specifying one or both of
276    
277      --enable-pcregrep-libz
278      --enable-pcregrep-libbz2
279    
280      Of course, the relevant libraries must be installed on your system.
281    
282    . It is possible to compile pcretest so that it links with the libreadline
283      library, by specifying
284    
285      --enable-pcretest-libreadline
286    
287      If this is done, when pcretest's input is from a terminal, it reads it using
288      the readline() function. This provides line-editing and history facilities.
289      Note that libreadline is GPL-licenced, so if you distribute a binary of
290      pcretest linked in this way, there may be licensing issues.
291    
292  The "configure" script builds eight files for the basic C library:    Setting this option causes the -lreadline option to be added to the pcretest
293      build. In many operating environments with a sytem-installed readline
294      library this is sufficient. However, in some environments (e.g. if an
295      unmodified distribution version of readline is in use), it may be necessary
296      to specify something like LIBS="-lncurses" as well. This is because, to quote
297      the readline INSTALL, "Readline uses the termcap functions, but does not link
298      with the termcap or curses library itself, allowing applications which link
299      with readline the to choose an appropriate library." If you get error
300      messages about missing functions tgetstr, tgetent, tputs, tgetflag, or tgoto,
301      this is the problem, and linking with the ncurses library should fix it.
302    
303    The "configure" script builds the following files for the basic C library:
304    
305  . Makefile is the makefile that builds the library  . Makefile is the makefile that builds the library
306  . config.h contains build-time configuration options for the library  . config.h contains build-time configuration options for the library
307    . pcre.h is the public PCRE header file
308  . pcre-config is a script that shows the settings of "configure" options  . pcre-config is a script that shows the settings of "configure" options
309  . libpcre.pc is data for the pkg-config command  . libpcre.pc is data for the pkg-config command
310  . libtool is a script that builds shared and/or static libraries  . libtool is a script that builds shared and/or static libraries
311  . RunTest is a script for running tests on the library  . RunTest is a script for running tests on the basic C library
312  . RunGrepTest is a script for running tests on the pcregrep command  . RunGrepTest is a script for running tests on the pcregrep command
313    
314  In addition, if a C++ compiler is found, the following are also built:  Versions of config.h and pcre.h are distributed in the PCRE tarballs under the
315    names config.h.generic and pcre.h.generic. These are provided for those who
316    have to built PCRE without using "configure" or CMake. If you use "configure"
317    or CMake, the .generic versions are not used.
318    
319    If a C++ compiler is found, the following files are also built:
320    
321  . pcrecpp.h is the header file for programs that call PCRE via the C++ wrapper  . libpcrecpp.pc is data for the pkg-config command
322    . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper
323  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions
324    
325  The "configure" script also creates config.status, which is an executable  The "configure" script also creates config.status, which is an executable
# Line 202  contains compiler output from tests that Line 328  contains compiler output from tests that
328    
329  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
330  libpcre and libpcreposix, a test program called pcretest, and the pcregrep  libpcre and libpcreposix, a test program called pcretest, and the pcregrep
331  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, "make" also builds the C++
332  wrapper library, which is called libpcrecpp, and some test programs called  wrapper library, which is called libpcrecpp, and some test programs called
333  pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.  pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.
334    Building the C++ wrapper can be disabled by adding --disable-cpp to the
335    "configure" command.
336    
337  The command "make test" runs all the appropriate tests. Details of the PCRE  The command "make check" runs all the appropriate tests. Details of the PCRE
338  tests are given in a separate section of this document, below.  tests are given below in a separate section of this document.
339    
340  You can use "make install" to copy the libraries, the public header files  You can use "make install" to install PCRE into live directories on your
341  pcre.h, pcreposix.h, pcrecpp.h, and pcre_stringpiece.h (the last two only if  system. The following are installed (file names are all relative to the
342  the C++ wrapper was built), and the man pages to appropriate live directories  <prefix> that is set when "configure" is run):
343  on your system, in the normal way.  
344      Commands (bin):
345        pcretest
346        pcregrep
347        pcre-config
348    
349      Libraries (lib):
350        libpcre
351        libpcreposix
352        libpcrecpp (if C++ support is enabled)
353    
354      Configuration information (lib/pkgconfig):
355        libpcre.pc
356        libpcrecpp.pc (if C++ support is enabled)
357    
358      Header files (include):
359        pcre.h
360        pcreposix.h
361        pcre_scanner.h      )
362        pcre_stringpiece.h  ) if C++ support is enabled
363        pcrecpp.h           )
364        pcrecpparg.h        )
365    
366      Man pages (share/man/man{1,3}):
367        pcregrep.1
368        pcretest.1
369        pcre.3
370        pcre*.3 (lots more pages, all starting "pcre")
371    
372      HTML documentation (share/doc/pcre/html):
373        index.html
374        *.html (lots more pages, hyperlinked from index.html)
375    
376      Text file documentation (share/doc/pcre):
377        AUTHORS
378        COPYING
379        ChangeLog
380        LICENCE
381        NEWS
382        README
383        pcre.txt       (a concatenation of the man(3) pages)
384        pcretest.txt   the pcretest man page
385        pcregrep.txt   the pcregrep man page
386    
387  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".
388  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 222  remove any directories, because these ar Line 392  remove any directories, because these ar
392  Retrieving configuration information on Unix-like systems  Retrieving configuration information on Unix-like systems
393  ---------------------------------------------------------  ---------------------------------------------------------
394    
395  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
396  to recall information about the PCRE configuration and installation. For  recall information about the PCRE configuration and installation. For example:
 example:  
397    
398    pcre-config --version    pcre-config --version
399    
# Line 243  single command is used. For example: Line 412  single command is used. For example:
412    pkg-config --cflags pcre    pkg-config --cflags pcre
413    
414  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
415  pkgconfig.  <prefix>/lib/pkgconfig.
416    
417    
418  Shared libraries on Unix-like systems  Shared libraries on Unix-like systems
# Line 260  built. The programs pcretest and pcregre Line 429  built. The programs pcretest and pcregre
429  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
430  you use "make install" to install shared libraries, pcregrep and pcretest are  you use "make install" to install shared libraries, pcregrep and pcretest are
431  automatically re-built to use the newly installed shared libraries before being  automatically re-built to use the newly installed shared libraries before being
432  installed themselves. However, the versions left in the source directory still  installed themselves. However, the versions left in the build directory still
433  use the uninstalled libraries.  use the uninstalled libraries.
434    
435  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 272  Then run "make" in the usual way. Simila Line 441  Then run "make" in the usual way. Simila
441  build only shared libraries.  build only shared libraries.
442    
443    
444  Cross-compiling on a Unix-like system  Cross-compiling on Unix-like systems
445  -------------------------------------  ------------------------------------
446    
447  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
448  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
449  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
450  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
451  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,
452  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
453  there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)  compiler.
454  when calling the "configure" command. If they are not specified, they default  
455  to the values of CC and CFLAGS.  When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
456    by making a copy of pcre_chartables.c.dist, which is a default set of tables
457    that assumes ASCII code. Cross-compiling with the default tables should not be
458    a problem.
459    
460    If you need to modify the character tables when cross-compiling, you should
461    move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
462    run it on the local host to make a new version of pcre_chartables.c.dist.
463    Then when you cross-compile PCRE this new version of the tables will be used.
464    
465    
466  Using HP's ANSI C++ compiler (aCC)  Using HP's ANSI C++ compiler (aCC)
467  ----------------------------------  ----------------------------------
468    
469  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
470  "configure" script, you *must* include the "-AA" option in the CXXFLAGS  "configure" script, you must include the "-AA" option in the CXXFLAGS
471  environment variable in order for the C++ components to compile correctly.  environment variable in order for the C++ components to compile correctly.
472    
473  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 302  running the "configure" script: Line 479  running the "configure" script:
479    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
480    
481    
482  Building on non-Unix systems  Using Sun's compilers for Solaris
483  ----------------------------  ---------------------------------
484    
485    A user reports that the following configurations work on Solaris 9 sparcv9 and
486    Solaris 9 x86 (32-bit):
487    
488      Solaris 9 sparcv9: ./configure --disable-cpp CC=/bin/cc CFLAGS="-m64 -g"
489      Solaris 9 x86:     ./configure --disable-cpp CC=/bin/cc CFLAGS="-g"
490    
491    
492    Using PCRE from MySQL
493    ---------------------
494    
495    On systems where both PCRE and MySQL are installed, it is possible to make use
496    of PCRE from within MySQL, as an alternative to the built-in pattern matching.
497    There is a web page that tells you how to do this:
498    
499      http://www.mysqludf.org/lib_mysqludf_preg/index.php
500    
501    
502    Making new tarballs
503    -------------------
504    
505  For a non-Unix system, read the comments in the file NON-UNIX-USE, though if  The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
506  the system supports the use of "configure" and "make" you may be able to build  zip formats. The command "make distcheck" does the same, but then does a trial
507  PCRE in the same way as for Unix systems.  build of the new distribution to ensure that it works.
508    
509  PCRE has been compiled on Windows systems and on Macintoshes, but I don't know  If you have modified any of the man page sources in the doc directory, you
510  the details because I don't use those systems. It should be straightforward to  should first run the PrepareRelease script before making a distribution. This
511  build PCRE on any system that has a Standard C compiler and library, because it  script creates the .txt and HTML forms of the documentation from the man pages.
 uses only Standard C functions.  
512    
513    
514  Testing PCRE  Testing PCRE
515  ------------  ------------
516    
517  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
518  configuring process. There is also a script called RunGrepTest that tests the  created by the configuring process. There is also a script called RunGrepTest
519  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
520  test programs called pcrecpp_unittest, pcre_scanner_unittest, and  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
521  pcre_stringpiece_unittest are provided.  pcre_stringpiece_unittest are also built.
522    
523  Both the scripts and all the program tests are run if you obey "make runtest",  Both the scripts and all the program tests are run if you obey "make check" or
524  "make check", or "make test". For other systems, see the instructions in  "make test". For other systems, see the instructions in NON-UNIX-USE.
 NON-UNIX-USE.  
525    
526  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
527  own man page) on each of the testinput files (in the testdata directory) in  own man page) on each of the testinput files in the testdata directory in
528  turn, and compares the output with the contents of the corresponding testoutput  turn, and compares the output with the contents of the corresponding testoutput
529  files. A file called testtry is used to hold the main output from pcretest  files. A file called testtry is used to hold the main output from pcretest
530  (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
# Line 337  the test files, give its number as an ar Line 532  the test files, give its number as an ar
532    
533    RunTest 2    RunTest 2
534    
535  The first test file can also be fed directly into the perltest script to check  The first test file can also be fed directly into the perltest.pl script to
536  that Perl gives the same results. The only difference you should see is in the  check that Perl gives the same results. The only difference you should see is
537  first few lines, where the Perl version is given instead of the PCRE version.  in the first few lines, where the Perl version is given instead of the PCRE
538    version.
539    
540  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
541  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
542  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
543  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
544  pcre_compile().  pcre_compile().
545    
546  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 370  is output to say why. If running this te Line 566  is output to say why. If running this te
566  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,
567  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.
568    
569    [If you are trying to run this test on Windows, you may be able to get it to
570    work by changing "fr_FR" to "french" everywhere it occurs. Alternatively, use
571    RunTest.bat. The version of RunTest.bat included with PCRE 7.4 and above uses
572    Windows versions of test 2. More info on using RunTest.bat is included in the
573    document entitled NON-UNIX-USE.]
574    
575  The fourth test checks the UTF-8 support. It is not run automatically unless  The fourth test checks the UTF-8 support. It is not run automatically unless
576  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when
577  running "configure". This file can be also fed directly to the perltest script,  running "configure". This file can be also fed directly to the perltest.pl
578  provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,  script, provided you are running Perl 5.8 or higher.
 commented in the script, can be be used.)  
579    
580  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
581  features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
582    
583  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
584  not run automatically unless PCRE is built with Unicode property support. To to  character properties. It it not run automatically unless PCRE is built with
585  this you must set --enable-unicode-properties when running "configure".  Unicode property support. To to this you must set --enable-unicode-properties
586    when running "configure".
587    
588  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative
589  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
590  property support, respectively. The eighth and ninth tests are not run  property support, respectively. The eighth and ninth tests are not run
591  automatically unless PCRE is build with the relevant support.  automatically unless PCRE is build with the relevant support.
592    
593    The tenth test checks some internal offsets and code size features; it is run
594    only when the default "link size" of 2 is set (in other cases the sizes
595    change).
596    
597    The eleventh test checks out features that are new in Perl 5.10, and the
598    twelfth test checks a number internals and non-Perl features concerned with
599    Unicode property support. It it not run automatically unless PCRE is built with
600    Unicode property support. To to this you must set --enable-unicode-properties
601    when running "configure".
602    
603    
604  Character tables  Character tables
605  ----------------  ----------------
606    
607  PCRE uses four tables for manipulating and identifying characters whose values  For speed, PCRE uses four tables for manipulating and identifying characters
608  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
609  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
610  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
611  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
612  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.
613    
614  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
615  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
616  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
617  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
618  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
619  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
620  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
621  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
622  re-generated.  the default tables by editing pcre_chartables.c and then re-building PCRE. If
623    you do this, you should take care to ensure that the file does not get
624    automatically re-generated. The best way to do this is to move
625    pcre_chartables.c.dist out of the way and replace it with your customized
626    tables.
627    
628    When the dftables program is run as a result of --enable-rebuild-chartables,
629    it uses the default C locale that is set on your system. It does not pay
630    attention to the LC_xxx environment variables. In other words, it uses the
631    system's default locale rather than whatever the compiling user happens to have
632    set. If you really do want to build a source set of character tables in a
633    locale that is specified by the LC_xxx variables, you can run the dftables
634    program by hand with the -L option. For example:
635    
636      ./dftables -L pcre_chartables.c.special
637    
638  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,
639  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
640  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
641  building 32-byte bit maps that represent character classes.  building 32-byte bit maps that represent character classes for code points less
642    than 256.
643    
644  The final 256-byte table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
645  follows:  follows:
# Line 428  You should not alter the set of characte Line 655  You should not alter the set of characte
655  will cause PCRE to malfunction.  will cause PCRE to malfunction.
656    
657    
658  Manifest  File manifest
659  --------  -------------
660    
661  The distribution should contain the following files:  The distribution should contain the following files:
662    
663  (A) The actual source files of the PCRE library functions and their  (A) Source files of the PCRE library functions and their headers:
     headers:  
664    
665    dftables.c            auxiliary program for building chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
666                                when --enable-rebuild-chartables is specified
667    
668    pcreposix.c           )    pcre_chartables.c.dist  a default set of character tables that assume ASCII
669    pcre_compile.c        )                              coding; used, unless --enable-rebuild-chartables is
670    pcre_config.c         )                              specified, by copying to pcre_chartables.c
671    pcre_dfa_exec.c       )  
672    pcre_exec.c           )    pcreposix.c             )
673    pcre_fullinfo.c       )    pcre_compile.c          )
674    pcre_get.c            ) sources for the functions in the library,    pcre_config.c           )
675    pcre_globals.c        )   and some internal functions that they use    pcre_dfa_exec.c         )
676    pcre_info.c           )    pcre_exec.c             )
677    pcre_maketables.c     )    pcre_fullinfo.c         )
678    pcre_newline.c        )    pcre_get.c              ) sources for the functions in the library,
679    pcre_ord2utf8.c       )    pcre_globals.c          )   and some internal functions that they use
680    pcre_refcount.c       )    pcre_info.c             )
681    pcre_study.c          )    pcre_maketables.c       )
682    pcre_tables.c         )    pcre_newline.c          )
683    pcre_try_flipped.c    )    pcre_ord2utf8.c         )
684    pcre_ucp_searchfuncs.c)    pcre_refcount.c         )
685    pcre_valid_utf8.c     )    pcre_study.c            )
686    pcre_version.c        )    pcre_tables.c           )
687    pcre_xclass.c         )    pcre_try_flipped.c      )
688      pcre_ucd.c              )
689    pcre_printint.src     ) debugging function that is #included in pcretest, and    pcre_valid_utf8.c       )
690                          )   can also be #included in pcre_compile()    pcre_version.c          )
691      pcre_xclass.c           )
692    pcre.h                the public PCRE header file    pcre_printint.src       ) debugging function that is #included in pcretest,
693    pcreposix.h           header for the external POSIX wrapper API                            )   and can also be #included in pcre_compile()
694    pcre_internal.h       header for internal use    pcre.h.in               template for pcre.h when built by "configure"
695    ucp.h                 ) headers concerned with    pcreposix.h             header for the external POSIX wrapper API
696    ucpinternal.h         )   Unicode property handling    pcre_internal.h         header for internal use
697    ucptable.h            ) (this one is the data table)    ucp.h                   header for Unicode property handling
698    config.in             template for config.h, which is built by configure  
699      config.h.in             template for config.h, which is built by "configure"
700    pcrecpp.h             the header file for the C++ wrapper  
701    pcrecpparg.h.in       "source" for another C++ header file    pcrecpp.h               public header file for the C++ wrapper
702    pcrecpp.cc            )    pcrecpparg.h.in         template for another C++ header file
703    pcre_scanner.cc       ) source for the C++ wrapper library    pcre_scanner.h          public header file for C++ scanner functions
704      pcrecpp.cc              )
705    pcre_stringpiece.h.in "source" for pcre_stringpiece.h, the header for the    pcre_scanner.cc         ) source for the C++ wrapper library
706                            C++ stringpiece functions  
707    pcre_stringpiece.cc   source for the C++ stringpiece functions    pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
708                                C++ stringpiece functions
709  (B) Auxiliary files:    pcre_stringpiece.cc     source for the C++ stringpiece functions
710    
711    AUTHORS               information about the author of PCRE  (B) Source files for programs that use PCRE:
712    ChangeLog             log of changes to the code  
713    INSTALL               generic installation instructions    pcredemo.c              simple demonstration of coding calls to PCRE
714    LICENCE               conditions for the use of PCRE    pcregrep.c              source of a grep utility that uses PCRE
715    COPYING               the same, using GNU's standard name    pcretest.c              comprehensive test program
716    Makefile.in           template for Unix Makefile, which is built by configure  
717    NEWS                  important changes in this release  (C) Auxiliary files:
718    NON-UNIX-USE          notes on building PCRE on non-Unix systems  
719    README                this file    132html                 script to turn "man" pages into HTML
720    RunTest.in            template for a Unix shell script for running tests    AUTHORS                 information about the author of PCRE
721    RunGrepTest.in        template for a Unix shell script for pcregrep tests    ChangeLog               log of changes to the code
722    config.guess          ) files used by libtool,    CleanTxt                script to clean nroff output for txt man pages
723    config.sub            )   used only when building a shared library    Detrail                 script to remove trailing spaces
724    config.h.in           "source" for the config.h header file    HACKING                 some notes about the internals of PCRE
725    configure             a configuring shell script (built by autoconf)    INSTALL                 generic installation instructions
726    configure.ac          the autoconf input used to build configure    LICENCE                 conditions for the use of PCRE
727    doc/Tech.Notes        notes on the encoding    COPYING                 the same, using GNU's standard name
728    doc/*.3               man page sources for the PCRE functions    Makefile.in             ) template for Unix Makefile, which is built by
729    doc/*.1               man page sources for pcregrep and pcretest                            )   "configure"
730    doc/html/*            HTML documentation    Makefile.am             ) the automake input that was used to create
731    doc/pcre.txt          plain text version of the man pages                            )   Makefile.in
732    doc/pcretest.txt      plain text documentation of test program    NEWS                    important changes in this release
733    doc/perltest.txt      plain text documentation of Perl test program    NON-UNIX-USE            notes on building PCRE on non-Unix systems
734    install-sh            a shell script for installing files    PrepareRelease          script to make preparations for "make dist"
735    libpcre.pc.in         "source" for libpcre.pc for pkg-config    README                  this file
736    ltmain.sh             file used to build a libtool script    RunTest                 a Unix shell script for running tests
737    mkinstalldirs         script for making install directories    RunGrepTest             a Unix shell script for pcregrep tests
738    pcretest.c            comprehensive test program    aclocal.m4              m4 macros (generated by "aclocal")
739    pcredemo.c            simple demonstration of coding calls to PCRE    config.guess            ) files used by libtool,
740    perltest.pl           Perl test program    config.sub              )   used only when building a shared library
741    pcregrep.c            source of a grep utility that uses PCRE    configure               a configuring shell script (built by autoconf)
742    pcre-config.in        source of script which retains PCRE information    configure.ac            ) the autoconf input that was used to build
743    pcrecpp_unittest.c           )                            )   "configure" and config.h
744    pcre_scanner_unittest.c      ) test programs for the C++ wrapper    depcomp                 ) script to find program dependencies, generated by
745    pcre_stringpiece_unittest.c  )                            )   automake
746    testdata/testinput*   test data for main library tests    doc/*.3                 man page sources for PCRE
747    testdata/testoutput*  expected test results    doc/*.1                 man page sources for pcregrep and pcretest
748    testdata/grep*        input and output for pcregrep tests    doc/index.html.src      the base HTML page
749      doc/html/*              HTML documentation
750      doc/pcre.txt            plain text version of the man pages
751      doc/pcretest.txt        plain text documentation of test program
752      doc/perltest.txt        plain text documentation of Perl test program
753      install-sh              a shell script for installing files
754      libpcre.pc.in           template for libpcre.pc for pkg-config
755      libpcreposix.pc.in      template for libpcreposix.pc for pkg-config
756      libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
757      ltmain.sh               file used to build a libtool script
758      missing                 ) common stub for a few missing GNU programs while
759                              )   installing, generated by automake
760      mkinstalldirs           script for making install directories
761      perltest.pl             Perl test program
762      pcre-config.in          source of script which retains PCRE information
763      pcrecpp_unittest.cc          )
764      pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
765      pcre_stringpiece_unittest.cc )
766      testdata/testinput*     test data for main library tests
767      testdata/testoutput*    expected test results
768      testdata/grep*          input and output for pcregrep tests
769    
770    (D) Auxiliary files for cmake support
771    
772      cmake/COPYING-CMAKE-SCRIPTS
773      cmake/FindPackageHandleStandardArgs.cmake
774      cmake/FindReadline.cmake
775      CMakeLists.txt
776      config-cmake.h.in
777    
778  (C) Auxiliary files for Win32 DLL  (E) Auxiliary files for VPASCAL
779    
780    libpcre.def    makevp.bat
781    libpcreposix.def    makevp_c.txt
782      makevp_l.txt
783      pcregexp.pas
784    
785  (D) Auxiliary file for VPASCAL  (F) Auxiliary files for building PCRE "by hand"
786    
787    makevp.bat    pcre.h.generic          ) a version of the public PCRE header file
788                              )   for use in non-"configure" environments
789      config.h.generic        ) a version of config.h for use in non-"configure"
790                              )   environments
791    
792    (F) Miscellaneous
793    
794      RunTest.bat            a script for running tests under Windows
795    
796  Philip Hazel  Philip Hazel
797  Email local part: ph10  Email local part: ph10
798  Email domain: cam.ac.uk  Email domain: cam.ac.uk
799  March 2007  Last updated: 19 January 2010

Legend:
Removed from v.99  
changed lines
  Added in v.489

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12