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

Diff of /code/trunk/README

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

revision 93 by nigel, Sat Feb 24 21:41:42 2007 UTC revision 260 by ph10, Thu Sep 20 10:19:16 2007 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    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  Building PCRE on a Unix-like system  
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 some experimental support for "cmake" in
123    the PCRE distribution, but it is incomplete and not documented. However, if you
124    are a "cmake" user, you might want to try it.
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    
182      If you specify --enable-newline-is-cr or --enable-newline-is-crlf, some of
183      the standard tests will fail, because the lines in the test files end with
184      LF. Even if the files are edited to change the line endings, there are likely
185      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 141  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 157  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  The "configure" script builds eight files for the basic C library:    --enable-ebcdic
258    
259      This automatically implies --enable-rebuild-chartables (see above).
260    
261    The "configure" script builds the following files for the basic C library:
262    
263  . Makefile is the makefile that builds the library  . Makefile is the makefile that builds the library
264  . config.h contains build-time configuration options for the library  . config.h contains build-time configuration options for the library
265    . pcre.h is the public PCRE header file
266  . pcre-config is a script that shows the settings of "configure" options  . pcre-config is a script that shows the settings of "configure" options
267  . libpcre.pc is data for the pkg-config command  . libpcre.pc is data for the pkg-config command
268  . libtool is a script that builds shared and/or static libraries  . libtool is a script that builds shared and/or static libraries
269  . RunTest is a script for running tests on the library  . RunTest is a script for running tests on the basic C library
270  . RunGrepTest is a script for running tests on the pcregrep command  . RunGrepTest is a script for running tests on the pcregrep command
271    
272  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
273    the names config.h.generic and pcre.h.generic. These are provided for the
274    benefit of those who have to built PCRE without the benefit of "configure". If
275    you use "configure", the .generic versions are not used.
276    
277  . 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:
278    
279    . libpcrecpp.pc is data for the pkg-config command
280    . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper
281  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions  . pcre_stringpiece.h is the header for the C++ "stringpiece" functions
282    
283  The "configure" script also creates config.status, which is an executable  The "configure" script also creates config.status, which is an executable
# Line 195  script that can be run to recreate the c Line 285  script that can be run to recreate the c
285  contains compiler output from tests that "configure" runs.  contains compiler output from tests that "configure" runs.
286    
287  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
288  libpcre and libpcreposix, a test program called pcretest, and the pcregrep  libpcre and libpcreposix, a test program called pcretest, a demonstration
289  command. If a C++ compiler was found on your system, it also builds the C++  program called pcredemo, and the pcregrep command. If a C++ compiler was found
290  wrapper library, which is called libpcrecpp, and some test programs called  on your system, "make" also builds the C++ wrapper library, which is called
291  pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.  libpcrecpp, and some test programs called pcrecpp_unittest,
292    pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper
293  The command "make test" runs all the appropriate tests. Details of the PCRE  can be disabled by adding --disable-cpp to the "configure" command.
294  tests are given in a separate section of this document, below.  
295    The command "make check" runs all the appropriate tests. Details of the PCRE
296  You can use "make install" to copy the libraries, the public header files  tests are given below in a separate section of this document.
297  pcre.h, pcreposix.h, pcrecpp.h, and pcre_stringpiece.h (the last two only if  
298  the C++ wrapper was built), and the man pages to appropriate live directories  You can use "make install" to install PCRE into live directories on your
299  on your system, in the normal way.  system. The following are installed (file names are all relative to the
300    <prefix> that is set when "configure" is run):
301    
302      Commands (bin):
303        pcretest
304        pcregrep
305        pcre-config
306    
307      Libraries (lib):
308        libpcre
309        libpcreposix
310        libpcrecpp (if C++ support is enabled)
311    
312      Configuration information (lib/pkgconfig):
313        libpcre.pc
314        libpcrecpp.pc (if C++ support is enabled)
315    
316      Header files (include):
317        pcre.h
318        pcreposix.h
319        pcre_scanner.h      )
320        pcre_stringpiece.h  ) if C++ support is enabled
321        pcrecpp.h           )
322        pcrecpparg.h        )
323    
324      Man pages (share/man/man{1,3}):
325        pcregrep.1
326        pcretest.1
327        pcre.3
328        pcre*.3 (lots more pages, all starting "pcre")
329    
330      HTML documentation (share/doc/pcre/html):
331        index.html
332        *.html (lots more pages, hyperlinked from index.html)
333    
334      Text file documentation (share/doc/pcre):
335        AUTHORS
336        COPYING
337        ChangeLog
338        LICENCE
339        NEWS
340        README
341        pcre.txt       (a concatenation of the man(3) pages)
342        pcretest.txt   the pcretest man page
343        pcregrep.txt   the pcregrep man page
344    
345    Note that the pcredemo program that is built by "configure" is *not* installed
346    anywhere. It is a demonstration for programmers wanting to use PCRE.
347    
348  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".
349  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 216  remove any directories, because these ar Line 353  remove any directories, because these ar
353  Retrieving configuration information on Unix-like systems  Retrieving configuration information on Unix-like systems
354  ---------------------------------------------------------  ---------------------------------------------------------
355    
356  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
357  to recall information about the PCRE configuration and installation. For  recall information about the PCRE configuration and installation. For example:
 example:  
