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

Diff of /code/trunk/README

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

revision 65 by nigel, Sat Feb 24 21:40:08 2007 UTC revision 338 by ph10, Sun Apr 13 14:58:34 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  PCRE has its own native API, but a set of "wrapper" functions that are based on    The PCRE APIs
16  the POSIX API are also supplied in the library libpcreposix. Note that this    Documentation for PCRE
17  just provides a POSIX calling interface to PCRE: the regular expressions    Contributions by users of PCRE
18  themselves still follow Perl syntax and semantics. The header file    Building PCRE on non-Unix systems
19  for the POSIX-style functions is called pcreposix.h. The official POSIX name is    Building PCRE on Unix-like systems
20  regex.h, but I didn't want to risk possible problems with existing files of    Retrieving configuration information on Unix-like systems
21  that name by distributing it that way. To use it with an existing program that    Shared libraries on Unix-like systems
22  uses the POSIX API, it will have to be renamed or pointed at by a link.    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
31    -------------
32    
33    PCRE is written in C, and it has its own API. The distribution also includes a
34    set of C++ wrapper functions (see the pcrecpp man page for details), courtesy
35    of Google Inc.
36    
37    In addition, there is a set of C wrapper functions that are based on the POSIX
38    regular expression API (see the pcreposix man page). These end up in the
39    library called libpcreposix. Note that this just provides a POSIX calling
40    interface to PCRE; the regular expressions themselves still follow Perl syntax
41    and semantics. The POSIX API is restricted, and does not give full access to
42    all of PCRE's facilities.
43    
44    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
51    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
54    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
65    ----------------------
66    
67    If you install PCRE in the normal way on a Unix-like system, you will end up
68    with a set of man pages whose names all start with "pcre". The one that is just
69    called "pcre" lists all the others. In addition to these man pages, the PCRE
70    documentation is supplied in two other forms:
71    
72      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         concatenation of the text forms of all the section 3 man pages except
75         those that summarize individual functions. The other two are the text
76         forms of the section 1 man pages for the pcregrep and pcretest commands.
77         These text forms are provided for ease of scanning with text editors or
78         similar tools. They are installed in <prefix>/share/doc/pcre, where
79         <prefix> is the installation prefix (defaulting to /usr/local).
80    
81      2. A set of files containing all the documentation in HTML form, hyperlinked
82         in various ways, and rooted in a file called index.html, is distributed in
83         doc/html and installed in <prefix>/share/doc/pcre/html.
84    
85    
86  Contributions by users of PCRE  Contributions by users of PCRE
# Line 24  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  Building PCRE on a Unix-like system  
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    
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
119    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 56  into /source/pcre/pcre-xxx, but you want Line 146  into /source/pcre/pcre-xxx, but you want
146  cd /build/pcre/pcre-xxx  cd /build/pcre/pcre-xxx
147  /source/pcre/pcre-xxx/configure  /source/pcre/pcre-xxx/configure
148    
149    PCRE is written in C and is normally compiled as a C library. However, it is
150    possible to build it as a C++ library, though the provided building apparatus
151    does not have any features to support this.
152    
153  There are some optional features that can be included or omitted from the PCRE  There are some optional features that can be included or omitted from the PCRE
154  library. You can read more about them in the pcrebuild man page.  library. You can read more about them in the pcrebuild man page.
155    
156    . 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,
158      it will try to find a C++ compiler and C++ header files, and if it succeeds,
159      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
163    for handling UTF-8 is not included in the library. (Even when included, it    for handling UTF-8 is not included in the library. (Even when included, it
164    still has to be enabled by an option at run time.)    still has to be enabled by an option at run time.)
165    
166  . You can build PCRE to recognized CR or NL as the newline character, instead  . If, in addition to support for UTF-8 character strings, you want to include
167    of whatever your compiler uses for "\n", by adding --newline-is-cr or    support for the \P, \p, and \X sequences that recognize Unicode character
168    --newline-is-nl to the "configure" command, respectively. Only do this if you    properties, you must add --enable-unicode-properties to the "configure"
169    really understand what you are doing. On traditional Unix-like systems, the    command. This adds about 30K to the size of the library (in the form of a
170    newline character is NL.    property table); only the basic two-letter properties such as Lu are
171      supported.
172    
173    . You can build PCRE to recognize either CR or LF or the sequence CRLF or any
174      of the preceding, or any of the Unicode newline sequences as indicating the
175      end of a line. Whatever you specify at build time is the default; the caller
176      of PCRE can change the selection at run time. The default newline indicator
177      is a single LF character (the Unix standard). You can specify the default
178      newline indicator by adding --enable-newline-is-cr or --enable-newline-is-lf
179      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    
201    on the "configure" command.    on the "configure" command.
202    
203  . PCRE has a counter which can be set to limit the amount of resources it uses.  . PCRE has a counter that can be set to limit the amount of resources it uses.
204    If the limit is exceeded during a match, the match fails. The default is ten    If the limit is exceeded during a match, the match fails. The default is ten
205    million. You can change the default by setting, for example,    million. You can change the default by setting, for example,
206    
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
214      during a matching process. This also has a default of ten million, which is
215      essentially "unlimited". You can change the default by setting, for example,
216    
217      --with-match-limit-recursion=500000
218    
219      Recursive function calls use up the runtime stack; running out of stack can
220      cause programs to crash in strange ways. There is a discussion about stack
221      sizes in the pcrestack man page.
222    
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.  
   
 The "configure" script builds five files:  
