From 12d3f3b9e62ea2c83840d8201d117bf64491bf6d Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Tue, 23 Oct 2018 22:27:39 +0200
Subject: Add man pages for strn[case]chr[nul] and strrn[case]chr
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@kth.se>
---
 man/libsimple_strnchr.3 | 86 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 86 insertions(+)
 create mode 100644 man/libsimple_strnchr.3

(limited to 'man/libsimple_strnchr.3')

diff --git a/man/libsimple_strnchr.3 b/man/libsimple_strnchr.3
new file mode 100644
index 0000000..86a5583
--- /dev/null
+++ b/man/libsimple_strnchr.3
@@ -0,0 +1,86 @@
+.TH LIBSIMPLE_STRNCHR 3 2018-10-23 libsimple
+.SH NAME
+libsimple_strnchr \- find a character in a string
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+char *libsimple_strnchr(const char *\fIs\fP, int \fIc\fP, size_t \fIn\fP);
+
+#ifndef strnchr
+# define strnchr libsimple_strnchr
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_strnchr ()
+function scans the string
+.IR s ,
+truncated to
+.I n
+bytes unless it is shorter,
+for the first occurence of the character
+.I c
+(it is converted to a
+.BR char ).
+If no such character exist in the string,
+the string's end is returned.
+.PP
+The comparison is case-sensitive.
+.SH RETURN VALUE
+The
+.BR libsimple_strnchr ()
+function returns the pointer
+.I s
+with a minimal offset such that
+.IR *r==c ,
+where
+.I r
+is the returned pointer, if no such
+offset less than
+.I n
+exists, it returns
+.IR NULL .
+.SH ERRORS
+The
+.BR libsimple_strnchr ()
+function cannot fail.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lb lb lb
+l l l.
+Interface	Attribute	Value
+T{
+.BR libsimple_strnchr ()
+T}	Thread safety	MT-Safe
+T{
+.BR libsimple_strnchr ()
+T}	Async-signal safety	AS-Safe
+T{
+.BR libsimple_strnchr ()
+T}	Async-cancel safety	AC-Safe
+.TE
+.SH EXAMPLES
+None.
+.SH APPLICATION USAGE
+None.
+.SH RATIONALE
+None.
+.SH FUTURE DIRECTIONS
+None.
+.SH NOTES
+None.
+.SH BUGS
+None.
+.SH SEE ALSO
+.BR libsimple_strnchrnul (3),
+.BR libsimple_strncasechr (3),
+.BR libsimple_strrnchr (3)
+.BR strchr (3),
+.BR memchr (3),
-- 
cgit v1.2.3-70-g09d2