Add man pages for strn[case]chr[nul] and strrn[case]chr

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

14 files changed, 538 insertions, 13 deletions

diff --git a/libsimple/strn.h b/libsimple/strn.h
index 90017f2..b83273c 100644
--- a/libsimple/strn.h
+++ b/libsimple/strn.h
@@ -12,7 +12,7 @@
  *             within the first `n` bytes
  */
 _LIBSIMPLE_GCC_ONLY(__attribute__((__pure__, __nonnull__, __warn_unused_result__)))
-char *libsimple_strnchr(const char *, int, size_t); /* TODO doc */
+char *libsimple_strnchr(const char *, int, size_t);
 #ifndef strnchr
 # define strnchr libsimple_strnchr
 #endif
@@ -29,7 +29,7 @@ char *libsimple_strnchr(const char *, int, size_t); /* TODO doc */
  *             within the first `n` bytes
  */
 _LIBSIMPLE_GCC_ONLY(__attribute__((__pure__, __nonnull__, __warn_unused_result__)))
-char *libsimple_strncasechr(const char *, int, size_t); /* TODO doc */
+char *libsimple_strncasechr(const char *, int, size_t);
 #ifndef strncasechr
 # define strncasechr libsimple_strncasechr
 #endif
@@ -46,7 +46,7 @@ char *libsimple_strncasechr(const char *, int, size_t); /* TODO doc */
  *             offset exists within the first `n` bytes, `&s[n]` is returned
  */
 _LIBSIMPLE_GCC_ONLY(__attribute__((__pure__, __nonnull__, __returns_nonnull__, __warn_unused_result__)))
-char *libsimple_strnchrnul(const char *, int, size_t); /* TODO doc */
+char *libsimple_strnchrnul(const char *, int, size_t);
 #ifndef strnchrnul
 # define strnchrnul libsimple_strnchrnul
 #endif
@@ -63,7 +63,7 @@ char *libsimple_strnchrnul(const char *, int, size_t); /* TODO doc */
  *             exists within the first `n` bytes, `&s[n]` is returned
  */
 _LIBSIMPLE_GCC_ONLY(__attribute__((__pure__, __nonnull__, __returns_nonnull__, __warn_unused_result__)))
-char *libsimple_strncasechrnul(const char *, int, size_t); /* TODO doc */
+char *libsimple_strncasechrnul(const char *, int, size_t);
 #ifndef strncasechrnul
 # define strncasechrnul libsimple_strncasechrnul
 #endif
@@ -79,7 +79,7 @@ char *libsimple_strncasechrnul(const char *, int, size_t); /* TODO doc */
  *             where `r` is the returned pointer, `NULL` if no such offset exists
  */
 _LIBSIMPLE_GCC_ONLY(__attribute__((__pure__, __nonnull__, __warn_unused_result__)))
-char *libsimple_strrnchr(const char *, int, size_t); /* TODO doc */
+char *libsimple_strrnchr(const char *, int, size_t);
 #ifndef strrnchr
 # define strrnchr libsimple_strrnchr
 #endif
@@ -95,7 +95,7 @@ char *libsimple_strrnchr(const char *, int, size_t); /* TODO doc */
  *             where `r` is the returned pointer, `NULL` if no such offset exists
  */
 _LIBSIMPLE_GCC_ONLY(__attribute__((__pure__, __nonnull__, __warn_unused_result__)))
-char *libsimple_strrncasechr(const char *, int, size_t); /* TODO doc */
+char *libsimple_strrncasechr(const char *, int, size_t);
 #ifndef strrncasechr
 # define strrncasechr libsimple_strrncasechr
 #endif
diff --git a/man/libsimple_memcasechr.3 b/man/libsimple_memcasechr.3
index d90c7d4..3934598 100644
--- a/man/libsimple_memcasechr.3
+++ b/man/libsimple_memcasechr.3
@@ -1,4 +1,4 @@
-.TH LIBSIMPLE_MEMCASECHR 3 2018-10-21 libsimple
+.TH LIBSIMPLE_MEMCASECHR 3 2018-10-23 libsimple
 .SH NAME
 libsimple_memcasechr \- find byte in memory
 .SH SYNOPSIS
