.\" Copyright (C) 2008 Michael Kerrisk <mtk.manpages@gmail.com>
.\" starting from a version by Davide Libenzi <davidel@xmailserver.org>
.\"
+.\" %%%LICENSE_START(GPLv2+_SW_3_PARA)
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
-.\" You should have received a copy of the GNU General Public License
-.\" along with this program; if not, write to the Free Software
-.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston,
-.\" MA 02111-1307 USA
+.\" You should have received a copy of the GNU General Public
+.\" License along with this manual; if not, see
+.\" <http://www.gnu.org/licenses/>.
+.\" %%%LICENSE_END
.\"
.\" 2008-10-10, mtk: describe eventfd2(), and EFD_NONBLOCK and EFD_CLOEXEC
.\"
.SH DESCRIPTION
.BR eventfd ()
creates an "eventfd object" that can be used as
-an event wait/notify mechanism by userspace applications,
-and by the kernel to notify userspace applications of events.
+an event wait/notify mechanism by user-space applications,
+and by the kernel to notify user-space applications of events.
The object contains an unsigned 64-bit integer
.RI ( uint64_t )
counter that is maintained by the kernel.
.IP
The eventfd file descriptor also supports the other file-descriptor
multiplexing APIs:
-.BR pselect (2),
-.BR ppoll (2),
+.BR pselect (2)
and
-.BR epoll (7).
+.BR ppoll (2).
.TP
.BR close (2)
When the file descriptor is no longer required it should be closed.
are preserved across
.BR execve (2),
unless the close-on-exec flag has been set.
-.SH "RETURN VALUE"
+.SH RETURN VALUE
On success,
.BR eventfd ()
returns a new eventfd file descriptor.
required (versus the two required for a pipe).
When used in the kernel, an eventfd
-file descriptor can provide a kernel-userspace bridge allowing,
+file descriptor can provide a bridge from kernel to user space, allowing,
for example, functionalities like KAIO (kernel AIO)
.\" or eventually syslets/threadlets
to signal to a file descriptor that some operation is complete.
}
}
.fi
-.SH "SEE ALSO"
+.SH SEE ALSO
.BR futex (2),
.BR pipe (2),
.BR poll (2),