aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/sleep-until.129
1 files changed, 27 insertions, 2 deletions
diff --git a/doc/man/sleep-until.1 b/doc/man/sleep-until.1
index 7567eb4..6672fcf 100644
--- a/doc/man/sleep-until.1
+++ b/doc/man/sleep-until.1
@@ -3,12 +3,36 @@
sleep-until - sleeps until a specified time
.SH SYNOPSIS
.B sleep-until
+.IR clockname ...
.IR timepoint ...
.SH DESCRIPTION
Pause until \fItimepoint\fP. \fItimepoint\fP is the number of
-seconds since Epoch, in UTC but not accounting for leap seconds.
+seconds since Epoch, in UTC but not accounting for leap seconds,
+by default. If \fIclockname\fP is specifed, \fItimepoint\fP is
+the number of seconds since the zerotime of that clock.
\fItimepoint\fP may be an arbitrary floating point number.
Pause is continued when interrupted.
+.PP
+On Linux 4.2.2 the clocks that can be used are:
+.TP
+*
+\fBCLOCK_REALTIME\fP
+.TP
+*
+\fBCLOCK_MONOTONIC\fP
+.TP
+*
+\fBCLOCK_BOOTTIME\fP
+.TP
+*
+\fBCLOCK_REALTIME_ALARM\fP
+.TP
+*
+\fBCLOCK_BOOTTIME_ALARM\fP
+.PP
+Note that the neither course clocks, \fBCLOCK_MONOTONIC_RAW\fP
+(the proper implementation of a monotonic clock), and
+\fBCLOCK_TAI\fP does not work.
.SH EXIT STATUS
.TP
0
@@ -18,7 +42,8 @@ The command was successful.
The command failed.
.SH SEE ALSO
.BR sleep (1),
-.BR date (1)
+.BR date (1),
+.BR clock_gettime (3)
.SH AUTHORS
Principal author, Mattias Andrée. See the COPYING file for the full
list of authors.