@@ -78,4 +78,6 @@ None.
 .BR libsimple_memrcasechr (3),
 .BR libsimple_rawmemcasechr (3),
 .BR libsimple_memcasemem (3),
+.BR libsimple_strncasechr (3),
+.BR libsimple_strcasechr (3),
 .BR memchr (3)
diff --git a/man/libsimple_memrcasechr.3 b/man/libsimple_memrcasechr.3
index a86a345..100f938 100644
--- a/man/libsimple_memrcasechr.3
+++ b/man/libsimple_memrcasechr.3
@@ -1,4 +1,4 @@
-.TH LIBSIMPLE_MEMRCASECHR 3 2018-10-21 libsimple
+.TH LIBSIMPLE_MEMRCASECHR 3 2018-10-23 libsimple
 .SH NAME
 libsimple_memrcasechr \- find byte in memory
 .SH SYNOPSIS
@@ -78,4 +78,6 @@ None.
 .BR libsimple_memcasechr (3),
 .BR libsimple_memrchr (3),
 .BR libsimple_rawmemrcasechr (3),
-.BR libsimple_memrcasemem (3)
+.BR libsimple_memrcasemem (3),
+.BR libsimple_strrncasechr (3),
+.BR libsimple_strrcasechr (3)
diff --git a/man/libsimple_memrchr.3 b/man/libsimple_memrchr.3
index 3aa2214..362c8ba 100644
--- a/man/libsimple_memrchr.3
+++ b/man/libsimple_memrchr.3
@@ -1,4 +1,4 @@
-.TH LIBSIMPLE_MEMRCHR 3 2018-10-21 libsimple
+.TH LIBSIMPLE_MEMRCHR 3 2018-10-23 libsimple
 .SH NAME
 libsimple_memrchr \- find byte in memory
 .SH SYNOPSIS
@@ -78,4 +78,6 @@ None.
 .BR libsimple_memrcasechr (3),
 .BR libsimple_rawmemrchr (3),
 .BR libsimple_memrmem (3),
+.BR libsimple_strrnchr (3),
 .BR memchr (3)
+.BR strrchr (3)
diff --git a/man/libsimple_strcasechr.3 b/man/libsimple_strcasechr.3
index c7cc780..4751538 100644
--- a/man/libsimple_strcasechr.3
+++ b/man/libsimple_strcasechr.3
@@ -1,4 +1,4 @@
-.TH LIBSIMPLE_STRCASECHR 3 2018-10-21 libsimple
+.TH LIBSIMPLE_STRCASECHR 3 2018-10-23 libsimple
 .SH NAME
 libsimple_strcasechr \- find a character in a string
 .SH SYNOPSIS
@@ -76,4 +76,6 @@ None.
 .SH SEE ALSO
 .BR libsimple_strcasechrnul (3),
 .BR libsimple_strrcasechr (3),
+.BR libsimple_strncasechr (3),
+.BR libsimple_memcasechr (3),
 .BR strchr (3)
diff --git a/man/libsimple_strcasechrnul.3 b/man/libsimple_strcasechrnul.3
index 81bdc7a..b532249 100644
--- a/man/libsimple_strcasechrnul.3
+++ b/man/libsimple_strcasechrnul.3
@@ -73,4 +73,5 @@ None.
 None.
 .SH SEE ALSO
 .BR libsimple_strcasechr (3),
-.BR libsimple_strchrnul (3)
+.BR libsimple_strchrnul (3),
+.BR libsimple_strncasechrnul (3)
diff --git a/man/libsimple_strchrnul.3 b/man/libsimple_strchrnul.3
index 0ed76d9..73c5f7d 100644
--- a/man/libsimple_strchrnul.3
+++ b/man/libsimple_strchrnul.3
@@ -74,4 +74,5 @@ None.
 .SH SEE ALSO
 .BR libsimple_strcasechrnul (3),
 .BR libsimple_strend (3),
