Add man pages for str[r]n[case]eq{,nul,len}

Signed-off-by: Mattias Andrée <maandree@kth.se>

1 files changed, 80 insertions, 0 deletions

diff --git a/man/libsimple_strneq.3 b/man/libsimple_strneq.3
new file mode 100644
index 0000000..5b6eebf
--- /dev/null
+++ b/man/libsimple_strneq.3
@@ -0,0 +1,80 @@
+.TH LIBSIMPLE_STRNEQ 3 2018-10-23 libsimple
+.SH NAME
+libsimple_strneq \- compare two strings
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+static inline int libsimple_strneq(const char *\fIa\fP, const char *\fIb\fP, size_t \fIn\fP);
+
+#ifndef strneq
+# define strneq libsimple_strneq
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_strneq ()
+function compares the strings
+.IR a ,
+truncated to
+.I n
+bytes unless it is shorter,
+and
+.IR b ,
+truncated to
+.I n
+bytes unless it is shorter,
+neither of which may be
+.BR NULL .
+.PP
+The comparison is case-sensitive.
+.IR "unsigned char *" s.
+.SH RETURN VALUE
+The
+.BR libsimple_strneq ()
+function returns 1 if the strings are equals,
+otherwise it returns 0.
+.SH ERRORS
+The
+.BR libsimple_strneq ()
+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_strneq ()
+T}	Thread safety	MT-Safe
+T{
+.BR libsimple_strneq ()
+T}	Async-signal safety	AS-Safe
+T{
+.BR libsimple_strneq ()
+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_strneqnul (3),
+.BR libsimple_strncaseeq (3),
+.BR libsimple_strneqlen (3),
+.BR libsimple_streq (3),
+.BR libsimple_memeq (3),
+.BR strncmp (3)