Add man pages for strn[case]cmpnul

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

1 files changed, 91 insertions, 0 deletions

diff --git a/man/libsimple_strncmpnul.3 b/man/libsimple_strncmpnul.3
new file mode 100644
index 0000000..b482e58
--- /dev/null
+++ b/man/libsimple_strncmpnul.3
@@ -0,0 +1,91 @@
+.TH LIBSIMPLE_STRNCMPNUL 3 2018-10-23 libsimple
+.SH NAME
+libsimple_strncmpnul \- compare two strings
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+static inline int libsimple_strncmpnul(const char *\fIa\fP, const char *\fIb\fP, size_t \fIn\fP);
+
+#ifndef strncmpnul
+# define strncmpnul libsimple_strncmpnul
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_strncmpnul ()
+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,
+both of which may be
+.BR NULL ,
+which is treated as less than the empty string.
+.PP
+If one of the strings begins with the other string
+but is longer, the longer string is treated as
+greater than the shorter string.
+.PP
+The comparison is case-sensitive and made as if
+the strings were
+.IR "unsigned char *" s.
+.SH RETURN VALUE
+The
+.BR libsimple_strncmpnul ()
+function returns a negative value if
+.I a
+is less than
+.IR b ,
+a positive value if
+.I a
+is greater than
+.IR b ,
+and 0 otherwise.
+.SH ERRORS
+The
+.BR libsimple_strncmpnul ()
+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_strncmpnul ()
+T}	Thread safety	MT-Safe
+T{
+.BR libsimple_strncmpnul ()
+T}	Async-signal safety	AS-Safe
+T{
+.BR libsimple_strncmpnul ()
+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_strncasecmpnul (3),
+.BR libsimple_strneqnul (3),
+.BR libsimple_strcmpnul (3),
+.BR strncmp (3)