aboutsummaryrefslogtreecommitdiff
path: root/misc/chattr.1.in
diff options
context:
space:
mode:
authorAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>2023-07-07 05:10:34 +0000
committerAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>2023-07-07 05:10:34 +0000
commit8e8408c65078c4f4c171e5cc2b567d6705bed024 (patch)
tree1605641dff9d3858f2b1595d8885bb0fe9496f34 /misc/chattr.1.in
parent037a031cb6f2d5e4575a3028e3c7135c59ee805a (diff)
parent63687023fc2e8871a718cb4e18458eece2e3460c (diff)
downloade2fsprogs-8e8408c65078c4f4c171e5cc2b567d6705bed024.tar.gz
Change-Id: Ib8f5c32e208ea07a1c7814b337878a6d47c59923
Diffstat (limited to 'misc/chattr.1.in')
-rw-r--r--misc/chattr.1.in122
1 files changed, 80 insertions, 42 deletions
diff --git a/misc/chattr.1.in b/misc/chattr.1.in
index 5e1eeb79..50c54e7d 100644
--- a/misc/chattr.1.in
+++ b/misc/chattr.1.in
@@ -23,47 +23,80 @@ chattr \- change file attributes on a Linux file system
.B chattr
changes the file attributes on a Linux file system.
.PP
-The format of a symbolic mode is +-=[aAcCdDeFijmPsStTux].
+The format of a symbolic
+.I mode
+is
+.BR +-= [ aAcCdDeFijmPsStTux ].
.PP
-The operator '+' causes the selected attributes to be added to the
-existing attributes of the files; '-' causes them to be removed; and '='
+The operator
+.RB ' + '
+causes the selected attributes to be added to the
+existing attributes of the files;
+.RB ' - '
+causes them to be removed; and
+.RB ' = '
causes them to be the only attributes that the files have.
.PP
-The letters 'aAcCdDeFijmPsStTux' select the new attributes for the files:
-append only (a),
-no atime updates (A),
-compressed (c),
-no copy on write (C),
-no dump (d),
-synchronous directory updates (D),
-extent format (e),
-case-insensitive directory lookups (F),
-immutable (i),
-data journalling (j),
-don't compress (m),
-project hierarchy (P),
-secure deletion (s),
-synchronous updates (S),
-no tail-merging (t),
-top of directory hierarchy (T),
-undeletable (u),
-and direct access for files (x).
+The letters
+.RB ' aAcCdDeFijmPsStTux '
+select the new attributes for the files:
+append only
+.RB ( a ),
+no atime updates
+.RB ( A ),
+compressed
+.RB ( c ),
+no copy on write
+.RB ( C ),
+no dump
+.RB ( d ),
+synchronous directory updates
+.RB ( D ),
+extent format
+.RB ( e ),
+case-insensitive directory lookups
+.RB ( F ),
+immutable
+.RB ( i ),
+data journaling
+.RB ( j ),
+don't compress
+.RB ( m ),
+project hierarchy
+.RB ( P ),
+secure deletion
+.RB ( s ),
+synchronous updates
+.RB ( S ),
+no tail-merging
+.RB ( t ),
+top of directory hierarchy
+.RB ( T ),
+undeletable
+.RB ( u ),
+and direct access for files
+.RB ( x ).
.PP
The following attributes are read-only, and may be listed by
.BR lsattr (1)
but not modified by chattr:
-encrypted (E),
-indexed directory (I),
-inline data (N),
-and verity (V).
+encrypted
+.RB ( E ),
+indexed directory
+.RB ( I ),
+inline data
+.RB ( N ),
+and verity
+.RB ( V ).
.PP
-Not all flags are supported or utilized by all filesystems; refer to
-filesystem-specific man pages such as
+Not all flags are supported or utilized by all file systems; refer to
+file system-specific man pages such as
.BR btrfs (5),
.BR ext4 (5),
+.BR mkfs.f2fs (8),
and
.BR xfs (5)
-for more filesystem-specific details.
+for more file system-specific details.
.SH OPTIONS
.TP
.B \-R
@@ -128,7 +161,7 @@ the blocks on disk. It may not be removed using
.TP
.B E
A file, directory, or symlink with the 'E' attribute set is encrypted by the
-filesystem. This attribute may not be set or cleared using
+file system. This attribute may not be set or cleared using
.BR chattr (1),
although it can be displayed by
.BR lsattr (1).
@@ -157,7 +190,7 @@ although it can be displayed by
A file with the 'j' attribute has all of its data written to the ext3 or
ext4 journal before being written to the file itself, if the file system
is mounted with the "data=ordered" or "data=writeback" options and the
-file system has a journal. When the filesystem is mounted with the
+file system has a journal. When the file system is mounted with the
"data=journal" option all file data is already journalled and this
attribute has no effect. Only the superuser or a process possessing the
CAP_SYS_RESOURCE capability can set or clear this attribute.
@@ -195,10 +228,10 @@ the 'sync' mount option applied to a subset of the files.
.TP
.B t
A file with the 't' attribute will not have a partial block fragment at
-the end of the file merged with other files (for those filesystems which
+the end of the file merged with other files (for those file systems which
support tail-merging). This is necessary for applications such as LILO
-which read the filesystem directly, and which don't understand tail-merged
-files. Note: As of this writing, the ext2, ext3, and ext4 filesystems do
+which read the file system directly, and which don't understand tail-merged
+files. Note: As of this writing, the ext2, ext3, and ext4 file systems do
not support tail-merging.
.TP
.B T
@@ -219,16 +252,20 @@ make sure to read the bugs and limitations section at the end of this
document.
.TP
.B x
-The 'x' attribute can be set on a directory or file. If the attribute
-is set on an existing directory, it will be inherited by all files and
-subdirectories that are subsequently created in the directory. If an
-existing directory has contained some files and subdirectories, modifying
-the attribute on the parent directory doesn't change the attributes on
-these files and subdirectories.
+A file with the 'x' requests the use of direct access (dax) mode, if the
+kernel supports DAX. This can be overridden by the 'dax=never' mount
+option. For more information see the kernel documentation for dax:
+<https://www.kernel.org/doc/html/latest/filesystems/dax.html>.
+.IP
+If the attribute is set on an existing directory, it will be inherited
+by all files and subdirectories that are subsequently created in the
+directory. If an existing directory has contained some files and
+subdirectories, modifying the attribute on the parent directory doesn't
+change the attributes on these files and subdirectories.
.TP
.B V
A file with the 'V' attribute set has fs-verity enabled. It cannot be
-written to, and the filesystem will automatically verify all data read
+written to, and the file system will automatically verify all data read
from it against a cryptographic hash that covers the entire file's
contents, e.g. via a Merkle tree. This makes it possible to efficiently
authenticate the file. This attribute may not be set or cleared using
@@ -242,7 +279,7 @@ was written by Remy Card <Remy.Card@linux.org>. It is currently being
maintained by Theodore Ts'o <tytso@alum.mit.edu>.
.SH BUGS AND LIMITATIONS
The 'c', 's', and 'u' attributes are not honored
-by the ext2, ext3, and ext4 filesystems as implemented in the current
+by the ext2, ext3, and ext4 file systems as implemented in the current
mainline Linux kernels.
Setting 'a' and 'i' attributes will not affect the ability to write
to already existing file descriptors.
@@ -258,4 +295,5 @@ http://e2fsprogs.sourceforge.net.
.BR lsattr (1),
.BR btrfs (5),
.BR ext4 (5),
+.BR mkfs.f2fs (8),
.BR xfs (5).