new upstream release (3.3.0); modify package compatibility for Stretch
[ossec-hids.git] / src / external / pcre2-10.32 / doc / pcre2_set_compile_extra_options.3
1 .TH PCRE2_SET_COMPILE_EXTRA_OPTIONS 3 "16 June 2017" "PCRE2 10.30"
2 .SH NAME
3 PCRE2 - Perl-compatible regular expressions (revised API)
4 .SH SYNOPSIS
5 .rs
6 .sp
7 .B #include <pcre2.h>
8 .PP
9 .nf
10 .B int pcre2_set_compile_extra_options(pcre2_compile_context *\fIccontext\fP,
11 .B "  PCRE2_SIZE \fIextra_options\fP);"
12 .fi
13 .
14 .SH DESCRIPTION
15 .rs
16 .sp
17 This function sets additional option bits for \fBpcre2_compile()\fP that are
18 housed in a compile context. It completely replaces all the bits. The extra
19 options are:
20 .sp
21 .\" JOIN
22   PCRE2_EXTRA_ALLOW_SURROGATE_ESCAPES  Allow \ex{df800} to \ex{dfff}
23                                          in UTF-8 and UTF-32 modes
24 .\" JOIN
25   PCRE2_EXTRA_BAD_ESCAPE_IS_LITERAL    Treat all invalid escapes as
26                                          a literal following character
27   PCRE2_EXTRA_MATCH_LINE               Pattern matches whole lines
28   PCRE2_EXTRA_MATCH_WORD               Pattern matches "words"
29 .sp
30 There is a complete description of the PCRE2 native API in the
31 .\" HREF
32 \fBpcre2api\fP
33 .\"
34 page and a description of the POSIX API in the
35 .\" HREF
36 \fBpcre2posix\fP
37 .\"
38 page.