aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlejandro Colomar <alx.manpages@gmail.com>2022-08-01 22:28:49 +0200
committerAlejandro Colomar <alx.manpages@gmail.com>2022-08-01 22:28:49 +0200
commit5a04ab888c69fc441aa0e882ad34eb5b62faaf5f (patch)
tree28071daf72985d4da48f51e2e7dbb6609239220e
parentef2ae458595b1ece2b5af039832548c94ed2f420 (diff)
downloadman-pages-5a04ab888c69fc441aa0e882ad34eb5b62faaf5f.tar.gz
timer_settime.2, timerfd_create.2, itimerspec.3type: Document itimerspec in a new page
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
-rw-r--r--man2/timer_settime.212
-rw-r--r--man2/timerfd_create.215
-rw-r--r--man3type/itimerspec.3type33
3 files changed, 37 insertions, 23 deletions
diff --git a/man2/timer_settime.2 b/man2/timer_settime.2
index 724f90a57e..0ebe82795d 100644
--- a/man2/timer_settime.2
+++ b/man2/timer_settime.2
@@ -42,16 +42,8 @@ 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
-.EX
-struct itimerspec {
- struct timespec it_interval; /* Timer interval */
- struct timespec it_value; /* Initial expiration */
-};
-.EE
-.in
+structure is described in
+.BR itimerspec (3type).
.PP
Each of the substructures of the
.I itimerspec
diff --git a/man2/timerfd_create.2 b/man2/timerfd_create.2
index 38c7bbfe39..822f140f2a 100644
--- a/man2/timerfd_create.2
+++ b/man2/timerfd_create.2
@@ -140,19 +140,8 @@ The
argument specifies the initial expiration and interval for the timer.
The
.I itimerspec
-structure used for this argument contains two fields,
-each of which is in turn a
-.BR timespec (3)
-structure:
-.PP
-.in +4n
-.EX
-struct itimerspec {
- struct timespec it_interval; /* Interval for periodic timer */
- struct timespec it_value; /* Initial expiration */
-};
-.EE
-.in
+structure used for this argument is described in
+.BR itimerspec (3type).
.PP
.I new_value.it_value
specifies the initial expiration of the timer,
diff --git a/man3type/itimerspec.3type b/man3type/itimerspec.3type
new file mode 100644
index 0000000000..4ededad523
--- /dev/null
+++ b/man3type/itimerspec.3type
@@ -0,0 +1,33 @@
+.\" Copyright (c) 2022 by Alejandro Colomar <colomar.6.4.3@gmail.com>
+.\"
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
+.\"
+.\"
+.TH itimerspec 3type 2022-08-01 Linux "Linux Programmer's Manual"
+.SH NAME
+timespec \- interval for a timer with nanosecond precission
+.SH LIBRARY
+Standard C library
+.RI ( libc )
+.SH SYNOPSIS
+.nf
+.B #include <time.h>
+.PP
+.B struct itimerspec {
+.BR " struct timespec it_interval;" " /* Interval for periodic timer */"
+.BR " struct timespec it_value;" " /* Initial expiration */"
+.B };
+.fi
+.SH DESCRIPTION
+Describes the initial expiration of a timer,
+and its interval,
+in seconds and nanoseconds.
+.SH STANDARDS
+Linux-specific.
+.SH NOTES
+The following header also provides this type:
+.IR <sys/timerfd.h> .
+.SH SEE ALSO
+.BR timerfd_create (2),
+.BR timer_settime (2),
+.BR timespec (3type)