358    
359    pcre-config --version    pcre-config --version
360    
# Line 237  single command is used. For example: Line 373  single command is used. For example:
373    pkg-config --cflags pcre    pkg-config --cflags pcre
374    
375  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
376  pkgconfig.  <prefix>/lib/pkgconfig.
377    
378    
379  Shared libraries on Unix-like systems  Shared libraries on Unix-like systems
# Line 254  built. The programs pcretest and pcregre Line 390  built. The programs pcretest and pcregre
390  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
391  you use "make install" to install shared libraries, pcregrep and pcretest are  you use "make install" to install shared libraries, pcregrep and pcretest are
392  automatically re-built to use the newly installed shared libraries before being  automatically re-built to use the newly installed shared libraries before being
393  installed themselves. However, the versions left in the source directory still  installed themselves. However, the versions left in the build directory still
394  use the uninstalled libraries.  use the uninstalled libraries.
395    
396  To build PCRE using static libraries only you must use --disable-shared when  To build PCRE using static libraries only you must use --disable-shared when
# Line 266  Then run "make" in the usual way. Simila Line 402  Then run "make" in the usual way. Simila
402  build only shared libraries.  build only shared libraries.
403    
404    
405  Cross-compiling on a Unix-like system  Cross-compiling on Unix-like systems
406  -------------------------------------  ------------------------------------
407    
408  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
409  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
410  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
411  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
412  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,
413  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
414  there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)  compiler.
415  when calling the "configure" command. If they are not specified, they default  
416  to the values of CC and CFLAGS.  When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
417    by making a copy of pcre_chartables.c.dist, which is a default set of tables
418    that assumes ASCII code. Cross-compiling with the default tables should not be
419    a problem.
420    
421    If you need to modify the character tables when cross-compiling, you should
422    move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
423    run it on the local host to make a new version of pcre_chartables.c.dist.
424    Then when you cross-compile PCRE this new version of the tables will be used.
425    
426    
427  Using HP's ANSI C++ compiler (aCC)  Using HP's ANSI C++ compiler (aCC)
428  ----------------------------------  ----------------------------------
429    
430  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
431  "configure" script, you *must* include the "-AA" option in the CXXFLAGS  "configure" script, you must include the "-AA" option in the CXXFLAGS
432  environment variable in order for the C++ components to compile correctly.  environment variable in order for the C++ components to compile correctly.
433    
434  Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby  Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby
# Line 296  running the "configure" script: Line 440  running the "configure" script:
440    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
441    
442    
443  Building on non-Unix systems  Making new tarballs
444  ----------------------------  -------------------
445    
446  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
447  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
448  PCRE in the same way as for Unix systems.  build of the new distribution to ensure that it works.
449    
450  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
451  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
452  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.  
453    
454    
455  Testing PCRE  Testing PCRE
456  ------------  ------------
457    
458  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
459  configuring process. There is also a script called RunGrepTest that tests the  created by the configuring process. There is also a script called RunGrepTest
460  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
461  test programs called pcrecpp_unittest, pcre_scanner_unittest, and  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
462  pcre_stringpiece_unittest are provided.  pcre_stringpiece_unittest are also built.
463    
464  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
465  "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.  
466    
467  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
468  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
469  turn, and compares the output with the contents of the corresponding testoutput  turn, and compares the output with the contents of the corresponding testoutput
470  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
471  (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 331  the test files, give its number as an ar Line 473  the test files, give its number as an ar
473    
474    RunTest 2    RunTest 2
475    
476  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
477  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
478  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
479    version.
480    
481  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),  The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
482  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error  pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
483  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
484  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
485  pcre_compile().  pcre_compile().
486    
487  If you build PCRE with a locale setting that is not the standard C locale, the  If you build PCRE with a locale setting that is not the standard C locale, the
# Line 364  is output to say why. If running this te Line 507  is output to say why. If running this te
507  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,
508  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.
509    
510    [If you are trying to run this test on Windows, you may be able to get it to
511    work by changing "fr_FR" to "french" everywhere it occurs. Alternatively, use
512    RunTest.bat. The version of RunTest.bat included with PCRE 7.4 and above uses
513    Windows versions of test 2. More info on using RunTest.bat is included in the
514    document entitled NON-UNIX-USE.]
515    
516  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
517  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
518  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 373  commented in the script, can be be used. Line 522  commented in the script, can be be used.
522  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
523  features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
524    
525  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
526  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
527  this you must set --enable-unicode-properties when running "configure".  this you must set --enable-unicode-properties when running "configure".
528    
529  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 386  automatically unless PCRE is build with Line 535  automatically unless PCRE is build with
535  Character tables  Character tables
536  ----------------  ----------------
537    
538  PCRE uses four tables for manipulating and identifying characters whose values  For speed, PCRE uses four tables for manipulating and identifying characters
539  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
540  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
541  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
542  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
543  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.
544    
545  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
546  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
547  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
548  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
549  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
550  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
551  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
552  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
553  re-generated.  the default tables by editing pcre_chartables.c and then re-building PCRE. If
554    you do this, you should take care to ensure that the file does not get
555    automatically re-generated. The best way to do this is to move
556    pcre_chartables.c.dist out of the way and replace it with your customized
557    tables.
558    
559    When the dftables program is run as a result of --enable-rebuild-chartables,
560    it uses the default C locale that is set on your system. It does not pay
561    attention to the LC_xxx environment variables. In other words, it uses the
562    system's default locale rather than whatever the compiling user happens to have
563    set. If you really do want to build a source set of character tables in a
564    locale that is specified by the LC_xxx variables, you can run the dftables
565    program by hand with the -L option. For example:
566    
567      ./dftables -L pcre_chartables.c.special
568    
569  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,
570  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
571  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
572  building 32-byte bit maps that represent character classes.  building 32-byte bit maps that represent character classes for code points less
573    than 256.
574    
575  The final 256-byte table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
576  follows:  follows:
# Line 422  You should not alter the set of characte Line 586  You should not alter the set of characte
586  will cause PCRE to malfunction.  will cause PCRE to malfunction.
587    
588    
589  Manifest  File manifest
590  --------  -------------
591    
592  The distribution should contain the following files:  The distribution should contain the following files:
593    
594  (A) The actual source files of the PCRE library functions and their  (A) Source files of the PCRE library functions and their headers:
     headers:  