228    
229    . 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 memory blocks
231      obtained from the heap via the special functions pcre_stack_malloc() and
232      pcre_stack_free() to save data that would otherwise be saved on the stack. To
233      build PCRE like this, use
234    
235      --disable-stack-for-recursion
236    
237      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
239      pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not
240      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      --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
291    . 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
294    . 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  . Makefile is built by copying Makefile.in and making substitutions.  . RunTest is a script for running tests on the basic C library
297  . config.h is built by copying config.in and making substitutions.  . RunGrepTest is a script for running tests on the pcregrep command
298  . pcre-config is built by copying pcre-config.in and making substitutions.  
299  . RunTest is a script for running tests  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    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
309    
310    The "configure" script also creates config.status, which is an executable
311    script that can be run to recreate the configuration, and config.log, which
312    contains compiler output from tests that "configure" runs.
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. You can use "make install" to copy these, the public header files  command. If a C++ compiler was found on your system, "make" also builds the C++
317  pcre.h and pcreposix.h, and the man pages to appropriate live directories on  wrapper library, which is called libpcrecpp, and some test programs called
318  your system, in the normal way.  pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest.
319    Building the C++ wrapper can be disabled by adding --disable-cpp to the
320  Running "make install" also installs the command pcre-config, which can be used  "configure" command.
321  to recall information about the PCRE configuration and installation. For  
322  example,  The command "make check" runs all the appropriate tests. Details of the PCRE
323    tests are given below in a separate section of this document.
324    
325    You can use "make install" to install PCRE into live directories on your
326    system. The following are installed (file names are all relative to the
327    <prefix> that is set when "configure" is run):
328    
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".
373    This removes all the files that "make install" installed. However, it does not
374    remove any directories, because these are often shared with other programs.
375    
376    
377    Retrieving configuration information on Unix-like systems
378    ---------------------------------------------------------
379    
380    Running "make install" installs the command pcre-config, which can be used to
381    recall information about the PCRE configuration and installation. For example:
382    
383    pcre-config --version    pcre-config --version
384    
385  prints the version number, and  prints the version number, and
386    
387   pcre-config --libs    pcre-config --libs
388    
389  outputs information about where the library is installed. This command can be  outputs information about where the library is installed. This command can be
390  included in makefiles for programs that use PCRE, saving the programmer from  included in makefiles for programs that use PCRE, saving the programmer from
391  having to remember too many details.  having to remember too many details.
392    
393    The pkg-config command is another system for saving and retrieving information
394    about installed libraries. Instead of separate commands for each library, a
395    single command is used. For example:
396    
397  Cross-compiling PCRE on a Unix-like system    pkg-config --cflags pcre
 ------------------------------------------  
398    
399  PCRE needs to compile and run an auxiliary program as part of the building  The data is held in *.pc files that are installed in a directory called
400  process. Obviously, if the real compilation is for some other system, it can't  <prefix>/lib/pkgconfig.
 use the same CC and CFLAGS values when it is doing this. For cross compilation,  
 therefore, you must set CC_FOR_BUILD to the local host's compiler, and you can  
 set flags in CFLAGS_FOR_BUILD if you need to.  
