/[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 391 by ph10, Tue Mar 17 21:16:01 2009 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      Making new tarballs
28      Testing PCRE
29      Character tables
30      File manifest
31    
32    
33  The PCRE APIs  The PCRE APIs
34  -------------  -------------
35    
36  PCRE is written in C, and it has its own API. The distribution now includes a  PCRE is written in C, and it has its own API. The distribution also includes a
37  set of C++ wrapper functions, courtesy of Google Inc. (see the pcrecpp man page  set of C++ wrapper functions (see the pcrecpp man page for details), courtesy
38  for details).  of Google Inc.
39    
40  Also included 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
41  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
42  provides a POSIX calling interface to PCRE: the regular expressions themselves  library called libpcreposix. Note that this just provides a POSIX calling
43  still follow Perl syntax and semantics. The header file for the POSIX-style  interface to PCRE; the regular expressions themselves still follow Perl syntax
44  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
45  didn't want to risk possible problems with existing files of that name by  all of PCRE's facilities.
46  distributing it that way. To use it with an existing program that uses the  
47  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
48    official POSIX name is regex.h, but I did not want to risk possible problems
49    with existing files of that name by distributing it that way. To use PCRE with
50    an existing program that uses the POSIX API, pcreposix.h will have to be
51    renamed or pointed at by a link.
52    
53  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
54  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
55    file (as mentioned above), you must also take care when linking programs to
56  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
57  up the "real" POSIX functions of the same name.  up the POSIX functions of the same name from the other library.
58    
59    One way of avoiding this confusion is to compile PCRE with the addition of
60    -Dregcomp=PCREregcomp (and similarly for the other POSIX functions) to the
61    compiler flags (CFLAGS if you are using "configure" -- see below). This has the
62    effect of renaming the functions so that the names no longer clash. Of course,
63    you have to do the same thing for your applications, or write them using the
64    new names.
65    
66    
67  Documentation for PCRE  Documentation for PCRE
68  ----------------------  ----------------------
69    
70  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
71  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
72  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
73  supplied in two other forms; however, as there is no standard place to install  documentation is supplied in two other forms:
74  them, they are left in the doc directory of the unpacked source distribution.  
75  These forms are:    1. There are files called doc/pcre.txt, doc/pcregrep.txt, and
76         doc/pcretest.txt in the source distribution. The first of these is a
77    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
78       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
79       man pages except those that summarize individual functions. The other two       forms of the section 1 man pages for the pcregrep and pcretest commands.
80       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
81       pcretest commands. Text forms are provided for ease of scanning with text       similar tools. They are installed in <prefix>/share/doc/pcre, where
82       editors or similar tools.       <prefix> is the installation prefix (defaulting to /usr/local).
83    
84    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
85       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
86       doc/index.html.       doc/html and installed in <prefix>/share/doc/pcre/html.
87    
88    
89  Contributions by users of PCRE  Contributions by users of PCRE
# Line 59  You can find contributions from PCRE use Line 93  You can find contributions from PCRE use
93    
94    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
95    
96  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
97  Several of them provide support for compiling PCRE on various flavours of  complete in themselves; others are pointers to URLs containing relevant files.
98  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
99  others are pointers to URLs containing relevant files.  contributions provided support for compiling PCRE on various flavours of
100    Windows (I myself do not use Windows). Nowadays there is more Windows support
101    in the standard distribution, so these contibutions have been archived.
102    
103    
104    Building PCRE on non-Unix systems
105    ---------------------------------
106    
107  Building PCRE on a Unix-like system  For a non-Unix system, please read the comments in the file NON-UNIX-USE,
108  -----------------------------------  though if your system supports the use of "configure" and "make" you may be
109    able to build PCRE in the same way as for Unix-like systems. PCRE can also be
110    configured in many platform environments using the GUI facility of CMake's
111    CMakeSetup. It creates Makefiles, solution files, etc.
112    
113    PCRE has been compiled on many different operating systems. It should be
114    straightforward to build PCRE on any system that has a Standard C compiler and
115    library, because it uses only Standard C functions.
116    
117    
118    Building PCRE on Unix-like systems
119    ----------------------------------
120    
121  If you are using HP's ANSI C++ compiler (aCC), please see the special note  If you are using HP's ANSI C++ compiler (aCC), please see the special note
122  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
123    
124    The following instructions assume the use of the widely used "configure, make,
125    make install" process. There is also support for CMake in the PCRE
126    distribution; there are some comments about using CMake in the NON-UNIX-USE
127    file, though it can also be used in Unix-like systems.
128    
129  To build PCRE on a Unix-like system, first run the "configure" command from the  To build PCRE on a Unix-like system, first run the "configure" command from the
130  PCRE distribution directory, with your current directory set to the directory  PCRE distribution directory, with your current directory set to the directory
131  where you want the files to be created. This command is a standard GNU  where you want the files to be created. This command is a standard GNU
132  "autoconf" configuration script, for which generic instructions are supplied in  "autoconf" configuration script, for which generic instructions are supplied in
133  INSTALL.  the file INSTALL.
134    
135  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
136  this case, on many systems, just running "./configure" is sufficient, but the  this case, on many systems, just running "./configure" is sufficient. However,
137  usual methods of changing standard defaults are available. For example:  the usual methods of changing standard defaults are available. For example:
138    
139  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local  CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
140    
# Line 103  library. You can read more about them in Line 158  library. You can read more about them in
158    
159  . If you want to suppress the building of the C++ wrapper library, you can add  . If you want to suppress the building of the C++ wrapper library, you can add
160    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
161    will try to find a C++ compiler and C++ header files, and if it succeeds, it    it will try to find a C++ compiler and C++ header files, and if it succeeds,
162    will try to build the C++ wrapper.    it will try to build the C++ wrapper.
163    
164  . If you want to make use of the support for UTF-8 character strings in PCRE,  . If you want to make use of the support for UTF-8 Unicode character strings in
165    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
166    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,
167    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
168      with this option, its input can only either be ASCII or UTF-8, even when
169      running on EBCDIC platforms. It is not possible to use both --enable-utf8 and
170      --enable-ebcdic at the same time.
171    
172  . 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
173    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 177  library. You can read more about them in
177    supported.    supported.
178    
179  . 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
180    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
181    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
182    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
183    (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
184    --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
185    to the "configure" command, respectively.    or --enable-newline-is-crlf or --enable-newline-is-anycrlf or
186      --enable-newline-is-any to the "configure" command, respectively.
187    If you specify --newline-is-cr or --newline-is-crlf, some of the standard  
188    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
189    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
190    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
191    some failures.    to be some failures. With --enable-newline-is-anycrlf or
192      --enable-newline-is-any, many tests should succeed, but there may be some
193      failures.
194    
195    . By default, the sequence \R in a pattern matches any Unicode line ending
196      sequence. This is independent of the option specifying what PCRE considers to
197      be the end of a line (see above). However, the caller of PCRE can restrict \R
198      to match only CR, LF, or CRLF. You can make this the default by adding
199      --enable-bsr-anycrlf to the "configure" command (bsr = "backslash R").
200    
201  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
202    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
203    them. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
204    
205    --with-posix-malloc-threshold=20    --with-posix-malloc-threshold=20
206    
# Line 147  library. You can read more about them in Line 213  library. You can read more about them in
213    --with-match-limit=500000    --with-match-limit=500000
214    
215    on the "configure" command. This is just the default; individual calls to    on the "configure" command. This is just the default; individual calls to
216    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
217    man page.    pcreapi man page.
218    
219  . 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
220    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 229  library. You can read more about them in
229  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
230    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
231    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
232    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
233    (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.  
234    
235  . 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
236    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
237    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
238    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
239    this, use    build PCRE like this, use
240    
241    --disable-stack-for-recursion    --disable-stack-for-recursion
242    
243    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
244    necessary in environments with limited stack sizes. This applies only to the    necessary in environments with limited stack sizes. This applies only to the
245    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
246    use deeply nested recursion.    use deeply nested recursion. There is a discussion about stack sizes in the
247      pcrestack man page.
248    
249    . For speed, PCRE uses four tables for manipulating and identifying characters
250      whose code point values are less than 256. By default, it uses a set of
251      tables for ASCII encoding that is part of the distribution. If you specify
252    
253      --enable-rebuild-chartables
254    
255      a program called dftables is compiled and run in the default C locale when
256      you obey "make". It builds a source file called pcre_chartables.c. If you do
257      not specify this option, pcre_chartables.c is created as a copy of
258      pcre_chartables.c.dist. See "Character tables" below for further information.
259    
260    . It is possible to compile PCRE for use on systems that use EBCDIC as their
261      character code (as opposed to ASCII) by specifying
262    
263      --enable-ebcdic
264    
265      This automatically implies --enable-rebuild-chartables (see above). However,
266      when PCRE is built this way, it always operates in EBCDIC. It cannot support
267      both EBCDIC and UTF-8.
268    
269    . It is possible to compile pcregrep to use libz and/or libbz2, in order to
270      read .gz and .bz2 files (respectively), by specifying one or both of
271    
272  The "configure" script builds eight files for the basic C library:    --enable-pcregrep-libz
273      --enable-pcregrep-libbz2
274    
275      Of course, the relevant libraries must be installed on your system.
276    
277    . It is possible to compile pcretest so that it links with the libreadline
278      library, by specifying
279    
280      --enable-pcretest-libreadline
281    
282      If this is done, when pcretest's input is from a terminal, it reads it using
283      the readline() function. This provides line-editing and history facilities.
284      Note that libreadline is GPL-licenced, so if you distribute a binary of
285      pcretest linked in this way, there may be licensing issues.
286    
287      Setting this option causes the -lreadline option to be added to the pcretest
288      build. In many operating environments with a sytem-installed readline
289      library this is sufficient. However, in some environments (e.g. if an
290      unmodified distribution version of readline is in use), it may be necessary
291      to specify something like LIBS="-lncurses" as well. This is because, to quote
292      the readline INSTALL, "Readline uses the termcap functions, but does not link
293      with the termcap or curses library itself, allowing applications which link
294      with readline the to choose an appropriate library." If you get error
295      messages about missing functions tgetstr, tgetent, tputs, tgetflag, or tgoto,
296      this is the problem, and linking with the ncurses library should fix it.
297    
298    The "configure" script builds the following files for the basic C library:
299    
300  . Makefile is the makefile that builds the library  . Makefile is the makefile that builds the library
301  . config.h contains build-time configuration options for the library  . config.h contains build-time configuration options for the library
302    . pcre.h is the public PCRE header file
303  . pcre-config is a script that shows the settings of "configure" options  . pcre-config is a script that shows the settings of "configure" options
304  . libpcre.pc is data for the pkg-config command  . libpcre.pc is data for the pkg-config command
305  . libtool is a script that builds shared and/or static libraries  . libtool is a script that builds shared and/or static libraries
306  . RunTest is a script for running tests on the library  . RunTest is a script for running tests on the basic C library
307  . RunGrepTest is a script for running tests on the pcregrep command  . RunGrepTest is a script for running tests on the pcregrep command
308    
309  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
310    the names config.h.generic and pcre.h.generic. These are provided for the
311    benefit of those who have to built PCRE without the benefit of "configure". If
312    you use "configure", the .generic versions are not used.
313    
314  . pcrecpp.h is the header file for programs that call PCRE via the C++ wrapper  If a C++ compiler is found, the following files are also built:
315    
316    . libpcrecpp.pc is data for the pkg-config command
317    . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper
318  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions
319    
320  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 323  contains compiler output from tests that
323    
324  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
325  libpcre and libpcreposix, a test program called pcretest, and the pcregrep  libpcre and libpcreposix, a test program called pcretest, and the pcregrep
326  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++
327  wrapper library, which is called libpcrecpp, and some test programs called  wrapper library, which is called libpcrecpp, and some test programs called
328  pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.  pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.
329    Building the C++ wrapper can be disabled by adding --disable-cpp to the
330    "configure" command.
331    
332  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
333  tests are given in a separate section of this document, below.  tests are given below in a separate section of this document.
334    
335  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
336  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
337  the C++ wrapper was built), and the man pages to appropriate live directories  <prefix> that is set when "configure" is run):
338  on your system, in the normal way.  
339      Commands (bin):
340        pcretest
341        pcregrep
342        pcre-config
343    
344      Libraries (lib):
345        libpcre
346        libpcreposix
347        libpcrecpp (if C++ support is enabled)
348    
349      Configuration information (lib/pkgconfig):
350        libpcre.pc
351        libpcrecpp.pc (if C++ support is enabled)
352    
353      Header files (include):
354        pcre.h
355        pcreposix.h
356        pcre_scanner.h      )
357        pcre_stringpiece.h  ) if C++ support is enabled
358        pcrecpp.h           )
359        pcrecpparg.h        )
360    
361      Man pages (share/man/man{1,3}):
362        pcregrep.1
363        pcretest.1
364        pcre.3
365        pcre*.3 (lots more pages, all starting "pcre")
366    
367      HTML documentation (share/doc/pcre/html):
368        index.html
369        *.html (lots more pages, hyperlinked from index.html)
370    
371      Text file documentation (share/doc/pcre):
372        AUTHORS
373        COPYING
374        ChangeLog
375        LICENCE
376        NEWS
377        README
378        pcre.txt       (a concatenation of the man(3) pages)
379        pcretest.txt   the pcretest man page
380        pcregrep.txt   the pcregrep man page
381    
382  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".
383  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 387  remove any directories, because these ar
387  Retrieving configuration information on Unix-like systems  Retrieving configuration information on Unix-like systems
388  ---------------------------------------------------------  ---------------------------------------------------------
389    
390  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
391  to recall information about the PCRE configuration and installation. For  recall information about the PCRE configuration and installation. For example:
 example:  
