diff options
author | Mattias Andrée <maandree@kth.se> | 2018-10-20 19:05:06 +0200 |
---|---|---|
committer | Mattias Andrée <maandree@kth.se> | 2018-10-20 19:14:26 +0200 |
commit | 3d938e4090d4dc2d5ed58bf4d00e85d8747d1228 (patch) | |
tree | f2b4d3cc33afa1bd61264ee88295e95073836a9c /man | |
parent | Add man pages for putenvf and getenv functions (diff) | |
download | libsimple-3d938e4090d4dc2d5ed58bf4d00e85d8747d1228.tar.gz libsimple-3d938e4090d4dc2d5ed58bf4d00e85d8747d1228.tar.bz2 libsimple-3d938e4090d4dc2d5ed58bf4d00e85d8747d1228.tar.xz |
Add man pages for memrchr, rawmemchr, and rawmemrchr
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man')
-rw-r--r-- | man/libsimple_getenv_e.3 | 1 | ||||
-rw-r--r-- | man/libsimple_getenv_ne.3 | 1 | ||||
-rw-r--r-- | man/libsimple_memrchr.3 | 78 | ||||
-rw-r--r-- | man/libsimple_rawmemchr.3 | 78 | ||||
-rw-r--r-- | man/libsimple_rawmemrchr.3 | 80 | ||||
-rw-r--r-- | man/libsimple_vputenvf.3 | 1 | ||||
l--------- | man/memends.3libsimple | 1 | ||||
l--------- | man/memeq.3libsimple | 1 | ||||
l--------- | man/memmem.3libsimple | 1 | ||||
l--------- | man/mempcpy.3libsimple | 1 | ||||
l--------- | man/mempset.3libsimple | 1 | ||||
l--------- | man/memrchr.3libsimple | 1 | ||||
l--------- | man/memrmem.3libsimple | 1 | ||||
l--------- | man/memstarts.3libsimple | 1 | ||||
l--------- | man/rawmemchr.3libsimple | 1 | ||||
l--------- | man/rawmemrchr.3libsimple | 1 |
16 files changed, 246 insertions, 3 deletions
diff --git a/man/libsimple_getenv_e.3 b/man/libsimple_getenv_e.3 index ba9cd04..27fba39 100644 --- a/man/libsimple_getenv_e.3 +++ b/man/libsimple_getenv_e.3 @@ -1,4 +1,3 @@ -.\" -*- nroff -*- .TH LIBSIMPLE_GETENV_E 3 2018-10-20 libsimple .SH NAME libsimple_getenv_e \- get value of an environment variable or the empty string diff --git a/man/libsimple_getenv_ne.3 b/man/libsimple_getenv_ne.3 index 337a5f5..a0eca77 100644 --- a/man/libsimple_getenv_ne.3 +++ b/man/libsimple_getenv_ne.3 @@ -1,4 +1,3 @@ -.\" -*- nroff -*- .TH LIBSIMPLE_GETENV_NE 3 2018-10-20 libsimple .SH NAME libsimple_getenv_ne \- get non-empty value of an environment variable diff --git a/man/libsimple_memrchr.3 b/man/libsimple_memrchr.3 new file mode 100644 index 0000000..4c93b0a --- /dev/null +++ b/man/libsimple_memrchr.3 @@ -0,0 +1,78 @@ +.TH LIBSIMPLE_MEMRCHR 3 2018-10-20 libsimple +.SH NAME +libsimple_memrchr \- find byte in memory +.SH SYNOPSIS +.nf +#include <libsimple.h> + +void *libsimple_memrchr(const void *s, int c, size_t n); + +#ifndef memrchr +# define memrchr libsimple_memrchr +#endif +.fi + +Link with +.IR \-lsimple . +.SH DESCRIPTION +The +.BR libsimple_memrchr () +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 ). +.SH RETURN VALUE +The +.BR libsimple_memrchr () +function returns the pointer +.I s +with a maximal offset such that +.IR *r==c , +where +.I r +is the returned pointer. +If no such offset exists, +.B NULL +is returned. +.SH ERRORS +The +.BR libsimple_memrchr () +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_memrchr () +T} Thread safety MT-Safe +T{ +.BR libsimple_memrchr () +T} Async-signal safety AS-Safe +T{ +.BR libsimple_memrchr () +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_rawmemrchr (3), +.BR libsimple_memrmem (3), +.BR memchr (3) diff --git a/man/libsimple_rawmemchr.3 b/man/libsimple_rawmemchr.3 new file mode 100644 index 0000000..347ab4c --- /dev/null +++ b/man/libsimple_rawmemchr.3 @@ -0,0 +1,78 @@ +.TH LIBSIMPLE_RAWMEMCHR 3 2018-10-20 libsimple +.SH NAME +libsimple_rawmemchr \- find byte in memory +.SH SYNOPSIS +.nf +#include <libsimple.h> + +void *libsimple_rawmemchr(const void *s, int c); + +#ifndef rawmemchr +# define rawmemchr libsimple_rawmemchr +#endif +.fi + +Link with +.IR \-lsimple . +.SH DESCRIPTION +The +.BR libsimple_rawmemchr () +function scans the memory segment +.I s +for the first occurence of the byte +.I c +(it is converted to a +.BR char ). +.PP +The +.BR libsimple_rawmemchr () +function assumes there is at least one +occurence, its behaviour is undefined +if this is not the case. +.SH RETURN VALUE +The +.BR libsimple_rawmemchr () +function returns the pointer +.I s +with a minimal offset such that +.IR *r==c , +where +.I r +is the returned pointer. +.SH ERRORS +The +.BR libsimple_rawmemchr () +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_rawmemchr () +T} Thread safety MT-Safe +T{ +.BR libsimple_rawmemchr () +T} Async-signal safety AS-Safe +T{ +.BR libsimple_rawmemchr () +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_rawmemrchr (3), +.BR memchr (3) 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) diff --git a/man/libsimple_vputenvf.3 b/man/libsimple_vputenvf.3 index b18d82f..3c081e1 100644 --- a/man/libsimple_vputenvf.3 +++ b/man/libsimple_vputenvf.3 @@ -1,4 +1,3 @@ -.\" -*- nroff -*- .TH LIBSIMPLE_VPUTENVF 3 2018-10-20 libsimple .SH NAME libsimple_vputenvf \- change or add a string formatted value to the environment diff --git a/man/memends.3libsimple b/man/memends.3libsimple new file mode 120000 index 0000000..5ab92b7 --- /dev/null +++ b/man/memends.3libsimple @@ -0,0 +1 @@ +libsimple_memends.3
\ No newline at end of file diff --git a/man/memeq.3libsimple b/man/memeq.3libsimple new file mode 120000 index 0000000..6d3ecb3 --- /dev/null +++ b/man/memeq.3libsimple @@ -0,0 +1 @@ +libsimple_memeq.3
\ No newline at end of file diff --git a/man/memmem.3libsimple b/man/memmem.3libsimple new file mode 120000 index 0000000..81f1d83 --- /dev/null +++ b/man/memmem.3libsimple @@ -0,0 +1 @@ +libsimple_memmem.3
\ No newline at end of file diff --git a/man/mempcpy.3libsimple b/man/mempcpy.3libsimple new file mode 120000 index 0000000..3ae360f --- /dev/null +++ b/man/mempcpy.3libsimple @@ -0,0 +1 @@ +libsimple_mempcpy.3
\ No newline at end of file diff --git a/man/mempset.3libsimple b/man/mempset.3libsimple new file mode 120000 index 0000000..619340a --- /dev/null +++ b/man/mempset.3libsimple @@ -0,0 +1 @@ +libsimple_mempset.3
\ No newline at end of file diff --git a/man/memrchr.3libsimple b/man/memrchr.3libsimple new file mode 120000 index 0000000..1dbd392 --- /dev/null +++ b/man/memrchr.3libsimple @@ -0,0 +1 @@ +libsimple_memrchr.3
\ No newline at end of file diff --git a/man/memrmem.3libsimple b/man/memrmem.3libsimple new file mode 120000 index 0000000..ff9d6f4 --- /dev/null +++ b/man/memrmem.3libsimple @@ -0,0 +1 @@ +libsimple_memrmem.3
\ No newline at end of file diff --git a/man/memstarts.3libsimple b/man/memstarts.3libsimple new file mode 120000 index 0000000..40f1024 --- /dev/null +++ b/man/memstarts.3libsimple @@ -0,0 +1 @@ +libsimple_memstarts.3
\ No newline at end of file diff --git a/man/rawmemchr.3libsimple b/man/rawmemchr.3libsimple new file mode 120000 index 0000000..5391310 --- /dev/null +++ b/man/rawmemchr.3libsimple @@ -0,0 +1 @@ +libsimple_rawmemchr.3
\ No newline at end of file diff --git a/man/rawmemrchr.3libsimple b/man/rawmemrchr.3libsimple new file mode 120000 index 0000000..b0c9553 --- /dev/null +++ b/man/rawmemrchr.3libsimple @@ -0,0 +1 @@ +libsimple_rawmemrchr.3
\ No newline at end of file |