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.
pcre2 | Introductory page |
pcre-2config | Information about the installation configuration |
pcre2api | PCRE2's native API |
pcre2build | Building PCRE2 |
pcre2callout | The callout facility |
pcre2compat | Compability with Perl |
pcre2demo | A demonstration C program that uses the PCRE2 library |
pcre2grep | The pcre2grep command |
pcre2jit | Discussion of the just-in-time optimization support |
pcre2limits | Details of size and other limits |
pcre2matching | Discussion of the two matching algorithms |
pcre2partial | Using PCRE2 for partial matching |
pcre2pattern | Specification of the regular expressions supported by PCRE2 |
pcre2perform | Some comments on performance |
pcre2posix | The POSIX API to the PCRE2 8-bit library |
pcre2sample | Discussion of the pcre2demo program |
pcre2stack | Discussion of PCRE2's stack usage |
pcre2syntax | Syntax quick-reference summary |
pcre2test | The pcre2test command for testing PCRE2 |
pcre2unicode | 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.
pcre2_code_free | Free a compiled pattern |
pcre2_compile | Compile a regular expression pattern |
pcre2_compile2 | Compile a regular expression (alternate interface) |
pcre2_config | Show build-time configuration options |
pcre2_dfa_match | Match a compiled pattern to a subject string (DFA algorithm; not Perl compatible) |
pcre2_get_error_message | Free study data |
pcre2_jit_compile | Process a compiled pattern with the JIT compiler |
pcre2_jit_match | Fast path interface to JIT matching |
pcre2_jit_stack_alloc | Create a stack for JIT matching |
pcre2_jit_stack_assign | Assign stack for JIT matching |
pcre2_jit_stack_free | Free a JIT matching stack |
pcre2_maketables | Build character tables in current locale |
pcre2_match | Match a compiled pattern to a subject string (Perl compatible) |
pcre2_pattern_info | Extract information about a pattern |
pcre2_substring_copy_byname | Extract named substring into given buffer |
pcre2_substring_copy_bynumber | Extract numbered substring into given buffer |
pcre2_substring_free | Free extracted substring |
pcre2_substring_get_byname | Extract named substring into new memory |
pcre2_substring_get_bynumber | Extract numbered substring into new memory |
pcre2_substring_length_byname | Find length of named substring |
pcre2_substring_length_bynumber | Find length of numbered substring |
pcre2_substring_list_free | Free list of extracted substrings |
pcre2_substring_list_get | Extract all substrings into new memory |
pcre2_substring_nametable_scan | Find table entries for given string name |
pcre2_substring_number_from_name | Convert captured string name to number |