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 .I mode
  16 ]
  17 .I files...
  18 .SH DESCRIPTION
  19 .B chattr
  20 changes the file attributes on a Linux file system.
  21 .PP
  22 The format of a symbolic mode is +-=[acdeijstuACDST].
  23 .PP
  24 The operator `+' causes the selected attributes to be added to the
  25 existing attributes of the files; `-' causes them to be removed; and
  26 `=' causes them to be the only attributes that the files have.
  27 .PP
  28 The letters `acdeijstuACDST' select the new attributes for the files:
  29 append only (a), compressed (c), no dump (d), extent format (e), immutable (i),
  30 data journalling (j), secure deletion (s), no tail-merging (t),
  31 undeletable (u), no atime updates (A), no copy on write (C),
  32 synchronous directory updates (D), synchronous updates (S),
  33 and top of directory hierarchy (T).
  34 .PP
  35 The following attributes are read-only, and may be listed by
  36 .BR lsattr (1)
  37 but not modified by chattr: huge file (h), compression error (E),
  38 indexed directory (I), compression raw access (X), and compressed dirty
  39 file (Z).
  40 .SH OPTIONS
  41 .TP
  42 .B \-R
  43 Recursively change attributes of directories and their contents.
  44 .TP
  45 .B \-V
  46 Be verbose with chattr's output and print the program version.
  47 .TP
  48 .B \-f
  49 Suppress most error messages.
  50 .TP
  51 .BI \-v " version"
  52 Set the file's version/generation number.
  53 .SH ATTRIBUTES
  54 When a file with the 'A' attribute set is accessed, its atime record is
  55 not modified.  This avoids a certain amount of disk I/O for laptop
  56 systems.
  57 .PP
  58 A file with the `a' attribute set can only be open in append mode for writing.
  59 Only the superuser or a process possessing the CAP_LINUX_IMMUTABLE
  60 capability can set or clear this attribute.
  61 .PP
  62 A file with the `c' attribute set is automatically compressed on the disk
  63 by the kernel.  A read from this file returns uncompressed data.  A write to
  64 this file compresses data before storing them on the disk.  Note: please
  65 make sure to read the bugs and limitations section at the end of this
  66 document.
  67 .PP
  68 A file with the 'C' attribute set will not be subject to copy-on-write
  69 updates.  This flag is only supported on file systems which perform
  70 copy-on-write.  (Note: For btrfs, the 'C' flag should be
  71 set on new or empty files.  If it is set on a file which already has
  72 data blocks, it is undefined when the blocks assigned to the file will
  73 be fully stable.  If the 'C' flag is set on a directory, it will have no
  74 effect on the directory, but new files created in that directory will
  75 the No_COW attribute.)
  76 .PP
  77 When a directory with the `D' attribute set is modified,
  78 the changes are written synchronously on the disk; this is equivalent to
  79 the `dirsync' mount option applied to a subset of the files.
  80 .PP
  81 A file with the `d' attribute set is not candidate for backup when the
  82 .BR dump (8)
  83 program is run.
  84 .PP
  85 The 'E' attribute is used by the experimental compression patches to
  86 indicate that a compressed file has a compression error.  It may not be
  87 set or reset using
  88 .BR chattr (1),
  89 although it can be displayed by
  90 .BR lsattr (1).
  91 .PP
  92 The 'e' attribute indicates that the file is using extents for mapping
  93 the blocks on disk.  It may not be removed using
  94 .BR chattr (1).
  95 .PP
  96 The 'I' attribute is used by the htree code to indicate that a directory
  97 is being indexed using hashed trees.  It may not be set or reset using
  98 .BR chattr (1),
  99 although it can be displayed by
 100 .BR lsattr (1).
 101 .PP
 102 The 'h' attribute indicates the file is storing its blocks in units of the
 103 filesystem blocksize instead of in units of sectors, and means that the file
 104 is (or at one time was) larger than 2TB.  It may not be set or reset using
 105 .BR chattr (1),
 106 although it can be displayed by
 107 .BR lsattr (1).
 108 .PP
 109 A file with the `i' attribute cannot be modified: it cannot be deleted or
 110 renamed, no link can be created to this file and no data can be written
 111 to the file.  Only the superuser or a process possessing the
 112 CAP_LINUX_IMMUTABLE capability can set or clear this attribute.
 113 .PP
 114 A file with the `j' attribute has all of its data written to the ext3
 115 journal before being written to the file itself, if the filesystem is
 116 mounted with the "data=ordered" or "data=writeback" options.  When the
 117 filesystem is mounted with the "data=journal" option all file data
 118 is already journalled and this attribute has no effect.  Only
 119 the superuser or a process possessing the CAP_SYS_RESOURCE
 120 capability can set or clear this attribute.
 121 .PP
 122 When a file with the `s' attribute set is deleted, its blocks are zeroed
 123 and written back to the disk.  Note: please make sure to read the bugs
 124 and limitations section at the end of this document.
 125 .PP
 126 When a file with the `S' attribute set is modified,
 127 the changes are written synchronously on the disk; this is equivalent to
 128 the `sync' mount option applied to a subset of the files.
 129 .PP
 130 A directory with the 'T' attribute will be deemed to be the top of
 131 directory hierarchies for the purposes of the Orlov block allocator.
 132 This is a hint to the block allocator used by ext3 and ext4 that the
 133 subdirectories under this directory are not related, and thus should be
 134 spread apart for allocation purposes.   For example it is a very good
 135 idea to set the 'T' attribute on the /home directory, so that /home/john
 136 and /home/mary are placed into separate block groups.  For directories
 137 where this attribute is not set, the Orlov block allocator will try to
 138 group subdirectories closer together where possible.
 139 .PP
 140 A file with the 't' attribute will not have a partial block fragment at
 141 the end of the file merged with other files (for those filesystems which
 142 support tail-merging).  This is necessary for applications such as LILO
 143 which read the filesystem directly, and which don't understand tail-merged
 144 files.  Note: As of this writing, the ext2 or ext3 filesystems do not
 145 (yet, except in very experimental patches) support tail-merging.
 146 .PP
 147 When a file with the `u' attribute set is deleted, its contents are
 148 saved.  This allows the user to ask for its undeletion.  Note: please
 149 make sure to read the bugs and limitations section at the end of this
 150 document.
 151 .PP
 152 The 'X' attribute is used by the experimental compression patches to
 153 indicate that a raw contents of a compressed file can be accessed
 154 directly.  It currently may not be set or reset using
 155 .BR chattr (1),
 156 although it can be displayed by
 157 .BR lsattr (1).
 158 .PP
 159 The 'Z' attribute is used by the experimental compression patches to
 160 indicate a compressed file is dirty.  It may not be set or reset using
 161 .BR chattr (1),
 162 although it can be displayed by
 163 .BR lsattr (1).
 164 .PP
 165 .SH AUTHOR
 166 .B chattr
 167 was written by Remy Card <Remy.Card@linux.org>.  It is currently being
 168 maintained by Theodore Ts'o <tytso@alum.mit.edu>.
 169 .SH BUGS AND LIMITATIONS
 170 The `c', 's',  and `u' attributes are not honored
 171 by the ext2, ext3, and ext4 filesystems as implemented in the current
 172 mainline Linux kernels.
 173 .PP
 174 The `j' option is only useful if the filesystem is mounted as ext3.
 175 .PP
 176 The `D' option is only useful on Linux kernel 2.5.19 and later.
 177 .SH AVAILABILITY
 178 .B chattr
 179 is part of the e2fsprogs package and is available from
 180 http://e2fsprogs.sourceforge.net.
 181 .SH SEE ALSO
 182 .BR lsattr (1)