← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/pcre3/oneiric

« back to all changes in this revision

Viewing changes to doc/pcre_compile.3

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2011-01-25 12:25:05 UTC
  • mfrom: (1.1.10 upstream)
  • Revision ID: james.westby@ubuntu.com-20110125122505-poii7htffw5ctwdy
Tags: 8.12-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/pcre_compile.3
20
20
same as \fBpcre_compile2()\fP, except for the absence of the \fIerrorcodeptr\fP
21
21
argument. Its arguments are:
22
22
.sp
23
 
  \fIpattern\fR       A zero-terminated string containing the
 
23
  \fIpattern\fP       A zero-terminated string containing the
24
24
                  regular expression to be compiled
25
 
  \fIoptions\fR       Zero or more option bits
26
 
  \fIerrptr\fR        Where to put an error message
27
 
  \fIerroffset\fR     Offset in pattern where error was found
28
 
  \fItableptr\fR      Pointer to character tables, or NULL to
 
25
  \fIoptions\fP       Zero or more option bits
 
26
  \fIerrptr\fP        Where to put an error message
 
27
  \fIerroffset\fP     Offset in pattern where error was found
 
28
  \fItableptr\fP      Pointer to character tables, or NULL to
29
29
                  use the built-in default
30
30
.sp
31
31
The option bits are:
55
55
  PCRE_NO_UTF8_CHECK      Do not check the pattern for UTF-8
56
56
                            validity (only relevant if
57
57
                            PCRE_UTF8 is set)
 
58
  PCRE_UCP                Use Unicode properties for \ed, \ew, etc.
58
59
  PCRE_UNGREEDY           Invert greediness of quantifiers
59
60
  PCRE_UTF8               Run in UTF-8 mode
60
61
.sp
61
62
PCRE must be built with UTF-8 support in order to use PCRE_UTF8 and
62
 
PCRE_NO_UTF8_CHECK.
 
63
PCRE_NO_UTF8_CHECK, and with UCP support if PCRE_UCP is used.
63
64
.P
64
65
The yield of the function is a pointer to a private data structure that
65
66
contains the compiled pattern, or NULL if an error was detected. Note that
68
69
.P
69
70
There is a complete description of the PCRE native API in the
70
71
.\" HREF
71
 
\fBpcreapi\fR
 
72
\fBpcreapi\fP
72
73
.\"
73
74
page and a description of the POSIX API in the
74
75
.\" HREF
75
 
\fBpcreposix\fR
 
76
\fBpcreposix\fP
76
77
.\"
77
78
page.