aboutsummaryrefslogtreecommitdiffstats
path: root/libred_check_timetravel.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2019-10-06 14:54:42 +0200
committerMattias Andrée <maandree@kth.se>2019-10-06 14:54:42 +0200
commitf5b396dd73ea28506286e0be09d5e76e802222a2 (patch)
treecfc285a83639e78858d954cf82815cefe10a55ce /libred_check_timetravel.3
parentClean up (diff)
downloadlibred-f5b396dd73ea28506286e0be09d5e76e802222a2.tar.gz
libred-f5b396dd73ea28506286e0be09d5e76e802222a2.tar.bz2
libred-f5b396dd73ea28506286e0be09d5e76e802222a2.tar.xz
Simplify
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
-rw-r--r--libred_check_timetravel.3 (renamed from man/libred_check_timetravel.3)22
1 files changed, 10 insertions, 12 deletions
diff --git a/man/libred_check_timetravel.3 b/libred_check_timetravel.3
index 1d34d39..cf79cd2 100644
--- a/man/libred_check_timetravel.3
+++ b/libred_check_timetravel.3
@@ -11,8 +11,9 @@ int \fBlibred_check_timetravel\fP(void);
Link with
.IR -lred .
.SH DESCRIPTION
-.B libred_check_timetravel
-exits the process if
+The
+.BR libred_check_timetravel ()
+function exits the process if
.B libred
is not compiled to support the current time, which is the case
if it was compiled without
@@ -20,19 +21,16 @@ if it was compiled without
and the clock is before year 2000.5 in the Julian calendar. Before
exiting, the function will print an informative error message to
standard error.
-.SH "RETURN VALUE"
+.SH RETURN VALUE
Upon successful completion, without time incompatibility, the function
-returns 0. Upon failure, that is, it is unable to read the clock, the
-function returns -1.
+.BR libred_check_timetravel ()
+returns 0. On failure, the function returns -1 and sets
+.I errno
+to indicate the error.
.SH ERRORS
The function may fail for any reason specified for
-.BR clock_gettime (3),
-and set the value of
-.B errno
-to the same values.
-.SH "FUTURE DIRECTIONS"
-None.
-.SH "SEE ALSO"
+.BR clock_gettime (3).
+.SH SEE ALSO
.BR libred.h (0),
.BR libred (7),
.BR libred_solar_elevation (3)