From 72b2291551712d6182c798b23884bf50f2cf244e Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Tue, 10 Nov 2015 01:31:04 +0100 Subject: update doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- README | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) (limited to 'README') diff --git a/README b/README index c37bdae..8725722 100644 --- a/README +++ b/README @@ -2,14 +2,26 @@ NAME sleep-until – sleeps until a specified time SYNOPSIS - sleep-until TIMEPOINT... + sleep-until CLOCKNAME... TIMEPOINT... DESCRIPTION Pause until TIMEPOINT. TIMEPOINT is the number of seconds - since Epoch, in UTC but not accounting for leap seconds. + since Epoch, in UTC but not accounting for leap seconds, + by default. If CLOCKNAME is specifed, TIMEPOINT is the + number of seconds since the zerotime of that clock. TIMEPOINT may be an arbitrary floating point number. Pause is continued when interrupted. + On Linux 4.2.2 the clocks that can be used are: + * CLOCK_REALTIME + * CLOCK_MONOTONIC + * CLOCK_BOOTTIME + * CLOCK_REALTIME_ALARM + * CLOCK_BOOTTIME_ALARM + Note that the neither course clocks, CLOCK_MONOTONIC_RAW + (the proper implementation of a monotonic clock), and + CLOCK_TAI does not work. + SEE ALSO sleep(1), date(1) -- cgit v1.2.3-70-g09d2