Add man pages for str[r]n[case]str

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

12 files changed, 368 insertions, 17 deletions

diff --git a/libsimple/strn.h b/libsimple/strn.h
index 7aec11b..743c739 100644
--- a/libsimple/strn.h
+++ b/libsimple/strn.h
@@ -189,7 +189,7 @@ int libsimple_strncaseends(const char *, const char *, size_t); /* TODO doc */
  *                    exists
  */
 _LIBSIMPLE_GCC_ONLY(__attribute__((__pure__, __nonnull__, __warn_unused_result__)))
-char *libsimple_strnstr(const char *, const char *, size_t); /* TODO doc */
+char *libsimple_strnstr(const char *, const char *, size_t);
 #ifndef strnstr
 # define strnstr libsimple_strnstr
 #endif
@@ -206,7 +206,7 @@ char *libsimple_strnstr(const char *, const char *, size_t); /* TODO doc */
  *                    exists
  */
 _LIBSIMPLE_GCC_ONLY(__attribute__((__pure__, __nonnull__, __warn_unused_result__)))
-char *libsimple_strncasestr(const char *, const char *, size_t); /* TODO doc */
+char *libsimple_strncasestr(const char *, const char *, size_t);
 #ifndef strncasestr
 # define strncasestr libsimple_strncasestr
 #endif
@@ -223,7 +223,7 @@ char *libsimple_strncasestr(const char *, const char *, size_t); /* TODO doc */
  *                    exists
  */
 _LIBSIMPLE_GCC_ONLY(__attribute__((__pure__, __nonnull__, __warn_unused_result__)))
-char *libsimple_strrnstr(const char *, const char *, size_t); /* TODO doc */
+char *libsimple_strrnstr(const char *, const char *, size_t);
 #ifndef strrnstr
 # define strrnstr libsimple_strrnstr
 #endif
@@ -240,7 +240,7 @@ char *libsimple_strrnstr(const char *, const char *, size_t); /* TODO doc */
  *                    exists
  */
 _LIBSIMPLE_GCC_ONLY(__attribute__((__pure__, __nonnull__, __warn_unused_result__)))
-char *libsimple_strrncasestr(const char *, const char *, size_t); /* TODO doc */
+char *libsimple_strrncasestr(const char *, const char *, size_t);
 #ifndef strrncasestr
 # define strrncasestr libsimple_strrncasestr
 #endif
diff --git a/man/libsimple_memcasemem.3 b/man/libsimple_memcasemem.3
index 1b22e9b..37c6cda 100644
--- a/man/libsimple_memcasemem.3
+++ b/man/libsimple_memcasemem.3
@@ -1,4 +1,4 @@
-.TH LIBSIMPLE_MEMCASEMEM 3 2018-10-21 libsimple
+.TH LIBSIMPLE_MEMCASEMEM 3 2018-10-23 libsimple
 .SH NAME
 libsimple_memcasemem \- find byte string in memory
 .SH SYNOPSIS
@@ -77,4 +77,6 @@ None.
 .SH SEE ALSO
 .BR libsimple_memmem (3),
 .BR libsimple_memrcasemem (3),
-.BR libsimple_memcasechr (3)
+.BR libsimple_memcasechr (3),
+.BR libsimple_strncasestr (3),
+.BR libsimple_strcasestr (3)
diff --git a/man/libsimple_memmem.3 b/man/libsimple_memmem.3
index 4c1a628..30dea44 100644
--- a/man/libsimple_memmem.3
+++ b/man/libsimple_memmem.3
@@ -1,4 +1,4 @@
-.TH LIBSIMPLE_MEMMEM 3 2018-10-21 libsimple
+.TH LIBSIMPLE_MEMMEM 3 2018-10-23 libsimple
 .SH NAME
 libsimple_memmem \- find byte string in memory
 .SH SYNOPSIS
@@ -78,4 +78,6 @@ None.
 .BR libsimple_memrcasemem (3),
 .BR libsimple_memrmem (3),
 .BR libsimple_memelem (3),
+.BR libsimple_strnstr (3),
+.BR strstr (3),
 .BR memchr (3)
