timerfd.2: Add documentation for CLOCK_UPTIME and CLOCK_BOOTTIME

Add CLOCK_UPTIME and CLOCK_BOOTTIME options and a quick pointer
to clock_gettime(2) for a better definition of these values.

Reviewed-by: imp (small tweaks and added Xr)
Pull-Request: https://github.com/freebsd/freebsd-src/pull/1302
This commit is contained in:
Cormac Stephenson 2024-06-28 10:45:44 -06:00 committed by Warner Losh
parent 239e24eb0c
commit 172328c477

View File

@ -23,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.Dd May 21, 2023 .Dd June 28, 2024
.Dt TIMERFD 2 .Dt TIMERFD 2
.Os .Os
.Sh NAME .Sh NAME
@ -95,9 +95,16 @@ argument specifies the clock used as a timing base and may be:
.Bl -tag -width "Dv CLOCK_MONOTONIC" -compact .Bl -tag -width "Dv CLOCK_MONOTONIC" -compact
.It Dv CLOCK_REALTIME .It Dv CLOCK_REALTIME
Increments as a wall clock should. Increments as a wall clock should.
.It Dv CLOCK_BOOTTIME
.It Dv CLOCK_MONOTONIC .It Dv CLOCK_MONOTONIC
Increments monotonically in SI seconds. Increments monotonically in SI seconds.
.It Dv CLOCK_UPTIME
Increments monotonically in SI seconds, but is paused while the system is
suspended.
.El .El
See
.Xr clock_gettime 2
for more precise definitions.
.Pp .Pp
The The
.Fa flags .Fa flags