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