From 2eb1524105156516e9f7752ee206ad8eb7456671 Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Tue, 30 Oct 2018 18:31:11 +0100
Subject: Add man page for timeval2timespec and timespec2timeval
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@kth.se>
---
 man/libsimple_timespec2timeval.3 |   1 +
 man/libsimple_timeval2timespec.3 | 112 +++++++++++++++++++++++++++++++++++++++
 man/timespec2timeval.3libsimple  |   1 +
 man/timeval2timespec.3libsimple  |   1 +
 4 files changed, 115 insertions(+)
 create mode 120000 man/libsimple_timespec2timeval.3
 create mode 100644 man/libsimple_timeval2timespec.3
 create mode 120000 man/timespec2timeval.3libsimple
 create mode 120000 man/timeval2timespec.3libsimple

(limited to 'man')

diff --git a/man/libsimple_timespec2timeval.3 b/man/libsimple_timespec2timeval.3
new file mode 120000
index 0000000..ea39fdf
--- /dev/null
+++ b/man/libsimple_timespec2timeval.3
@@ -0,0 +1 @@
+libsimple_timeval2timespec.3
\ No newline at end of file
diff --git a/man/libsimple_timeval2timespec.3 b/man/libsimple_timeval2timespec.3
new file mode 100644
index 0000000..d4381ce
--- /dev/null
+++ b/man/libsimple_timeval2timespec.3
@@ -0,0 +1,112 @@
+.TH LIBSIMPLE_TIMEVAL2TIMESPEC 3 2018-10-30 libsimple
+.SH NAME
+libsimple_timeval2timespec, libsimple_timespec2timeval \- convert between timespec and timeval
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+static inline void libsimple_timeval2timespec(struct timespec *restrict \fIts\fP, const struct timeval *restrict \fItv\fP);
+int libsimple_timespec2timeval(struct timeval *restrict \fItv\fP, const struct timespec *restrict \fIts\fP);
+
+#ifndef timeval2timespec
+# define timeval2timespec libsimple_timeval2timespec
+#endif
+#ifndef timespec2timeval
+# define timespec2timeval libsimple_timespec2timeval
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_timeval2timespec ()
+converts the value
+.I *tv
+to a
+.B struct timespec
+and stores the result in
+.IR ts .
+.PP
+The
+.BR libsimple_timespec2timeval ()
+converts the value
+.I *ts
+to a
+.BR "struct timeval" ,
+rounding to nearest microsecond,
+and stores the result in
+.IR tv .
+.SH RETURN VALUE
+The
+.BR libsimple_timespec2timeval ()
+function returns 0 on successful completion; otherwise -1 is returned
+and sets
+.I errno
+to indicate the error.
+.PP
+The
+.BR libsimple_timeval2timespec ()
+function does not return a value.
+.SH ERRORS
+The
+.BR libsimple_timespec2timeval ()
+function fail if:
+.TP
+.B EOVERFLOW
+The value
+.I {.tv_sec=TIME_MAX,.tv_nsec=999999500L}
+or a greater value converted, which would lead to overflow.
+The value
+.I {.tv_sec=TIME_MAX,.tv_usec=999999L}
+will be stored in
+.IR tv .
+.PP
+The
+.BR libsimple_timeval2timespec ()
+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_timeval2timespec ()
+.br
+.BR libsimple_timespec2timeval ()
+T}	Thread safety	MT-Safe
+T{
+.BR libsimple_timeval2timespec ()
+.br
+.BR libsimple_timespec2timeval ()
+T}	Async-signal safety	AS-Safe
+T{
+.BR libsimple_timeval2timespec ()
+.br
+.BR libsimple_timespec2timeval ()
+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_doubletotimespec (3)
diff --git a/man/timespec2timeval.3libsimple b/man/timespec2timeval.3libsimple
new file mode 120000
index 0000000..db76384
--- /dev/null
+++ b/man/timespec2timeval.3libsimple
@@ -0,0 +1 @@
+libsimple_timespec2timeval.3
\ No newline at end of file
diff --git a/man/timeval2timespec.3libsimple b/man/timeval2timespec.3libsimple
new file mode 120000
index 0000000..ea39fdf
--- /dev/null
+++ b/man/timeval2timespec.3libsimple
@@ -0,0 +1 @@
+libsimple_timeval2timespec.3
\ No newline at end of file
-- 
cgit v1.2.3-70-g09d2