595    
596    dftables.c            auxiliary program for building chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
597                                when --enable-rebuild-chartables is specified
598    
599    pcreposix.c           )    pcre_chartables.c.dist  a default set of character tables that assume ASCII
600    pcre_compile.c        )                              coding; used, unless --enable-rebuild-chartables is
601    pcre_config.c         )                              specified, by copying to pcre_chartables.c
602    pcre_dfa_exec.c       )  
603    pcre_exec.c           )    pcreposix.c             )
604    pcre_fullinfo.c       )    pcre_compile.c          )
605    pcre_get.c            ) sources for the functions in the library,    pcre_config.c           )
606    pcre_globals.c        )   and some internal functions that they use    pcre_dfa_exec.c         )
607    pcre_info.c           )    pcre_exec.c             )
608    pcre_maketables.c     )    pcre_fullinfo.c         )
609    pcre_newline.c        )    pcre_get.c              ) sources for the functions in the library,
610    pcre_ord2utf8.c       )    pcre_globals.c          )   and some internal functions that they use
611    pcre_refcount.c       )    pcre_info.c             )
612    pcre_study.c          )    pcre_maketables.c       )
613    pcre_tables.c         )    pcre_newline.c          )
614    pcre_try_flipped.c    )    pcre_ord2utf8.c         )
615    pcre_ucp_searchfuncs.c)    pcre_refcount.c         )
616    pcre_valid_utf8.c     )    pcre_study.c            )
617    pcre_version.c        )    pcre_tables.c           )
618    pcre_xclass.c         )    pcre_try_flipped.c      )
619    ucptable.c            )    pcre_ucp_searchfuncs.c  )
620      pcre_valid_utf8.c       )
621    pcre_printint.src     ) debugging function that is #included in pcretest, and    pcre_version.c          )
622                          )   can also be #included in pcre_compile()    pcre_xclass.c           )
623      pcre_printint.src       ) debugging function that is #included in pcretest,
624    pcre.h                the public PCRE header file                            )   and can also be #included in pcre_compile()
625    pcreposix.h           header for the external POSIX wrapper API    pcre.h.in               template for pcre.h when built by "configure"
626    pcre_internal.h       header for internal use    pcreposix.h             header for the external POSIX wrapper API
627    ucp.h                 ) headers concerned with    pcre_internal.h         header for internal use
628    ucpinternal.h         )   Unicode property handling    ucp.h                   ) headers concerned with
629    config.in             template for config.h, which is built by configure    ucpinternal.h           )   Unicode property handling
630      ucptable.h              ) (this one is the data table)
631    pcrecpp.h             the header file for the C++ wrapper  
632    pcrecpparg.h.in       "source" for another C++ header file    config.h.in             template for config.h, which is built by "configure"
633    pcrecpp.cc            )  
634    pcre_scanner.cc       ) source for the C++ wrapper library    pcrecpp.h               public header file for the C++ wrapper
635      pcrecpparg.h.in         template for another C++ header file
636    pcre_stringpiece.h.in "source" for pcre_stringpiece.h, the header for the    pcre_scanner.h          public header file for C++ scanner functions
637                            C++ stringpiece functions    pcrecpp.cc              )
638    pcre_stringpiece.cc   source for the C++ stringpiece functions    pcre_scanner.cc         ) source for the C++ wrapper library
639    
640  (B) Auxiliary files:    pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
641                                C++ stringpiece functions
642    AUTHORS               information about the author of PCRE    pcre_stringpiece.cc     source for the C++ stringpiece functions
643    ChangeLog             log of changes to the code  
644    INSTALL               generic installation instructions  (B) Source files for programs that use PCRE:
645    LICENCE               conditions for the use of PCRE  
646    COPYING               the same, using GNU's standard name    pcredemo.c              simple demonstration of coding calls to PCRE
647    Makefile.in           template for Unix Makefile, which is built by configure    pcregrep.c              source of a grep utility that uses PCRE
648    NEWS                  important changes in this release    pcretest.c              comprehensive test program
649    NON-UNIX-USE          notes on building PCRE on non-Unix systems  
650    README                this file  (C) Auxiliary files:
651    RunTest.in            template for a Unix shell script for running tests  
652    RunGrepTest.in        template for a Unix shell script for pcregrep tests    132html                 script to turn "man" pages into HTML
653    config.guess          ) files used by libtool,    AUTHORS                 information about the author of PCRE
654    config.sub            )   used only when building a shared library    ChangeLog               log of changes to the code
655    config.h.in           "source" for the config.h header file    CleanTxt                script to clean nroff output for txt man pages
656    configure             a configuring shell script (built by autoconf)    Detrail                 script to remove trailing spaces
657    configure.ac          the autoconf input used to build configure    HACKING                 some notes about the internals of PCRE
658    doc/Tech.Notes        notes on the encoding    INSTALL                 generic installation instructions
659    doc/*.3               man page sources for the PCRE functions    LICENCE                 conditions for the use of PCRE
660    doc/*.1               man page sources for pcregrep and pcretest    COPYING                 the same, using GNU's standard name
661    doc/html/*            HTML documentation    Makefile.in             ) template for Unix Makefile, which is built by
662    doc/pcre.txt          plain text version of the man pages                            )   "configure"
663    doc/pcretest.txt      plain text documentation of test program    Makefile.am             ) the automake input that was used to create
664    doc/perltest.txt      plain text documentation of Perl test program                            )   Makefile.in
665    install-sh            a shell script for installing files    NEWS                    important changes in this release
666    libpcre.pc.in         "source" for libpcre.pc for pkg-config    NON-UNIX-USE            notes on building PCRE on non-Unix systems
667    ltmain.sh             file used to build a libtool script    PrepareRelease          script to make preparations for "make dist"
668    mkinstalldirs         script for making install directories    README                  this file
669    pcretest.c            comprehensive test program    RunTest                 a Unix shell script for running tests
670    pcredemo.c            simple demonstration of coding calls to PCRE    RunGrepTest             a Unix shell script for pcregrep tests
671    perltest              Perl test program    aclocal.m4              m4 macros (generated by "aclocal")
672    pcregrep.c            source of a grep utility that uses PCRE    config.guess            ) files used by libtool,
673    pcre-config.in        source of script which retains PCRE information    config.sub              )   used only when building a shared library
674    pcrecpp_unittest.c           )    configure               a configuring shell script (built by autoconf)
675    pcre_scanner_unittest.c      ) test programs for the C++ wrapper    configure.ac            ) the autoconf input that was used to build
676    pcre_stringpiece_unittest.c  )                            )   "configure" and config.h
677    testdata/testinput*   test data for main library tests    depcomp                 ) script to find program dependencies, generated by
678    testdata/testoutput*  expected test results                            )   automake
679    testdata/grep*        input and output for pcregrep tests    doc/*.3                 man page sources for the PCRE functions
680      doc/*.1                 man page sources for pcregrep and pcretest
681      doc/index.html.src      the base HTML page
682      doc/html/*              HTML documentation
683      doc/pcre.txt            plain text version of the man pages
684      doc/pcretest.txt        plain text documentation of test program
685      doc/perltest.txt        plain text documentation of Perl test program
686      install-sh              a shell script for installing files
687      libpcre.pc.in           template for libpcre.pc for pkg-config
688      libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
689      ltmain.sh               file used to build a libtool script
690      missing                 ) common stub for a few missing GNU programs while
691                              )   installing, generated by automake
692      mkinstalldirs           script for making install directories
693      perltest.pl             Perl test program
694      pcre-config.in          source of script which retains PCRE information
695      pcrecpp_unittest.cc          )
696      pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
697      pcre_stringpiece_unittest.cc )
698      testdata/testinput*     test data for main library tests
699      testdata/testoutput*    expected test results
700      testdata/grep*          input and output for pcregrep tests
701    
702  (C) Auxiliary files for Win32 DLL  (D) Auxiliary files for cmake support
703    
704    libpcre.def    CMakeLists.txt
705    libpcreposix.def    config-cmake.h.in
706    
707  (D) Auxiliary file for VPASCAL  (E) Auxiliary files for VPASCAL
708    
709    makevp.bat    makevp.bat
710      makevp_c.txt
711      makevp_l.txt
712      pcregexp.pas
713    
714    (F) Auxiliary files for building PCRE "by hand"
715    
716      pcre.h.generic          ) a version of the public PCRE header file
717                              )   for use in non-"configure" environments
718      config.h.generic        ) a version of config.h for use in non-"configure"
719                              )   environments
720    
721    (F) Miscellaneous
722    
723      RunTest.bat            a script for running tests under Windows
724    
725  Philip Hazel  Philip Hazel
726  Email local part: ph10  Email local part: ph10
727  Email domain: cam.ac.uk  Email domain: cam.ac.uk
728  November 2006  Last updated: 21 September 2007

Legend:
Removed from v.93  
changed lines
  Added in v.260

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12