diff options
| author | Mattias Andrée <maandree@kth.se> | 2018-10-23 20:25:52 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2018-10-23 20:25:52 +0200 |
| commit | d086d2c9c9add2648cb017fae9aa9a3fbc5ec959 (patch) | |
| tree | f1885692e9c7456e06381a1fcbc6e8e1c4cfdf6a | |
| parent | Add man pages for str[r]n[case]eq{,nul,len} (diff) | |
| download | libsimple-d086d2c9c9add2648cb017fae9aa9a3fbc5ec959.tar.gz libsimple-d086d2c9c9add2648cb017fae9aa9a3fbc5ec959.tar.bz2 libsimple-d086d2c9c9add2648cb017fae9aa9a3fbc5ec959.tar.xz | |
Add man page for strnend
Signed-off-by: Mattias Andrée <maandree@kth.se>
| -rw-r--r-- | libsimple/strn.h | 2 | ||||
| -rw-r--r-- | man/libsimple_strend.3 | 3 | ||||
| -rw-r--r-- | man/libsimple_strnend.3 | 78 |
3 files changed, 81 insertions, 2 deletions
diff --git a/libsimple/strn.h b/libsimple/strn.h index 0959100..03c849a 100644 --- a/libsimple/strn.h +++ b/libsimple/strn.h @@ -112,7 +112,7 @@ char *libsimple_strrncasechr(const char *, int, size_t); /* TODO doc */ * if `s`, `&s[n]` is returned */ _LIBSIMPLE_GCC_ONLY(__attribute__((__pure__, __nonnull__, __returns_nonnull__, __warn_unused_result__))) -char *libsimple_strnend(const char *, size_t); /* TODO doc */ +char *libsimple_strnend(const char *, size_t); #ifndef strnend # define strnend libsimple_strnend #endif diff --git a/man/libsimple_strend.3 b/man/libsimple_strend.3 index e1652b6..adfdf6f 100644 --- a/man/libsimple_strend.3 +++ b/man/libsimple_strend.3 @@ -1,4 +1,4 @@ -.TH LIBSIMPLE_STREND 3 2018-10-21 libsimple +.TH LIBSIMPLE_STREND 3 2018-10-23 libsimple .SH NAME libsimple_strend \- find a character in a string .SH SYNOPSIS @@ -66,4 +66,5 @@ None. None. .SH SEE ALSO .BR libsimple_strchrnul (3), +.BR libsimple_strnend (3), .BR strchr (3) diff --git a/man/libsimple_strnend.3 b/man/libsimple_strnend.3 new file mode 100644 index 0000000..26ed564 --- /dev/null +++ b/man/libsimple_strnend.3 @@ -0,0 +1,78 @@ +.TH LIBSIMPLE_STRNEND 3 2018-10-23 libsimple +.SH NAME +libsimple_strnend \- find a character in a string +.SH SYNOPSIS +.nf +#include <libsimple.h> + +static inline char *libsimple_strnend(const char *\fIs\fP, size_t \fIn\fP); + +#ifndef strnend +# define strnend libsimple_strnend +#endif +.fi +.PP +Link with +.IR \-lsimple . +.SH DESCRIPTION +The +.BR libsimple_strnend () +function scans the string +.IR s , +truncated to +.I n +bytes unless it is shorter, +for its end. +.SH RETURN VALUE +The +.BR libsimple_strnend () +function returns the pointer +.I s +with an offset such that +.IR !*r , +where +.I r +is the returned pointer. However, +if no such offset less than +.I n +exists, +.I &s[n] +is returned. +.SH ERRORS +The +.BR libsimple_strnend () +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_strnend () +T} Thread safety MT-Safe +T{ +.BR libsimple_strnend () +T} Async-signal safety AS-Safe +T{ +.BR libsimple_strnend () +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_strnchrnul (3), +.BR libsimple_strnchr (3), +.BR libsimple_strend (3) |