392    
393    pcre-config --version    pcre-config --version
394    
# Line 243  single command is used. For example: Line 407  single command is used. For example:
407    pkg-config --cflags pcre    pkg-config --cflags pcre
408    
409  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
410  pkgconfig.  <prefix>/lib/pkgconfig.
411    
412    
413  Shared libraries on Unix-like systems  Shared libraries on Unix-like systems
# Line 260  built. The programs pcretest and pcregre Line 424  built. The programs pcretest and pcregre
424  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
425  you use "make install" to install shared libraries, pcregrep and pcretest are  you use "make install" to install shared libraries, pcregrep and pcretest are
426  automatically re-built to use the newly installed shared libraries before being  automatically re-built to use the newly installed shared libraries before being
427  installed themselves. However, the versions left in the source directory still  installed themselves. However, the versions left in the build directory still
428  use the uninstalled libraries.  use the uninstalled libraries.
429    
430  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 436  Then run "make" in the usual way. Simila
436  build only shared libraries.  build only shared libraries.
437    
438    
439  Cross-compiling on a Unix-like system  Cross-compiling on Unix-like systems
440  -------------------------------------  ------------------------------------
441    
442  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
443  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
444  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
445  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
446  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,
447  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
448  there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)  compiler.
449  when calling the "configure" command. If they are not specified, they default  
450  to the values of CC and CFLAGS.  When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
451    by making a copy of pcre_chartables.c.dist, which is a default set of tables
452    that assumes ASCII code. Cross-compiling with the default tables should not be
453    a problem.
454    
455    If you need to modify the character tables when cross-compiling, you should
456    move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
457    run it on the local host to make a new version of pcre_chartables.c.dist.
458    Then when you cross-compile PCRE this new version of the tables will be used.
459    
460    
461  Using HP's ANSI C++ compiler (aCC)  Using HP's ANSI C++ compiler (aCC)
462  ----------------------------------  ----------------------------------
463    
464  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
465  "configure" script, you *must* include the "-AA" option in the CXXFLAGS  "configure" script, you must include the "-AA" option in the CXXFLAGS
466  environment variable in order for the C++ components to compile correctly.  environment variable in order for the C++ components to compile correctly.
467    
468  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 474  running the "configure" script:
474    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
475    
476    
477  Building on non-Unix systems  Making new tarballs
478  ----------------------------  -------------------
479    
480  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
481  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
482  PCRE in the same way as for Unix systems.  build of the new distribution to ensure that it works.
483    
484  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
485  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
486  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.  
487    
488    
489  Testing PCRE  Testing PCRE
490  ------------  ------------
491    
492  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
493  configuring process. There is also a script called RunGrepTest that tests the  created by the configuring process. There is also a script called RunGrepTest
494  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
495  test programs called pcrecpp_unittest, pcre_scanner_unittest, and  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
496  pcre_stringpiece_unittest are provided.  pcre_stringpiece_unittest are also built.
497    
498  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
499  "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.  
500    
501  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
502  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
503  turn, and compares the output with the contents of the corresponding testoutput  turn, and compares the output with the contents of the corresponding testoutput
504  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
505  (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 507  the test files, give its number as an ar
507    
508    RunTest 2    RunTest 2
509    
510  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
511  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
512  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
513    version.
514    
515  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
516  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
517  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
518  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
519  pcre_compile().  pcre_compile().
520    
521  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 541  is output to say why. If running this te
541  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,
542  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.
543    
544    [If you are trying to run this test on Windows, you may be able to get it to
545    work by changing "fr_FR" to "french" everywhere it occurs. Alternatively, use
546    RunTest.bat. The version of RunTest.bat included with PCRE 7.4 and above uses
547    Windows versions of test 2. More info on using RunTest.bat is included in the
548    document entitled NON-UNIX-USE.]
549    
550  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
551  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
552  running "configure". This file can be also fed directly to the perltest script,  running "configure". This file can be also fed directly to the perltest script,
# Line 379  commented in the script, can be be used. Line 556  commented in the script, can be be used.
556  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
557  features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
558    
559  The sixth and test checks the support for Unicode character properties. It it  The sixth test checks the support for Unicode character properties. It it not
560  not run automatically unless PCRE is built with Unicode property support. To to  run automatically unless PCRE is built with Unicode property support. To to
561  this you must set --enable-unicode-properties when running "configure".  this you must set --enable-unicode-properties when running "configure".
562    
563  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative  The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative
# Line 392  automatically unless PCRE is build with Line 569  automatically unless PCRE is build with
569  Character tables  Character tables
570  ----------------  ----------------
571    
572  PCRE uses four tables for manipulating and identifying characters whose values  For speed, PCRE uses four tables for manipulating and identifying characters
573  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
574  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
575  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
576  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
577  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.
578    
579  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
580  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
581  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
582  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
583  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
584  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
585  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
586  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
587  re-generated.  the default tables by editing pcre_chartables.c and then re-building PCRE. If
588    you do this, you should take care to ensure that the file does not get
589    automatically re-generated. The best way to do this is to move
590    pcre_chartables.c.dist out of the way and replace it with your customized
591    tables.
592    
593    When the dftables program is run as a result of --enable-rebuild-chartables,
594    it uses the default C locale that is set on your system. It does not pay
595    attention to the LC_xxx environment variables. In other words, it uses the
596    system's default locale rather than whatever the compiling user happens to have
597    set. If you really do want to build a source set of character tables in a
598    locale that is specified by the LC_xxx variables, you can run the dftables
599    program by hand with the -L option. For example:
600    
601      ./dftables -L pcre_chartables.c.special
602    
603  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,
604  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
605  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
606  building 32-byte bit maps that represent character classes.  building 32-byte bit maps that represent character classes for code points less
607    than 256.
608    
609  The final 256-byte table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
610  follows:  follows:
# Line 428  You should not alter the set of characte Line 620  You should not alter the set of characte
620  will cause PCRE to malfunction.  will cause PCRE to malfunction.
621    
622    
623  Manifest  File manifest
624  --------  -------------
625    
626  The distribution should contain the following files:  The distribution should contain the following files:
627    
628  (A) The actual source files of the PCRE library functions and their  (A) Source files of the PCRE library functions and their headers:
     headers:  
629    
630    dftables.c            auxiliary program for building chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
631                                when --enable-rebuild-chartables is specified
632    
633    pcreposix.c           )    pcre_chartables.c.dist  a default set of character tables that assume ASCII
634    pcre_compile.c        )                              coding; used, unless --enable-rebuild-chartables is
635    pcre_config.c         )                              specified, by copying to pcre_chartables.c
636    pcre_dfa_exec.c       )  
637    pcre_exec.c           )    pcreposix.c             )
638    pcre_fullinfo.c       )    pcre_compile.c          )
639    pcre_get.c            ) sources for the functions in the library,    pcre_config.c           )
640    pcre_globals.c        )   and some internal functions that they use    pcre_dfa_exec.c         )
641    pcre_info.c           )    pcre_exec.c             )
642    pcre_maketables.c     )    pcre_fullinfo.c         )
643    pcre_newline.c        )    pcre_get.c              ) sources for the functions in the library,
644    pcre_ord2utf8.c       )    pcre_globals.c          )   and some internal functions that they use
645    pcre_refcount.c       )    pcre_info.c             )
646    pcre_study.c          )    pcre_maketables.c       )
647    pcre_tables.c         )    pcre_newline.c          )
648    pcre_try_flipped.c    )    pcre_ord2utf8.c         )
649    pcre_ucp_searchfuncs.c)    pcre_refcount.c         )
650    pcre_valid_utf8.c     )    pcre_study.c            )
651    pcre_version.c        )    pcre_tables.c           )
652    pcre_xclass.c         )    pcre_try_flipped.c      )
653      pcre_ucd.c              )
654    pcre_printint.src     ) debugging function that is #included in pcretest, and    pcre_valid_utf8.c       )
655                          )   can also be #included in pcre_compile()    pcre_version.c          )
656      pcre_xclass.c           )
657    pcre.h                the public PCRE header file    pcre_printint.src       ) debugging function that is #included in pcretest,
658    pcreposix.h           header for the external POSIX wrapper API                            )   and can also be #included in pcre_compile()
659    pcre_internal.h       header for internal use    pcre.h.in               template for pcre.h when built by "configure"
660    ucp.h                 ) headers concerned with    pcreposix.h             header for the external POSIX wrapper API
661    ucpinternal.h         )   Unicode property handling    pcre_internal.h         header for internal use
662    ucptable.h            ) (this one is the data table)    ucp.h                   header for Unicode property handling
663    config.in             template for config.h, which is built by configure  
664      config.h.in             template for config.h, which is built by "configure"
665    pcrecpp.h             the header file for the C++ wrapper  
666    pcrecpparg.h.in       "source" for another C++ header file    pcrecpp.h               public header file for the C++ wrapper
667    pcrecpp.cc            )    pcrecpparg.h.in         template for another C++ header file
668    pcre_scanner.cc       ) source for the C++ wrapper library    pcre_scanner.h          public header file for C++ scanner functions
669      pcrecpp.cc              )
670    pcre_stringpiece.h.in "source" for pcre_stringpiece.h, the header for the    pcre_scanner.cc         ) source for the C++ wrapper library
671                            C++ stringpiece functions  
672    pcre_stringpiece.cc   source for the C++ stringpiece functions    pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
673                                C++ stringpiece functions
674  (B) Auxiliary files:    pcre_stringpiece.cc     source for the C++ stringpiece functions
675    
676    AUTHORS               information about the author of PCRE  (B) Source files for programs that use PCRE:
677    ChangeLog             log of changes to the code  
678    INSTALL               generic installation instructions    pcredemo.c              simple demonstration of coding calls to PCRE
679    LICENCE               conditions for the use of PCRE    pcregrep.c              source of a grep utility that uses PCRE
680    COPYING               the same, using GNU's standard name    pcretest.c              comprehensive test program
681    Makefile.in           template for Unix Makefile, which is built by configure  
682    NEWS                  important changes in this release  (C) Auxiliary files:
683    NON-UNIX-USE          notes on building PCRE on non-Unix systems  
684    README                this file    132html                 script to turn "man" pages into HTML
685    RunTest.in            template for a Unix shell script for running tests    AUTHORS                 information about the author of PCRE
686    RunGrepTest.in        template for a Unix shell script for pcregrep tests    ChangeLog               log of changes to the code
687    config.guess          ) files used by libtool,    CleanTxt                script to clean nroff output for txt man pages
688    config.sub            )   used only when building a shared library    Detrail                 script to remove trailing spaces
689    config.h.in           "source" for the config.h header file    HACKING                 some notes about the internals of PCRE
690    configure             a configuring shell script (built by autoconf)    INSTALL                 generic installation instructions
691    configure.ac          the autoconf input used to build configure    LICENCE                 conditions for the use of PCRE
692    doc/Tech.Notes        notes on the encoding    COPYING                 the same, using GNU's standard name
693    doc/*.3               man page sources for the PCRE functions    Makefile.in             ) template for Unix Makefile, which is built by
694    doc/*.1               man page sources for pcregrep and pcretest                            )   "configure"
695    doc/html/*            HTML documentation    Makefile.am             ) the automake input that was used to create
696    doc/pcre.txt          plain text version of the man pages                            )   Makefile.in
697    doc/pcretest.txt      plain text documentation of test program    NEWS                    important changes in this release
698    doc/perltest.txt      plain text documentation of Perl test program    NON-UNIX-USE            notes on building PCRE on non-Unix systems
699    install-sh            a shell script for installing files    PrepareRelease          script to make preparations for "make dist"
700    libpcre.pc.in         "source" for libpcre.pc for pkg-config    README                  this file
701    ltmain.sh             file used to build a libtool script    RunTest                 a Unix shell script for running tests
702    mkinstalldirs         script for making install directories    RunGrepTest             a Unix shell script for pcregrep tests
703    pcretest.c            comprehensive test program    aclocal.m4              m4 macros (generated by "aclocal")
704    pcredemo.c            simple demonstration of coding calls to PCRE    config.guess            ) files used by libtool,
705    perltest.pl           Perl test program    config.sub              )   used only when building a shared library
706    pcregrep.c            source of a grep utility that uses PCRE    configure               a configuring shell script (built by autoconf)
707    pcre-config.in        source of script which retains PCRE information    configure.ac            ) the autoconf input that was used to build
708    pcrecpp_unittest.c           )                            )   "configure" and config.h
709    pcre_scanner_unittest.c      ) test programs for the C++ wrapper    depcomp                 ) script to find program dependencies, generated by
710    pcre_stringpiece_unittest.c  )                            )   automake
711    testdata/testinput*   test data for main library tests    doc/*.3                 man page sources for the PCRE functions
712    testdata/testoutput*  expected test results    doc/*.1                 man page sources for pcregrep and pcretest
713    testdata/grep*        input and output for pcregrep tests    doc/index.html.src      the base HTML page
714      doc/html/*              HTML documentation
715      doc/pcre.txt            plain text version of the man pages
716      doc/pcretest.txt        plain text documentation of test program
717      doc/perltest.txt        plain text documentation of Perl test program
718      install-sh              a shell script for installing files
719      libpcre.pc.in           template for libpcre.pc for pkg-config
720      libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
721      ltmain.sh               file used to build a libtool script
722      missing                 ) common stub for a few missing GNU programs while
723                              )   installing, generated by automake
724      mkinstalldirs           script for making install directories
725      perltest.pl             Perl test program
726      pcre-config.in          source of script which retains PCRE information
727      pcrecpp_unittest.cc          )
728      pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
729      pcre_stringpiece_unittest.cc )
730      testdata/testinput*     test data for main library tests
731      testdata/testoutput*    expected test results
732      testdata/grep*          input and output for pcregrep tests
733    
734    (D) Auxiliary files for cmake support
735    
736      cmake/COPYING-CMAKE-SCRIPTS
737      cmake/FindPackageHandleStandardArgs.cmake
738      cmake/FindReadline.cmake
739      CMakeLists.txt
740      config-cmake.h.in
741    
742  (C) Auxiliary files for Win32 DLL  (E) Auxiliary files for VPASCAL
743    
744    libpcre.def    makevp.bat
745    libpcreposix.def    makevp_c.txt
746      makevp_l.txt
747      pcregexp.pas
748    
749  (D) Auxiliary file for VPASCAL  (F) Auxiliary files for building PCRE "by hand"
750    
751    makevp.bat    pcre.h.generic          ) a version of the public PCRE header file
752                              )   for use in non-"configure" environments
753      config.h.generic        ) a version of config.h for use in non-"configure"
754                              )   environments
755    
756    (F) Miscellaneous
757    
758      RunTest.bat            a script for running tests under Windows
759    
760  Philip Hazel  Philip Hazel
761  Email local part: ph10  Email local part: ph10
762  Email domain: cam.ac.uk  Email domain: cam.ac.uk
763  March 2007  Last updated: 17 March 2009

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

  ViewVC Help
Powered by ViewVC 1.1.5