summaryrefslogtreecommitdiffstats
path: root/man2/epoll_ctl.2
diff options
context:
space:
mode:
Diffstat (limited to 'man2/epoll_ctl.2')
-rw-r--r--man2/epoll_ctl.246
1 files changed, 23 insertions, 23 deletions
diff --git a/man2/epoll_ctl.2 b/man2/epoll_ctl.2
index 6d5bc032e..8ea45ae9b 100644
--- a/man2/epoll_ctl.2
+++ b/man2/epoll_ctl.2
@@ -20,7 +20,7 @@ Standard C library
.SH DESCRIPTION
This system call is used to add, modify, or remove
entries in the interest list of the
-.BR epoll (7)
+.MR epoll 7
instance
referred to by the file descriptor
.IR epfd .
@@ -39,9 +39,9 @@ Add an entry to the interest list of the epoll file descriptor,
The entry includes the file descriptor,
.IR fd ,
a reference to the corresponding open file description (see
-.BR epoll (7)
+.MR epoll 7
and
-.BR open (2)),
+.MR open 2 ),
and the settings specified in
.IR event .
.TP
@@ -66,14 +66,14 @@ argument describes the object linked to the file descriptor
The
.I struct epoll_event
is described in
-.BR epoll_event (3type).
+.MR epoll_event 3type .
.P
The
.I data
member of the
.I epoll_event
structure specifies data that the kernel should save and then return (via
-.BR epoll_wait (2))
+.MR epoll_wait 2 )
when this file descriptor becomes ready.
.P
The
@@ -82,18 +82,18 @@ member of the
.I epoll_event
structure is a bit mask composed by ORing together zero or more event types,
returned by
-.BR epoll_wait (2),
+.MR epoll_wait 2 ,
and input flags, which affect its behaviour, but aren't returned.
The available event types are:
.TP
.B EPOLLIN
The associated file is available for
-.BR read (2)
+.MR read 2
operations.
.TP
.B EPOLLOUT
The associated file is available for
-.BR write (2)
+.MR write 2
operations.
.TP
.BR EPOLLRDHUP " (since Linux 2.6.17)"
@@ -107,14 +107,14 @@ There is an exceptional condition on the file descriptor.
See the discussion of
.B POLLPRI
in
-.BR poll (2).
+.MR poll 2 .
.TP
.B EPOLLERR
Error condition happened on the associated file descriptor.
This event is also reported for the write end of a pipe when the read end
has been closed.
.IP
-.BR epoll_wait (2)
+.MR epoll_wait 2
will always report for this event; it is not necessary to set it in
.I events
when calling
@@ -123,7 +123,7 @@ when calling
.B EPOLLHUP
Hang up happened on the associated file descriptor.
.IP
-.BR epoll_wait (2)
+.MR epoll_wait 2
will always wait for this event; it is not necessary to set it in
.I events
when calling
@@ -142,14 +142,14 @@ The default behavior for
.B epoll
is level-triggered.
See
-.BR epoll (7)
+.MR epoll 7
for more detailed information about edge-triggered and
level-triggered notification.
.TP
.BR EPOLLONESHOT " (since Linux 2.6.2)"
Requests one-shot notification for the associated file descriptor.
This means that after an event notified for the file descriptor by
-.BR epoll_wait (2),
+.MR epoll_wait 2 ,
the file descriptor is disabled in the interest list and no other events
will be reported by the
.B epoll
@@ -173,11 +173,11 @@ ensure that the system does not enter "suspend" or
"hibernate" while this event is pending or being processed.
The event is considered as being "processed" from the time
when it is returned by a call to
-.BR epoll_wait (2)
+.MR epoll_wait 2
until the next call to
-.BR epoll_wait (2)
+.MR epoll_wait 2
on the same
-.BR epoll (7)
+.MR epoll 7
file descriptor,
the closure of that file descriptor,
the removal of the event file descriptor with
@@ -196,7 +196,7 @@ When a wakeup event occurs and multiple epoll file descriptors
are attached to the same target file using
.BR EPOLLEXCLUSIVE ,
one or more of the epoll file descriptors will receive an event with
-.BR epoll_wait (2).
+.MR epoll_wait 2 .
The default in this scenario (when
.B EPOLLEXCLUSIVE
is not set) is for all epoll file descriptors to receive an event.
@@ -358,7 +358,7 @@ was encountered while trying to register
.RB ( EPOLL_CTL_ADD )
a new file descriptor on an epoll instance.
See
-.BR epoll (7)
+.MR epoll 7
for further details.
.TP
.B EPERM
@@ -380,7 +380,7 @@ glibc 2.3.2.
The
.B epoll
interface supports all file descriptors that support
-.BR poll (2).
+.MR poll 2 .
.SH BUGS
Before Linux 2.6.9, the
.B EPOLL_CTL_DEL
@@ -423,7 +423,7 @@ capability if attempting to use the
.B EPOLLWAKEUP
flag.
.SH SEE ALSO
-.BR epoll_create (2),
-.BR epoll_wait (2),
-.BR poll (2),
-.BR epoll (7)
+.MR epoll_create 2 ,
+.MR epoll_wait 2 ,
+.MR poll 2 ,
+.MR epoll 7