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

Contents of /code/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 286 - (show annotations) (download)
Mon Dec 17 14:46:11 2007 UTC (6 years, 7 months ago) by ph10
File size: 33307 byte(s)
Add .gz and .bz2 optional support to pcregrep.

1 README file for PCRE (Perl-compatible regular expression library)
2 -----------------------------------------------------------------
3
4 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
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.
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
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
87 ------------------------------
88
89 You can find contributions from PCRE users in the directory
90
91 ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
92
93 There is a README file giving brief descriptions of what they are. Some are
94 complete in themselves; others are pointers to URLs containing relevant files.
95 Some of this material is likely to be well out-of-date. Several of the earlier
96 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
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 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
127 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
129 "autoconf" configuration script, for which generic instructions are supplied in
130 the file INSTALL.
131
132 Most commonly, people build PCRE within its own distribution directory, and in
133 this case, on many systems, just running "./configure" is sufficient. However,
134 the usual methods of changing standard defaults are available. For example:
135
136 CFLAGS='-O2 -Wall' ./configure --prefix=/opt/local
137
138 specifies that the C compiler should be run with the flags '-O2 -Wall' instead
139 of the default, and that "make install" should install PCRE under /opt/local
140 instead of the default /usr/local.
141
142 If you want to build in a different directory, just run "configure" with that
143 directory as current. For example, suppose you have unpacked the PCRE source
144 into /source/pcre/pcre-xxx, but you want to build it in /build/pcre/pcre-xxx:
145
146 cd /build/pcre/pcre-xxx
147 /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
154 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,
162 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
164 still has to be enabled by an option at run time.)
165
166 . If, in addition to support for UTF-8 character strings, you want to include
167 support for the \P, \p, and \X sequences that recognize Unicode character
168 properties, you must add --enable-unicode-properties to the "configure"
169 command. This adds about 30K to the size of the library (in the form of a
170 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
196 storage for processing capturing parentheses if there are more than 10 of
197 them in a pattern. You can increase this threshold by setting, for example,
198
199 --with-posix-malloc-threshold=20
200
201 on the "configure" command.
202
203 . 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
205 million. You can change the default by setting, for example,
206
207 --with-match-limit=500000
208
209 on the "configure" command. This is just the default; individual calls to
210 pcre_exec() can supply their own value. There is more discussion on the
211 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
224 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
226 ever to be necessary. Increasing the internal link size will reduce
227 performance.
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 to read .gz
262 and .bz2 files (respectively) by specifying one or both of
263
264 --enable-pcregrep-libz
265 --enable-pcregrep-libbz2
266
267 The "configure" script builds the following files for the basic C library:
268
269 . Makefile is the makefile that builds the library
270 . config.h contains build-time configuration options for the library
271 . pcre.h is the public PCRE header file
272 . pcre-config is a script that shows the settings of "configure" options
273 . libpcre.pc is data for the pkg-config command
274 . libtool is a script that builds shared and/or static libraries
275 . RunTest is a script for running tests on the basic C library
276 . RunGrepTest is a script for running tests on the pcregrep command
277
278 Versions of config.h and pcre.h are distributed in the PCRE tarballs under
279 the names config.h.generic and pcre.h.generic. These are provided for the
280 benefit of those who have to built PCRE without the benefit of "configure". If
281 you use "configure", the .generic versions are not used.
282
283 If a C++ compiler is found, the following files are also built:
284
285 . libpcrecpp.pc is data for the pkg-config command
286 . pcrecpparg.h is a header file for programs that call PCRE via the C++ wrapper
287 . pcre_stringpiece.h is the header for the C++ "stringpiece" functions
288
289 The "configure" script also creates config.status, which is an executable
290 script that can be run to recreate the configuration, and config.log, which
291 contains compiler output from tests that "configure" runs.
292
293 Once "configure" has run, you can run "make". It builds two libraries, called
294 libpcre and libpcreposix, a test program called pcretest, a demonstration
295 program called pcredemo, and the pcregrep command. If a C++ compiler was found
296 on your system, "make" also builds the C++ wrapper library, which is called
297 libpcrecpp, and some test programs called pcrecpp_unittest,
298 pcre_scanner_unittest, and pcre_stringpiece_unittest. Building the C++ wrapper
299 can be disabled by adding --disable-cpp to the "configure" command.
300
301 The command "make check" runs all the appropriate tests. Details of the PCRE
302 tests are given below in a separate section of this document.
303
304 You can use "make install" to install PCRE into live directories on your
305 system. The following are installed (file names are all relative to the
306 <prefix> that is set when "configure" is run):
307
308 Commands (bin):
309 pcretest
310 pcregrep
311 pcre-config
312
313 Libraries (lib):
314 libpcre
315 libpcreposix
316 libpcrecpp (if C++ support is enabled)
317
318 Configuration information (lib/pkgconfig):
319 libpcre.pc
320 libpcrecpp.pc (if C++ support is enabled)
321
322 Header files (include):
323 pcre.h
324 pcreposix.h
325 pcre_scanner.h )
326 pcre_stringpiece.h ) if C++ support is enabled
327 pcrecpp.h )
328 pcrecpparg.h )
329
330 Man pages (share/man/man{1,3}):
331 pcregrep.1
332 pcretest.1
333 pcre.3
334 pcre*.3 (lots more pages, all starting "pcre")
335
336 HTML documentation (share/doc/pcre/html):
337 index.html
338 *.html (lots more pages, hyperlinked from index.html)
339
340 Text file documentation (share/doc/pcre):
341 AUTHORS
342 COPYING
343 ChangeLog
344 LICENCE
345 NEWS
346 README
347 pcre.txt (a concatenation of the man(3) pages)
348 pcretest.txt the pcretest man page
349 pcregrep.txt the pcregrep man page
350
351 Note that the pcredemo program that is built by "configure" is *not* installed
352 anywhere. It is a demonstration for programmers wanting to use PCRE.
353
354 If you want to remove PCRE from your system, you can run "make uninstall".
355 This removes all the files that "make install" installed. However, it does not
356 remove any directories, because these are often shared with other programs.
357
358
359 Retrieving configuration information on Unix-like systems
360 ---------------------------------------------------------
361
362 Running "make install" installs the command pcre-config, which can be used to
363 recall information about the PCRE configuration and installation. For example:
364
365 pcre-config --version
366
367 prints the version number, and
368
369 pcre-config --libs
370
371 outputs information about where the library is installed. This command can be
372 included in makefiles for programs that use PCRE, saving the programmer from
373 having to remember too many details.
374
375 The pkg-config command is another system for saving and retrieving information
376 about installed libraries. Instead of separate commands for each library, a
377 single command is used. For example:
378
379 pkg-config --cflags pcre
380
381 The data is held in *.pc files that are installed in a directory called
382 <prefix>/lib/pkgconfig.
383
384
385 Shared libraries on Unix-like systems
386 -------------------------------------
387
388 The default distribution builds PCRE as shared libraries and static libraries,
389 as long as the operating system supports shared libraries. Shared library
390 support relies on the "libtool" script which is built as part of the
391 "configure" process.
392
393 The libtool script is used to compile and link both shared and static
394 libraries. They are placed in a subdirectory called .libs when they are newly
395 built. The programs pcretest and pcregrep are built to use these uninstalled
396 libraries (by means of wrapper scripts in the case of shared libraries). When
397 you use "make install" to install shared libraries, pcregrep and pcretest are
398 automatically re-built to use the newly installed shared libraries before being
399 installed themselves. However, the versions left in the build directory still
400 use the uninstalled libraries.
401
402 To build PCRE using static libraries only you must use --disable-shared when
403 configuring it. For example:
404
405 ./configure --prefix=/usr/gnu --disable-shared
406
407 Then run "make" in the usual way. Similarly, you can use --disable-static to
408 build only shared libraries.
409
410
411 Cross-compiling on Unix-like systems
412 ------------------------------------
413
414 You can specify CC and CFLAGS in the normal way to the "configure" command, in
415 order to cross-compile PCRE for some other host. However, you should NOT
416 specify --enable-rebuild-chartables, because if you do, the dftables.c source
417 file is compiled and run on the local host, in order to generate the inbuilt
418 character tables (the pcre_chartables.c file). This will probably not work,
419 because dftables.c needs to be compiled with the local compiler, not the cross
420 compiler.
421
422 When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
423 by making a copy of pcre_chartables.c.dist, which is a default set of tables
424 that assumes ASCII code. Cross-compiling with the default tables should not be
425 a problem.
426
427 If you need to modify the character tables when cross-compiling, you should
428 move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
429 run it on the local host to make a new version of pcre_chartables.c.dist.
430 Then when you cross-compile PCRE this new version of the tables will be used.
431
432
433 Using HP's ANSI C++ compiler (aCC)
434 ----------------------------------
435
436 Unless C++ support is disabled by specifying the "--disable-cpp" option of the
437 "configure" script, you must include the "-AA" option in the CXXFLAGS
438 environment variable in order for the C++ components to compile correctly.
439
440 Also, note that the aCC compiler on PA-RISC platforms may have a defect whereby
441 needed libraries fail to get included when specifying the "-AA" compiler
442 option. If you experience unresolved symbols when linking the C++ programs,
443 use the workaround of specifying the following environment variable prior to
444 running the "configure" script:
445
446 CXXLDFLAGS="-lstd_v2 -lCsup_v2"
447
448
449 Making new tarballs
450 -------------------
451
452 The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
453 zip formats. The command "make distcheck" does the same, but then does a trial
454 build of the new distribution to ensure that it works.
455
456 If you have modified any of the man page sources in the doc directory, you
457 should first run the PrepareRelease script before making a distribution. This
458 script creates the .txt and HTML forms of the documentation from the man pages.
459
460
461 Testing PCRE
462 ------------
463
464 To test the basic PCRE library on a Unix system, run the RunTest script that is
465 created by the configuring process. There is also a script called RunGrepTest
466 that tests the options of the pcregrep command. If the C++ wrapper library is
467 built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and
468 pcre_stringpiece_unittest are also built.
469
470 Both the scripts and all the program tests are run if you obey "make check" or
471 "make test". For other systems, see the instructions in NON-UNIX-USE.
472
473 The RunTest script runs the pcretest test program (which is documented in its
474 own man page) on each of the testinput files in the testdata directory in
475 turn, and compares the output with the contents of the corresponding testoutput
476 files. A file called testtry is used to hold the main output from pcretest
477 (testsavedregex is also used as a working file). To run pcretest on just one of
478 the test files, give its number as an argument to RunTest, for example:
479
480 RunTest 2
481
482 The first test file can also be fed directly into the perltest.pl script to
483 check that Perl gives the same results. The only difference you should see is
484 in the first few lines, where the Perl version is given instead of the PCRE
485 version.
486
487 The second set of tests check pcre_fullinfo(), pcre_info(), pcre_study(),
488 pcre_copy_substring(), pcre_get_substring(), pcre_get_substring_list(), error
489 detection, and run-time flags that are specific to PCRE, as well as the POSIX
490 wrapper API. It also uses the debugging flags to check some of the internals of
491 pcre_compile().
492
493 If you build PCRE with a locale setting that is not the standard C locale, the
494 character tables may be different (see next paragraph). In some cases, this may
495 cause failures in the second set of tests. For example, in a locale where the
496 isprint() function yields TRUE for characters in the range 128-255, the use of
497 [:isascii:] inside a character class defines a different set of characters, and
498 this shows up in this test as a difference in the compiled code, which is being
499 listed for checking. Where the comparison test output contains [\x00-\x7f] the
500 test will contain [\x00-\xff], and similarly in some other cases. This is not a
501 bug in PCRE.
502
503 The third set of tests checks pcre_maketables(), the facility for building a
504 set of character tables for a specific locale and using them instead of the
505 default tables. The tests make use of the "fr_FR" (French) locale. Before
506 running the test, the script checks for the presence of this locale by running
507 the "locale" command. If that command fails, or if it doesn't include "fr_FR"
508 in the list of available locales, the third test cannot be run, and a comment
509 is output to say why. If running this test produces instances of the error
510
511 ** Failed to set locale "fr_FR"
512
513 in the comparison output, it means that locale is not available on your system,
514 despite being listed by "locale". This does not mean that PCRE is broken.
515
516 [If you are trying to run this test on Windows, you may be able to get it to
517 work by changing "fr_FR" to "french" everywhere it occurs. Alternatively, use
518 RunTest.bat. The version of RunTest.bat included with PCRE 7.4 and above uses
519 Windows versions of test 2. More info on using RunTest.bat is included in the
520 document entitled NON-UNIX-USE.]
521
522 The fourth test checks the UTF-8 support. It is not run automatically unless
523 PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when
524 running "configure". This file can be also fed directly to the perltest script,
525 provided you are running Perl 5.8 or higher. (For Perl 5.6, a small patch,
526 commented in the script, can be be used.)
527
528 The fifth test checks error handling with UTF-8 encoding, and internal UTF-8
529 features of PCRE that are not relevant to Perl.
530
531 The sixth test checks the support for Unicode character properties. It it not
532 run automatically unless PCRE is built with Unicode property support. To to
533 this you must set --enable-unicode-properties when running "configure".
534
535 The seventh, eighth, and ninth tests check the pcre_dfa_exec() alternative
536 matching function, in non-UTF-8 mode, UTF-8 mode, and UTF-8 mode with Unicode
537 property support, respectively. The eighth and ninth tests are not run
538 automatically unless PCRE is build with the relevant support.
539
540
541 Character tables
542 ----------------
543
544 For speed, PCRE uses four tables for manipulating and identifying characters
545 whose code point values are less than 256. The final argument of the
546 pcre_compile() function is a pointer to a block of memory containing the
547 concatenated tables. A call to pcre_maketables() can be used to generate a set
548 of tables in the current locale. If the final argument for pcre_compile() is
549 passed as NULL, a set of default tables that is built into the binary is used.
550
551 The source file called pcre_chartables.c contains the default set of tables. By
552 default, this is created as a copy of pcre_chartables.c.dist, which contains
553 tables for ASCII coding. However, if --enable-rebuild-chartables is specified
554 for ./configure, a different version of pcre_chartables.c is built by the
555 program dftables (compiled from dftables.c), which uses the ANSI C character
556 handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
557 build the table sources. This means that the default C locale which is set for
558 your system will control the contents of these default tables. You can change
559 the default tables by editing pcre_chartables.c and then re-building PCRE. If
560 you do this, you should take care to ensure that the file does not get
561 automatically re-generated. The best way to do this is to move
562 pcre_chartables.c.dist out of the way and replace it with your customized
563 tables.
564
565 When the dftables program is run as a result of --enable-rebuild-chartables,
566 it uses the default C locale that is set on your system. It does not pay
567 attention to the LC_xxx environment variables. In other words, it uses the
568 system's default locale rather than whatever the compiling user happens to have
569 set. If you really do want to build a source set of character tables in a
570 locale that is specified by the LC_xxx variables, you can run the dftables
571 program by hand with the -L option. For example:
572
573 ./dftables -L pcre_chartables.c.special
574
575 The first two 256-byte tables provide lower casing and case flipping functions,
576 respectively. The next table consists of three 32-byte bit maps which identify
577 digits, "word" characters, and white space, respectively. These are used when
578 building 32-byte bit maps that represent character classes for code points less
579 than 256.
580
581 The final 256-byte table has bits indicating various character types, as
582 follows:
583
584 1 white space character
585 2 letter
586 4 decimal digit
587 8 hexadecimal digit
588 16 alphanumeric or '_'
589 128 regular expression metacharacter or binary zero
590
591 You should not alter the set of characters that contain the 128 bit, as that
592 will cause PCRE to malfunction.
593
594
595 File manifest
596 -------------
597
598 The distribution should contain the following files:
599
600 (A) Source files of the PCRE library functions and their headers:
601
602 dftables.c auxiliary program for building pcre_chartables.c
603 when --enable-rebuild-chartables is specified
604
605 pcre_chartables.c.dist a default set of character tables that assume ASCII
606 coding; used, unless --enable-rebuild-chartables is
607 specified, by copying to pcre_chartables.c
608
609 pcreposix.c )
610 pcre_compile.c )
611 pcre_config.c )
612 pcre_dfa_exec.c )
613 pcre_exec.c )
614 pcre_fullinfo.c )
615 pcre_get.c ) sources for the functions in the library,
616 pcre_globals.c ) and some internal functions that they use
617 pcre_info.c )
618 pcre_maketables.c )
619 pcre_newline.c )
620 pcre_ord2utf8.c )
621 pcre_refcount.c )
622 pcre_study.c )
623 pcre_tables.c )
624 pcre_try_flipped.c )
625 pcre_ucp_searchfuncs.c )
626 pcre_valid_utf8.c )
627 pcre_version.c )
628 pcre_xclass.c )
629 pcre_printint.src ) debugging function that is #included in pcretest,
630 ) and can also be #included in pcre_compile()
631 pcre.h.in template for pcre.h when built by "configure"
632 pcreposix.h header for the external POSIX wrapper API
633 pcre_internal.h header for internal use
634 ucp.h ) headers concerned with
635 ucpinternal.h ) Unicode property handling
636 ucptable.h ) (this one is the data table)
637
638 config.h.in template for config.h, which is built by "configure"
639
640 pcrecpp.h public header file for the C++ wrapper
641 pcrecpparg.h.in template for another C++ header file
642 pcre_scanner.h public header file for C++ scanner functions
643 pcrecpp.cc )
644 pcre_scanner.cc ) source for the C++ wrapper library
645
646 pcre_stringpiece.h.in template for pcre_stringpiece.h, the header for the
647 C++ stringpiece functions
648 pcre_stringpiece.cc source for the C++ stringpiece functions
649
650 (B) Source files for programs that use PCRE:
651
652 pcredemo.c simple demonstration of coding calls to PCRE
653 pcregrep.c source of a grep utility that uses PCRE
654 pcretest.c comprehensive test program
655
656 (C) Auxiliary files:
657
658 132html script to turn "man" pages into HTML
659 AUTHORS information about the author of PCRE
660 ChangeLog log of changes to the code
661 CleanTxt script to clean nroff output for txt man pages
662 Detrail script to remove trailing spaces
663 HACKING some notes about the internals of PCRE
664 INSTALL generic installation instructions
665 LICENCE conditions for the use of PCRE
666 COPYING the same, using GNU's standard name
667 Makefile.in ) template for Unix Makefile, which is built by
668 ) "configure"
669 Makefile.am ) the automake input that was used to create
670 ) Makefile.in
671 NEWS important changes in this release
672 NON-UNIX-USE notes on building PCRE on non-Unix systems
673 PrepareRelease script to make preparations for "make dist"
674 README this file
675 RunTest a Unix shell script for running tests
676 RunGrepTest a Unix shell script for pcregrep tests
677 aclocal.m4 m4 macros (generated by "aclocal")
678 config.guess ) files used by libtool,
679 config.sub ) used only when building a shared library
680 configure a configuring shell script (built by autoconf)
681 configure.ac ) the autoconf input that was used to build
682 ) "configure" and config.h
683 depcomp ) script to find program dependencies, generated by
684 ) automake
685 doc/*.3 man page sources for the PCRE functions
686 doc/*.1 man page sources for pcregrep and pcretest
687 doc/index.html.src the base HTML page
688 doc/html/* HTML documentation
689 doc/pcre.txt plain text version of the man pages
690 doc/pcretest.txt plain text documentation of test program
691 doc/perltest.txt plain text documentation of Perl test program
692 install-sh a shell script for installing files
693 libpcre.pc.in template for libpcre.pc for pkg-config
694 libpcrecpp.pc.in template for libpcrecpp.pc for pkg-config
695 ltmain.sh file used to build a libtool script
696 missing ) common stub for a few missing GNU programs while
697 ) installing, generated by automake
698 mkinstalldirs script for making install directories
699 perltest.pl Perl test program
700 pcre-config.in source of script which retains PCRE information
701 pcrecpp_unittest.cc )
702 pcre_scanner_unittest.cc ) test programs for the C++ wrapper
703 pcre_stringpiece_unittest.cc )
704 testdata/testinput* test data for main library tests
705 testdata/testoutput* expected test results
706 testdata/grep* input and output for pcregrep tests
707
708 (D) Auxiliary files for cmake support
709
710 CMakeLists.txt
711 config-cmake.h.in
712
713 (E) Auxiliary files for VPASCAL
714
715 makevp.bat
716 makevp_c.txt
717 makevp_l.txt
718 pcregexp.pas
719
720 (F) Auxiliary files for building PCRE "by hand"
721
722 pcre.h.generic ) a version of the public PCRE header file
723 ) for use in non-"configure" environments
724 config.h.generic ) a version of config.h for use in non-"configure"
725 ) environments
726
727 (F) Miscellaneous
728
729 RunTest.bat a script for running tests under Windows
730
731 Philip Hazel
732 Email local part: ph10
733 Email domain: cam.ac.uk
734 Last updated: 17 December 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