timer_create.2: Document CLOCK_REALTIME_ALARM and CLOCK_BOOTTIME_ALARM

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2016-11-21 14:53:44 +01:00
parent 39c97bde31
commit 8b047fe272
1 changed files with 22 additions and 4 deletions

View File

@ -23,10 +23,6 @@
.\" the source, must acknowledge the copyright and authors of this work.
.\" %%%LICENSE_END
.\"
.\" FIXME Linux 3.0 adds CLOCK_BOOTTIME_ALARM and CLOCK_REALTIME_ALARM,
.\" which need be documented
.\" Does this also affect timerfd_create()?
.\"
.TH TIMER_CREATE 2 2015-07-23 Linux "Linux Programmer's Manual"
.SH NAME
timer_create \- create a POSIX per-process timer
@ -96,6 +92,28 @@ This is useful for applications that need to be suspend-aware.
.BR CLOCK_REALTIME
is not suitable for such applications, since that clock is affected
by discontinuous changes to the system clock.
.TP
.BR CLOCK_REALTIME_ALARM " (since Linux 3.0)"
.\" commit 9a7adcf5c6dea63d2e47e6f6d2f7a6c9f48b9337
This clock is like
.BR CLOCK_REALTIME ,
but will wake the system if it is suspended.
The caller must have the
.B CAP_WAKE_ALARM
capability in order to set a timer against this clock.
.TP
.BR CLOCK_BOOTTIME_ALARM " (since Linux 3.0)"
.\" commit 9a7adcf5c6dea63d2e47e6f6d2f7a6c9f48b9337
This clock is like
.BR CLOCK_BOOTTIME ,
but will wake the system if it is suspended.
The caller must have the
.B CAP_WAKE_ALARM
capability in order to set a timer against this clock.
.\" FIXME Linux 3.0 adds CLOCK_BOOTTIME_ALARM and CLOCK_REALTIME_ALARM,
.\" which need be documented
.\" Does this also affect timerfd_create()?
.\"
.PP
As well as the above values,
.I clockid