From ea7245f229c8f0e3401b992865b0a21a06ff3afc Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Tue, 5 Jan 2016 16:47:32 +0100 Subject: add libred_check_timetravel.3 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- doc/man/libred_check_timetravel.3 | 55 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 doc/man/libred_check_timetravel.3 (limited to 'doc') diff --git a/doc/man/libred_check_timetravel.3 b/doc/man/libred_check_timetravel.3 new file mode 100644 index 0000000..adfde1d --- /dev/null +++ b/doc/man/libred_check_timetravel.3 @@ -0,0 +1,55 @@ +.TH LIBRED_CHECK_TIMETRAVEL 3 LIBRED +.SH NAME +libred_check_timetravel \- Exit the process if the clock is too far in the past +.SH SYNOPSIS +.nf +#include + +int \fBlibred_check_timetravel\fP(void); +.fi +.PP +Link with +.IR -lred . +.SH DESCRIPTION +.B libred_check_timetravel +exits the process if +.B libred +is not compiled to support the current time, which is the case +if it was compiled without +.I \-DTIMETRAVELLER +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" +Upon successful completion, without time incompatibility, the returns +0. Upon failure, that is, it is unable to read the clock, the function +returns -1. +.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 libred.h (0), +.BR libred (7), +.BR libred_solar_elevation (3) +.SH LICENSE +Copyright \(co 2016 Mattias Andrée +.br +License GPLv3+: GNU GPL version 3 or later . +.br +This is free software: you are free to change and redistribute it. +.br +There is NO WARRANTY, to the extent permitted by law. +.PP +Copying and distribution of this manual, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. This file is offered as-is, +without any warranty. +.SH BUGS +Please report bugs to +or to . + -- cgit v1.2.3-70-g09d2