execve.2, exec.3: Consistently use the term 'pathname' (not 'path')

[thirdparty/man-pages.git] / man2 / timer_settime.2

diff --git a/man2/timer_settime.2 b/man2/timer_settime.2
index ba596cb3b97fa910cf559f1a50ec48f30377b62f..e2b5d8c323fde0fefda91c42f5ad39bcc5581490 100644 (file)
--- a/man2/timer_settime.2
+++ b/man2/timer_settime.2
@@ -1,6 +1,7 @@
 .\" Copyright (c) 2009 Linux Foundation, written by Michael Kerrisk
 .\"     <mtk.manpages@gmail.com>
 .\"
+.\" %%%LICENSE_START(VERBATIM)
 .\" Permission is granted to make and distribute verbatim copies of this
 .\" manual provided the copyright notice and this permission notice are
 .\" preserved on all copies.
@@ -20,46 +21,48 @@
 .\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
-.TH TIMER_SETTIME 2 2009-02-20 Linux "Linux Programmer's Manual"
+.\" %%%LICENSE_END
+.\"
+.TH TIMER_SETTIME 2 2017-09-15 Linux "Linux Programmer's Manual"
 .SH NAME
 timer_settime, timer_gettime \- arm/disarm and fetch
 state of POSIX per-process timer
 .SH SYNOPSIS
 .nf
 .B  #include <time.h>
-
+.PP
 .BI "int timer_settime(timer_t " timerid ", int " flags ,
 .BI "                  const struct itimerspec *" new_value ,
-.BI "                  struct itimerspec * " old_value );
+.BI "                  struct itimerspec *" old_value );
 .BI "int timer_gettime(timer_t " timerid ", struct itimerspec *" curr_value );
 .fi
-
+.PP
 Link with \fI\-lrt\fP.
-.sp
+.PP
 .in -4n
 Feature Test Macro Requirements for glibc (see
 .BR feature_test_macros (7)):
 .in
-.sp
+.PP
 .BR timer_settime (),
 .BR timer_gettime ():
-_POSIX_C_SOURCE >= 199309L
+_POSIX_C_SOURCE\ >=\ 199309L
 .SH DESCRIPTION
 .BR timer_settime ()
 arms or disarms the timer identified by
 .IR timerid .
 The
 .I new_value
-argument is an
+argument is pointer to an
 .I itimerspec
 structure that specifies the new initial value and
 the new interval for the timer.
 The
 .I itimerspec
 structure is defined as follows:
-
+.PP
 .in +4n
-.nf
+.EX
 struct timespec {
     time_t tv_sec;                /* Seconds */
     long   tv_nsec;               /* Nanoseconds */
@@ -69,9 +72,9 @@ struct itimerspec {
     struct timespec it_interval;  /* Timer interval */
     struct timespec it_value;     /* Initial expiration */
 };
-.fi
+.EE
 .in
-
+.PP
 Each of the substructures of the
 .I itimerspec
 structure is a
@@ -80,8 +83,8 @@ structure that allows a time value to be specified
 in seconds and nanoseconds.
 These time values are measured according to the clock
 that was specified when the timer was created by
-.BR timer_create ()
-
+.BR timer_create (2).
+.PP
 If
 .I new_value->it_value
 specifies a nonzero value (i.e., either subfield is nonzero), then
@@ -95,7 +98,7 @@ If
 specifies a zero value
 (i.e., both subfields are zero),
 then the timer is disarmed.
-
+.PP
 The
 .I new_value->it_interval
 field specifies the period of the timer, in seconds and nanoseconds.
@@ -104,10 +107,10 @@ the timer is reloaded from the value specified in
 .IR new_value->it_interval .
 If
 .I new_value->it_interval
-specifies a zero value
+specifies a zero value,
 then the timer expires just once, at the time specified by
 .IR it_value .
-
+.PP
 By default, the initial expiration time specified in
 .I new_value->it_value
 is interpreted relative to the current time on the timer's
@@ -128,7 +131,7 @@ and the overrun count (see
 .BR timer_getoverrun (2))
 will be set correctly.
 .\" By experiment: the overrun count is set correctly, for CLOCK_REALTIME.
-
+.PP
 If the value of the
 .B CLOCK_REALTIME
 clock is adjusted while an absolute timer based on that clock is armed,
@@ -138,15 +141,16 @@ Adjustments to the
 clock have no effect on relative timers based on that clock.
 .\" Similar remarks might apply with respect to process and thread CPU time
 .\" clocks, but these clocks are not currently (2.6.28) settable on Linux.
-
+.PP
 If
 .I old_value
-is not NULL, then it returns the previous interval of the timer (in
+is not NULL, then it points to a buffer
+that is used to return the previous interval of the timer (in
 .IR old_value->it_interval )
 and the amount of time until the timer
 would previously have next expired (in
 .IR old_value->it_value ).
-
+.PP
 .BR timer_gettime ()
 returns the time until next expiration, and the interval,
 for the timer specified by
@@ -201,12 +205,11 @@ is negative or greater than 999,999,999.
 .SH VERSIONS
 These system calls are available since Linux 2.6.
 .SH CONFORMING TO
-POSIX.1-2001
+POSIX.1-2001, POSIX.1-2008.
 .SH EXAMPLE
 See
 .BR timer_create (2).
 .SH SEE ALSO
 .BR timer_create (2),
-.BR timer_settime (2),
 .BR timer_getoverrun (2),
 .BR time (7)