LDP
/
man-pages
mirror of https://github.com/mkerrisk/man-pages
0
1
Fork 0
Code Releases Activity

getitimer.2: Rename arguments for consistency with other timer pages 

Also some other minor wording improvements

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2009-02-10 12:37:42 +13:00
parent d6a54d42ba
commit b8fb88249b
1 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
man2/getitimer.2
View File

@ -4,17 +4,17 @@
.\" Modified Tue Oct 22 00:22:35 EDT 1996 by Eric S. Raymond <esr@thyrsus.com>
.\" 2005-04-06 mtk, Matthias Lang <matthias@corelatus.se>
.\" Noted MAX_SEC_IN_JIFFIES ceiling
.TH GETITIMER 2 2008-08-06 "Linux" "Linux Programmer's Manual"
.TH GETITIMER 2 2009-02-11 "Linux" "Linux Programmer's Manual"
.SH NAME
getitimer, setitimer \- get or set value of an interval timer
.SH SYNOPSIS
.nf
.B #include <sys/time.h>
.sp
.BI "int getitimer(int " which ", struct itimerval *" value );
.BI "int getitimer(int " which ", struct itimerval *" curr_value );
.br
.BI "int setitimer(int " which ", const struct itimerval *" value ,
.BI " struct itimerval *" ovalue );
.BI "int setitimer(int " which ", const struct itimerval *" new_value ,
.BI " struct itimerval *" old_value );
.fi
.SH DESCRIPTION
The system provides each process with three interval timers,
@ -62,9 +62,9 @@ struct timeval {
.LP
The function
.BR getitimer ()
fills the structure indicated by
.I value
with the current setting for the timer indicated by
fills the structure pointed to by
.I curr_value
with the current setting for the timer specified by
.I which
(one of
.BR ITIMER_REAL ,
@ -78,12 +78,13 @@ is disabled.
Similarly,
.I it_interval
is set to the reset value.
The function
.BR setitimer ()
sets the indicated timer to the value in
.IR value .
sets the specified timer to the value in
.IR new_value .
If
.I ovalue
.I old_value
is non-NULL, the old value of the timer is stored there.
.LP
Timers decrement from
@ -121,10 +122,11 @@ is set appropriately.
.SH ERRORS
.TP
.B EFAULT
.I value
.IR new_value ,
.IR old_value ,
or
.I ovalue
are not valid pointers.
.I curr_value
is not valid a pointer.
.TP
.B EINVAL
.I which
@ -135,7 +137,9 @@ or
.BR ITIMER_PROF ;
or (since Linux 2.6.22) one of the
.I tv_usec
fields contains a value outside the range 0 to 999999.
fields in the structure pointed to by
.I new_value
contains a value outside the range 0 to 999999.
.SH "CONFORMING TO"
POSIX.1-2001, SVr4, 4.4BSD (this call first appeared in 4.2BSD).
POSIX.1-2008 marks