/[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 436 by ph10, Sun Sep 6 16:23:55 2009 UTC revision 456 by ph10, Fri Oct 2 08:53:31 2009 UTC
# Line 1  Line 1 
1  .TH PCREBUILD 3  .TH PCREBUILD 3
2  .SH NAME  .SH NAME
3  PCRE - Perl-compatible regular expressions  PCRE - Perl-compatible regular expressions
4    .
5    .
6  .SH "PCRE BUILD-TIME OPTIONS"  .SH "PCRE BUILD-TIME OPTIONS"
7  .rs  .rs
8  .sp  .sp
# Line 29  The following sections include descripti Line 31  The following sections include descripti
31  --enable and --disable always come in pairs, so the complementary option always  --enable and --disable always come in pairs, so the complementary option always
32  exists as well, but as it specifies the default, it is not described.  exists as well, but as it specifies the default, it is not described.
33  .  .
34    .
35  .SH "C++ SUPPORT"  .SH "C++ SUPPORT"
36  .rs  .rs
37  .sp  .sp
# Line 40  for PCRE. You can disable this by adding Line 43  for PCRE. You can disable this by adding
43  .sp  .sp
44  to the \fBconfigure\fP command.  to the \fBconfigure\fP command.
45  .  .
46    .
47  .SH "UTF-8 SUPPORT"  .SH "UTF-8 SUPPORT"
48  .rs  .rs
49  .sp  .sp
# Line 50  To build PCRE with support for UTF-8 Uni Line 54  To build PCRE with support for UTF-8 Uni
54  to the \fBconfigure\fP command. Of itself, this does not make PCRE treat  to the \fBconfigure\fP command. Of itself, this does not make PCRE treat
55  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
56  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
57  function.  or \fBpcre_compile2()\fP functions.
58  .P  .P
59  If you set --enable-utf8 when compiling in an EBCDIC environment, PCRE expects  If you set --enable-utf8 when compiling in an EBCDIC environment, PCRE expects
60  its input to be either ASCII or UTF-8 (depending on the runtime option). It is  its input to be either ASCII or UTF-8 (depending on the runtime option). It is
# Line 58  not possible to support both EBCDIC and Line 62  not possible to support both EBCDIC and
62  library. Consequently, --enable-utf8 and --enable-ebcdic are mutually  library. Consequently, --enable-utf8 and --enable-ebcdic are mutually
63  exclusive.  exclusive.
64  .  .
65    .
66  .SH "UNICODE CHARACTER PROPERTY SUPPORT"  .SH "UNICODE CHARACTER PROPERTY SUPPORT"
67  .rs  .rs
68  .sp  .sp
# Line 80  supported. Details are given in the Line 85  supported. Details are given in the
85  .\"  .\"
86  documentation.  documentation.
87  .  .
88    .
89  .SH "CODE VALUE OF NEWLINE"  .SH "CODE VALUE OF NEWLINE"
90  .rs  .rs
91  .sp  .sp
# Line 112  Whatever line ending convention is selec Line 118  Whatever line ending convention is selec
118  overridden when the library functions are called. At build time it is  overridden when the library functions are called. At build time it is
119  conventional to use the standard for your operating system.  conventional to use the standard for your operating system.
120  .  .
121    .
122  .SH "WHAT \eR MATCHES"  .SH "WHAT \eR MATCHES"
123  .rs  .rs
124  .sp  .sp
# Line 124  the default is changed so that \eR match Line 131  the default is changed so that \eR match
131  selected when PCRE is built can be overridden when the library functions are  selected when PCRE is built can be overridden when the library functions are
132  called.  called.
133  .  .
134    .
135  .SH "BUILDING SHARED AND STATIC LIBRARIES"  .SH "BUILDING SHARED AND STATIC LIBRARIES"
136  .rs  .rs
137  .sp  .sp
# Line 135  Unix libraries by default. You can suppr Line 143  Unix libraries by default. You can suppr
143  .sp  .sp
144  to the \fBconfigure\fP command, as required.  to the \fBconfigure\fP command, as required.
145  .  .
146    .
147  .SH "POSIX MALLOC USAGE"  .SH "POSIX MALLOC USAGE"
148  .rs  .rs
149  .sp  .sp
# Line 154  such as Line 163  such as
163  .sp  .sp
164  to the \fBconfigure\fP command.  to the \fBconfigure\fP command.
165  .  .
166    .
167  .SH "HANDLING VERY LARGE PATTERNS"  .SH "HANDLING VERY LARGE PATTERNS"
168  .rs  .rs
169  .sp  .sp
# Line 162  another (for example, from an opening pa Line 172  another (for example, from an opening pa
172  metacharacter). By default, two-byte values are used for these offsets, leading  metacharacter). By default, two-byte values are used for these offsets, leading
173  to a maximum size for a compiled pattern of around 64K. This is sufficient to  to a maximum size for a compiled pattern of around 64K. This is sufficient to
174  handle all but the most gigantic patterns. Nevertheless, some people do want to  handle all but the most gigantic patterns. Nevertheless, some people do want to
175  process enormous patterns, so it is possible to compile PCRE to use three-byte  process truyl enormous patterns, so it is possible to compile PCRE to use
176  or four-byte offsets by adding a setting such as  three-byte or four-byte offsets by adding a setting such as
177  .sp  .sp
178    --with-link-size=3    --with-link-size=3
179  .sp  .sp
# Line 171  to the \fBconfigure\fP command. The valu Line 181  to the \fBconfigure\fP command. The valu
181  longer offsets slows down the operation of PCRE because it has to load  longer offsets slows down the operation of PCRE because it has to load
182  additional bytes when handling them.  additional bytes when handling them.
183  .  .
184    .
185  .SH "AVOIDING EXCESSIVE STACK USAGE"  .SH "AVOIDING EXCESSIVE STACK USAGE"
186  .rs  .rs
187  .sp  .sp
# Line 194  to the \fBconfigure\fP command. With thi Line 205  to the \fBconfigure\fP command. With thi
205  \fBpcre_stack_malloc\fP and \fBpcre_stack_free\fP variables to call memory  \fBpcre_stack_malloc\fP and \fBpcre_stack_free\fP variables to call memory
206  management functions. By default these point to \fBmalloc()\fP and  management functions. By default these point to \fBmalloc()\fP and
207  \fBfree()\fP, but you can replace the pointers so that your own functions are  \fBfree()\fP, but you can replace the pointers so that your own functions are
208  used.  used instead.
209  .P  .P
210  Separate functions are provided rather than using \fBpcre_malloc\fP and  Separate functions are provided rather than using \fBpcre_malloc\fP and
211  \fBpcre_free\fP because the usage is very predictable: the block sizes  \fBpcre_free\fP because the usage is very predictable: the block sizes
# Line 202  requested are always the same, and the b Line 213  requested are always the same, and the b
213  order. A calling program might be able to implement optimized functions that  order. A calling program might be able to implement optimized functions that
214  perform better than \fBmalloc()\fP and \fBfree()\fP. PCRE runs noticeably more  perform better than \fBmalloc()\fP and \fBfree()\fP. PCRE runs noticeably more
215  slowly when built in this way. This option affects only the \fBpcre_exec()\fP  slowly when built in this way. This option affects only the \fBpcre_exec()\fP
216  function; it is not relevant for the the \fBpcre_dfa_exec()\fP function.  function; it is not relevant for \fBpcre_dfa_exec()\fP.
217    .
218  .  .
219  .SH "LIMITING PCRE RESOURCE USAGE"  .SH "LIMITING PCRE RESOURCE USAGE"
220  .rs  .rs
# Line 235  constraints. However, you can set a lowe Line 247  constraints. However, you can set a lowe
247  .sp  .sp
248  to the \fBconfigure\fP command. This value can also be overridden at run time.  to the \fBconfigure\fP command. This value can also be overridden at run time.
249  .  .
250    .
251  .SH "CREATING CHARACTER TABLES AT BUILD TIME"  .SH "CREATING CHARACTER TABLES AT BUILD TIME"
252  .rs  .rs
253  .sp  .sp
# Line 253  compiling, because \fBdftables\fP is run Line 266  compiling, because \fBdftables\fP is run
266  create alternative tables when cross compiling, you will have to do so "by  create alternative tables when cross compiling, you will have to do so "by
267  hand".)  hand".)
268  .  .
269    .
270  .SH "USING EBCDIC CODE"  .SH "USING EBCDIC CODE"
271  .rs  .rs
272  .sp  .sp
# Line 268  to the \fBconfigure\fP command. This set Line 282  to the \fBconfigure\fP command. This set
282  an EBCDIC environment (for example, an IBM mainframe operating system). The  an EBCDIC environment (for example, an IBM mainframe operating system). The
283  --enable-ebcdic option is incompatible with --enable-utf8.  --enable-ebcdic option is incompatible with --enable-utf8.
284  .  .
285    .
286  .SH "PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT"  .SH "PCREGREP OPTIONS FOR COMPRESSED FILE SUPPORT"
287  .rs  .rs
288  .sp  .sp
# Line 282  to the \fBconfigure\fP command. These op Line 297  to the \fBconfigure\fP command. These op
297  relevant libraries are installed on your system. Configuration will fail if  relevant libraries are installed on your system. Configuration will fail if
298  they are not.  they are not.
299  .  .
300    .
301  .SH "PCRETEST OPTION FOR LIBREADLINE SUPPORT"  .SH "PCRETEST OPTION FOR LIBREADLINE SUPPORT"
302  .rs  .rs
303  .sp  .sp
# Line 292  If you add Line 308  If you add
308  to the \fBconfigure\fP command, \fBpcretest\fP is linked with the  to the \fBconfigure\fP command, \fBpcretest\fP is linked with the
309  \fBlibreadline\fP library, and when its input is from a terminal, it reads it  \fBlibreadline\fP library, and when its input is from a terminal, it reads it
310  using the \fBreadline()\fP function. This provides line-editing and history  using the \fBreadline()\fP function. This provides line-editing and history
311  facilities. Note that \fBlibreadline\fP is GPL-licenced, so if you distribute a  facilities. Note that \fBlibreadline\fP is GPL-licensed, so if you distribute a
312  binary of \fBpcretest\fP linked in this way, there may be licensing issues.  binary of \fBpcretest\fP linked in this way, there may be licensing issues.
313  .P  .P
314  Setting this option causes the \fB-lreadline\fP option to be added to the  Setting this option causes the \fB-lreadline\fP option to be added to the
# Line 334  Cambridge CB2 3QH, England. Line 350  Cambridge CB2 3QH, England.
350  .rs  .rs
351  .sp  .sp
352  .nf  .nf
353  Last updated: 06 September 2009  Last updated: 29 September 2009
354  Copyright (c) 1997-2009 University of Cambridge.  Copyright (c) 1997-2009 University of Cambridge.
355  .fi  .fi

Legend:
Removed from v.436  
changed lines
  Added in v.456

  ViewVC Help
Powered by ViewVC 1.1.5