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