blob: 0dcc8de86d764c3af019f9bbd76c74648c43450b [file] [log] [blame]
Elliott Hughes5b808042021-10-01 10:56:10 -07001.TH PCRE2_SET_COMPILE_EXTRA_OPTIONS 3 "31 August 2021" "PCRE2 10.38"
2.SH NAME
3PCRE2 - 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 " uint32_t \fIextra_options\fP);"
12.fi
13.
14.SH DESCRIPTION
15.rs
16.sp
17This function sets additional option bits for \fBpcre2_compile()\fP that are
18housed in a compile context. It completely replaces all the bits. The extra
19options are:
20.sp
Elliott Hughes5b808042021-10-01 10:56:10 -070021 PCRE2_EXTRA_ALLOW_LOOKAROUND_BSK Allow \eK in lookarounds
Elliott Hughes4e19c8e2022-04-15 15:11:02 -070022.\" JOIN
23 PCRE2_EXTRA_ALLOW_SURROGATE_ESCAPES Allow \ex{d800} to \ex{dfff}
Elliott Hughes5b808042021-10-01 10:56:10 -070024 in UTF-8 and UTF-32 modes
25.\" JOIN
26 PCRE2_EXTRA_ALT_BSUX Extended alternate \eu, \eU, and
27 \ex handling
28.\" JOIN
29 PCRE2_EXTRA_BAD_ESCAPE_IS_LITERAL Treat all invalid escapes as
30 a literal following character
31 PCRE2_EXTRA_ESCAPED_CR_IS_LF Interpret \er as \en
32 PCRE2_EXTRA_MATCH_LINE Pattern matches whole lines
33 PCRE2_EXTRA_MATCH_WORD Pattern matches "words"
34.sp
35There is a complete description of the PCRE2 native API in the
36.\" HREF
37\fBpcre2api\fP
38.\"
39page and a description of the POSIX API in the
40.\" HREF
41\fBpcre2posix\fP
42.\"
43page.