1.1 --- a/tools/pcre/doc/pcrecpp.3 Sun Mar 17 11:29:55 2013 -0400
1.2 +++ b/tools/pcre/doc/pcrecpp.3 Sun Mar 17 11:32:03 2013 -0400
1.3 @@ -1,4 +1,4 @@
1.4 -.TH PCRECPP 3
1.5 +.TH PCRECPP 3 "08 January 2012" "PCRE 8.30"
1.6 .SH NAME
1.7 PCRE - Perl-compatible regular expressions.
1.8 .SH "SYNOPSIS OF C++ WRAPPER"
1.9 @@ -12,7 +12,8 @@
1.10 The C++ wrapper for PCRE was provided by Google Inc. Some additional
1.11 functionality was added by Giuseppe Maxia. This brief man page was constructed
1.12 from the notes in the \fIpcrecpp.h\fP file, which should be consulted for
1.13 -further details.
1.14 +further details. Note that the C++ wrapper supports only the original 8-bit
1.15 +PCRE library. There is no 16-bit or 32-bit support at present.
1.16 .
1.17 .
1.18 .SH "MATCHING INTERFACE"
1.19 @@ -172,7 +173,7 @@
1.20 PCRE_DOTALL dot matches newlines /s
1.21 PCRE_DOLLAR_ENDONLY $ matches only at end N/A
1.22 PCRE_EXTRA strict escape parsing N/A
1.23 - PCRE_EXTENDED ignore whitespaces /x
1.24 + PCRE_EXTENDED ignore white spaces /x
1.25 PCRE_UTF8 handles UTF8 chars built-in
1.26 PCRE_UNGREEDY reverses * and *? N/A
1.27 PCRE_NO_AUTO_CAPTURE disables capturing parens N/A (*)
1.28 @@ -195,11 +196,11 @@
1.29 RE_Options & set_caseless(bool)
1.30 .sp
1.31 which sets or unsets the modifier. Moreover, PCRE_EXTRA_MATCH_LIMIT can be
1.32 -accessed through the \fBset_match_limit()\fR and \fBmatch_limit()\fR member
1.33 -functions. Setting \fImatch_limit\fR to a non-zero value will limit the
1.34 +accessed through the \fBset_match_limit()\fP and \fBmatch_limit()\fP member
1.35 +functions. Setting \fImatch_limit\fP to a non-zero value will limit the
1.36 execution of pcre to keep it from doing bad things like blowing the stack or
1.37 taking an eternity to return a result. A value of 5000 is good enough to stop
1.38 -stack blowup in a 2MB thread stack. Setting \fImatch_limit\fR to zero disables
1.39 +stack blowup in a 2MB thread stack. Setting \fImatch_limit\fP to zero disables
1.40 match limiting. Alternatively, you can call \fBmatch_limit_recursion()\fP
1.41 which uses PCRE_EXTRA_MATCH_LIMIT_RECURSION to limit how much PCRE
1.42 recurses. \fBmatch_limit()\fP limits the number of matches PCRE does;
1.43 @@ -207,16 +208,16 @@
1.44 therefore the amount of stack that is used.
1.45 .P
1.46 Normally, to pass one or more modifiers to a RE class, you declare
1.47 -a \fIRE_Options\fR object, set the appropriate options, and pass this
1.48 +a \fIRE_Options\fP object, set the appropriate options, and pass this
1.49 object to a RE constructor. Example:
1.50 .sp
1.51 - RE_options opt;
1.52 + RE_Options opt;
1.53 opt.set_caseless(true);
1.54 if (RE("HELLO", opt).PartialMatch("hello world")) ...
1.55 .sp
1.56 RE_options has two constructors. The default constructor takes no arguments and
1.57 creates a set of flags that are off by default. The optional parameter
1.58 -\fIoption_flags\fR is to facilitate transfer of legacy code from C programs.
1.59 +\fIoption_flags\fP is to facilitate transfer of legacy code from C programs.
1.60 This lets you do
1.61 .sp
1.62 RE(pattern,
1.63 @@ -230,13 +231,13 @@
1.64 .sp
1.65 If you are going to pass one of the most used modifiers, there are some
1.66 convenience functions that return a RE_Options class with the
1.67 -appropriate modifier already set: \fBCASELESS()\fR, \fBUTF8()\fR,
1.68 -\fBMULTILINE()\fR, \fBDOTALL\fR(), and \fBEXTENDED()\fR.
1.69 +appropriate modifier already set: \fBCASELESS()\fP, \fBUTF8()\fP,
1.70 +\fBMULTILINE()\fP, \fBDOTALL\fP(), and \fBEXTENDED()\fP.
1.71 .P
1.72 If you need to set several options at once, and you don't want to go through
1.73 the pains of declaring a RE_Options object and setting several options, there
1.74 is a parallel method that give you such ability on the fly. You can concatenate
1.75 -several \fBset_xxxxx()\fR member functions, since each of them returns a
1.76 +several \fBset_xxxxx()\fP member functions, since each of them returns a
1.77 reference to its class object. For example, to pass PCRE_CASELESS,
1.78 PCRE_EXTENDED, and PCRE_MULTILINE to a RE with one statement, you may write:
1.79 .sp
1.80 @@ -260,7 +261,7 @@
1.81 Example: read lines of the form "var = value" from a string.
1.82 string contents = ...; // Fill string somehow
1.83 pcrecpp::StringPiece input(contents); // Wrap in a StringPiece
1.84 -
1.85 +.sp
1.86 string var;
1.87 int value;
1.88 pcrecpp::RE re("(\e\ew+) = (\e\ed+)\en");
1.89 @@ -343,5 +344,5 @@
1.90 .rs
1.91 .sp
1.92 .nf
1.93 -Last updated: 17 March 2009
1.94 +Last updated: 08 January 2012
1.95 .fi