/usr/share/doc/pcre2-devel/html

Name	Size	Mode	Actions
index.html	13696	0644	edit dl rm
NON-AUTOTOOLS-BUILD.txt	17762	0644	edit dl rm
pcre2-config.html	3498	0644	edit dl rm
pcre2.html	9575	0644	edit dl rm
pcre2api.html	171917	0644	edit dl rm
pcre2build.html	24793	0644	edit dl rm
pcre2callout.html	20058	0644	edit dl rm
pcre2compat.html	10297	0644	edit dl rm
pcre2convert.html	7884	0644	edit dl rm
pcre2demo.html	20164	0644	edit dl rm
pcre2grep.html	48111	0644	edit dl rm
pcre2jit.html	20036	0644	edit dl rm
pcre2limits.html	3257	0644	edit dl rm
pcre2matching.html	10863	0644	edit dl rm
pcre2partial.html	20826	0644	edit dl rm
pcre2pattern.html	155879	0644	edit dl rm
pcre2perform.html	11852	0644	edit dl rm
pcre2posix.html	14502	0644	edit dl rm
pcre2sample.html	3905	0644	edit dl rm
pcre2serialize.html	10082	0644	edit dl rm
pcre2syntax.html	20478	0644	edit dl rm
pcre2test.html	87053	0644	edit dl rm
pcre2unicode.html	12150	0644	edit dl rm
pcre2_callout_enumerate.html	2431	0644	edit dl rm
pcre2_code_copy.html	1370	0644	edit dl rm
pcre2_code_copy_with_tables.html	1491	0644	edit dl rm
pcre2_code_free.html	1243	0644	edit dl rm
pcre2_compile.html	4318	0644	edit dl rm
pcre2_compile_context_copy.html	1176	0644	edit dl rm
pcre2_compile_context_create.html	1271	0644	edit dl rm
pcre2_compile_context_free.html	1233	0644	edit dl rm
pcre2_config.html	3575	0644	edit dl rm
pcre2_converted_pattern_free.html	1249	0644	edit dl rm
pcre2_convert_context_copy.html	1157	0644	edit dl rm
pcre2_convert_context_create.html	1251	0644	edit dl rm
pcre2_convert_context_free.html	1214	0644	edit dl rm
pcre2_dfa_match.html	3499	0644	edit dl rm
pcre2_general_context_copy.html	1225	0644	edit dl rm
pcre2_general_context_create.html	1486	0644	edit dl rm
pcre2_general_context_free.html	1172	0644	edit dl rm
pcre2_get_error_message.html	1745	0644	edit dl rm
pcre2_get_mark.html	1505	0644	edit dl rm
pcre2_get_ovector_count.html	1072	0644	edit dl rm
pcre2_get_ovector_pointer.html	1148	0644	edit dl rm
pcre2_get_startchar.html	1430	0644	edit dl rm
pcre2_jit_compile.html	1843	0644	edit dl rm
pcre2_jit_free_unused_memory.html	1327	0644	edit dl rm
pcre2_jit_match.html	2039	0644	edit dl rm
pcre2_jit_stack_assign.html	2562	0644	edit dl rm
pcre2_jit_stack_create.html	1725	0644	edit dl rm
pcre2_jit_stack_free.html	1223	0644	edit dl rm
pcre2_maketables.html	1653	0644	edit dl rm
pcre2_match.html	3577	0644	edit dl rm
pcre2_match_context_copy.html	1164	0644	edit dl rm
pcre2_match_context_create.html	1261	0644	edit dl rm
pcre2_match_context_free.html	1223	0644	edit dl rm
pcre2_match_data_create.html	1623	0644	edit dl rm
pcre2_match_data_create_from_pattern.html	1740	0644	edit dl rm
pcre2_match_data_free.html	1239	0644	edit dl rm
pcre2_pattern_convert.html	2663	0644	edit dl rm
pcre2_pattern_info.html	4801	0644	edit dl rm
pcre2_serialize_decode.html	2547	0644	edit dl rm
pcre2_serialize_encode.html	2721	0644	edit dl rm
pcre2_serialize_free.html	1187	0644	edit dl rm
pcre2_serialize_get_number_of_codes.html	1634	0644	edit dl rm
pcre2_set_bsr.html	1199	0644	edit dl rm
pcre2_set_callout.html	1276	0644	edit dl rm
pcre2_set_character_tables.html	1235	0644	edit dl rm
pcre2_set_compile_extra_options.html	1513	0644	edit dl rm
pcre2_set_compile_recursion_guard.html	1664	0644	edit dl rm
pcre2_set_depth_limit.html	1080	0644	edit dl rm
pcre2_set_glob_escape.html	1365	0644	edit dl rm
pcre2_set_glob_separator.html	1336	0644	edit dl rm
pcre2_set_heap_limit.html	1076	0644	edit dl rm
pcre2_set_match_limit.html	1067	0644	edit dl rm
pcre2_set_max_pattern_length.html	1336	0644	edit dl rm
pcre2_set_newline.html	1566	0644	edit dl rm
pcre2_set_offset_limit.html	1073	0644	edit dl rm
pcre2_set_parens_nest_limit.html	1122	0644	edit dl rm
pcre2_set_recursion_limit.html	1097	0644	edit dl rm
pcre2_set_recursion_memory_management.html	1245	0644	edit dl rm
pcre2_substitute.html	4084	0644	edit dl rm
pcre2_substring_copy_byname.html	2059	0644	edit dl rm
pcre2_substring_copy_bynumber.html	1860	0644	edit dl rm
pcre2_substring_free.html	1196	0644	edit dl rm
pcre2_substring_get_byname.html	2187	0644	edit dl rm
pcre2_substring_get_bynumber.html	2023	0644	edit dl rm
pcre2_substring_length_byname.html	1364	0644	edit dl rm
pcre2_substring_length_bynumber.html	1518	0644	edit dl rm
pcre2_substring_list_free.html	1211	0644	edit dl rm
pcre2_substring_list_get.html	2136	0644	edit dl rm
pcre2_substring_nametable_scan.html	1845	0644	edit dl rm
pcre2_substring_number_from_name.html	1645	0644	edit dl rm
README.txt	41975	0644	edit dl rm

