summaryrefslogtreecommitdiffstats
path: root/man2/fanotify_init.2
diff options
context:
space:
mode:
Diffstat (limited to 'man2/fanotify_init.2')
-rw-r--r--man2/fanotify_init.242
1 files changed, 21 insertions, 21 deletions
diff --git a/man2/fanotify_init.2 b/man2/fanotify_init.2
index e5f9cbf29..f4929140b 100644
--- a/man2/fanotify_init.2
+++ b/man2/fanotify_init.2
@@ -16,14 +16,14 @@ Standard C library
.fi
.SH DESCRIPTION
For an overview of the fanotify API, see
-.BR fanotify (7).
+.MR fanotify 7 .
.P
.BR fanotify_init ()
initializes a new fanotify group and returns a file descriptor for the event
queue associated with the group.
.P
The file descriptor is used in calls to
-.BR fanotify_mark (2)
+.MR fanotify_mark 2
to specify the files, directories, mounts, or filesystems for which fanotify
events shall be created.
These events are received by reading from the file descriptor.
@@ -38,7 +38,7 @@ monitor the same files.
.P
The number of fanotify groups per user is limited.
See
-.BR fanotify (7)
+.MR fanotify 7
for details about this limit.
.P
The
@@ -101,7 +101,7 @@ on the new file descriptor.
See the description of the
.B O_CLOEXEC
flag in
-.BR open (2).
+.MR open 2 .
.TP
.B FAN_NONBLOCK
Enable the nonblocking flag
@@ -109,14 +109,14 @@ Enable the nonblocking flag
for the file descriptor.
Reading from the file descriptor will not block.
Instead, if no data is available,
-.BR read (2)
+.MR read 2
fails with the error
.BR EAGAIN .
.TP
.B FAN_UNLIMITED_QUEUE
Remove the limit on the number of events in the event queue.
See
-.BR fanotify (7)
+.MR fanotify 7
for details about this limit.
Use of this flag requires the
.B CAP_SYS_ADMIN
@@ -125,7 +125,7 @@ capability.
.B FAN_UNLIMITED_MARKS
Remove the limit on the number of fanotify marks per user.
See
-.BR fanotify (7)
+.MR fanotify 7
for details about this limit.
Use of this flag requires the
.B CAP_SYS_ADMIN
@@ -139,9 +139,9 @@ in the
field of the
.I "struct fanotify_event_metadata"
supplied to
-.BR read (2)
+.MR read 2
(see
-.BR fanotify (7)).
+.MR fanotify 7 ).
Use of this flag requires the
.B CAP_SYS_ADMIN
capability.
@@ -195,7 +195,7 @@ or
is not permitted with this flag and will result in the error
.BR EINVAL .
See
-.BR fanotify (7)
+.MR fanotify 7
for additional details.
.TP
.BR FAN_REPORT_DIR_FID " (since Linux 5.9)"
@@ -228,7 +228,7 @@ Without the
.B FAN_REPORT_FID
flag, no event will be reported.
See
-.BR fanotify (7)
+.MR fanotify 7
for additional details.
.TP
.BR FAN_REPORT_NAME " (since Linux 5.9)"
@@ -274,10 +274,10 @@ is that of the parent directory object and the reported name is the name of a
directory entry where the object was located at the time of the event.
The rationale behind this logic is that the reported directory file handle can
be passed to
-.BR open_by_handle_at (2)
+.MR open_by_handle_at 2
to get an open directory file descriptor and that file descriptor along with
the reported name can be used to call
-.BR fstatat (2).
+.MR fstatat 2 .
The same rule that applies to record type
.B FAN_EVENT_INFO_TYPE_DFID
also applies to record type
@@ -288,7 +288,7 @@ Note that there is no guarantee that the filesystem object will be found at the
location described by the directory entry information at the time the event is
received.
See
-.BR fanotify (7)
+.MR fanotify 7
for additional details.
.TP
.B FAN_REPORT_DFID_NAME
@@ -342,7 +342,7 @@ and will contain a pidfd for the process that
was responsible for generating an event.
A pidfd returned in this information record object is
no different to the pidfd that is returned when calling
-.BR pidfd_open (2).
+.MR pidfd_open 2 .
Usage of this information record are for applications that
may be interested in reliably determining whether
the process responsible for generating an event
@@ -363,7 +363,7 @@ may be supported at some point in the future,
so this restriction may eventually be lifted.
For more details on information records,
see
-.BR fanotify (7).
+.MR fanotify 7 .
.P
The
.I event_f_flags
@@ -373,7 +373,7 @@ that are created for fanotify events.
For details of these flags, see the description of the
.I flags
values in
-.BR open (2).
+.MR open 2 .
.I event_f_flags
includes a multi-bit field for the access mode.
This field can take the following values:
@@ -404,7 +404,7 @@ Enable the close-on-exec flag for the file descriptor.
See the description of the
.B O_CLOEXEC
flag in
-.BR open (2)
+.MR open 2
for reasons why this may be useful.
.P
The following are also allowable:
@@ -442,7 +442,7 @@ defines all allowable bits for
.B EMFILE
The number of fanotify groups for this user exceeds the limit.
See
-.BR fanotify (7)
+.MR fanotify 7
for details about this limit.
.TP
.B EMFILE
@@ -538,5 +538,5 @@ such as
can be set, and will consequently be set for the file descriptors
returned when reading from the fanotify file descriptor.
.SH SEE ALSO
-.BR fanotify_mark (2),
-.BR fanotify (7)
+.MR fanotify_mark 2 ,
+.MR fanotify 7