aboutsummaryrefslogtreecommitdiffstats
path: root/man3/libsimple_rawmemrelem.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2024-08-18 09:43:16 +0200
committerMattias Andrée <maandree@kth.se>2024-08-18 09:43:16 +0200
commit715b59e5002b971a987c3c8a2e1b3e61d80388f7 (patch)
treeaa64aa9fed94388056432f0f4a2180d5c03523fd /man3/libsimple_rawmemrelem.3
parentAdd @since for definitions added in version 1.0 and 1.1 (diff)
parentFix tests and libsimple_arraycpy and libsimple_arraymove (diff)
downloadlibsimple-715b59e5002b971a987c3c8a2e1b3e61d80388f7.tar.gz
libsimple-715b59e5002b971a987c3c8a2e1b3e61d80388f7.tar.bz2
libsimple-715b59e5002b971a987c3c8a2e1b3e61d80388f7.tar.xz
Merge tag '1.2' into since
Version 1.2
Diffstat (limited to 'man3/libsimple_rawmemrelem.3')
-rw-r--r--man3/libsimple_rawmemrelem.314
1 files changed, 13 insertions, 1 deletions
diff --git a/man3/libsimple_rawmemrelem.3 b/man3/libsimple_rawmemrelem.3
index 4ac85aa..1628f2f 100644
--- a/man3/libsimple_rawmemrelem.3
+++ b/man3/libsimple_rawmemrelem.3
@@ -1,6 +1,7 @@
-.TH LIBSIMPLE_RAWMEMRELEM 3 2018-11-25 libsimple
+.TH LIBSIMPLE_RAWMEMRELEM 3 libsimple
.SH NAME
libsimple_rawmemrelem \- find aligned byte string in memory
+
.SH SYNOPSIS
.nf
#include <libsimple.h>
@@ -14,6 +15,7 @@ void *libsimple_rawmemrelem(const void *\fIhaystack\fP, const void *\fIneedle\fP
.PP
Link with
.IR \-lsimple .
+
.SH DESCRIPTION
The
.BR libsimple_rawmemrelem ()
@@ -34,6 +36,7 @@ occurence, its behaviour is undefined
if this is not the case.
.PP
The comparison is case-sensitive.
+
.SH RETURN VALUE
The
.BR libsimple_rawmemrelem ()
@@ -47,10 +50,12 @@ is the returned pointer, and such that
the offset is equivalent to zero modulo
.IR width .
If no such offset exists, the behaviour is undefined.
+
.SH ERRORS
The
.BR libsimple_rawmemrelem ()
function cannot fail.
+
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
@@ -69,18 +74,25 @@ T{
.BR libsimple_rawmemrelem ()
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_rawmemrelem_inv (3),
.BR libsimple_memrelem (3),