diff options
author | Mattias Andrée <maandree@kth.se> | 2018-10-29 21:36:10 +0100 |
---|---|---|
committer | Mattias Andrée <maandree@kth.se> | 2018-10-29 21:36:10 +0100 |
commit | 618ef575fb5af9365be4e72eb2c1934006cfb074 (patch) | |
tree | 2f2f46e1af8d921c4d0a933f4ca3d12384c1de4c /man/libsimple_sumtimespec.3 | |
parent | Add documentation to time.h (diff) | |
download | libsimple-618ef575fb5af9365be4e72eb2c1934006cfb074.tar.gz libsimple-618ef575fb5af9365be4e72eb2c1934006cfb074.tar.bz2 libsimple-618ef575fb5af9365be4e72eb2c1934006cfb074.tar.xz |
Add man pages for {sum,diff,mul,cmp}time{spec,val}
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man/libsimple_sumtimespec.3')
-rw-r--r-- | man/libsimple_sumtimespec.3 | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/man/libsimple_sumtimespec.3 b/man/libsimple_sumtimespec.3 new file mode 100644 index 0000000..95dd30b --- /dev/null +++ b/man/libsimple_sumtimespec.3 @@ -0,0 +1,115 @@ +.TH LIBSIMPLE_SUMTIMESPEC 3 2018-10-29 libsimple +.SH NAME +libsimple_sumtimespec \- calculate the sum of two durations +.SH SYNOPSIS +.nf +#include <libsimple.h> + +int libsimple_sumtimespec(struct timespec *\fIsum\fP, const struct timespec *\fIaugend\fP, const struct timespec *\fIaddend\fP); +int libsimple_sumtimeval(struct timeval *\fIsum\fP, const struct timeval *\fIaugend\fP, const struct timeval *\fIaddend\fP); + +#ifndef sumtimespec +# define sumtimespec libsimple_sumtimespec +#endif +#ifndef sumtimeval +# define sumtimeval libsimple_sumtimeval +#endif +.fi +.PP +Link with +.IR \-lsimple . +.SH DESCRIPTION +The +.BR libsimple_sumtimespec () +and +.BR libsimple_sumtimeval () +functions calculates the sum of +.I augend +and +.I addend +and stores the result in +.IR sum . +.SH RETURN VALUE +The +.BR libsimple_sumtimespec () +and +.BR libsimple_sumtimeval () +functions return 0 on successful completion; +otherwise, \−1 is returned and +.I errno +is set to indicate the error. +.SH ERRORS +The +.BR libsimple_sumtimespec () +and +.BR libsimple_sumtimeval () +functions fail if: +.TP +.B ERANGE +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} +for the +.BR libsimple_sumtimespec () +function and to +.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} +for the +.BR libsimple_sumtimespec () +function and to +.I {.tv_sec=TIME_MIN,tv_usec=0} +for the +.BR libsimple_sumtimeval () +function. +.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_sumtimespec () +.br +.BR libsimple_sumtimeval () +T} Thread safety MT-Safe +T{ +.BR libsimple_sumtimespec () +.br +.BR libsimple_sumtimeval () +T} Async-signal safety AS-Safe +T{ +.BR libsimple_sumtimespec () +.br +.BR libsimple_sumtimeval () +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_difftimespec (3), +.BR libsimple_multimespec (3), +.BR libsimple_cmptimespec (3), +.BR libsimple_timespectostr (3), +.BR libsimple_strtotimespec (3), +.BR libsimple_timespectodouble (3), +.BR libsimple_doubletotimespec (3), +.BR libsimple_timeval2timespec (3) |