+.BR libsimple_strnchrnul (3),
 .BR strchr (3)
diff --git a/man/libsimple_strncasechr.3 b/man/libsimple_strncasechr.3
new file mode 100644
index 0000000..aaa21ae
--- /dev/null
+++ b/man/libsimple_strncasechr.3
@@ -0,0 +1,86 @@
+.TH LIBSIMPLE_STRNCASECHR 3 2018-10-23 libsimple
+.SH NAME
+libsimple_strncasechr \- find a character in a string
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+char *libsimple_strncasechr(const char *\fIs\fP, int \fIc\fP, size_t \fIn\fP);
+
+#ifndef strncasechr
+# define strncasechr libsimple_strncasechr
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_strncasechr ()
+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-insensitive.
+.SH RETURN VALUE
+The
+.BR libsimple_strncasechr ()
+function returns the pointer
+.I s
+with a minimal offset such that
+.IR tolower(*r)==tolower(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_strncasechr ()
+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_strncasechr ()
+T}	Thread safety	MT-Safe
+T{
+.BR libsimple_strncasechr ()
+T}	Async-signal safety	AS-Safe
+T{
+.BR libsimple_strncasechr ()
+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_strncasechrnul (3),
+.BR libsimple_strrncasechr (3),
+.BR libsimple_strnchr (3),
+.BR libsimple_strcasechr (3),
+.BR libsimple_memcasechr (3)
diff --git a/man/libsimple_strncasechrnul.3 b/man/libsimple_strncasechrnul.3
new file mode 100644
index 0000000..241b61a
--- /dev/null
+++ b/man/libsimple_strncasechrnul.3
@@ -0,0 +1,85 @@
+.TH LIBSIMPLE_STRNCASECHRNUL 3 2018-10-21 libsimple
+.SH NAME
+libsimple_strncasechrnul \- find a character in a string
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+char *libsimple_strncasechrnul(const char *\fIs\fP, int \fIc\fP, size_t \fIn\fP);
+
+#ifndef strncasechrnul
+# define strncasechrnul libsimple_strncasechrnul
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_strncasechrnul ()
+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-insensitive.
+.SH RETURN VALUE
+The
+.BR libsimple_strncasechrnul ()
+function returns the pointer
+.I s
+with a minimal offset such that
+.IR tolower(*r)==tolower(c)||!*r ,
+where
+.I r
+is the returned pointer. However if no such
+offset less than
+.I n
+exists,
+.B NULL
+is returned.
+.SH ERRORS
+The
+.BR libsimple_strncasechrnul ()
+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_strncasechrnul ()
+T}	Thread safety	MT-Safe
+T{
+.BR libsimple_strncasechrnul ()
+T}	Async-signal safety	AS-Safe
+T{
+.BR libsimple_strncasechrnul ()
+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_strncasechr (3),
+.BR libsimple_strnchrnul (3),
+.BR libsimple_strcasechrnul (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),
diff --git a/man/libsimple_strnchrnul.3 b/man/libsimple_strnchrnul.3
new file mode 100644
index 0000000..ae0b994
--- /dev/null
+++ b/man/libsimple_strnchrnul.3
@@ -0,0 +1,86 @@
+.TH LIBSIMPLE_STRNCHRNUL 3 2018-10-21 libsimple
+.SH NAME
+libsimple_strnchrnul \- find a character in a string
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+char *libsimple_strnchrnul(const char *\fIs\fP, int \fIc\fP, size_t \fIn\fP);
+
+#ifndef strnchrnul
+# define strnchrnul libsimple_strnchrnul
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_strnchrnul ()
+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_strnchrnul ()
+function returns the pointer
+.I s
+with a minimal offset such that
+.IR *r==c||!*r ,
+where
+.I r
+is the returned pointer. However if no such
+offset less than
+.I n
+exists,
+.B NULL
+is returned.
+.SH ERRORS
+The
+.BR libsimple_strnchrnul ()
+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_strnchrnul ()
+T}	Thread safety	MT-Safe
+T{
+.BR libsimple_strnchrnul ()
+T}	Async-signal safety	AS-Safe
+T{
+.BR libsimple_strnchrnul ()
+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. I promise!
+.SH SEE ALSO
+.BR libsimple_strncasechrnul (3),
+.BR libsimple_strnchr (3),
+.BR libsimple_strnend (3),
+.BR libsimple_strchrnul (3)
diff --git a/man/libsimple_strrcasechr.3 b/man/libsimple_strrcasechr.3
index 65382e6..c30a946 100644
--- a/man/libsimple_strrcasechr.3
+++ b/man/libsimple_strrcasechr.3
@@ -1,4 +1,4 @@
-.TH LIBSIMPLE_STRRCASECHR 3 2018-10-21 libsimple
+.TH LIBSIMPLE_STRRCASECHR 3 2018-10-23 libsimple
 .SH NAME
 libsimple_strrcasechr \- find a character in a string
 .SH SYNOPSIS
@@ -75,4 +75,6 @@ None.
 None.
 .SH SEE ALSO
 .BR libsimple_strcasechr (3),
+.BR libsimple_strrncasechr (3),
+.BR libsimple_memrcasechr (3),
 .BR strrchr (3)
diff --git a/man/libsimple_strrncasechr.3 b/man/libsimple_strrncasechr.3
new file mode 100644
index 0000000..e39daea
--- /dev/null
+++ b/man/libsimple_strrncasechr.3
@@ -0,0 +1,85 @@
+.TH LIBSIMPLE_STRRNCASECHR 3 2018-10-23 libsimple
+.SH NAME
+libsimple_strrncasechr \- find a character in a string
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+char *libsimple_strrncasechr(const char *\fIs\fP, int \fIc\fP, size_t \fIn\fP);
+
+#ifndef strrncasechr
+# define strrncasechr libsimple_strrncasechr
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_strrncasechr ()
+function scans the string
+.IR s ,
+truncated to
+.I n
+bytes unless it is shorter,
+for the last 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-insensitive.
+.SH RETURN VALUE
+The
+.BR libsimple_strrncasechr ()
+function returns the pointer
+.I s
+with a maximal offset such that
+.IR tolower(*r)==tolower(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_strrncasechr ()
+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_strrncasechr ()
+T}	Thread safety	MT-Safe
+T{
+.BR libsimple_strrncasechr ()
+T}	Async-signal safety	AS-Safe
+T{
+.BR libsimple_strrncasechr ()
+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_strncasechr (3),
+.BR libsimple_strrnchr (3),
+.BR libsimple_strrcasechr (3),
+.BR libsimple_memrcasechr (3)
diff --git a/man/libsimple_strrnchr.3 b/man/libsimple_strrnchr.3
new file mode 100644
index 0000000..8a7a2cc
--- /dev/null
+++ b/man/libsimple_strrnchr.3
@@ -0,0 +1,85 @@
+.TH LIBSIMPLE_STRRNCHR 3 2018-10-23 libsimple
+.SH NAME
+libsimple_strrnchr \- find a character in a string
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+char *libsimple_strrnchr(const char *\fIs\fP, int \fIc\fP, size_t \fIn\fP);
+
+#ifndef strrnchr
+# define strrnchr libsimple_strrnchr
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_strrnchr ()
+function scans the string
+.IR s ,
+truncated to
+.I n
+bytes unless it is shorter,
+for the last 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_strrnchr ()
+function returns the pointer
+.I s
+with a maximal 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_strrnchr ()
+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_strrnchr ()
+T}	Thread safety	MT-Safe
+T{
+.BR libsimple_strrnchr ()
+T}	Async-signal safety	AS-Safe
+T{
+.BR libsimple_strrnchr ()
+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_strrncasechr (3),
+.BR libsimple_strnchr (3),
+.BR libsimple_strrchr (3),
+.BR libsimple_memrchr (3)