Merge branch 'maint' into next

[tools/e2fsprogs.git] / misc / chattr.1.in

diff --git a/misc/chattr.1.in b/misc/chattr.1.in
index 5a4928a..922410b 100644 (file)
--- a/misc/chattr.1.in
+++ b/misc/chattr.1.in
@@ -23,13 +23,13 @@ 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 +-=[aAcCdDeFijPsStTux].
+The format of a symbolic mode is +-=[aAcCdDeFijmPsStTux].
 .PP
 The operator '+' causes the selected attributes to be added to the
 existing attributes of the files; '-' causes them to be removed; and '='
 causes them to be the only attributes that the files have.
 .PP
-The letters 'aAcCdDeFijPsStTux' select the new attributes for the files:
+The letters 'aAcCdDeFijmPsStTux' select the new attributes for the files:
 append only (a),
 no atime updates (A),
 compressed (c),
@@ -39,7 +39,8 @@ synchronous directory updates (D),
 extent format (e),
 case-insensitive directory lookups (F),
 immutable (i),
-data journalling (j),
+data journaling (j),
+don't compress (m),
 project hierarchy (P),
 secure deletion (s),
 synchronous updates (S),
@@ -56,13 +57,13 @@ indexed directory (I),
 inline data (N),
 and verity (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),
 and
 .BR xfs (5)
-for more filesystem-specific details.
+for more file system-specific details.
 .SH OPTIONS
 .TP
 .B \-R
@@ -96,7 +97,8 @@ A file with the 'c' attribute set is automatically compressed on the disk
 by the kernel.  A read from this file returns uncompressed data.  A write to
 this file compresses data before storing them on the disk.  Note: please
 make sure to read the bugs and limitations section at the end of this
-document.
+document.  (Note: For btrfs, If the 'c' flag is set, then the 'C' flag
+cannot be set. Also conflicts with btrfs mount option 'nodatasum')
 .TP
 .B C
 A file with the 'C' attribute set will not be subject to copy-on-write
@@ -106,7 +108,8 @@ set on new or empty files.  If it is set on a file which already has
 data blocks, it is undefined when the blocks assigned to the file will
 be fully stable.  If the 'C' flag is set on a directory, it will have no
 effect on the directory, but new files created in that directory will
-have the No_COW attribute set.)
+have the No_COW attribute set. If the 'C' flag is set, then the 'c' flag
+cannot be set.)
 .TP
 .B d
 A file with the 'd' attribute set is not a candidate for backup when the
@@ -125,7 +128,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).
@@ -154,11 +157,15 @@ 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.
 .TP
+.B m
+A file with the 'm' attribute is excluded from compression on file
+systems that support per-file compression.
+.TP
 .B N
 A file with the 'N' attribute set indicates that the file has data
 stored inline, within the inode itself. It may not be set or cleared
@@ -188,10 +195,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
@@ -221,7 +228,7 @@ 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
@@ -235,7 +242,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.