+++ /dev/null
-<HTML>\r
-<HEAD>\r
-<TITLE>pcreposix specification</TITLE>\r
-</HEAD>\r
-<body bgcolor="#FFFFFF" text="#00005A">\r
-<H1>pcreposix specification</H1>\r
-This HTML document has been generated automatically from the original man page.\r
-If there is any nonsense in it, please consult the man page in case the\r
-conversion went wrong.\r
-<UL>\r
-<LI><A NAME="TOC1" HREF="#SEC1">NAME</A>\r
-<LI><A NAME="TOC2" HREF="#SEC2">SYNOPSIS</A>\r
-<LI><A NAME="TOC3" HREF="#SEC3">DESCRIPTION</A>\r
-<LI><A NAME="TOC4" HREF="#SEC4">COMPILING A PATTERN</A>\r
-<LI><A NAME="TOC5" HREF="#SEC5">MATCHING A PATTERN</A>\r
-<LI><A NAME="TOC6" HREF="#SEC6">ERROR MESSAGES</A>\r
-<LI><A NAME="TOC7" HREF="#SEC7">STORAGE</A>\r
-<LI><A NAME="TOC8" HREF="#SEC8">AUTHOR</A>\r
-</UL>\r
-<LI><A NAME="SEC1" HREF="#TOC1">NAME</A>\r
-<P>\r
-pcreposix - POSIX API for Perl-compatible regular expressions.\r
-</P>\r
-<LI><A NAME="SEC2" HREF="#TOC1">SYNOPSIS</A>\r
-<P>\r
-<B>#include <pcreposix.h></B>\r
-</P>\r
-<P>\r
-<B>int regcomp(regex_t *<I>preg</I>, const char *<I>pattern</I>,</B>\r
-<B>int <I>cflags</I>);</B>\r
-</P>\r
-<P>\r
-<B>int regexec(regex_t *<I>preg</I>, const char *<I>string</I>,</B>\r
-<B>size_t <I>nmatch</I>, regmatch_t <I>pmatch</I>[], int <I>eflags</I>);</B>\r
-</P>\r
-<P>\r
-<B>size_t regerror(int <I>errcode</I>, const regex_t *<I>preg</I>,</B>\r
-<B>char *<I>errbuf</I>, size_t <I>errbuf_size</I>);</B>\r
-</P>\r
-<P>\r
-<B>void regfree(regex_t *<I>preg</I>);</B>\r
-</P>\r
-<LI><A NAME="SEC3" HREF="#TOC1">DESCRIPTION</A>\r
-<P>\r
-This set of functions provides a POSIX-style API to the PCRE regular expression\r
-package. See the <B>pcre</B> documentation for a description of the native API,\r
-which contains additional functionality.\r
-</P>\r
-<P>\r
-The functions described here are just wrapper functions that ultimately call\r
-the native API. Their prototypes are defined in the <B>pcreposix.h</B> header\r
-file, and on Unix systems the library itself is called <B>pcreposix.a</B>, so\r
-can be accessed by adding <B>-lpcreposix</B> to the command for linking an\r
-application which uses them. Because the POSIX functions call the native ones,\r
-it is also necessary to add \fR-lpcre\fR.\r
-</P>\r
-<P>\r
-I have implemented only those option bits that can be reasonably mapped to PCRE\r
-native options. In addition, the options REG_EXTENDED and REG_NOSUB are defined\r
-with the value zero. They have no effect, but since programs that are written\r
-to the POSIX interface often use them, this makes it easier to slot in PCRE as\r
-a replacement library. Other POSIX options are not even defined.\r
-</P>\r
-<P>\r
-When PCRE is called via these functions, it is only the API that is POSIX-like\r
-in style. The syntax and semantics of the regular expressions themselves are\r
-still those of Perl, subject to the setting of various PCRE options, as\r
-described below.\r
-</P>\r
-<P>\r
-The header for these functions is supplied as <B>pcreposix.h</B> to avoid any\r
-potential clash with other POSIX libraries. It can, of course, be renamed or\r
-aliased as <B>regex.h</B>, which is the "correct" name. It provides two\r
-structure types, <I>regex_t</I> for compiled internal forms, and\r
-<I>regmatch_t</I> for returning captured substrings. It also defines some\r
-constants whose names start with "REG_"; these are used for setting options and\r
-identifying error codes.\r
-</P>\r
-<LI><A NAME="SEC4" HREF="#TOC1">COMPILING A PATTERN</A>\r
-<P>\r
-The function <B>regcomp()</B> is called to compile a pattern into an\r
-internal form. The pattern is a C string terminated by a binary zero, and\r
-is passed in the argument <I>pattern</I>. The <I>preg</I> argument is a pointer\r
-to a regex_t structure which is used as a base for storing information about\r
-the compiled expression.\r
-</P>\r
-<P>\r
-The argument <I>cflags</I> is either zero, or contains one or more of the bits\r
-defined by the following macros:\r
-</P>\r
-<P>\r
-<PRE>\r
- REG_ICASE\r
-</PRE>\r
-</P>\r
-<P>\r
-The PCRE_CASELESS option is set when the expression is passed for compilation\r
-to the native function.\r
-</P>\r
-<P>\r
-<PRE>\r
- REG_NEWLINE\r
-</PRE>\r
-</P>\r
-<P>\r
-The PCRE_MULTILINE option is set when the expression is passed for compilation\r
-to the native function.\r
-</P>\r
-<P>\r
-In the absence of these flags, no options are passed to the native function.\r
-This means the the regex is compiled with PCRE default semantics. In\r
-particular, the way it handles newline characters in the subject string is the\r
-Perl way, not the POSIX way. Note that setting PCRE_MULTILINE has only\r
-<I>some</I> of the effects specified for REG_NEWLINE. It does not affect the way\r
-newlines are matched by . (they aren't) or a negative class such as [^a] (they\r
-are).\r
-</P>\r
-<P>\r
-The yield of <B>regcomp()</B> is zero on success, and non-zero otherwise. The\r
-<I>preg</I> structure is filled in on success, and one member of the structure\r
-is publicized: <I>re_nsub</I> contains the number of capturing subpatterns in\r
-the regular expression. Various error codes are defined in the header file.\r
-</P>\r
-<LI><A NAME="SEC5" HREF="#TOC1">MATCHING A PATTERN</A>\r
-<P>\r
-The function <B>regexec()</B> is called to match a pre-compiled pattern\r
-<I>preg</I> against a given <I>string</I>, which is terminated by a zero byte,\r
-subject to the options in <I>eflags</I>. These can be:\r
-</P>\r
-<P>\r
-<PRE>\r
- REG_NOTBOL\r
-</PRE>\r
-</P>\r
-<P>\r
-The PCRE_NOTBOL option is set when calling the underlying PCRE matching\r
-function.\r
-</P>\r
-<P>\r
-<PRE>\r
- REG_NOTEOL\r
-</PRE>\r
-</P>\r
-<P>\r
-The PCRE_NOTEOL option is set when calling the underlying PCRE matching\r
-function.\r
-</P>\r
-<P>\r
-The portion of the string that was matched, and also any captured substrings,\r
-are returned via the <I>pmatch</I> argument, which points to an array of\r
-<I>nmatch</I> structures of type <I>regmatch_t</I>, containing the members\r
-<I>rm_so</I> and <I>rm_eo</I>. These contain the offset to the first character of\r
-each substring and the offset to the first character after the end of each\r
-substring, respectively. The 0th element of the vector relates to the entire\r
-portion of <I>string</I> that was matched; subsequent elements relate to the\r
-capturing subpatterns of the regular expression. Unused entries in the array\r
-have both structure members set to -1.\r
-</P>\r
-<P>\r
-A successful match yields a zero return; various error codes are defined in the\r
-header file, of which REG_NOMATCH is the "expected" failure code.\r
-</P>\r
-<LI><A NAME="SEC6" HREF="#TOC1">ERROR MESSAGES</A>\r
-<P>\r
-The <B>regerror()</B> function maps a non-zero errorcode from either\r
-<B>regcomp</B> or <B>regexec</B> to a printable message. If <I>preg</I> is not\r
-NULL, the error should have arisen from the use of that structure. A message\r
-terminated by a binary zero is placed in <I>errbuf</I>. The length of the\r
-message, including the zero, is limited to <I>errbuf_size</I>. The yield of the\r
-function is the size of buffer needed to hold the whole message.\r
-</P>\r
-<LI><A NAME="SEC7" HREF="#TOC1">STORAGE</A>\r
-<P>\r
-Compiling a regular expression causes memory to be allocated and associated\r
-with the <I>preg</I> structure. The function <B>regfree()</B> frees all such\r
-memory, after which <I>preg</I> may no longer be used as a compiled expression.\r
-</P>\r
-<LI><A NAME="SEC8" HREF="#TOC1">AUTHOR</A>\r
-<P>\r
-Philip Hazel <ph10@cam.ac.uk>\r
-<BR>\r
-University Computing Service,\r
-<BR>\r
-New Museums Site,\r
-<BR>\r
-Cambridge CB2 3QG, England.\r
-<BR>\r
-Phone: +44 1223 334714\r
-</P>\r
-<P>\r
-Copyright (c) 1997-2000 University of Cambridge.\r
projects / privoxy.git / blobdiff