[src/trunk]: src/lib/libc/sys document ITIMER_MONOTONIC.

[christos <christos%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/6ac6b5924395
branches:  trunk
changeset: 770641:6ac6b5924395
user:      christos <christos%NetBSD.org@localhost>
date:      Thu Oct 27 16:10:37 2011 +0000

description:
document ITIMER_MONOTONIC.

diffstat:

 lib/libc/sys/getitimer.2 |  24 +++++++++++++++++++++---
 1 files changed, 21 insertions(+), 3 deletions(-)

diffs (58 lines):

diff -r b3f032e68e0a -r 6ac6b5924395 lib/libc/sys/getitimer.2
--- a/lib/libc/sys/getitimer.2  Thu Oct 27 14:47:59 2011 +0000
+++ b/lib/libc/sys/getitimer.2  Thu Oct 27 16:10:37 2011 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: getitimer.2,v 1.27 2011/10/03 15:49:02 njoly Exp $
+.\"    $NetBSD: getitimer.2,v 1.28 2011/10/27 16:10:37 christos Exp $
 .\"
 .\" Copyright (c) 1983, 1991, 1993
 .\"    The Regents of the University of California.  All rights reserved.
@@ -29,7 +29,7 @@
 .\"
 .\"     @(#)getitimer.2        8.3 (Berkeley) 5/16/95
 .\"
-.Dd October 3, 2011
+.Dd October 27, 2011
 .Dt GETITIMER 2
 .Os
 .Sh NAME
@@ -93,9 +93,13 @@
 The
 .Fa which
 parameter specifies the type of the timer:
-.Bl -tag -width "ITIMER_VIRTUAL " -offset indent
+.Bl -tag -width "ITIMER_MONOTONIC " -offset indent
 .It Dv ITIMER_REAL
 timer decrements in real time.
+This timer is affected by
+.Xr adjtime 2
+and
+.Xr settimeofday 2 .
 A
 .Dv SIGALRM
 signal is
@@ -121,6 +125,16 @@
 Because this signal may interrupt in-progress
 system calls, programs using this timer must be prepared to
 restart interrupted system calls.
+.It Dv ITIMER_MONOTONIC
+timer decrements in monotonic time.
+This timer is not affected by
+.Xr adjtime 2
+and
+.Xr settimeofday 2 .
+A
+.Dv SIGALRM
+signal is
+delivered when this timer expires.
 .El
 Note that:
 .Bl -bullet -offset indent
@@ -179,3 +193,7 @@
 .Fn getitimer
 function call appeared in
 .Bx 4.2 .
+The
+.Dv ITIMER_MONOTONIC
+functionality appeared in
+.Nx 6.0 .