diff --git a/man/libsimple_memrcasemem.3 b/man/libsimple_memrcasemem.3
index 712cb03..76b6ea5 100644
--- a/man/libsimple_memrcasemem.3
+++ b/man/libsimple_memrcasemem.3
@@ -1,4 +1,4 @@
-.TH LIBSIMPLE_MEMRCASEMEM 3 2018-10-21 libsimple
+.TH LIBSIMPLE_MEMRCASEMEM 3 2018-10-23 libsimple
 .SH NAME
 libsimple_memrcasemem \- find byte string in memory
 .SH SYNOPSIS
@@ -77,4 +77,6 @@ None.
 .SH SEE ALSO
 .BR libsimple_memrmem (3),
 .BR libsimple_memcasemem (3),
-.BR libsimple_memrcasechr (3)
+.BR libsimple_memrcasechr (3),
+.BR libsimple_strrncasestr (3),
+.BR libsimple_strrcasestr (3)
diff --git a/man/libsimple_memrmem.3 b/man/libsimple_memrmem.3
index c08d577..706fc03 100644
--- a/man/libsimple_memrmem.3
+++ b/man/libsimple_memrmem.3
@@ -1,4 +1,4 @@
-.TH LIBSIMPLE_MEMRMEM 3 2018-10-21 libsimple
+.TH LIBSIMPLE_MEMRMEM 3 2018-10-23 libsimple
 .SH NAME
 libsimple_memrmem \- find byte string in memory
 .SH SYNOPSIS
@@ -78,4 +78,6 @@ None.
 .BR libsimple_memcasemem (3),
 .BR libsimple_memmem (3),
 .BR libsimple_memrelem (3),
-.BR libsimple_memrchr (3)
+.BR libsimple_memrchr (3),
+.BR libsimple_strrnstr (3),
+.BR libsimple_strrstr (3)
diff --git a/man/libsimple_strcasestr.3 b/man/libsimple_strcasestr.3
index fe8c6bb..8ee2c45 100644
--- a/man/libsimple_strcasestr.3
+++ b/man/libsimple_strcasestr.3
@@ -1,4 +1,4 @@
-.TH LIBSIMPLE_STRCASESTR 3 2018-10-21 libsimple
+.TH LIBSIMPLE_STRCASESTR 3 2018-10-23 libsimple
 .SH NAME
 libsimple_strcasestr \- find a substring in a string
 .SH SYNOPSIS
@@ -35,6 +35,9 @@ begins with
 where
 .I r
 is the returned pointer.
+If no such offset exists,
+.B NULL
+is returned.
 .SH ERRORS
 The
 .BR libsimple_strcasestr ()
@@ -71,4 +74,6 @@ None.
 None.
 .SH SEE ALSO
 .BR libsimple_strrcasestr (3),
+.BR libsimple_strncasestr (3),
+.BR libsimple_memcasemem (3),
 .BR strstr (3)
