misc/chattr.1.in

   1 .\" -*- nroff -*-
   2 .TH CHATTR 1 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
   3 .SH NAME
   4 chattr \- change file attributes on a Linux file system
   5 .SH SYNOPSIS
   6 .B chattr
   7 [
   8 .B \-RVf
   9 ]
  10 [
  11 .B \-v
  12 .I version
  13 ]
  14 [
  15 .B \-p
  16 .I project
  17 ]
  18 [
  19 .I mode
  20 ]
  21 .I files...
  22 .SH DESCRIPTION
  23 .B chattr
  24 changes the file attributes on a Linux file system.
  25 .PP
  26 The format of a symbolic mode is +-=[aAcCdDeFijPsStTu].
  27 .PP
  28 The operator '+' causes the selected attributes to be added to the
  29 existing attributes of the files; '-' causes them to be removed; and '='
  30 causes them to be the only attributes that the files have.
  31 .PP
  32 The letters 'aAcCdDeFijPsStTu' select the new attributes for the files:
  33 append only (a),
  34 no atime updates (A),
  35 compressed (c),
  36 no copy on write (C),
  37 no dump (d),
  38 synchronous directory updates (D),
  39 extent format (e),
  40 case-insensitive directory lookups (F),
  41 immutable (i),
  42 data journalling (j),
  43 project hierarchy (P),
  44 secure deletion (s),
  45 synchronous updates (S),
  46 no tail-merging (t),
  47 top of directory hierarchy (T),
  48 and undeletable (u).
  49 .PP
  50 The following attributes are read-only, and may be listed by
  51 .BR lsattr (1)
  52 but not modified by chattr:
  53 encrypted (E),
  54 indexed directory (I),
  55 inline data (N),
  56 and verity (V).
  57 .PP
  58 Not all flags are supported or utilized by all filesystems; refer to
  59 filesystem-specific man pages such as
  60 .BR btrfs (5),
  61 .BR ext4 (5),
  62 and
  63 .BR xfs (5)
  64 for more filesystem-specific details.
  65 .SH OPTIONS
  66 .TP
  67 .B \-R
  68 Recursively change attributes of directories and their contents.
  69 .TP
  70 .B \-V
  71 Be verbose with chattr's output and print the program version.
  72 .TP
  73 .B \-f
  74 Suppress most error messages.
  75 .TP
  76 .BI \-v " version"
  77 Set the file's version/generation number.
  78 .TP
  79 .BI \-p " project"
  80 Set the file's project number.
  81 .SH ATTRIBUTES
  82 A file with the 'a' attribute set can only be opened in append mode for
  83 writing.  Only the superuser or a process possessing the
  84 CAP_LINUX_IMMUTABLE capability can set or clear this attribute.
  85 .PP
  86 When a file with the 'A' attribute set is accessed, its atime record is
  87 not modified.  This avoids a certain amount of disk I/O for laptop
  88 systems.
  89 .PP
  90 A file with the 'c' attribute set is automatically compressed on the disk
  91 by the kernel.  A read from this file returns uncompressed data.  A write to
  92 this file compresses data before storing them on the disk.  Note: please
  93 make sure to read the bugs and limitations section at the end of this
  94 document.
  95 .PP
  96 A file with the 'C' attribute set will not be subject to copy-on-write
  97 updates.  This flag is only supported on file systems which perform
  98 copy-on-write.  (Note: For btrfs, the 'C' flag should be
  99 set on new or empty files.  If it is set on a file which already has
 100 data blocks, it is undefined when the blocks assigned to the file will
 101 be fully stable.  If the 'C' flag is set on a directory, it will have no
 102 effect on the directory, but new files created in that directory will
 103 have the No_COW attribute set.)
 104 .PP
 105 A file with the 'd' attribute set is not a candidate for backup when the
 106 .BR dump (8)
 107 program is run.
 108 .PP
 109 When a directory with the 'D' attribute set is modified,
 110 the changes are written synchronously to the disk; this is equivalent to
 111 the 'dirsync' mount option applied to a subset of the files.
 112 .PP
 113 The 'e' attribute indicates that the file is using extents for mapping
 114 the blocks on disk.  It may not be removed using
 115 .BR chattr (1).
 116 .PP
 117 A file, directory, or symlink with the 'E' attribute set is encrypted by the
 118 filesystem.  This attribute may not be set or cleared using
 119 .BR chattr (1),
 120 although it can be displayed by
 121 .BR lsattr (1).
 122 .PP
 123 A directory with the 'F' attribute set indicates that all the path
 124 lookups inside that directory are made in a case-insensitive fashion.
 125 This attribute can only be changed in empty directories on file systems
 126 with the casefold feature enabled.
 127 .PP
 128 A file with the 'i' attribute cannot be modified: it cannot be deleted or
 129 renamed, no link can be created to this file, most of the file's
 130 metadata can not be modified, and the file can not be opened in write mode.
 131 Only the superuser or a process possessing the CAP_LINUX_IMMUTABLE
 132 capability can set or clear this attribute.
 133 .PP
 134 The 'I' attribute is used by the htree code to indicate that a directory
 135 is being indexed using hashed trees.  It may not be set or cleared using
 136 .BR chattr (1),
 137 although it can be displayed by
 138 .BR lsattr (1).
 139 .PP
 140 A file with the 'j' attribute has all of its data written to the ext3 or
 141 ext4 journal before being written to the file itself, if the file system
 142 is mounted with the "data=ordered" or "data=writeback" options and the
 143 file system has a journal.  When the filesystem is mounted with the
 144 "data=journal" option all file data is already journalled and this
 145 attribute has no effect.  Only the superuser or a process possessing the
 146 CAP_SYS_RESOURCE capability can set or clear this attribute.
 147 .PP
 148 A file with the 'N' attribute set indicates that the file has data
 149 stored inline, within the inode itself. It may not be set or cleared
 150 using
 151 .BR chattr (1),
 152 although it can be displayed by
 153 .BR lsattr (1).
 154 .PP
 155 A directory with the 'P' attribute set will enforce a hierarchical
 156 structure for project id's.  This means that files and directory created
 157 in the directory will inherit the project id of the directory, rename
 158 operations are constrained so when a file or directory is moved into
 159 another directory, that the project id's much match.  In addition, a
 160 hard link to file can only be created when the project id for the file
 161 and the destination directory match.
 162 .PP
 163 When a file with the 's' attribute set is deleted, its blocks are zeroed
 164 and written back to the disk.  Note: please make sure to read the bugs
 165 and limitations section at the end of this document.
 166 .PP
 167 When a file with the 'S' attribute set is modified,
 168 the changes are written synchronously to the disk; this is equivalent to
 169 the 'sync' mount option applied to a subset of the files.
 170 .PP
 171 A file with the 't' attribute will not have a partial block fragment at
 172 the end of the file merged with other files (for those filesystems which
 173 support tail-merging).  This is necessary for applications such as LILO
 174 which read the filesystem directly, and which don't understand tail-merged
 175 files.  Note: As of this writing, the ext2, ext3, and ext4 filesystems do
 176 not support tail-merging.
 177 .PP
 178 A directory with the 'T' attribute will be deemed to be the top of
 179 directory hierarchies for the purposes of the Orlov block allocator.
 180 This is a hint to the block allocator used by ext3 and ext4 that the
 181 subdirectories under this directory are not related, and thus should be
 182 spread apart for allocation purposes.   For example it is a very good
 183 idea to set the 'T' attribute on the /home directory, so that /home/john
 184 and /home/mary are placed into separate block groups.  For directories
 185 where this attribute is not set, the Orlov block allocator will try to
 186 group subdirectories closer together where possible.
 187 .PP
 188 When a file with the 'u' attribute set is deleted, its contents are
 189 saved.  This allows the user to ask for its undeletion.  Note: please
 190 make sure to read the bugs and limitations section at the end of this
 191 document.
 192 .PP
 193 A file with the 'V' attribute set has fs-verity enabled.  It cannot be
 194 written to, and the filesystem will automatically verify all data read
 195 from it against a cryptographic hash that covers the entire file's
 196 contents, e.g. via a Merkle tree.  This makes it possible to efficiently
 197 authenticate the file.  This attribute may not be set or cleared using
 198 .BR chattr (1),
 199 although it can be displayed by
 200 .BR lsattr (1).
 201 .PP
 202 .SH AUTHOR
 203 .B chattr
 204 was written by Remy Card <Remy.Card@linux.org>.  It is currently being
 205 maintained by Theodore Ts'o <tytso@alum.mit.edu>.
 206 .SH BUGS AND LIMITATIONS
 207 The 'c', 's',  and 'u' attributes are not honored
 208 by the ext2, ext3, and ext4 filesystems as implemented in the current
 209 mainline Linux kernels.
 210 Setting 'a' and 'i' attributes will not affect the ability to write
 211 to already existing file descriptors.
 212 .PP
 213 The 'j' option is only useful for ext3 and ext4 file systems.
 214 .PP
 215 The 'D' option is only useful on Linux kernel 2.5.19 and later.
 216 .SH AVAILABILITY
 217 .B chattr
 218 is part of the e2fsprogs package and is available from
 219 http://e2fsprogs.sourceforge.net.
 220 .SH SEE ALSO
 221 .BR lsattr (1),
 222 .BR btrfs (5),
 223 .BR ext4 (5),
 224 .BR xfs (5).