summaryrefslogtreecommitdiffstats
path: root/man7/inode.7
diff options
context:
space:
mode:
Diffstat (limited to 'man7/inode.7')
-rw-r--r--man7/inode.772
1 files changed, 36 insertions, 36 deletions
diff --git a/man7/inode.7 b/man7/inode.7
index 45bf71467..444c17362 100644
--- a/man7/inode.7
+++ b/man7/inode.7
@@ -9,11 +9,11 @@ inode \- file inode information
.SH DESCRIPTION
Each file has an inode containing metadata about the file.
An application can retrieve this metadata using
-.BR stat (2)
+.MR stat 2
(or related calls), which returns a
.I stat
structure, or
-.BR statx (2),
+.MR statx 2 ,
which returns a
.I statx
structure.
@@ -21,9 +21,9 @@ structure.
The following is a list of the information typically found in,
or associated with, the file inode,
with the names of the corresponding structure fields returned by
-.BR stat (2)
+.MR stat 2
and
-.BR statx (2):
+.MR statx 2 :
.TP
Device where inode resides
\fIstat.st_dev\fP; \fIstatx.stx_dev_minor\fP and \fIstatx.stx_dev_major\fP
@@ -53,7 +53,7 @@ Link count
.IP
This field contains the number of hard links to the file.
Additional links to an existing file are created using
-.BR link (2).
+.MR link 2 .
.TP
User ID
\fIstat.st_uid\fP; \fIstatx.stx_uid\fP
@@ -62,7 +62,7 @@ This field records the user ID of the owner of the file.
For newly created files,
the file user ID is the effective user ID of the creating process.
The user ID of a file can be changed using
-.BR chown (2).
+.MR chown 2 .
.TP
Group ID
\fIstat.st_gid\fP; \fIstatx.stx_gid\fP
@@ -74,7 +74,7 @@ the effective group ID of the creating process,
depending on whether or not the set-group-ID bit
is set on the parent directory (see below).
The group ID of a file can be changed using
-.BR chown (2).
+.MR chown 2 .
.TP
Device represented by this inode
\fIstat.st_rdev\fP; \fIstatx.stx_rdev_minor\fP and \fIstatx.stx_rdev_major\fP
@@ -122,15 +122,15 @@ Last access timestamp (atime)
.IP
This is the file's last access timestamp.
It is changed by file accesses, for example, by
-.BR execve (2),
-.BR mknod (2),
-.BR pipe (2),
-.BR utime (2),
+.MR execve 2 ,
+.MR mknod 2 ,
+.MR pipe 2 ,
+.MR utime 2 ,
and
-.BR read (2)
+.MR read 2
(of more than zero bytes).
Other interfaces, such as
-.BR mmap (2),
+.MR mmap 2 ,
may or may not update the atime timestamp
.IP
Some filesystem types allow mounting in such a way that file
@@ -141,14 +141,14 @@ and/or directory accesses do not cause an update of the atime timestamp.
and
.I relatime
in
-.BR mount (8),
+.MR mount 8 ,
and related information in
-.BR mount (2).)
+.MR mount 2 .)
In addition, the atime timestamp
is not updated if a file is opened with the
.B O_NOATIME
flag; see
-.BR open (2).
+.MR open 2 .
.TP
File creation (birth) timestamp (btime)
(not returned in the \fIstat\fP structure); \fIstatx.stx_btime\fP
@@ -165,11 +165,11 @@ Last modification timestamp (mtime)
.IP
This is the file's last modification timestamp.
It is changed by file modifications, for example, by
-.BR mknod (2),
-.BR truncate (2),
-.BR utime (2),
+.MR mknod 2 ,
+.MR truncate 2 ,
+.MR utime 2 ,
and
-.BR write (2)
+.MR write 2
(of more than zero bytes).
Moreover, the mtime timestamp
of a directory is changed by the creation or deletion of files
@@ -188,7 +188,7 @@ It is changed by writing or by setting inode information
The timestamp fields report time measured with a zero point at the
.IR Epoch ,
1970-01-01 00:00:00 +0000, UTC (see
-.BR time (7)).
+.MR time 7 ).
.P
Nanosecond timestamps are supported on XFS, JFS, Btrfs, and
ext4 (since Linux 2.6.23).
@@ -201,9 +201,9 @@ and
.I statx
structures are defined as structures that include a nanosecond component.
See
-.BR stat (2)
+.MR stat 2
and
-.BR statx (2)
+.MR statx 2
for details.
On filesystems that do not support subsecond timestamps,
the nanosecond fields in the
@@ -216,7 +216,7 @@ structures are returned with the value 0.
The
.I stat.st_mode
field (for
-.BR statx (2),
+.MR statx 2 ,
the
.I statx.stx_mode
field) contains the file type and mode.
@@ -265,25 +265,25 @@ macros are defined by POSIX to allow the test of the file type in
to be written more concisely:
.RS 4
.TP 1.2i
-.BR S_ISREG (m)
+.MR S_ISREG m
is it a regular file?
.TP
-.BR S_ISDIR (m)
+.MR S_ISDIR m
directory?
.TP
-.BR S_ISCHR (m)
+.MR S_ISCHR m
character device?
.TP
-.BR S_ISBLK (m)
+.MR S_ISBLK m
block device?
.TP
-.BR S_ISFIFO (m)
+.MR S_ISFIFO m
FIFO (named pipe)?
.TP
-.BR S_ISLNK (m)
+.MR S_ISLNK m
symbolic link? (Not in POSIX.1-1996.)
.TP
-.BR S_ISSOCK (m)
+.MR S_ISSOCK m
socket? (Not in POSIX.1-1996.)
.RE
.P
@@ -408,7 +408,7 @@ and directories created there will also get the
bit set.
For an executable file, the set-group-ID bit causes the effective group ID
of a process that executes the file to change as described in
-.BR execve (2).
+.MR execve 2 .
For a file that does not have the group execution bit
.RB ( S_IXGRP )
set,
@@ -474,7 +474,7 @@ For such files, one should simply try to read as many bytes as possible
(and append \[aq]\e0\[aq] to the returned buffer
if it is to be interpreted as a string).
.SH SEE ALSO
-.BR stat (1),
-.BR stat (2),
-.BR statx (2),
-.BR symlink (7)
+.MR stat 1 ,
+.MR stat 2 ,
+.MR statx 2 ,
+.MR symlink 7