Edit: /usr/share/doc/pcre2-devel/html/pcre2_compile.html (4318B)

<html>
<head>
<title>pcre2_compile specification</title>
</head>
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
<h1>pcre2_compile man page</h1>

Return to the <a href="index.html">PCRE2 index page</a>.


This page is part of the PCRE2 HTML documentation. It was generated
automatically from the original man page. If there is any nonsense in it,
please consult the man page, in case the conversion went wrong.
 
 
SYNOPSIS
 

#include &#60;pcre2.h&#62;


pcre2_code *pcre2_compile(PCRE2_SPTR pattern, PCRE2_SIZE length,
 uint32_t options, int *errorcode, PCRE2_SIZE *erroroffset,
 pcre2_compile_context *ccontext);

 
DESCRIPTION
 

This function compiles a regular expression pattern into an internal form. Its
arguments are:
<pre>
 pattern A string containing expression to be compiled
 length The length of the string or PCRE2_ZERO_TERMINATED
 options Option bits
 errorcode Where to put an error code
 erroffset Where to put an error offset
 ccontext Pointer to a compile context or NULL
</pre>
The length of the pattern and any error offset that is returned are in code
units, not characters. A compile context is needed only if you want to provide
custom memory allocation functions, or to provide an external function for
system stack size checking, or to change one or more of these parameters:
<pre>
 What \R matches (Unicode newlines, or CR, LF, CRLF only);
 PCRE2's character tables;
 The newline character sequence;
 The compile time nested parentheses limit;
 The maximum pattern length (in code units) that is allowed.
 The additional options bits (see pcre2_set_compile_extra_options())
</pre>
The option bits are:
<pre>
 PCRE2_ANCHORED Force pattern anchoring
 PCRE2_ALLOW_EMPTY_CLASS Allow empty classes
 PCRE2_ALT_BSUX Alternative handling of \u, \U, and \x
 PCRE2_ALT_CIRCUMFLEX Alternative handling of ^ in multiline mode
 PCRE2_ALT_VERBNAMES Process backslashes in verb names
 PCRE2_AUTO_CALLOUT Compile automatic callouts
 PCRE2_CASELESS Do caseless matching
 PCRE2_DOLLAR_ENDONLY $ not to match newline at end
 PCRE2_DOTALL . matches anything including NL
 PCRE2_DUPNAMES Allow duplicate names for subpatterns
 PCRE2_ENDANCHORED Pattern can match only at end of subject
 PCRE2_EXTENDED Ignore white space and # comments
 PCRE2_FIRSTLINE Force matching to be before newline
 PCRE2_LITERAL Pattern characters are all literal
 PCRE2_MATCH_UNSET_BACKREF Match unset backreferences
 PCRE2_MULTILINE ^ and $ match newlines within data
 PCRE2_NEVER_BACKSLASH_C Lock out the use of \C in patterns
 PCRE2_NEVER_UCP Lock out PCRE2_UCP, e.g. via (*UCP)
 PCRE2_NEVER_UTF Lock out PCRE2_UTF, e.g. via (*UTF)
 PCRE2_NO_AUTO_CAPTURE Disable numbered capturing paren-
 theses (named ones available)
 PCRE2_NO_AUTO_POSSESS Disable auto-possessification
 PCRE2_NO_DOTSTAR_ANCHOR Disable automatic anchoring for .*
 PCRE2_NO_START_OPTIMIZE Disable match-time start optimizations
 PCRE2_NO_UTF_CHECK Do not check the pattern for UTF validity
 (only relevant if PCRE2_UTF is set)
 PCRE2_UCP Use Unicode properties for \d, \w, etc.
 PCRE2_UNGREEDY Invert greediness of quantifiers
 PCRE2_USE_OFFSET_LIMIT Enable offset limit for unanchored matching
 PCRE2_UTF Treat pattern and subjects as UTF strings
