aboutsummaryrefslogtreecommitdiffstats
path: root/man/libsimple_memelem.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2018-11-07 22:18:04 +0100
committerMattias Andrée <maandree@kth.se>2018-11-07 22:18:04 +0100
commit9fc2b129167e1f2a16d942369f057f618a00d81c (patch)
treec15d15d8afc525a423ce0d43d95f676e6e5a2541 /man/libsimple_memelem.3
parentAdd arrayalloc man page (diff)
downloadlibsimple-9fc2b129167e1f2a16d942369f057f618a00d81c.tar.gz
libsimple-9fc2b129167e1f2a16d942369f057f618a00d81c.tar.bz2
libsimple-9fc2b129167e1f2a16d942369f057f618a00d81c.tar.xz
Move section 3 man pages to man3/ and add libsimple.h.0
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man/libsimple_memelem.3')
-rw-r--r--man/libsimple_memelem.384
1 files changed, 0 insertions, 84 deletions
diff --git a/man/libsimple_memelem.3 b/man/libsimple_memelem.3
deleted file mode 100644
index 833e246..0000000
--- a/man/libsimple_memelem.3
+++ /dev/null
@@ -1,84 +0,0 @@
-.TH LIBSIMPLE_MEMELEM 3 2018-10-20 libsimple
-.SH NAME
-libsimple_memelem \- find aligned byte string in memory
-.SH SYNOPSIS
-.nf
-#include <libsimple.h>
-
-void *libsimple_memelem(const void *\fIhaystack\fP, size_t \fInhaystack\fP, const void *\fIneedle\fP, size_t \fInneedle\fP);
-
-#ifndef memelem
-# define memelem libsimple_memelem
-#endif
-.fi
-.PP
-Link with
-.IR \-lsimple .
-.SH DESCRIPTION
-The
-.BR libsimple_memelem ()
-function scans the memory segment
-.IR haystack ,
-with the size
-.IR nhaystack*nneedle ,
-for the first occurence of the byte string
-.I needle
-with the size
-.IR nneedle ,
-and with an offset equivalent to zero modulo
-.IR nneedle .
-.PP
-The comparison is case-sensitive.
-.SH RETURN VALUE
-The
-.BR libsimple_memelem ()
-function returns the pointer
-.I s
-with a minimal offset such that
-.IR !memcmp(r,needle,nneedle) ,
-where
-.I r
-is the returned pointer, and such that
-the offset is equivalent to zero modulo
-.IR nneedle .
-If no such offset exists,
-.B NULL
-is returned.
-.SH ERRORS
-The
-.BR libsimple_memelem ()
-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_memelem ()
-T} Thread safety MT-Safe
-T{
-.BR libsimple_memelem ()
-T} Async-signal safety AS-Safe
-T{
-.BR libsimple_memelem ()
-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_memrelem (3),
-.BR libsimple_memmem (3),
-.BR memchr (3)