More per-function documentation; revised perltest.sh replaces perltest.pl.

git-svn-id: svn://vcs.exim.org/pcre2/code/trunk@122 6239d852-aaf2-0410-a92c-79f79f948069

1 files changed, 30 insertions, 0 deletions

diff --git a/doc/pcre2_get_startchar.3 b/doc/pcre2_get_startchar.3
new file mode 100644
index 0000000..203ab93
--- /dev/null
+++ b/doc/pcre2_get_startchar.3
@@ -0,0 +1,30 @@
+.TH PCRE2_GET_STARTCHAR 3 "24 October 2014" "PCRE2 10.00"
+.SH NAME
+PCRE2 - Perl-compatible regular expressions (revised API)
+.SH SYNOPSIS
+.rs
+.sp
+.B #include <pcre2.h>
+.PP
+.nf
+.B PCRE2_SIZE pcre2_get_startchar(pcre2_match_data *\fImatch_data\fP);
+.fi
+.
+.SH DESCRIPTION
+.rs
+.sp
+After a successful call of \fBpcre2_match()\fP that was passed the match block
+that is this function's argument, this function returns the code unit offset of
+the character at which the successful match started. This can be different to
+the value of \fIovector[0]\fP if the pattern contains the \eK escape sequence.
+Note, however, that \eK has no effect for a partial match.
+.P
+There is a complete description of the PCRE2 native API in the
+.\" HREF
+\fBpcre2api\fP
+.\"
+page and a description of the POSIX API in the
+.\" HREF
+\fBpcre2posix\fP
+.\"
+page.