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

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

  ViewVC Help
Powered by ViewVC 1.1.5