Add man pages for memrchr, rawmemchr, and rawmemrchr

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

1 files changed, 80 insertions, 0 deletions

diff --git a/man/libsimple_rawmemrchr.3 b/man/libsimple_rawmemrchr.3
new file mode 100644
index 0000000..c445794
--- /dev/null
+++ b/man/libsimple_rawmemrchr.3
@@ -0,0 +1,80 @@
+.TH LIBSIMPLE_RAWMEMRCHR 3 2018-10-20 libsimple
+.SH NAME
+libsimple_rawmemrchr \- find byte in memory
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+void *libsimple_rawmemrchr(const void *s, int c, size_t n);
+
+#ifndef rawmemrchr
+# define rawmemrchr libsimple_rawmemrchr
+#endif
+.fi
+
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_rawmemrchr ()
+function scans the memory segment
+.IR s ,
+with the size
+.IR n ,
+for the last occurence of the byte
+.I c
+(it is converted to a
+.BR char ).
+.PP
+The
+.BR libsimple_rawmemrchr ()
+function assumes there is at least one
+occurence, its behaviour is undefined
+if this is not the case.
+.SH RETURN VALUE
+The
+.BR libsimple_rawmemrchr ()
+function returns the pointer
+.I s
+with a maximal offset such that
+.IR *r==c ,
+where
+.I r
+is the returned pointer.
+.SH ERRORS
+The
+.BR libsimple_rawmemrchr ()
+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_rawmemrchr ()
+T}	Thread safety	MT-Safe
+T{
+.BR libsimple_rawmemrchr ()
+T}	Async-signal safety	AS-Safe
+T{
+.BR libsimple_rawmemrchr ()
+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_memrchr (3),
+.BR libsimple_rawmemchr (3)