/[pcre]/code/trunk/doc/pcrebuild.3
ViewVC logotype

Diff of /code/trunk/doc/pcrebuild.3

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

revision 195 by ph10, Mon Jul 30 13:23:28 2007 UTC revision 392 by ph10, Tue Mar 17 21:30:30 2009 UTC
# Line 5  PCRE - Perl-compatible regular expressio Line 5  PCRE - Perl-compatible regular expressio
5  .rs  .rs
6  .sp  .sp
7  This document describes the optional features of PCRE that can be selected when  This document describes the optional features of PCRE that can be selected when
8  the library is compiled. They are all selected, or deselected, by providing  the library is compiled. It assumes use of the \fBconfigure\fP script, where
9  options to the \fBconfigure\fP script that is run before the \fBmake\fP  the optional features are selected or deselected by providing options to
10  command. The complete list of options for \fBconfigure\fP (which includes the  \fBconfigure\fP before running the \fBmake\fP command. However, the same
11  standard ones such as the selection of the installation directory) can be  options can be selected in both Unix-like and non-Unix-like environments using
12  obtained by running  the GUI facility of \fBCMakeSetup\fP if you are using \fBCMake\fP instead of
13    \fBconfigure\fP to build PCRE.
14    .P
15    The complete list of options for \fBconfigure\fP (which includes the standard
16    ones such as the selection of the installation directory) can be obtained by
17    running
18  .sp  .sp
19    ./configure --help    ./configure --help
20  .sp  .sp
# Line 33  to the \fBconfigure\fP command. Line 38  to the \fBconfigure\fP command.
38  .SH "UTF-8 SUPPORT"  .SH "UTF-8 SUPPORT"
39  .rs  .rs
40  .sp  .sp
41  To build PCRE with support for UTF-8 character strings, add  To build PCRE with support for UTF-8 Unicode character strings, add
42  .sp  .sp
43    --enable-utf8    --enable-utf8
44  .sp  .sp
# Line 41  to the \fBconfigure\fP command. Of itsel Line 46  to the \fBconfigure\fP command. Of itsel
46  strings as UTF-8. As well as compiling PCRE with this option, you also have  strings as UTF-8. As well as compiling PCRE with this option, you also have
47  have to set the PCRE_UTF8 option when you call the \fBpcre_compile()\fP  have to set the PCRE_UTF8 option when you call the \fBpcre_compile()\fP
48  function.  function.
49    .P
50    If you set --enable-utf8 when compiling in an EBCDIC environment, PCRE expects
51    its input to be either ASCII or UTF-8 (depending on the runtime option). It is
52    not possible to support both EBCDIC and UTF-8 codes in the same version of the
53    library. Consequently, --enable-utf8 and --enable-ebcdic are mutually
54    exclusive.
55  .  .
56  .SH "UNICODE CHARACTER PROPERTY SUPPORT"  .SH "UNICODE CHARACTER PROPERTY SUPPORT"
57  .rs  .rs
# Line 67  documentation. Line 78  documentation.
78  .SH "CODE VALUE OF NEWLINE"  .SH "CODE VALUE OF NEWLINE"
79  .rs  .rs
80  .sp  .sp
81  By default, PCRE interprets character 10 (linefeed, LF) as indicating the end  By default, PCRE interprets the linefeed (LF) character as indicating the end
82  of a line. This is the normal newline character on Unix-like systems. You can  of a line. This is the normal newline character on Unix-like systems. You can
83  compile PCRE to use character 13 (carriage return, CR) instead, by adding  compile PCRE to use carriage return (CR) instead, by adding
84  .sp  .sp
85    --enable-newline-is-cr    --enable-newline-is-cr
86  .sp  .sp
# Line 96  Whatever line ending convention is selec Line 107  Whatever line ending convention is selec
107  overridden when the library functions are called. At build time it is  overridden when the library functions are called. At build time it is
108  conventional to use the standard for your operating system.  conventional to use the standard for your operating system.
109  .  .
110    .SH "WHAT \eR MATCHES"
111    .rs
112    .sp
113    By default, the sequence \eR in a pattern matches any Unicode newline sequence,
114    whatever has been selected as the line ending sequence. If you specify
115    .sp
116      --enable-bsr-anycrlf
117    .sp
118    the default is changed so that \eR matches only CR, LF, or CRLF. Whatever is
119    selected when PCRE is built can be overridden when the library functions are
120    called.
121    .
122  .SH "BUILDING SHARED AND STATIC LIBRARIES"  .SH "BUILDING SHARED AND STATIC LIBRARIES"
123  .rs  .rs
124  .sp  .sp
# Line 236  EBCDIC environment by adding Line 259  EBCDIC environment by adding
259    --enable-ebcdic    --enable-ebcdic
260  .sp  .sp
261  to the \fBconfigure\fP command. This setting implies  to the \fBconfigure\fP command. This setting implies
262  --enable-rebuild-chartables. You should only use it if you know that you are in  --enable-rebuild-chartables. You should only use it if you know that you are in
263  an EBCDIC environment (for example, an IBM mainframe operating system).  an EBCDIC environment (for example, an IBM mainframe operating system). The
264    --enable-ebcdic option is incompatible with --enable-utf8.
265    .
266    .SH "PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT"
267    .rs
268    .sp
269    By default, \fBpcregrep\fP reads all files as plain text. You can build it so
270    that it recognizes files whose names end in \fB.gz\fP or \fB.bz2\fP, and reads
271    them with \fBlibz\fP or \fBlibbz2\fP, respectively, by adding one or both of
272    .sp
273      --enable-pcregrep-libz
274      --enable-pcregrep-libbz2
275    .sp
276    to the \fBconfigure\fP command. These options naturally require that the
277    relevant libraries are installed on your system. Configuration will fail if
278    they are not.
279    .
280    .SH "PCRETEST OPTION FOR LIBREADLINE SUPPORT"
281    .rs
282    .sp
283    If you add
284    .sp
285      --enable-pcretest-libreadline
286    .sp
287    to the \fBconfigure\fP command, \fBpcretest\fP is linked with the
288    \fBlibreadline\fP library, and when its input is from a terminal, it reads it
289    using the \fBreadline()\fP function. This provides line-editing and history
290    facilities. Note that \fBlibreadline\fP is GPL-licenced, so if you distribute a
291    binary of \fBpcretest\fP linked in this way, there may be licensing issues.
292    .P
293    Setting this option causes the \fB-lreadline\fP option to be added to the
294    \fBpcretest\fP build. In many operating environments with a sytem-installed
295    \fBlibreadline\fP this is sufficient. However, in some environments (e.g.
296    if an unmodified distribution version of readline is in use), some extra
297    configuration may be necessary. The INSTALL file for \fBlibreadline\fP says
298    this:
299    .sp
300      "Readline uses the termcap functions, but does not link with the
301      termcap or curses library itself, allowing applications which link
302      with readline the to choose an appropriate library."
303    .sp
304    If your environment has not been set up so that an appropriate library is
305    automatically included, you may need to add something like
306    .sp
307      LIBS="-ncurses"
308    .sp
309    immediately before the \fBconfigure\fP command.
310  .  .
311  .  .
312  .SH "SEE ALSO"  .SH "SEE ALSO"
# Line 260  Cambridge CB2 3QH, England. Line 329  Cambridge CB2 3QH, England.
329  .rs  .rs
330  .sp  .sp
331  .nf  .nf
332  Last updated: 30 July 2007  Last updated: 17 March 2009
333  Copyright (c) 1997-2007 University of Cambridge.  Copyright (c) 1997-2009 University of Cambridge.
334  .fi  .fi

Legend:
Removed from v.195  
changed lines
  Added in v.392

  ViewVC Help
Powered by ViewVC 1.1.5