</pre>
PCRE2 must be built with Unicode support (the default) in order to use
PCRE2_UTF, PCRE2_UCP and related options.


The yield of the function is a pointer to a private data structure that
contains the compiled pattern, or NULL if an error was detected.


There is a complete description of the PCRE2 native API, with more detail on
each option, in the
<a href="pcre2api.html">pcre2api</a>
page, and a description of the POSIX API in the
<a href="pcre2posix.html">pcre2posix</a>
page.

Return to the <a href="index.html">PCRE2 index page</a>.

pcre2_compile specification

pcre2_compile man page

Return to the PCRE2 index page.

This page is part of the PCRE2 HTML documentation. It was generated automatically from the original man page. If there is any nonsense in it, please consult the man page, in case the conversion went wrong.

SYNOPSIS

#include <pcre2.h>

pcre2_code *pcre2_compile(PCRE2_SPTR pattern, PCRE2_SIZE length, uint32_t options, int *errorcode, PCRE2_SIZE *erroroffset, pcre2_compile_context *ccontext);

DESCRIPTION

This function compiles a regular expression pattern into an internal form. Its arguments are:

  pattern       A string containing expression to be compiled
  length        The length of the string or PCRE2_ZERO_TERMINATED
  options       Option bits
  errorcode     Where to put an error code
  erroffset     Where to put an error offset
  ccontext      Pointer to a compile context or NULL

The length of the pattern and any error offset that is returned are in code units, not characters. A compile context is needed only if you want to provide custom memory allocation functions, or to provide an external function for system stack size checking, or to change one or more of these parameters:

  What \R matches (Unicode newlines, or CR, LF, CRLF only);
  PCRE2's character tables;
  The newline character sequence;
  The compile time nested parentheses limit;
  The maximum pattern length (in code units) that is allowed.
  The additional options bits (see pcre2_set_compile_extra_options())

The option bits are:

  PCRE2_ANCHORED           Force pattern anchoring
  PCRE2_ALLOW_EMPTY_CLASS  Allow empty classes
  PCRE2_ALT_BSUX           Alternative handling of \u, \U, and \x
  PCRE2_ALT_CIRCUMFLEX     Alternative handling of ^ in multiline mode
  PCRE2_ALT_VERBNAMES      Process backslashes in verb names
  PCRE2_AUTO_CALLOUT       Compile automatic callouts
  PCRE2_CASELESS           Do caseless matching
  PCRE2_DOLLAR_ENDONLY     $ not to match newline at end
  PCRE2_DOTALL             . matches anything including NL
  PCRE2_DUPNAMES           Allow duplicate names for subpatterns
  PCRE2_ENDANCHORED        Pattern can match only at end of subject
  PCRE2_EXTENDED           Ignore white space and # comments
  PCRE2_FIRSTLINE          Force matching to be before newline
  PCRE2_LITERAL            Pattern characters are all literal
  PCRE2_MATCH_UNSET_BACKREF  Match unset backreferences
  PCRE2_MULTILINE          ^ and $ match newlines within data
  PCRE2_NEVER_BACKSLASH_C  Lock out the use of \C in patterns
  PCRE2_NEVER_UCP          Lock out PCRE2_UCP, e.g. via (*UCP)
  PCRE2_NEVER_UTF          Lock out PCRE2_UTF, e.g. via (*UTF)
  PCRE2_NO_AUTO_CAPTURE    Disable numbered capturing paren-
                            theses (named ones available)
  PCRE2_NO_AUTO_POSSESS    Disable auto-possessification
  PCRE2_NO_DOTSTAR_ANCHOR  Disable automatic anchoring for .*
  PCRE2_NO_START_OPTIMIZE  Disable match-time start optimizations
  PCRE2_NO_UTF_CHECK       Do not check the pattern for UTF validity
                             (only relevant if PCRE2_UTF is set)
  PCRE2_UCP                Use Unicode properties for \d, \w, etc.
  PCRE2_UNGREEDY           Invert greediness of quantifiers
  PCRE2_USE_OFFSET_LIMIT   Enable offset limit for unanchored matching
  PCRE2_UTF                Treat pattern and subjects as UTF strings

PCRE2 must be built with Unicode support (the default) in order to use PCRE2_UTF, PCRE2_UCP and related options.

The yield of the function is a pointer to a private data structure that contains the compiled pattern, or NULL if an error was detected.

There is a complete description of the PCRE2 native API, with more detail on each option, in the pcre2api page, and a description of the POSIX API in the pcre2posix page.

Return to the PCRE2 index page.