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

Contents of /code/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 123 - (hide annotations) (download)
Mon Mar 12 15:19:06 2007 UTC (7 years, 5 months ago) by ph10
File size: 29071 byte(s)
Removal of trailing spaces.

1 nigel 41 README file for PCRE (Perl-compatible regular expression library)
2     -----------------------------------------------------------------
3 nigel 3
4 nigel 43 The latest release of PCRE is always available from
5    
6     ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.gz
7 ph10 123
8 ph10 111 There is a mailing list for discussion about the development of PCRE at
9 nigel 43
10 ph10 123 pcre-dev@exim.org
11    
12 nigel 41 Please read the NEWS file if you are upgrading from a previous release.
13 ph10 109 The contents of this README file are:
14 nigel 23
15 ph10 109 The PCRE APIs
16     Documentation for PCRE
17     Contributions by users of PCRE
18     Building PCRE on non-Unix systems
19 ph10 122 Building PCRE on Unix-like systems
20     Retrieving configuration information on Unix-like systems
21 ph10 109 Shared libraries on Unix-like systems
22 ph10 122 Cross-compiling on Unix-like systems
23 ph10 109 Using HP's ANSI C++ compiler (aCC)
24 ph10 111 Making new tarballs
25 ph10 109 Testing PCRE
26     Character tables
27     File manifest
28 nigel 35
29 ph10 109
30 nigel 77 The PCRE APIs
31     -------------
32    
33     PCRE is written in C, and it has its own API. The distribution now includes a
34     set of C++ wrapper functions, courtesy of Google Inc. (see the pcrecpp man page
35     for details).
36    
37 ph10 109 Also included in the distribution are a set of C wrapper functions that are
38     based on the POSIX API. These end up in the library called libpcreposix. Note
39     that this just provides a POSIX calling interface to PCRE; the regular
40     expressions themselves still follow Perl syntax and semantics. The POSIX API is
41     restricted, and does not give full access to all of PCRE's facilities.
42 nigel 77
43 ph10 109 The header file for the POSIX-style functions is called pcreposix.h. The
44     official POSIX name is regex.h, but I did not want to risk possible problems
45     with existing files of that name by distributing it that way. To use PCRE with
46     an existing program that uses the POSIX API, pcreposix.h will have to be
47     renamed or pointed at by a link.
48    
49 nigel 73 If you are using the POSIX interface to PCRE and there is already a POSIX regex
50 ph10 109 library installed on your system, as well as worrying about the regex.h header
51     file (as mentioned above), you must also take care when linking programs to
52 nigel 73 ensure that they link with PCRE's libpcreposix library. Otherwise they may pick
53 ph10 109 up the POSIX functions of the same name from the other library.
54 nigel 49
55 ph10 109 One way of avoiding this confusion is to compile PCRE with the addition of
56 ph10 122 -Dregcomp=PCREregcomp (and similarly for the other POSIX functions) to the
57     compiler flags (CFLAGS if you are using "configure" -- see below). This has the
58     effect of renaming the functions so that the names no longer clash. Of course,
59     you have to do the same thing for your applications, or write them using the
60     new names.
61 nigel 73
62 ph10 109
63 nigel 75 Documentation for PCRE
64     ----------------------
65    
66 ph10 122 If you install PCRE in the normal way on a Unix-like system, you will end up
67     with a set of man pages whose names all start with "pcre". The one that is just
68     called "pcre" lists all the others. In addition to these man pages, the PCRE
69     documentation is supplied in two other forms:
70 nigel 75
71 ph10 109 1. There are files called doc/pcre.txt, doc/pcregrep.txt, and
72     doc/pcretest.txt in the source distribution. The first of these is a
73     concatenation of the text forms of all the section 3 man pages except
74     those that summarize individual functions. The other two are the text
75     forms of the section 1 man pages for the pcregrep and pcretest commands.
76     These text forms are provided for ease of scanning with text editors or
77 ph10 123 similar tools. They are installed in <prefix>/share/doc/pcre, where
78 ph10 111 <prefix> is the installation prefix (defaulting to /usr/local).
79 nigel 75
80 ph10 109 2. A set of files containing all the documentation in HTML form, hyperlinked
81 ph10 123 in various ways, and rooted in a file called index.html, is distributed in
82 ph10 122 doc/html and installed in <prefix>/share/doc/pcre/html.
83 nigel 75
84    
85 nigel 53 Contributions by users of PCRE
86     ------------------------------
87    
88     You can find contributions from PCRE users in the directory
89    
90     ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
91    
92 ph10 122 There is a README file giving brief descriptions of what they are. Some are
93     complete in themselves; others are pointers to URLs containing relevant files.
94     Some of this material is likely to be well out-of-date. In particular, several
95     of the contributions provide support for compiling PCRE on various flavours of
96     Windows (I myself do not use Windows), but nowadays there is more Windows
97     support in the standard distribution.
98 nigel 53
99    
100 ph10 109 Building PCRE on non-Unix systems
101     ---------------------------------
102 ph10 101
103 ph10 122 For a non-Unix system, please read the comments in the file NON-UNIX-USE,
104     though if your system supports the use of "configure" and "make" you may be
105     able to build PCRE in the same way as for Unix-like systems.
106 ph10 101
107 ph10 109 PCRE has been compiled on many different operating systems. It should be
108     straightforward to build PCRE on any system that has a Standard C compiler and
109     library, because it uses only Standard C functions.
110 ph10 101
111    
112 ph10 122 Building PCRE on Unix-like systems
113     ----------------------------------
114 nigel 3
115 nigel 87 If you are using HP's ANSI C++ compiler (aCC), please see the special note
116     in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
117    
118 nigel 63 To build PCRE on a Unix-like system, first run the "configure" command from the
119     PCRE distribution directory, with your current directory set to the directory
120     where you want the files to be created. This command is a standard GNU
121     "autoconf" configuration script, for which generic instructions are supplied in
122 ph10 122 the file INSTALL.
123 nigel 3
124 nigel 53 Most commonly, people build PCRE within its own distribution directory, and in
125 ph10 109 this case, on many systems, just running "./configure" is sufficient. However,
126     the usual methods of changing standard defaults are available. For example:
127 nigel 53
128 nigel 41 CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
129    
130     specifies that the C compiler should be run with the flags '-O2 -Wall' instead
131     of the default, and that "make install" should install PCRE under /opt/local
132 nigel 49 instead of the default /usr/local.
133 nigel 41
134 nigel 53 If you want to build in a different directory, just run "configure" with that
135     directory as current. For example, suppose you have unpacked the PCRE source
136     into /source/pcre/pcre-xxx, but you want to build it in /build/pcre/pcre-xxx:
137    
138     cd /build/pcre/pcre-xxx
139     /source/pcre/pcre-xxx/configure
140    
141 nigel 87 PCRE is written in C and is normally compiled as a C library. However, it is
142     possible to build it as a C++ library, though the provided building apparatus
143     does not have any features to support this.
144    
145 nigel 63 There are some optional features that can be included or omitted from the PCRE
146     library. You can read more about them in the pcrebuild man page.
147 nigel 49
148 nigel 83 . If you want to suppress the building of the C++ wrapper library, you can add
149     --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
150     will try to find a C++ compiler and C++ header files, and if it succeeds, it
151     will try to build the C++ wrapper.
152    
153 nigel 63 . If you want to make use of the support for UTF-8 character strings in PCRE,
154     you must add --enable-utf8 to the "configure" command. Without it, the code
155     for handling UTF-8 is not included in the library. (Even when included, it
156     still has to be enabled by an option at run time.)
157    
158 nigel 75 . If, in addition to support for UTF-8 character strings, you want to include
159     support for the \P, \p, and \X sequences that recognize Unicode character
160     properties, you must add --enable-unicode-properties to the "configure"
161 nigel 91 command. This adds about 30K to the size of the library (in the form of a
162 nigel 75 property table); only the basic two-letter properties such as Lu are
163     supported.
164    
165 nigel 93 . You can build PCRE to recognize either CR or LF or the sequence CRLF or any
166     of the Unicode newline sequences as indicating the end of a line. Whatever
167     you specify at build time is the default; the caller of PCRE can change the
168     selection at run time. The default newline indicator is a single LF character
169     (the Unix standard). You can specify the default newline indicator by adding
170     --newline-is-cr or --newline-is-lf or --newline-is-crlf or --newline-is-any
171     to the "configure" command, respectively.
172 ph10 109
173     If you specify --newline-is-cr or --newline-is-crlf, some of the standard
174     tests will fail, because the lines in the test files end with LF. Even if
175 ph10 99 the files are edited to change the line endings, there are likely to be some
176     failures. With --newline-is-any, many tests should succeed, but there may be
177     some failures.
178 nigel 63
179     . When called via the POSIX interface, PCRE uses malloc() to get additional
180     storage for processing capturing parentheses if there are more than 10 of
181     them. You can increase this threshold by setting, for example,
182    
183     --with-posix-malloc-threshold=20
184    
185     on the "configure" command.
186    
187 nigel 77 . PCRE has a counter that can be set to limit the amount of resources it uses.
188 nigel 63 If the limit is exceeded during a match, the match fails. The default is ten
189     million. You can change the default by setting, for example,
190    
191     --with-match-limit=500000
192    
193     on the "configure" command. This is just the default; individual calls to
194 ph10 122 pcre_exec() can supply their own value. There is more discussion on the
195     pcreapi man page.
196 nigel 63
197 nigel 91 . There is a separate counter that limits the depth of recursive function calls
198     during a matching process. This also has a default of ten million, which is
199     essentially "unlimited". You can change the default by setting, for example,
200    
201     --with-match-limit-recursion=500000
202    
203     Recursive function calls use up the runtime stack; running out of stack can
204     cause programs to crash in strange ways. There is a discussion about stack
205     sizes in the pcrestack man page.
206    
207 nigel 63 . The default maximum compiled pattern size is around 64K. You can increase
208     this by adding --with-link-size=3 to the "configure" command. You can
209     increase it even more by setting --with-link-size=4, but this is unlikely
210 ph10 122 ever to be necessary.
211 nigel 63
212 nigel 77 . You can build PCRE so that its internal match() function that is called from
213 ph10 122 pcre_exec() does not call itself recursively. Instead, it uses memory blocks
214     obtained from the heap via the special functions pcre_stack_malloc() and
215     pcre_stack_free() to save data that would otherwise be saved on the stack. To
216     build PCRE like this, use
217 nigel 73
218     --disable-stack-for-recursion
219    
220     on the "configure" command. PCRE runs more slowly in this mode, but it may be
221 nigel 77 necessary in environments with limited stack sizes. This applies only to the
222     pcre_exec() function; it does not apply to pcre_dfa_exec(), which does not
223 ph10 122 use deeply nested recursion. There is a discussion about stack sizes in the
224     pcrestack man page.
225 nigel 73
226 ph10 109 The "configure" script builds the following files for the basic C library:
227 nigel 49
228 nigel 77 . Makefile is the makefile that builds the library
229     . config.h contains build-time configuration options for the library
230 ph10 109 . pcre.h is the public PCRE header file
231 nigel 77 . pcre-config is a script that shows the settings of "configure" options
232     . libpcre.pc is data for the pkg-config command
233 nigel 75 . libtool is a script that builds shared and/or static libraries
234 ph10 109 . RunTest is a script for running tests on the basic C library
235 nigel 77 . RunGrepTest is a script for running tests on the pcregrep command
236 nigel 41
237 ph10 123 Versions of config.h and pcre.h are distributed in the PCRE tarballs under
238 ph10 122 the names config.h.generic and pcre.h.generic. These are provided for the
239     benefit of those who have to built PCRE without the benefit of "configure". If
240     you use "configure", the .generic versions are not used.
241 nigel 77
242 ph10 109 If a C++ compiler is found, the following files are also built:
243    
244     . libpcrecpp.pc is data for the pkg-config command
245     . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper
246 nigel 77 . pcre_stringpiece.h is the header for the C++ "stringpiece" functions
247    
248     The "configure" script also creates config.status, which is an executable
249     script that can be run to recreate the configuration, and config.log, which
250     contains compiler output from tests that "configure" runs.
251    
252     Once "configure" has run, you can run "make". It builds two libraries, called
253 ph10 109 libpcre and libpcreposix, a test program called pcretest, a demonstration
254     program called pcredemo, and the pcregrep command. If a C++ compiler was found
255 ph10 122 on your system, "make" also builds the C++ wrapper library, which is called
256 ph10 109 libpcrecpp, and some test programs called pcrecpp_unittest,
257 ph10 122 pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper
258     can be disabled by adding --disable-cpp to the "configure" command.
259 nigel 3
260 ph10 109 The command "make check" runs all the appropriate tests. Details of the PCRE
261     tests are given below in a separate section of this document.
262 nigel 75
263 ph10 109 You can use "make install" to install PCRE into live directories on your
264     system. The following are installed (file names are all relative to the
265     <prefix> that is set when "configure" is run):
266 nigel 77
267 ph10 109 Commands (bin):
268     pcretest
269     pcregrep
270 ph10 111 pcre-config
271 ph10 109
272     Libraries (lib):
273     libpcre
274     libpcreposix
275     libpcrecpp (if C++ support is enabled)
276    
277     Configuration information (lib/pkgconfig):
278     libpcre.pc
279 ph10 122 libpcrecpp.pc (if C++ support is enabled)
280 ph10 109
281     Header files (include):
282     pcre.h
283     pcreposix.h
284     pcre_scanner.h )
285     pcre_stringpiece.h ) if C++ support is enabled
286     pcrecpp.h )
287     pcrecpparg.h )
288    
289     Man pages (share/man/man{1,3}):
290     pcregrep.1
291     pcretest.1
292     pcre.3
293     pcre*.3 (lots more pages, all starting "pcre")
294    
295     HTML documentation (share/doc/pcre/html):
296     index.html
297     *.html (lots more pages, hyperlinked from index.html)
298    
299     Text file documentation (share/doc/pcre):
300     AUTHORS
301     COPYING
302     ChangeLog
303     LICENCE
304     NEWS
305     README
306     pcre.txt (a concatenation of the man(3) pages)
307     pcretest.txt the pcretest man page
308     pcregrep.txt the pcregrep man page
309    
310 ph10 111 Note that the pcredemo program that is built by "configure" is *not* installed
311 ph10 109 anywhere. It is a demonstration for programmers wanting to use PCRE.
312    
313 nigel 77 If you want to remove PCRE from your system, you can run "make uninstall".
314     This removes all the files that "make install" installed. However, it does not
315     remove any directories, because these are often shared with other programs.
316    
317    
318 ph10 122 Retrieving configuration information on Unix-like systems
319     ---------------------------------------------------------
320 nigel 75
321 ph10 109 Running "make install" installs the command pcre-config, which can be used to
322     recall information about the PCRE configuration and installation. For example:
323 nigel 37
324 nigel 43 pcre-config --version
325    
326     prints the version number, and
327    
328 nigel 75 pcre-config --libs
329 nigel 43
330     outputs information about where the library is installed. This command can be
331     included in makefiles for programs that use PCRE, saving the programmer from
332     having to remember too many details.
333    
334 nigel 75 The pkg-config command is another system for saving and retrieving information
335     about installed libraries. Instead of separate commands for each library, a
336     single command is used. For example:
337 nigel 43
338 nigel 75 pkg-config --cflags pcre
339    
340     The data is held in *.pc files that are installed in a directory called
341 ph10 109 <prefix>/lib/pkgconfig.
342 nigel 75
343    
344 nigel 63 Shared libraries on Unix-like systems
345     -------------------------------------
346 nigel 53
347 nigel 77 The default distribution builds PCRE as shared libraries and static libraries,
348     as long as the operating system supports shared libraries. Shared library
349     support relies on the "libtool" script which is built as part of the
350 nigel 53 "configure" process.
351 nigel 39
352 nigel 53 The libtool script is used to compile and link both shared and static
353     libraries. They are placed in a subdirectory called .libs when they are newly
354     built. The programs pcretest and pcregrep are built to use these uninstalled
355     libraries (by means of wrapper scripts in the case of shared libraries). When
356     you use "make install" to install shared libraries, pcregrep and pcretest are
357     automatically re-built to use the newly installed shared libraries before being
358 ph10 122 installed themselves. However, the versions left in the build directory still
359 nigel 53 use the uninstalled libraries.
360    
361     To build PCRE using static libraries only you must use --disable-shared when
362 nigel 75 configuring it. For example:
363 nigel 3
364 nigel 43 ./configure --prefix=/usr/gnu --disable-shared
365 nigel 41
366 nigel 53 Then run "make" in the usual way. Similarly, you can use --disable-static to
367     build only shared libraries.
368 nigel 41
369 nigel 43
370 ph10 122 Cross-compiling on Unix-like systems
371     ------------------------------------
372 nigel 63
373     You can specify CC and CFLAGS in the normal way to the "configure" command, in
374     order to cross-compile PCRE for some other host. However, during the building
375     process, the dftables.c source file is compiled *and run* on the local host, in
376     order to generate the default character tables (the chartables.c file). It
377     therefore needs to be compiled with the local compiler, not the cross compiler.
378 nigel 77 You can do this by specifying CC_FOR_BUILD (and if necessary CFLAGS_FOR_BUILD;
379     there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)
380 nigel 73 when calling the "configure" command. If they are not specified, they default
381     to the values of CC and CFLAGS.
382 nigel 63
383    
384 nigel 87 Using HP's ANSI C++ compiler (aCC)
385     ----------------------------------
386    
387 nigel 93 Unless C++ support is disabled by specifying the "--disable-cpp" option of the
388 ph10 122 "configure" script, you must include the "-AA" option in the CXXFLAGS
389 nigel 87 environment variable in order for the C++ components to compile correctly.
390    
391     Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby
392     needed libraries fail to get included when specifying the "-AA" compiler
393     option. If you experience unresolved symbols when linking the C++ programs,
394     use the workaround of specifying the following environment variable prior to
395     running the "configure" script:
396    
397     CXXLDFLAGS="-lstd_v2 -lCsup_v2"
398    
399 ph10 123
400 ph10 111 Making new tarballs
401     -------------------
402 nigel 87
403 ph10 123 The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
404     zip formats. However, if you have modified any of the man page sources in the
405     doc directory, you should first run the PrepareRelease script. This re-creates
406 ph10 111 the .txt and HTML forms of the documentation from the man pages.
407    
408    
409 nigel 41 Testing PCRE
410     ------------
411    
412 ph10 122 To test the basic PCRE library on a Unix system, run the RunTest script that is
413     created by the configuring process. There is also a script called RunGrepTest
414     that tests the options of the pcregrep command. If the C++ wrapper library is
415     built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
416 ph10 109 pcre_stringpiece_unittest are also built.
417 nigel 41
418 ph10 109 Both the scripts and all the program tests are run if you obey "make check" or
419     "make test". For other systems, see the instructions in NON-UNIX-USE.
420 nigel 77
421     The RunTest script runs the pcretest test program (which is documented in its
422 ph10 122 own man page) on each of the testinput files in the testdata directory in
423 nigel 77 turn, and compares the output with the contents of the corresponding testoutput
424 nigel 93 files. A file called testtry is used to hold the main output from pcretest
425 nigel 75 (testsavedregex is also used as a working file). To run pcretest on just one of
426     the test files, give its number as an argument to RunTest, for example:
427 nigel 41
428 nigel 63 RunTest 2
429 nigel 3
430 ph10 109 The first test file can also be fed directly into the perltest.pl script to
431     check that Perl gives the same results. The only difference you should see is
432     in the first few lines, where the Perl version is given instead of the PCRE
433     version.
434 nigel 3
435 nigel 49 The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
436     pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
437     detection, and run-time flags that are specific to PCRE, as well as the POSIX
438 ph10 122 wrapper API. It also uses the debugging flags to check some of the internals of
439 nigel 49 pcre_compile().
440 nigel 7
441 nigel 49 If you build PCRE with a locale setting that is not the standard C locale, the
442     character tables may be different (see next paragraph). In some cases, this may
443     cause failures in the second set of tests. For example, in a locale where the
444     isprint() function yields TRUE for characters in the range 128-255, the use of
445     [:isascii:] inside a character class defines a different set of characters, and
446     this shows up in this test as a difference in the compiled code, which is being
447     listed for checking. Where the comparison test output contains [\x00-\x7f] the
448     test will contain [\x00-\xff], and similarly in some other cases. This is not a
449     bug in PCRE.
450    
451 nigel 63 The third set of tests checks pcre_maketables(), the facility for building a
452 nigel 25 set of character tables for a specific locale and using them instead of the
453 nigel 73 default tables. The tests make use of the "fr_FR" (French) locale. Before
454     running the test, the script checks for the presence of this locale by running
455     the "locale" command. If that command fails, or if it doesn't include "fr_FR"
456     in the list of available locales, the third test cannot be run, and a comment
457     is output to say why. If running this test produces instances of the error
458 nigel 25
459 nigel 73 ** Failed to set locale "fr_FR"
460 nigel 25
461     in the comparison output, it means that locale is not available on your system,
462     despite being listed by "locale". This does not mean that PCRE is broken.
463    
464 nigel 63 The fourth test checks the UTF-8 support. It is not run automatically unless
465     PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when
466     running "configure". This file can be also fed directly to the perltest script,
467     provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,
468     commented in the script, can be be used.)
469 nigel 3
470 nigel 75 The fifth test checks error handling with UTF-8 encoding, and internal UTF-8
471     features of PCRE that are not relevant to Perl.
472 nigel 3
473 ph10 122 The sixth test checks the support for Unicode character properties. It it not
474     run automatically unless PCRE is built with Unicode property support. To to
475 nigel 77 this you must set --enable-unicode-properties when running "configure".
476 nigel 63
477 nigel 77 The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative
478     matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode
479     property support, respectively. The eighth and ninth tests are not run
480     automatically unless PCRE is build with the relevant support.
481 nigel 75
482 nigel 77
483 nigel 3 Character tables
484     ----------------
485    
486 ph10 122 For speed, PCRE uses four tables for manipulating and identifying characters
487     whose code point values are less than 256. The final argument of the
488     pcre_compile() function is a pointer to a block of memory containing the
489     concatenated tables. A call to pcre_maketables() can be used to generate a set
490     of tables in the current locale. If the final argument for pcre_compile() is
491     passed as NULL, a set of default tables that is built into the binary is used.
492 nigel 3
493 nigel 25 The source file called chartables.c contains the default set of tables. This is
494 nigel 27 not supplied in the distribution, but is built by the program dftables
495     (compiled from dftables.c), which uses the ANSI C character handling functions
496 nigel 25 such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table
497 nigel 35 sources. This means that the default C locale which is set for your system will
498     control the contents of these default tables. You can change the default tables
499     by editing chartables.c and then re-building PCRE. If you do this, you should
500 ph10 122 take care to ensure that the file does not get automaticaly re-generated.
501 nigel 3
502 nigel 25 The first two 256-byte tables provide lower casing and case flipping functions,
503     respectively. The next table consists of three 32-byte bit maps which identify
504     digits, "word" characters, and white space, respectively. These are used when
505 ph10 111 building 32-byte bit maps that represent character classes for code points less
506 ph10 109 than 256.
507 nigel 25
508     The final 256-byte table has bits indicating various character types, as
509 nigel 3 follows:
510    
511     1 white space character
512     2 letter
513     4 decimal digit
514     8 hexadecimal digit
515     16 alphanumeric or '_'
516     128 regular expression metacharacter or binary zero
517    
518     You should not alter the set of characters that contain the 128 bit, as that
519     will cause PCRE to malfunction.
520    
521    
522 ph10 109 File manifest
523     -------------
524 nigel 3
525 nigel 41 The distribution should contain the following files:
526 nigel 3
527 ph10 109 (A) Source files of the PCRE library functions and their headers:
528 nigel 3
529 ph10 109 dftables.c auxiliary program for building chartables.c
530 ph10 111
531 ph10 109 pcreposix.c )
532     pcre_compile.c )
533     pcre_config.c )
534     pcre_dfa_exec.c )
535     pcre_exec.c )
536     pcre_fullinfo.c )
537     pcre_get.c ) sources for the functions in the library,
538     pcre_globals.c ) and some internal functions that they use
539     pcre_info.c )
540     pcre_maketables.c )
541     pcre_newline.c )
542     pcre_ord2utf8.c )
543     pcre_refcount.c )
544     pcre_study.c )
545     pcre_tables.c )
546     pcre_try_flipped.c )
547     pcre_ucp_searchfuncs.c )
548     pcre_valid_utf8.c )
549     pcre_version.c )
550     pcre_xclass.c )
551     pcre_printint.src ) debugging function that is #included in pcretest,
552     ) and can also be #included in pcre_compile()
553     pcre.h.in template for pcre.h when built by "configure"
554     pcreposix.h header for the external POSIX wrapper API
555     pcre_internal.h header for internal use
556     ucp.h ) headers concerned with
557     ucpinternal.h ) Unicode property handling
558     ucptable.h ) (this one is the data table)
559 ph10 111
560     config.h.in template for config.h, which is built by "configure"
561    
562 ph10 109 pcrecpp.h public header file for the C++ wrapper
563     pcrecpparg.h.in template for another C++ header file
564 ph10 111 pcre_scanner.h public header file for C++ scanner functions
565 ph10 109 pcrecpp.cc )
566     pcre_scanner.cc ) source for the C++ wrapper library
567 ph10 111
568 ph10 109 pcre_stringpiece.h.in template for pcre_stringpiece.h, the header for the
569     C++ stringpiece functions
570     pcre_stringpiece.cc source for the C++ stringpiece functions
571 ph10 111
572 ph10 109 (B) Source files for programs that use PCRE:
573 nigel 75
574 ph10 109 pcredemo.c simple demonstration of coding calls to PCRE
575     pcregrep.c source of a grep utility that uses PCRE
576     pcretest.c comprehensive test program
577 ph10 111
578     (C) Auxiliary files:
579    
580     132html script to turn "man" pages into HTML
581 ph10 109 AUTHORS information about the author of PCRE
582     ChangeLog log of changes to the code
583 ph10 111 CleanTxt script to clean nroff output for txt man pages
584     Detrail script to remove trailing spaces
585     Index.html the base HTML page
586 ph10 109 INSTALL generic installation instructions
587     LICENCE conditions for the use of PCRE
588     COPYING the same, using GNU's standard name
589 ph10 111 Makefile.in ) template for Unix Makefile, which is built by
590 ph10 109 ) "configure"
591     Makefile.am ) the automake input that was used to create
592 ph10 111 ) Makefile.in
593 ph10 109 NEWS important changes in this release
594     NON-UNIX-USE notes on building PCRE on non-Unix systems
595 ph10 111 PrepareRelease script to make preparations for "make dist"
596 ph10 109 README this file
597     RunTest.in template for a Unix shell script for running tests
598     RunGrepTest.in template for a Unix shell script for pcregrep tests
599     aclocal.m4 m4 macros (generated by "aclocal")
600     config.guess ) files used by libtool,
601     config.sub ) used only when building a shared library
602     configure a configuring shell script (built by autoconf)
603 ph10 111 configure.ac ) the autoconf input that was used to build
604 ph10 109 ) "configure" and config.h
605     depcomp ) script to find program dependencies, generated by
606 ph10 111 ) automake
607 ph10 109 doc/*.3 man page sources for the PCRE functions
608     doc/*.1 man page sources for pcregrep and pcretest
609     doc/html/* HTML documentation
610     doc/pcre.txt plain text version of the man pages
611     doc/pcretest.txt plain text documentation of test program
612     doc/perltest.txt plain text documentation of Perl test program
613     install-sh a shell script for installing files
614     libpcre.pc.in template for libpcre.pc for pkg-config
615 ph10 111 libpcrecpp.pc.in template for libpcrecpp.pc for pkg-config
616 ph10 109 ltmain.sh file used to build a libtool script
617 ph10 111 missing ) common stub for a few missing GNU programs while
618 ph10 109 ) installing, generated by automake
619     mkinstalldirs script for making install directories
620     perltest.pl Perl test program
621     pcre-config.in source of script which retains PCRE information
622 ph10 111 pcrecpp_unittest.cc )
623     pcre_scanner_unittest.cc ) test programs for the C++ wrapper
624     pcre_stringpiece_unittest.cc )
625 ph10 109 testdata/testinput* test data for main library tests
626     testdata/testoutput* expected test results
627     testdata/grep* input and output for pcregrep tests
628 ph10 111
629 ph10 109 (D) Auxiliary files for cmake support
630 nigel 3
631 ph10 109 CMakeLists.txt
632 ph10 111 config-cmake.h.in
633 nigel 29
634 ph10 109 (E) Auxiliary files for VPASCAL
635 nigel 29
636 nigel 63 makevp.bat
637 ph10 109 !compile.txt
638     !linklib.txt
639 ph10 111 pcregexp.pas
640    
641     (F) Auxiliary files for building PCRE "by hand"
642    
643     pcre.h.generic ) a version of the public PCRE header file
644     ) for use in non-"configure" environments
645     config.h.generic ) a version of config.h for use in non-"configure"
646     ) environments
647    
648 ph10 109 (F) Miscellaneous
649 nigel 63
650 ph10 109 RunTest.bat a script for running tests under Windows
651    
652 nigel 77 Philip Hazel
653     Email local part: ph10
654     Email domain: cam.ac.uk
655 ph10 109 Last updated: March 2007

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12