From 3c0482dac1b7a4c1195beacbef811711392572dd Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Tue, 23 Oct 2018 21:22:10 +0200
Subject: Add man pages for str[r]n[case]str
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_strnstr.3 | 82 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 82 insertions(+)
 create mode 100644 man/libsimple_strnstr.3

(limited to 'man/libsimple_strnstr.3')

diff --git a/man/libsimple_strnstr.3 b/man/libsimple_strnstr.3
new file mode 100644
index 0000000..dca50bb
--- /dev/null
+++ b/man/libsimple_strnstr.3
@@ -0,0 +1,82 @@
+.TH LIBSIMPLE_STRNSTR 3 2018-10-23 libsimple
+.SH NAME
+libsimple_strnstr \- find a substring in a string
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+char *libsimple_strnstr(const char *\fIhaystack\fP, const char *\fIneedle\fP, size_t \fIn\fP);
+
+#ifndef strnstr
+# define strnstr libsimple_strnstr
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_strnstr ()
+function scans the string
+.IR haystack ,
+truncated to
+.I n
+bytes unless it is shorter,
+the first occurrence of the substring
+.IR needle .
+.PP
+The comparison is case-sensitive.
+.SH RETURN VALUE
+The
+.BR libsimple_strnstr ()
+function returns the pointer
+.I haystack
+with a minimal offset such that
+.I r
+begins with
+.IR needle ,
+where
+.I r
+is the returned pointer.
+If no such offset exists,
+.B NULL
+is returned.
+.SH ERRORS
+The
+.BR libsimple_strnstr ()
+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_strnstr ()
+T}	Thread safety	MT-Safe
+T{
+.BR libsimple_strnstr ()
+T}	Async-signal safety	AS-Safe
+T{
+.BR libsimple_strnstr ()
+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_strrnstr (3),
+.BR libsimple_strncasestr (3)
+.BR libsimple_memmem (3),
+.BR strstr (3)
-- 
cgit v1.2.3-70-g09d2