diff options
author | Mattias Andrée <maandree@kth.se> | 2018-10-20 21:14:53 +0200 |
---|---|---|
committer | Mattias Andrée <maandree@kth.se> | 2018-10-20 21:14:58 +0200 |
commit | ea8ff66636f6f2d521523854c889eed208f96f1f (patch) | |
tree | b156aa7bbedd6293de386bc7e1155800d68c4ce3 /man/libsimple_memstarts.3 | |
parent | Add memelem and memrelem (diff) | |
download | libsimple-ea8ff66636f6f2d521523854c889eed208f96f1f.tar.gz libsimple-ea8ff66636f6f2d521523854c889eed208f96f1f.tar.bz2 libsimple-ea8ff66636f6f2d521523854c889eed208f96f1f.tar.xz |
Add man pages for memstarts and memends, and fix highlighting in man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
-rw-r--r-- | man/libsimple_memstarts.3 | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/man/libsimple_memstarts.3 b/man/libsimple_memstarts.3 new file mode 100644 index 0000000..e5e183b --- /dev/null +++ b/man/libsimple_memstarts.3 @@ -0,0 +1,76 @@ +.TH LIBSIMPLE_MEMSTARTS 3 2018-10-20 libsimple +.SH NAME +libsimple_memstarts \- checks beginning of memory +.SH SYNOPSIS +.nf +#include <libsimple.h> + +void *libsimple_memstarts(const void *\fIs\fP, size_t \fIn\fP, const void *\fIt\fP, size_t \fIm\fP); + +#ifndef memstarts +# define memstarts libsimple_memstarts +#endif +.fi + +Link with +.IR \-lsimple . +.SH DESCRIPTION +The +.BR libsimple_memstarts () +function checks whether the +.I n +is at least as great as +.I m +and that the +.I m +first bytes of +.I s +is the same as the +.I m +first bytes of +.IR t . +.SH RETURN VALUE +The +.BR libsimple_memstarts () +function returns 1 if +.I s +begins with +.IR t , +otherwise it returns 0. +.SH ERRORS +The +.BR libsimple_memstarts () +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_memstarts () +T} Thread safety MT-Safe +T{ +.BR libsimple_memstarts () +T} Async-signal safety AS-Safe +T{ +.BR libsimple_memstarts () +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_memends (3), +.BR libsimple_memmem (3) |