401    
402    
403  Shared libraries on Unix-like systems  Shared libraries on Unix-like systems
404  -------------------------------------  -------------------------------------
405    
406  The default distribution builds PCRE as two shared libraries and two static  The default distribution builds PCRE as shared libraries and static libraries,
407  libraries, as long as the operating system supports shared libraries. Shared  as long as the operating system supports shared libraries. Shared library
408  library support relies on the "libtool" script which is built as part of the  support relies on the "libtool" script which is built as part of the
409  "configure" process.  "configure" process.
410    
411  The libtool script is used to compile and link both shared and static  The libtool script is used to compile and link both shared and static
# Line 149  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
421  configuring it. For example  configuring it. For example:
422    
423  ./configure --prefix=/usr/gnu --disable-shared  ./configure --prefix=/usr/gnu --disable-shared
424    
# Line 161  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 HOST_CC (and if necessary HOST_CFLAGS) when  because dftables.c needs to be compiled with the local compiler, not the cross
438  calling the "configure" command. If they are not specified, they default to the  compiler.
439  values of CC and CFLAGS.  
440    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  Building on non-Unix systems  that assumes ASCII code. Cross-compiling with the default tables should not be
443  ----------------------------  a problem.
444    
445  For a non-Unix system, read the comments in the file NON-UNIX-USE. PCRE has  If you need to modify the character tables when cross-compiling, you should
446  been compiled on Windows systems and on Macintoshes, but I don't know the  move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
447  details because I don't use those systems. It should be straightforward to  run it on the local host to make a new version of pcre_chartables.c.dist.
448  build PCRE on any system that has a Standard C compiler, because it uses only  Then when you cross-compile PCRE this new version of the tables will be used.
449  Standard C functions.  
450    
451    Using HP's ANSI C++ compiler (aCC)
452    ----------------------------------
453    
454    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
456    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
459    needed libraries fail to get included when specifying the "-AA" compiler
460    option. If you experience unresolved symbols when linking the C++ programs,
461    use the workaround of specifying the following environment variable prior to
462    running the "configure" script:
463    
464      CXXLDFLAGS="-lstd_v2 -lCsup_v2"
465    
466    
467    Making new tarballs
468    -------------------
469    
470    The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
471    zip formats. The command "make distcheck" does the same, but then does a trial
472    build of the new distribution to ensure that it works.
473    
474    If you have modified any of the man page sources in the doc directory, you
475    should first run the PrepareRelease script before making a distribution. This
476    script creates the .txt and HTML forms of the documentation from the man pages.
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. (This can also be run by "make runtest", "make check", or  created by the configuring process. There is also a script called RunGrepTest
484  "make test".) For other systems, see the instruction in NON-UNIX-USE.  that tests the options of the pcregrep command. If the C++ wrapper library is
485    built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
486  The script runs the pcretest test program (which is documented in its own man  pcre_stringpiece_unittest are also built.
487  page) on each of the testinput files (in the testdata directory) in turn,  
488  and compares the output with the contents of the corresponding testoutput file.  Both the scripts and all the program tests are run if you obey "make check" or
489  A file called testtry is used to hold the output from pcretest. To run pcretest  "make test". For other systems, see the instructions in NON-UNIX-USE.
490  on just one of the test files, give its number as an argument to RunTest, for  
491  example:  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
493    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
495    (testsavedregex is also used as a working file). To run pcretest on just one of
496    the test files, give its number as an argument to RunTest, for example:
497    
498    RunTest 2    RunTest 2
499    
500  The first file can also be fed directly into the perltest script to check that  The first test file can also be fed directly into the perltest.pl script to
501  Perl gives the same results. The only difference you should see is in the first  check that Perl gives the same results. The only difference you should see is
502  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 222  bug in PCRE. Line 520  bug in PCRE.
520    
521  The third set of tests checks pcre_maketables(), the facility for building a  The third set of tests checks pcre_maketables(), the facility for building a
522  set of character tables for a specific locale and using them instead of the  set of character tables for a specific locale and using them instead of the
523  default tables. The tests make use of the "fr" (French) locale. Before running  default tables. The tests make use of the "fr_FR" (French) locale. Before
524  the test, the script checks for the presence of this locale by running the  running the test, the script checks for the presence of this locale by running
525  "locale" command. If that command fails, or if it doesn't include "fr" in the  the "locale" command. If that command fails, or if it doesn't include "fr_FR"
526  list of available locales, the third test cannot be run, and a comment is  in the list of available locales, the third test cannot be run, and a comment
527  output to say why. If running this test produces instances of the error  is output to say why. If running this test produces instances of the error
528    
529    ** Failed to set locale "fr"    ** Failed to set locale "fr_FR"
530    
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,
543  provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,  provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,
544  commented in the script, can be be used.)  commented in the script, can be be used.)
545    
546  The fifth and final file tests error handling with UTF-8 encoding, and internal  The fifth test checks error handling with UTF-8 encoding, and internal UTF-8
547  UTF-8 features of PCRE that are not relevant to Perl.  features of PCRE that are not relevant to Perl.
548    
549    The sixth test checks the support for Unicode character properties. It it not
550    run automatically unless PCRE is built with Unicode property support. To to
551    this you must set --enable-unicode-properties when running "configure".
552    
553    The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative
554    matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode
555    property support, respectively. The eighth and ninth tests are not run
556    automatically unless PCRE is build with the relevant support.
557    
558    
559  Character tables  Character tables
560  ----------------  ----------------
561    
562  PCRE uses four tables for manipulating and identifying characters. The final  For speed, PCRE uses four tables for manipulating and identifying characters
563  argument of the pcre_compile() function is a pointer to a block of memory  whose code point values are less than 256. The final argument of the
564  containing the concatenated tables. A call to pcre_maketables() can be used to  pcre_compile() function is a pointer to a block of memory containing the
565  generate a set of tables in the current locale. If the final argument for  concatenated tables. A call to pcre_maketables() can be used to generate a set
566  pcre_compile() is passed as NULL, a set of default tables that is built into  of tables in the current locale. If the final argument for pcre_compile() is
567  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 282  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:
619      headers:  
620      dftables.c              auxiliary program for building pcre_chartables.c
621                                when --enable-rebuild-chartables is specified
622    
623    dftables.c            auxiliary program for building chartables.c    pcre_chartables.c.dist  a default set of character tables that assume ASCII
624    get.c                 )                              coding; used, unless --enable-rebuild-chartables is
625    maketables.c          )                              specified, by copying to pcre_chartables.c
626    study.c               ) source of  
627    pcre.c                )   the functions    pcreposix.c             )
628    pcreposix.c           )    pcre_compile.c          )
629    printint.c            )    pcre_config.c           )
630    pcre.in               "source" for the header for the external API; pcre.h    pcre_dfa_exec.c         )
631                            is built from this by "configure"    pcre_exec.c             )
632    pcreposix.h           header for the external POSIX wrapper API    pcre_fullinfo.c         )
633    internal.h            header for internal use    pcre_get.c              ) sources for the functions in the library,
634    config.in             template for config.h, which is built by configure    pcre_globals.c          )   and some internal functions that they use
635      pcre_info.c             )
636  (B) Auxiliary files:    pcre_maketables.c       )
637      pcre_newline.c          )
638    AUTHORS               information about the author of PCRE    pcre_ord2utf8.c         )
639    ChangeLog             log of changes to the code    pcre_refcount.c         )
640    INSTALL               generic installation instructions    pcre_study.c            )
641    LICENCE               conditions for the use of PCRE    pcre_tables.c           )
642    COPYING               the same, using GNU's standard name    pcre_try_flipped.c      )
643    Makefile.in           template for Unix Makefile, which is built by configure    pcre_ucp_searchfuncs.c  )
644    NEWS                  important changes in this release    pcre_valid_utf8.c       )
645    NON-UNIX-USE          notes on building PCRE on non-Unix systems    pcre_version.c          )
646    README                this file    pcre_xclass.c           )
647    RunTest.in            template for a Unix shell script for running tests    pcre_printint.src       ) debugging function that is #included in pcretest,
648    config.guess          ) files used by libtool,                            )   and can also be #included in pcre_compile()
649    config.sub            )   used only when building a shared library    pcre.h.in               template for pcre.h when built by "configure"
650    configure             a configuring shell script (built by autoconf)    pcreposix.h             header for the external POSIX wrapper API
651    configure.in          the autoconf input used to build configure    pcre_internal.h         header for internal use
652    doc/Tech.Notes        notes on the encoding    ucp.h                   ) headers concerned with
653    doc/*.3               man page sources for the PCRE functions    ucpinternal.h           )   Unicode property handling
654    doc/*.1               man page sources for pcregrep and pcretest    ucptable.h              ) (this one is the data table)
655    doc/html/*            HTML documentation  
656    doc/pcre.txt          plain text version of the man pages    config.h.in             template for config.h, which is built by "configure"
657    doc/pcretest.txt      plain text documentation of test program  
658    doc/perltest.txt      plain text documentation of Perl test program    pcrecpp.h               public header file for the C++ wrapper
659    install-sh            a shell script for installing files    pcrecpparg.h.in         template for another C++ header file
660    ltmain.sh             file used to build a libtool script    pcre_scanner.h          public header file for C++ scanner functions
661    pcretest.c            comprehensive test program    pcrecpp.cc              )
662    pcredemo.c            simple demonstration of coding calls to PCRE    pcre_scanner.cc         ) source for the C++ wrapper library
663    perltest              Perl test program  
664    pcregrep.c            source of a grep utility that uses PCRE    pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
665    pcre-config.in        source of script which retains PCRE information                              C++ stringpiece functions
666    testdata/testinput1   test data, compatible with Perl    pcre_stringpiece.cc     source for the C++ stringpiece functions
667    testdata/testinput2   test data for error messages and non-Perl things  
668    testdata/testinput3   test data for locale-specific tests  (B) Source files for programs that use PCRE:
669    testdata/testinput4   test data for UTF-8 tests compatible with Perl  
670    testdata/testinput5   test data for other UTF-8 tests    pcredemo.c              simple demonstration of coding calls to PCRE
671    testdata/testoutput1  test results corresponding to testinput1    pcregrep.c              source of a grep utility that uses PCRE
672    testdata/testoutput2  test results corresponding to testinput2    pcretest.c              comprehensive test program
673    testdata/testoutput3  test results corresponding to testinput3  
674    testdata/testoutput4  test results corresponding to testinput4  (C) Auxiliary files:
675    testdata/testoutput5  test results corresponding to testinput5  
676      132html                 script to turn "man" pages into HTML
677      AUTHORS                 information about the author of PCRE
678      ChangeLog               log of changes to the code
679      CleanTxt                script to clean nroff output for txt man pages
680      Detrail                 script to remove trailing spaces
681      HACKING                 some notes about the internals of PCRE
682      INSTALL                 generic installation instructions
683      LICENCE                 conditions for the use of PCRE
684      COPYING                 the same, using GNU's standard name
685      Makefile.in             ) template for Unix Makefile, which is built by
686                              )   "configure"
687      Makefile.am             ) the automake input that was used to create
688                              )   Makefile.in
689      NEWS                    important changes in this release
690      NON-UNIX-USE            notes on building PCRE on non-Unix systems
691      PrepareRelease          script to make preparations for "make dist"
692      README                  this file
693      RunTest                 a Unix shell script for running tests
694      RunGrepTest             a Unix shell script for pcregrep tests
695      aclocal.m4              m4 macros (generated by "aclocal")
696      config.guess            ) files used by libtool,
697      config.sub              )   used only when building a shared library
698      configure               a configuring shell script (built by autoconf)
699      configure.ac            ) the autoconf input that was used to build
700                              )   "configure" and config.h
701      depcomp                 ) script to find program dependencies, generated by
702                              )   automake
703      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    dll.mk    CMakeLists.txt
729    pcre.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 <ph10@cam.ac.uk>  Philip Hazel
750  February 2003  Email local part: ph10
751    Email domain: cam.ac.uk
752    Last updated: 13 April 2008

Legend:
Removed from v.65  
changed lines
  Added in v.338

  ViewVC Help
Powered by ViewVC 1.1.5