diff --git a/man/libsimple_strncasestr.3 b/man/libsimple_strncasestr.3
new file mode 100644
index 0000000..0235f7c
--- /dev/null
+++ b/man/libsimple_strncasestr.3
@@ -0,0 +1,82 @@
+.TH LIBSIMPLE_STRNCASESTR 3 2018-10-23 libsimple
+.SH NAME
+libsimple_strncasestr \- find a substring in a string
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+char *libsimple_strncasestr(const char *\fIhaystack\fP, const char *\fIneedle\fP), size_t \fIn\fP;
+
+#ifndef strncasestr
+# define strncasestr libsimple_strncasestr
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_strncasestr ()
+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-insensitive.
+.SH RETURN VALUE
+The
+.BR libsimple_strncasestr ()
+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_strncasestr ()
+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_strncasestr ()
+T}	Thread safety	MT-Safe
+T{
+.BR libsimple_strncasestr ()
+T}	Async-signal safety	AS-Safe
+T{
+.BR libsimple_strncasestr ()
+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_strrncasestr (3),
+.BR libsimple_strnstr (3),
+.BR libsimple_strcasestr (3),
+.BR libsimple_memcasemem (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)
diff --git a/man/libsimple_strrcasestr.3 b/man/libsimple_strrcasestr.3
index 4418795..a2844b5 100644
--- a/man/libsimple_strrcasestr.3
+++ b/man/libsimple_strrcasestr.3
@@ -1,4 +1,4 @@
-.TH LIBSIMPLE_STRRCASESTR 3 2018-10-21 libsimple
+.TH LIBSIMPLE_STRRCASESTR 3 2018-10-23 libsimple
 .SH NAME
 libsimple_strrcasestr \- find a substring in a string
 .SH SYNOPSIS
@@ -29,12 +29,15 @@ The
 function returns the pointer
 .I haystack
 with a maximal offset such that
-.I !*r
+.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_strrcasestr ()
@@ -71,4 +74,6 @@ None.
 None.
 .SH SEE ALSO
 .BR libsimple_strrstr (3),
-.BR libsimple_strcasestr (3)
+.BR libsimple_strcasestr (3),
+.BR libsimple_strrncasestr (3),
+.BR libsimple_memrcasemem (3)
diff --git a/man/libsimple_strrncasestr.3 b/man/libsimple_strrncasestr.3
new file mode 100644
index 0000000..dcf48b5
--- /dev/null
+++ b/man/libsimple_strrncasestr.3
@@ -0,0 +1,82 @@
+.TH LIBSIMPLE_STRRNCASESTR 3 2018-10-23 libsimple
+.SH NAME
+libsimple_strrncasestr \- find a substring in a string
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+char *libsimple_strrncasestr(const char *\fIhaystack\fP, const char *\fIneedle\fP, size_t \fIn\fP);
+
+#ifndef strrncasestr
+# define strrncasestr libsimple_strrncasestr
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_strrncasestr ()
+function scans the string
+.IR haystack ,
+truncated to
+.I n
+bytes unless it is shorter,
+the last occurrence of the substring
+.IR needle .
+.PP
+The comparison is case-insensitive.
+.SH RETURN VALUE
+The
+.BR libsimple_strrncasestr ()
+function returns the pointer
+.I haystack
+with a maximal 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_strrncasestr ()
+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_strrncasestr ()
+T}	Thread safety	MT-Safe
+T{
+.BR libsimple_strrncasestr ()
+T}	Async-signal safety	AS-Safe
+T{
+.BR libsimple_strrncasestr ()
+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_strrcasestr (3),
+.BR libsimple_memrcasemem (3)
diff --git a/man/libsimple_strrnstr.3 b/man/libsimple_strrnstr.3
new file mode 100644
index 0000000..9e95196
--- /dev/null
+++ b/man/libsimple_strrnstr.3
@@ -0,0 +1,82 @@
+.TH LIBSIMPLE_STRRNSTR 3 2018-10-23 libsimple
+.SH NAME
+libsimple_strrnstr \- find a substring in a string
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+char *libsimple_strrnstr(const char *\fIhaystack\fP, const char *\fIneedle\fP, size_t \fIn\fP);
+
+#ifndef strrnstr
+# define strrnstr libsimple_strrnstr
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_strrnstr ()
+function scans the string
+.IR haystack ,
+truncated to
+.I n
+bytes unless it is shorter,
+the last occurrence of the substring
+.IR needle .
+.PP
+The comparison is case-sensitive.
+.SH RETURN VALUE
+The
+.BR libsimple_strrnstr ()
+function returns the pointer
+.I haystack
+with a maximal 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_strrnstr ()
+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_strrnstr ()
+T}	Thread safety	MT-Safe
+T{
+.BR libsimple_strrnstr ()
+T}	Async-signal safety	AS-Safe
+T{
+.BR libsimple_strrnstr ()
+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_strrncasestr (3),
+.BR libsimple_strnstr (3),
+.BR libsimple_strrstr (3),
+.BR libsimple_memrmem (3)
diff --git a/man/libsimple_strrstr.3 b/man/libsimple_strrstr.3
index 973f50b..c3c16b7 100644
--- a/man/libsimple_strrstr.3
+++ b/man/libsimple_strrstr.3
@@ -1,4 +1,4 @@
-.TH LIBSIMPLE_STRRSTR 3 2018-10-21 libsimple
+.TH LIBSIMPLE_STRRSTR 3 2018-10-23 libsimple
 .SH NAME
 libsimple_strrstr \- find a substring in a string
 .SH SYNOPSIS
@@ -29,12 +29,15 @@ The
 function returns the pointer
 .I haystack
 with a maximal offset such that
-.I !*r
+.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_strrstr ()
@@ -71,4 +74,6 @@ None.
 None.
 .SH SEE ALSO
 .BR libsimple_strrcasestr (3),
+.BR libsimple_strrnstr (3),
+.BR libsimple_memrmem (3),
 .BR strstr (3)