Manual pages
The HTML documentation for PCRE2 consists of a number of pages that are listed below in alphabetical order. If you are new to PCRE2, please read the first one first.
Introductory page | |
Information about the installation configuration | |
PCRE2’s native API | |
Building PCRE2 | |
The callout facility | |
Compatibility with Perl | |
Experimental foreign pattern conversion functions | |
A demonstration C program that uses the PCRE2 library | |
The | |
Discussion of the just-in-time optimization support | |
Details of size and other limits | |
Discussion of the two matching algorithms | |
Using PCRE2 for partial matching | |
Specification of the regular expressions supported by PCRE2 | |
Some comments on performance | |
The POSIX API to the PCRE2 8-bit library | |
Discussion of the pcre2demo program | |
Serializing functions for saving precompiled patterns | |
Syntax quick-reference summary | |
The | |
Discussion of Unicode and UTF-8/UTF-16/UTF-32 support |
There are also individual pages that summarize the interface for each function in the library.
Enumerate callouts in a compiled pattern | |
Copy a compiled pattern | |
Copy a compiled pattern and its character tables | |
Free a compiled pattern | |
Compile a regular expression pattern | |
Copy a compile context | |
Create a compile context | |
Free a compile context | |
Show build-time related configuration options | |
Copy a convert context | |
Create a convert context | |
Free a convert context | |
Free converted foreign pattern | |
Match a compiled pattern to a subject string using the alternative matching algorithm (DFA algorithm; not Perl compatible) | |
Copy a general context | |
Create a general context | |
Free a general context | |
Get the \R convention | |
Get the match backtracking depth limit | |
Get textual error message for error number | |
Get the match backtracking heap limit | |
Get a (*MARK) name | |
Get the size of match data heapframes | |
Get the size of a match data block | |
Get the match limit | |
Get the maximum length of a pattern | |
Get the newline convention | |
Get the offset limit | |
Get the ovector count | |
Get a pointer to the ovector | |
Get the parentheses nesting limit | |
Get the starting character offset | |
Get a match subject pointer | |
Process a compiled pattern with the JIT compiler | |
Free unused JIT memory | |
Fast path interface to JIT matching | |
Assign stack for JIT matching | |
Create a stack for JIT matching | |
Free a JIT matching stack | |
Build character tables in current locale | |
Free character tables | |
Match a compiled pattern to a subject string (Perl compatible) | |
Copy a match context | |
Create a match context | |
Free a match context | |
Create a match data block | |
Create a match data block getting size from pattern | |
Free a match data block | |
Get the match parameters for the next match | |
Foreign pattern converter | |
Extract information about a pattern | |
Decode serialized compiled patterns | |
Serialize compiled patterns for save/restore | |
Free serialized compiled patterns | |
Get number of serialized compiled patterns | |
Set \R convention | |
Set up a callout function | |
Set character tables | |
Set compile time extra options | |
Set up a compile recursion guard function | |
Set the match backtracking depth limit | |
Set glob escape character | |
Set glob separator character | |
Set the match backtracking heap limit | |
Set the match limit | |
Set the maximum length of a compiled pattern | |
Set the maximum length of a pattern | |
Set the maximum match length for a variable-length lookbehind | |
Set the newline convention | |
Set the offset limit | |
Set an optimization directive | |
Set the parentheses nesting limit | |
Obsolete function; use pcre2_set_depth_limit | |
Obsolete function that does nothing | |
Set a substitution callout function | |
Set a substitution case callout function | |
Replace matched substrings | |
Extract named substring into given buffer | |
Extract numbered substring into given buffer | |
Free extracted substring | |
Extract named substring into new memory | |
Extract numbered substring into new memory | |
Find length of named substring | |
Find length of numbered substring | |
Free list of extracted substrings | |
Extract all substrings into new memory | |
Find table entries for given string name | |
Convert captured string name to number |