diff options
author | ph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069> | 2014-10-25 14:16:46 +0000 |
---|---|---|
committer | ph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069> | 2014-10-25 14:16:46 +0000 |
commit | 8751e9ed6abf7a63f3a207e711138abca34fb72a (patch) | |
tree | 1c708c3e04dac629e1b9f29cc12f1b6d4753fa07 /doc/pcre2_set_newline.3 | |
parent | 65f57acf6b8b2a5eb96890ffa6e68eccd0142192 (diff) | |
download | pcre2-8751e9ed6abf7a63f3a207e711138abca34fb72a.tar.gz |
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
Diffstat (limited to 'doc/pcre2_set_newline.3')
-rw-r--r-- | doc/pcre2_set_newline.3 | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/pcre2_set_newline.3 b/doc/pcre2_set_newline.3 new file mode 100644 index 0000000..8237500 --- /dev/null +++ b/doc/pcre2_set_newline.3 @@ -0,0 +1,38 @@ +.TH PCRE2_SET_NEWLINE 3 "22 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 int pcre2_set_newline(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIvalue\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function sets the newline convention within a compile context. This +specifies which character(s) are recognized as newlines when compiling and +matching patterns. The second argument must be one of: +.sp + PCRE2_NEWLINE_CR Carriage return only + PCRE2_NEWLINE_LF Linefeed only + PCRE2_NEWLINE_CRLF CR followed by LF only + PCRE2_NEWLINE_ANYCRLF Any of the above + PCRE2_NEWLINE_ANY Any Unicode newline sequence +.sp +The result is zero for success or PCRE2_ERROR_BADDATA if the second argument is +invalid. +.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. |