summaryrefslogtreecommitdiff
path: root/usr/src/man/man5/timerfd.5
diff options
context:
space:
mode:
Diffstat (limited to 'usr/src/man/man5/timerfd.5')
-rw-r--r--usr/src/man/man5/timerfd.583
1 files changed, 43 insertions, 40 deletions
diff --git a/usr/src/man/man5/timerfd.5 b/usr/src/man/man5/timerfd.5
index a6829901aa..3229095b49 100644
--- a/usr/src/man/man5/timerfd.5
+++ b/usr/src/man/man5/timerfd.5
@@ -1,44 +1,47 @@
-'\" te
-.\" Copyright (c) 2015, Joyent, Inc. All Rights Reserved.
-.\" This file and its contents are supplied under the terms of the
-.\" Common Development and Distribution License ("CDDL"), version 1.0.
-.\" You may only use this file in accordance with the terms of version
-.\" 1.0 of the CDDL.
-.\"
-.\" A full copy of the text of the CDDL should have accompanied this
-.\" source. A copy of the CDDL is also available via the Internet at
-.\" http://www.illumos.org/license/CDDL.
-.TH TIMERFD 5 "Feb 23, 2015"
-.SH NAME
-timerfd \- Linux-compatible timer notification facility
-.SH SYNOPSIS
-
-.LP
-.nf
-#include <sys/timerfd.h>
-.fi
-
-.SH DESCRIPTION
-.sp
-.LP
-
-\fBtimerfd\fR is a Linux-borne facility for creating POSIX timers and
+.\"
+.\" This file and its contents are supplied under the terms of the
+.\" Common Development and Distribution License ("CDDL"), version 1.0.
+.\" You may only use this file in accordance with the terms of version
+.\" 1.0 of the CDDL.
+.\"
+.\" A full copy of the text of the CDDL should have accompanied this
+.\" source. A copy of the CDDL is also available via the Internet at
+.\" http://www.illumos.org/license/CDDL.
+.\"
+.\"
+.\" Copyright (c) 2015, Joyent, Inc. All Rights Reserved.
+.\"
+.Dd Feb 23, 2015
+.Dt TIMERFD 5
+.Os
+.Sh NAME
+.Nm timerfd
+.Nd Linux-compatible timer notification facility
+.Sh SYNOPSIS
+.In sys/timerfd.h
+.Sh DESCRIPTION
+.Nm
+is a Linux-borne facility for creating POSIX timers and
receiving their subsequent events via a file descriptor.
The facility itself is arguably unnecessary:
-portable code can either use the timeout value present in
-\fBpoll\fR(2)/\fBport_get\fR(3C)/\fBepoll_wait\fR(3C) or -- if this
-is deemed of unacceptably poor resolution -- create a POSIX timer
-via \fBtimer_create\fR(3C) and use the resulting signal to induce an
-\fBEINTR\fR to polling threads. (For code that need not be
-portable, the \fBSIGEV_PORT\fR signal notification allows for explicit,
-event-oriented timer notification to be sent to a specified port;
-see \fBsignal.h\fR(3HEAD) for details.)
-This facility therefore exists only to accommodate Linux-borne
+portable code can either use the timeout value present in
+.Xr poll 2 /
+.Xr port_get 3C
+or -- if this is deemed of unacceptably poor resolution -- create a POSIX timer
+via
+.Xr timer_create 3C
+and use the resulting signal to induce an
+.Sy EINTR
+to polling threads. (For code that need not be
+portable, the
+.Sy SIGEV_PORT
+signal notification allows for explicit, event-oriented timer notification to be
+sent to a specified port; see
+.Xr signal.h 3HEAD
+for details.) This facility therefore exists only to accommodate Linux-borne
applications and binaries; it is compatible with its Linux antecedent in both
binary interface and in semantics.
-
-.SH SEE ALSO
-.sp
-.LP
-\fBtimerfd_create\fR(3C), \fBtimerfd_gettime\fR(3C), \fBtimerfd_settime\fR(3C)
-
+.Sh SEE ALSO
+.Xr timerfd_create 3C ,
+.Xr timerfd_gettime 3C ,
+.Xr timerfd_settime 3C