/[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 96 by nigel, Fri Mar 2 13:10:43 2007 UTC revision 231 by ph10, Tue Sep 11 11:15:33 2007 UTC
# Line 13  obtained by running Line 13  obtained by running
13  .sp  .sp
14    ./configure --help    ./configure --help
15  .sp  .sp
16  The following sections describe certain options whose names begin with --enable  The following sections include descriptions of options whose names begin with
17  or --disable. These settings specify changes to the defaults for the  --enable or --disable. These settings specify changes to the defaults for the
18  \fBconfigure\fP command. Because of the way that \fBconfigure\fP works,  \fBconfigure\fP command. Because of the way that \fBconfigure\fP works,
19  --enable and --disable always come in pairs, so the complementary option always  --enable and --disable always come in pairs, so the complementary option always
20  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.
# Line 56  character properties, you must add Line 56  character properties, you must add
56  to the \fBconfigure\fP command. This implies UTF-8 support, even if you have  to the \fBconfigure\fP command. This implies UTF-8 support, even if you have
57  not explicitly requested it.  not explicitly requested it.
58  .P  .P
59  Including Unicode property support adds around 90K of tables to the PCRE  Including Unicode property support adds around 30K of tables to the PCRE
60  library, approximately doubling its size. Only the general category properties  library. Only the general category properties such as \fILu\fP and \fINd\fP are
61  such as \fILu\fP and \fINd\fP are supported. Details are given in the  supported. Details are given in the
62  .\" HREF  .\" HREF
63  \fBpcrepattern\fP  \fBpcrepattern\fP
64  .\"  .\"
# Line 83  character sequence CRLF. If you want thi Line 83  character sequence CRLF. If you want thi
83  .sp  .sp
84  to the \fBconfigure\fP command. There is a fourth option, specified by  to the \fBconfigure\fP command. There is a fourth option, specified by
85  .sp  .sp
86      --enable-newline-is-anycrlf
87    .sp
88    which causes PCRE to recognize any of the three sequences CR, LF, or CRLF as
89    indicating a line ending. Finally, a fifth option, specified by
90    .sp
91    --enable-newline-is-any    --enable-newline-is-any
92  .sp  .sp
93  which causes PCRE to recognize any Unicode newline sequence.  causes PCRE to recognize any Unicode newline sequence.
94  .P  .P
95  Whatever line ending convention is selected when PCRE is built can be  Whatever line ending convention is selected when PCRE is built can be
96  overridden when the library functions are called. At build time it is  overridden when the library functions are called. At build time it is
97  conventional to use the standard for your operating system.  conventional to use the standard for your operating system.
98  .  .
99    .SH "WHAT \eR MATCHES"
100    .rs
101    .sp
102    By default, the sequence \eR in a pattern matches any Unicode newline sequence,
103    whatever has been selected as the line ending sequence. If you specify
104    .sp
105      --enable-bsr-anycrlf
106    .sp
107    the default is changed so that \eR matches only CR, LF, or CRLF. Whatever is
108    selected when PCRE is built can be overridden when the library functions are
109    called.
110    .
111  .SH "BUILDING SHARED AND STATIC LIBRARIES"  .SH "BUILDING SHARED AND STATIC LIBRARIES"
112  .rs  .rs
113  .sp  .sp
# Line 137  or four-byte offsets by adding a setting Line 154  or four-byte offsets by adding a setting
154  to the \fBconfigure\fP command. The value given must be 2, 3, or 4. Using  to the \fBconfigure\fP command. The value given must be 2, 3, or 4. Using
155  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
156  additional bytes when handling them.  additional bytes when handling them.
 .P  
 If you build PCRE with an increased link size, test 2 (and test 5 if you are  
 using UTF-8) will fail. Part of the output of these tests is a representation  
 of the compiled pattern, and this changes with the link size.  
157  .  .
158  .SH "AVOIDING EXCESSIVE STACK USAGE"  .SH "AVOIDING EXCESSIVE STACK USAGE"
159  .rs  .rs
# Line 163  build a version of PCRE that works this Line 176  build a version of PCRE that works this
176  .sp  .sp
177  to the \fBconfigure\fP command. With this configuration, PCRE will use the  to the \fBconfigure\fP command. With this configuration, PCRE will use the
178  \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
179  management functions. Separate functions are provided because the usage is very  management functions. By default these point to \fBmalloc()\fP and
180  predictable: the block sizes requested are always the same, and the blocks are  \fBfree()\fP, but you can replace the pointers so that your own functions are
181  always freed in reverse order. A calling program might be able to implement  used.
182  optimized functions that perform better than the standard \fBmalloc()\fP and  .P
183  \fBfree()\fP functions. PCRE runs noticeably more slowly when built in this  Separate functions are provided rather than using \fBpcre_malloc\fP and
184  way. This option affects only the \fBpcre_exec()\fP function; it is not  \fBpcre_free\fP because the usage is very predictable: the block sizes
185  relevant for the the \fBpcre_dfa_exec()\fP function.  requested are always the same, and the blocks are always freed in reverse
186    order. A calling program might be able to implement optimized functions that
187    perform better than \fBmalloc()\fP and \fBfree()\fP. PCRE runs noticeably more
188    slowly when built in this way. This option affects only the \fBpcre_exec()\fP
189    function; it is not relevant for the the \fBpcre_dfa_exec()\fP function.
190  .  .
191  .SH "LIMITING PCRE RESOURCE USAGE"  .SH "LIMITING PCRE RESOURCE USAGE"
192  .rs  .rs
# Line 202  constraints. However, you can set a lowe Line 219  constraints. However, you can set a lowe
219  .sp  .sp
220  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.
221  .  .
222    .SH "CREATING CHARACTER TABLES AT BUILD TIME"
223    .rs
224    .sp
225    PCRE uses fixed tables for processing characters whose code values are less
226    than 256. By default, PCRE is built with a set of tables that are distributed
227    in the file \fIpcre_chartables.c.dist\fP. These tables are for ASCII codes
228    only. If you add
229    .sp
230      --enable-rebuild-chartables
231    .sp
232    to the \fBconfigure\fP command, the distributed tables are no longer used.
233    Instead, a program called \fBdftables\fP is compiled and run. This outputs the
234    source for new set of tables, created in the default locale of your C runtime
235    system. (This method of replacing the tables does not work if you are cross
236    compiling, because \fBdftables\fP is run on the local host. If you need to
237    create alternative tables when cross compiling, you will have to do so "by
238    hand".)
239    .
240  .SH "USING EBCDIC CODE"  .SH "USING EBCDIC CODE"
241  .rs  .rs
242  .sp  .sp
243  PCRE assumes by default that it will run in an environment where the character  PCRE assumes by default that it will run in an environment where the character
244  code is ASCII (or Unicode, which is a superset of ASCII). PCRE can, however, be  code is ASCII (or Unicode, which is a superset of ASCII). This is the case for
245  compiled to run in an EBCDIC environment by adding  most computer operating systems. PCRE can, however, be compiled to run in an
246    EBCDIC environment by adding
247  .sp  .sp
248    --enable-ebcdic    --enable-ebcdic
249  .sp  .sp
250  to the \fBconfigure\fP command.  to the \fBconfigure\fP command. This setting implies
251    --enable-rebuild-chartables. You should only use it if you know that you are in
252    an EBCDIC environment (for example, an IBM mainframe operating system).
253  .  .
254  .  .
255  .SH "SEE ALSO"  .SH "SEE ALSO"
256  .rs  .rs
257  .sp  .sp
258  \fBpcreapi\fP(3), \fBpcre_config\fP(3).  \fBpcreapi\fP(3), \fBpcre_config\fP(3).
259  .P  .
260  .in 0  .
261  Last updated: 30 November 2006  .SH AUTHOR
262  .br  .rs
263  Copyright (c) 1997-2006 University of Cambridge.  .sp
264    .nf
265    Philip Hazel
266    University Computing Service
267    Cambridge CB2 3QH, England.
268    .fi
269    .
270    .
271    .SH REVISION
272    .rs
273    .sp
274    .nf
275    Last updated: 11 September 2007
276    Copyright (c) 1997-2007 University of Cambridge.
277    .fi

Legend:
Removed from v.96  
changed lines
  Added in v.231

  ViewVC Help
Powered by ViewVC 1.1.5