aboutsummaryrefslogtreecommitdiffstats
path: root/man/libsimple_doubletotimespec.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2018-10-30 18:08:15 +0100
committerMattias Andrée <maandree@kth.se>2018-10-30 18:26:18 +0100
commitabb471449efcb61571b6a63d3055598acafd9ffe (patch)
tree4ebd956ac77e09e588a370dfccd74615e4d8b044 /man/libsimple_doubletotimespec.3
parentAdd man pages for {sum,diff,mul,cmp}time{spec,val} (diff)
downloadlibsimple-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 'man/libsimple_doubletotimespec.3')
-rw-r--r--man/libsimple_doubletotimespec.388
1 files changed, 88 insertions, 0 deletions
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)