diff options
author | Mattias Andrée <maandree@kth.se> | 2018-10-30 18:08:15 +0100 |
---|---|---|
committer | Mattias Andrée <maandree@kth.se> | 2018-10-30 18:26:18 +0100 |
commit | abb471449efcb61571b6a63d3055598acafd9ffe (patch) | |
tree | 4ebd956ac77e09e588a370dfccd74615e4d8b044 | |
parent | Add man pages for {sum,diff,mul,cmp}time{spec,val} (diff) | |
download | libsimple-abb471449efcb61571b6a63d3055598acafd9ffe.tar.gz libsimple-abb471449efcb61571b6a63d3055598acafd9ffe.tar.bz2 libsimple-abb471449efcb61571b6a63d3055598acafd9ffe.tar.xz |
Add man pages for doubletotime{spec,val} and time{spec,val}todouble, and fix other man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
36 files changed, 219 insertions, 42 deletions
diff --git a/man/doubletotimespec.3libsimple b/man/doubletotimespec.3libsimple new file mode 120000 index 0000000..4158ff1 --- /dev/null +++ b/man/doubletotimespec.3libsimple @@ -0,0 +1 @@ +libsimple_doubletotimespec.3
\ No newline at end of file diff --git a/man/doubletotimeval.3libsimple b/man/doubletotimeval.3libsimple new file mode 120000 index 0000000..c61511a --- /dev/null +++ b/man/doubletotimeval.3libsimple @@ -0,0 +1 @@ +libsimple_doubletotimeval.3
\ No newline at end of file diff --git a/man/libsimple_aligned_memdup.3 b/man/libsimple_aligned_memdup.3 index b80d6af..17132ff 100644 --- a/man/libsimple_aligned_memdup.3 +++ b/man/libsimple_aligned_memdup.3 @@ -1,6 +1,6 @@ .TH LIBSIMPLE_ALIGNED_MEMDUP 3 2018-10-27 libsimple .SH NAME -libsimple_aligned_memdup \- duplicate bytes in memory +libsimple_aligned_memdup, libsimple_aligned_memdupa \- duplicate bytes in memory .SH SYNOPSIS .nf #include <libsimple.h> diff --git a/man/libsimple_cmptimespec.3 b/man/libsimple_cmptimespec.3 index f4ea051..14873ea 100644 --- a/man/libsimple_cmptimespec.3 +++ b/man/libsimple_cmptimespec.3 @@ -1,6 +1,6 @@ .TH LIBSIMPLE_CMPTIMESPEC 3 2018-10-29 libsimple .SH NAME -libsimple_cmptimespec \- calculate the sum of two durations +libsimple_cmptimespec, libsimple_cmptimeval \- calculate the sum of two durations .SH SYNOPSIS .nf #include <libsimple.h> diff --git a/man/libsimple_difftimespec.3 b/man/libsimple_difftimespec.3 index af0f7e3..49d4faa 100644 --- a/man/libsimple_difftimespec.3 +++ b/man/libsimple_difftimespec.3 @@ -1,6 +1,6 @@ .TH LIBSIMPLE_DIFFTIMESPEC 3 2018-10-29 libsimple .SH NAME -libsimple_difftimespec \- calculate the difference of two durations +libsimple_difftimespec, libsimple_difftimeval \- calculate the difference of two durations .SH SYNOPSIS .nf #include <libsimple.h> @@ -38,7 +38,7 @@ The and .BR libsimple_difftimeval () functions return 0 on successful completion; -otherwise, \−1 is returned and +otherwise, \-1 is returned and .I errno is set to indicate the error. .SH ERRORS @@ -53,21 +53,21 @@ The result is too large or too small to be stored; if the result is too large .I *diff will be set to -.I {.tv_sec=TIME_MAX,tv_nsec=999999999L} +.I {.tv_sec=TIME_MAX,.tv_nsec=999999999L} for the .BR libsimple_difftimespec () function and to -.I {.tv_sec=TIME_MAX,tv_usec=999999L} +.I {.tv_sec=TIME_MAX,.tv_usec=999999L} for the .BR libsimple_difftimeval () function, if the result is too small .I *diff will be set to -.I {.tv_sec=TIME_MIN,tv_nsec=0} +.I {.tv_sec=TIME_MIN,.tv_nsec=0} for the .BR libsimple_difftimespec () function and to -.I {.tv_sec=TIME_MIN,tv_usec=0} +.I {.tv_sec=TIME_MIN,.tv_usec=0} for the .BR libsimple_difftimeval () function. diff --git a/man/libsimple_doubletotimespec.3 b/man/libsimple_doubletotimespec.3 new file mode 100644 index 0000000..1d8790c --- /dev/null +++ b/man/libsimple_doubletotimespec.3 @@ -0,0 +1,88 @@ +.TH LIBSIMPLE_DOUBLETOTIMESPEC 3 2018-10-30 libsimple +.SH NAME +libsimple_doubletotimespec, libsimple_doubletotimeval \- convert a double to a duration data structure +.SH SYNOPSIS +.nf +#include <libsimple.h> + +void libsimple_doubletotimespec(struct timespec *\fIts\fP, double \fId\fP); +void libsimple_doubletotimeval(struct timeval *\fItv\fP, double \fId\fP); + +#ifndef doubletotimespec +# define doubletotimespec libsimple_doubletotimespec +#endif +#ifndef doubletotimeval +# define doubletotimeval libsimple_doubletotimeval +#endif +.fi +.PP +Link with +.IR \-lsimple . +.SH DESCRIPTION +The +.BR libsimple_doubletotimespec () +function converts the real value +.I d +to a +.B struct timespec +and stores the result in +.IR ts . +The +.BR libsimple_doubletotimeval () +function converts the real value +.I d +to a +.B struct timeval +and stores the result in +.IR tv . +.PP +Neither of these functions perform an overflow check. +.SH RETURN VALUE +None. +.SH ERRORS +No error checks are made. +.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_doubletotimespec () +.br +.BR libsimple_doubletotimeval () +T} Thread safety MT-Safe +T{ +.BR libsimple_doubletotimespec () +.br +.BR libsimple_doubletotimeval () +T} Async-signal safety AS-Safe +T{ +.BR libsimple_doubletotimespec () +.br +.BR libsimple_doubletotimeval () +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_sumtimespec (3), +.BR libsimple_difftimespec (3), +.BR libsimple_multimespec (3), +.BR libsimple_cmptimespec (3), +.BR libsimple_timespectostr (3), +.BR libsimple_strtotimespec (3), +.BR libsimple_timespectodouble (3), +.BR libsimple_timeval2timespec (3) diff --git a/man/libsimple_doubletotimeval.3 b/man/libsimple_doubletotimeval.3 new file mode 120000 index 0000000..4158ff1 --- /dev/null +++ b/man/libsimple_doubletotimeval.3 @@ -0,0 +1 @@ +libsimple_doubletotimespec.3
\ No newline at end of file diff --git a/man/libsimple_enstrdup.3 b/man/libsimple_enstrdup.3 index cb67577..512da34 100644 --- a/man/libsimple_enstrdup.3 +++ b/man/libsimple_enstrdup.3 @@ -1,6 +1,6 @@ .TH LIBSIMPLE_ENSTRDUP 3 2018-10-27 libsimple .SH NAME -libsimple_enstrdup \- duplicate a string +libsimple_enstrdup, libsimple_strdupa \- duplicate a string .SH SYNOPSIS .nf #include <libsimple.h> diff --git a/man/libsimple_enstrndup.3 b/man/libsimple_enstrndup.3 index 38a85ed..c761c1c 100644 --- a/man/libsimple_enstrndup.3 +++ b/man/libsimple_enstrndup.3 @@ -1,6 +1,6 @@ .TH LIBSIMPLE_ENSTRNDUP 3 2018-10-27 libsimple .SH NAME -libsimple_enstrndup \- duplicate the beginning of a string +libsimple_enstrndup, libsimple_strndupa \- duplicate the beginning of a string .SH SYNOPSIS .nf #include <libsimple.h> diff --git a/man/libsimple_getenv_ne.3 b/man/libsimple_getenv_ne.3 index 55b592e..cd788d3 100644 --- a/man/libsimple_getenv_ne.3 +++ b/man/libsimple_getenv_ne.3 @@ -34,7 +34,7 @@ If the environment variable .I name is defined with a non-empty value, its value is returned, otherwise -.I NULL +.B NULL is returned. .PP The returned pointer must not be deallocated and diff --git a/man/libsimple_memcasecmp.3 b/man/libsimple_memcasecmp.3 index 9f93995..63e0e27 100644 --- a/man/libsimple_memcasecmp.3 +++ b/man/libsimple_memcasecmp.3 @@ -26,7 +26,7 @@ and .PP The comparison is case-insensitive and made as if the strings were converted to lowercase and as -.IR "unsigned char *" s. +.BR "unsigned char *" s. .SH RETURN VALUE The .BR libsimple_memcasecmp () diff --git a/man/libsimple_multimespec.3 b/man/libsimple_multimespec.3 index 0d464ee..a55b7a2 100644 --- a/man/libsimple_multimespec.3 +++ b/man/libsimple_multimespec.3 @@ -1,6 +1,6 @@ .TH LIBSIMPLE_MULTIMESPEC 3 2018-10-29 libsimple .SH NAME -libsimple_multimespec \- multiply a duration with an integer +libsimple_multimespec, libsimple_multimeval \- multiply a duration with an integer .SH SYNOPSIS .nf #include <libsimple.h> @@ -35,7 +35,7 @@ The and .BR libsimple_multimeval () functions return 0 on successful completion; -otherwise, \−1 is returned and +otherwise, \-1 is returned and .I errno is set to indicate the error. .SH ERRORS @@ -50,21 +50,21 @@ The result is too large or too small to be stored; if the result is too large .I *diff will be set to -.I {.tv_sec=TIME_MAX,tv_nsec=999999999L} +.I {.tv_sec=TIME_MAX,.tv_nsec=999999999L} for the .BR libsimple_multimespec () function and to -.I {.tv_sec=TIME_MAX,tv_usec=999999L} +.I {.tv_sec=TIME_MAX,.tv_usec=999999L} for the .BR libsimple_multimeval () function, if the result is too small .I *diff will be set to -.I {.tv_sec=TIME_MIN,tv_nsec=0} +.I {.tv_sec=TIME_MIN,.tv_nsec=0} for the .BR libsimple_multimespec () function and to -.I {.tv_sec=TIME_MIN,tv_usec=0} +.I {.tv_sec=TIME_MIN,.tv_usec=0} for the .BR libsimple_multimeval () function. diff --git a/man/libsimple_strcasechr.3 b/man/libsimple_strcasechr.3 index 4751538..9e60426 100644 --- a/man/libsimple_strcasechr.3 +++ b/man/libsimple_strcasechr.3 @@ -38,7 +38,7 @@ where .I r is the returned pointer, if no such offset exists, it returns -.IR NULL . +.BR NULL . .SH ERRORS The .BR libsimple_strcasechr () diff --git a/man/libsimple_strcasecmpnul.3 b/man/libsimple_strcasecmpnul.3 index 07be013..2b0afe6 100644 --- a/man/libsimple_strcasecmpnul.3 +++ b/man/libsimple_strcasecmpnul.3 @@ -31,7 +31,7 @@ greater than the shorter string. .PP The comparison is case-insensitive and made as if the strings were converted to lowercase and as -.IR "unsigned char *" s. +.BR "unsigned char *" s. .SH RETURN VALUE The .BR libsimple_strcasecmpnul () diff --git a/man/libsimple_strcaseeq.3 b/man/libsimple_strcaseeq.3 index c3ad68b..b1a25bd 100644 --- a/man/libsimple_strcaseeq.3 +++ b/man/libsimple_strcaseeq.3 @@ -25,7 +25,6 @@ neither of which may be .BR NULL . .PP The comparison is case-insensitive. -.IR "unsigned char *" s. .SH RETURN VALUE The .BR libsimple_strcaseeq () diff --git a/man/libsimple_strcaseeqnul.3 b/man/libsimple_strcaseeqnul.3 index f405def..fa26a17 100644 --- a/man/libsimple_strcaseeqnul.3 +++ b/man/libsimple_strcaseeqnul.3 @@ -25,7 +25,6 @@ both of which may be .BR NULL . .PP The comparison is case-insensitive. -.IR "unsigned char *" s. .SH RETURN VALUE The .BR libsimple_strcaseeqnul () diff --git a/man/libsimple_streq.3 b/man/libsimple_streq.3 index 602b633..76c1779 100644 --- a/man/libsimple_streq.3 +++ b/man/libsimple_streq.3 @@ -25,7 +25,6 @@ neither of which may be .BR NULL . .PP The comparison is case-sensitive. -.IR "unsigned char *" s. .SH RETURN VALUE The .BR libsimple_streq () diff --git a/man/libsimple_streqnul.3 b/man/libsimple_streqnul.3 index eef5291..84ccf88 100644 --- a/man/libsimple_streqnul.3 +++ b/man/libsimple_streqnul.3 @@ -25,7 +25,6 @@ both of which may be .BR NULL . .PP The comparison is case-sensitive. -.IR "unsigned char *" s. .SH RETURN VALUE The .BR libsimple_streqnul () diff --git a/man/libsimple_strncasechr.3 b/man/libsimple_strncasechr.3 index aaa21ae..1a7716f 100644 --- a/man/libsimple_strncasechr.3 +++ b/man/libsimple_strncasechr.3 @@ -43,7 +43,7 @@ is the returned pointer, if no such offset less than .I n exists, it returns -.IR NULL . +.BR NULL . .SH ERRORS The .BR libsimple_strncasechr () diff --git a/man/libsimple_strncasecmpnul.3 b/man/libsimple_strncasecmpnul.3 index 4fda1b7..959ea78 100644 --- a/man/libsimple_strncasecmpnul.3 +++ b/man/libsimple_strncasecmpnul.3 @@ -37,7 +37,7 @@ greater than the shorter string. .PP The comparison is case-insensitive and made as if the strings were converted to lowercase and as -.IR "unsigned char *" s. +.BR "unsigned char *" s. .SH RETURN VALUE The .BR libsimple_strncasecmpnul () diff --git a/man/libsimple_strncaseeq.3 b/man/libsimple_strncaseeq.3 index f3b63cd..55c2f79 100644 --- a/man/libsimple_strncaseeq.3 +++ b/man/libsimple_strncaseeq.3 @@ -31,7 +31,6 @@ neither of which may be .BR NULL . .PP The comparison is case-insensitive. -.IR "unsigned char *" s. .SH RETURN VALUE The .BR libsimple_strncaseeq () diff --git a/man/libsimple_strncaseeqnul.3 b/man/libsimple_strncaseeqnul.3 index 0a9222a..743d4be 100644 --- a/man/libsimple_strncaseeqnul.3 +++ b/man/libsimple_strncaseeqnul.3 @@ -31,7 +31,6 @@ both of which may be .BR NULL . .PP The comparison is case-insensitive. -.IR "unsigned char *" s. .SH RETURN VALUE The .BR libsimple_strncaseeqnul () diff --git a/man/libsimple_strnchr.3 b/man/libsimple_strnchr.3 index 86a5583..2af62c3 100644 --- a/man/libsimple_strnchr.3 +++ b/man/libsimple_strnchr.3 @@ -43,7 +43,7 @@ is the returned pointer, if no such offset less than .I n exists, it returns -.IR NULL . +.BR NULL . .SH ERRORS The .BR libsimple_strnchr () diff --git a/man/libsimple_strncmpnul.3 b/man/libsimple_strncmpnul.3 index b482e58..f53dc8c 100644 --- a/man/libsimple_strncmpnul.3 +++ b/man/libsimple_strncmpnul.3 @@ -37,7 +37,7 @@ greater than the shorter string. .PP The comparison is case-sensitive and made as if the strings were -.IR "unsigned char *" s. +.BR "unsigned char *" s. .SH RETURN VALUE The .BR libsimple_strncmpnul () diff --git a/man/libsimple_strneq.3 b/man/libsimple_strneq.3 index 5b6eebf..a315870 100644 --- a/man/libsimple_strneq.3 +++ b/man/libsimple_strneq.3 @@ -31,7 +31,6 @@ neither of which may be .BR NULL . .PP The comparison is case-sensitive. -.IR "unsigned char *" s. .SH RETURN VALUE The .BR libsimple_strneq () diff --git a/man/libsimple_strneqnul.3 b/man/libsimple_strneqnul.3 index d01712f..610844b 100644 --- a/man/libsimple_strneqnul.3 +++ b/man/libsimple_strneqnul.3 @@ -31,7 +31,6 @@ both of which may be .BR NULL . .PP The comparison is case-sensitive. -.IR "unsigned char *" s. .SH RETURN VALUE The .BR libsimple_strneqnul () diff --git a/man/libsimple_strrcasechr.3 b/man/libsimple_strrcasechr.3 index c30a946..34475b6 100644 --- a/man/libsimple_strrcasechr.3 +++ b/man/libsimple_strrcasechr.3 @@ -38,7 +38,7 @@ where .I r is the returned pointer, if no such offset exists, it returns -.IR NULL . +.BR NULL . .SH ERRORS The .BR libsimple_strrcasechr () diff --git a/man/libsimple_strrncasechr.3 b/man/libsimple_strrncasechr.3 index e39daea..9d70548 100644 --- a/man/libsimple_strrncasechr.3 +++ b/man/libsimple_strrncasechr.3 @@ -43,7 +43,7 @@ is the returned pointer, if no such offset less than .I n exists, it returns -.IR NULL . +.BR NULL . .SH ERRORS The .BR libsimple_strrncasechr () diff --git a/man/libsimple_strrnchr.3 b/man/libsimple_strrnchr.3 index 8a7a2cc..f01025d 100644 --- a/man/libsimple_strrnchr.3 +++ b/man/libsimple_strrnchr.3 @@ -43,7 +43,7 @@ is the returned pointer, if no such offset less than .I n exists, it returns -.IR NULL . +.BR NULL . .SH ERRORS The .BR libsimple_strrnchr () diff --git a/man/libsimple_strtotimeval.3 b/man/libsimple_strtotimeval.3 new file mode 120000 index 0000000..9bc7f8b --- /dev/null +++ b/man/libsimple_strtotimeval.3 @@ -0,0 +1 @@ +libsimple_strtotimespec.3
\ No newline at end of file diff --git a/man/libsimple_sumtimespec.3 b/man/libsimple_sumtimespec.3 index 95dd30b..81632b8 100644 --- a/man/libsimple_sumtimespec.3 +++ b/man/libsimple_sumtimespec.3 @@ -1,6 +1,6 @@ .TH LIBSIMPLE_SUMTIMESPEC 3 2018-10-29 libsimple .SH NAME -libsimple_sumtimespec \- calculate the sum of two durations +libsimple_sumtimespec, libsimple_sumtimeval \- calculate the sum of two durations .SH SYNOPSIS .nf #include <libsimple.h> @@ -35,7 +35,7 @@ The and .BR libsimple_sumtimeval () functions return 0 on successful completion; -otherwise, \−1 is returned and +otherwise, \-1 is returned and .I errno is set to indicate the error. .SH ERRORS @@ -50,21 +50,21 @@ The result is too large or too small to be stored; if the result is too large .I *sum will be set to -.I {.tv_sec=TIME_MAX,tv_nsec=999999999L} +.I {.tv_sec=TIME_MAX,.tv_nsec=999999999L} for the .BR libsimple_sumtimespec () function and to -.I {.tv_sec=TIME_MAX,tv_usec=999999L} +.I {.tv_sec=TIME_MAX,.tv_usec=999999L} for the .BR libsimple_sumtimeval () function, if the result is too small .I *sum will be set to -.I {.tv_sec=TIME_MIN,tv_nsec=0} +.I {.tv_sec=TIME_MIN,.tv_nsec=0} for the .BR libsimple_sumtimespec () function and to -.I {.tv_sec=TIME_MIN,tv_usec=0} +.I {.tv_sec=TIME_MIN,.tv_usec=0} for the .BR libsimple_sumtimeval () function. diff --git a/man/libsimple_timespectodouble.3 b/man/libsimple_timespectodouble.3 new file mode 100644 index 0000000..fddc899 --- /dev/null +++ b/man/libsimple_timespectodouble.3 @@ -0,0 +1,90 @@ +.TH LIBSIMPLE_TIMESPECTODOUBLE 3 2018-10-30 libsimple +.SH NAME +libsimple_timespectodouble, libsimple_timevaltodouble \- convert a duration data structure to a double +.SH SYNOPSIS +.nf +#include <libsimple.h> + +static inline double libsimple_timespectodouble(const struct timespec *\fIts\fP); +static inline double libsimple_timevaltodouble(const struct timeval *\fItv\fP); + +#ifndef timespectodouble +# define timespectodouble libsimple_timespectodouble +#endif +#ifndef timevaltodouble +# define timevaltodouble libsimple_timevaltodouble +#endif +.fi +.PP +Link with +.IR \-lsimple . +.SH DESCRIPTION +The +.BR libsimple_timespectodouble () +and +.BR libsimple_timevaltodouble () +functions convert +.I ts +and +.IR tv , +respectively, to a +.B double +and return the result. +.SH RETURN VALUE +The +.BR libsimple_timespectodouble () +and +.BR libsimple_timevaltodouble () +functions return the input argument as a +.BR double . +.SH ERRORS +The +.BR libsimple_timespectodouble () +and +.BR libsimple_timevaltodouble () +functions 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_timespectodouble () +.br +.BR libsimple_timevaltodouble () +T} Thread safety MT-Safe +T{ +.BR libsimple_timespectodouble () +.br +.BR libsimple_timevaltodouble () +T} Async-signal safety AS-Safe +T{ +.BR libsimple_timespectodouble () +.br +.BR libsimple_timevaltodouble () +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_sumtimespec (3), +.BR libsimple_difftimespec (3), +.BR libsimple_multimespec (3), +.BR libsimple_cmptimespec (3), +.BR libsimple_timespectostr (3), +.BR libsimple_strtotimespec (3), +.BR libsimple_doubletotimespec (3), +.BR libsimple_timeval2timespec (3) diff --git a/man/libsimple_timevaltodouble.3 b/man/libsimple_timevaltodouble.3 new file mode 120000 index 0000000..dcb0a1c --- /dev/null +++ b/man/libsimple_timevaltodouble.3 @@ -0,0 +1 @@ +libsimple_timespectodouble.3
\ No newline at end of file diff --git a/man/libsimple_vputenvf.3 b/man/libsimple_vputenvf.3 index 479ac33..cc7f75d 100644 --- a/man/libsimple_vputenvf.3 +++ b/man/libsimple_vputenvf.3 @@ -57,7 +57,7 @@ The function is a version of the .BR libsimple_vputenvf () that uses variadic arguments instead of -.IR va_list . +.BR va_list . .PP The .BR libsimple_envputenvf () diff --git a/man/timespectodouble.3libsimple b/man/timespectodouble.3libsimple new file mode 120000 index 0000000..dcb0a1c --- /dev/null +++ b/man/timespectodouble.3libsimple @@ -0,0 +1 @@ +libsimple_timespectodouble.3
\ No newline at end of file diff --git a/man/timevaltodouble.3libsimple b/man/timevaltodouble.3libsimple new file mode 120000 index 0000000..87eeb49 --- /dev/null +++ b/man/timevaltodouble.3libsimple @@ -0,0 +1 @@ +libsimple_timevaltodouble.3
\ No newline at end of file |