misc/tune2fs.8.in

   1 .\" Revision 1.0 93/06/3 23:00  chk
   2 .\" Initial revision
   3 .\"
   4 .\"
   5 .TH TUNE2FS 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
   6 .SH NAME
   7 tune2fs \- adjust tunable filesystem parameters on ext2/ext3 filesystems
   8 .SH SYNOPSIS
   9 .B tune2fs
  10 [
  11 .B \-l
  12 ]
  13 [
  14 .B \-c
  15 .I max-mount-counts
  16 ]
  17 [
  18 .B \-e
  19 .I errors-behavior
  20 ]
  21 [
  22 .B \-f
  23 ]
  24 [
  25 .B \-i
  26 .I interval-between-checks
  27 ]
  28 [
  29 .B \-j
  30 ]
  31 [
  32 .B \-J
  33 .I journal-options
  34 ]
  35 [
  36 .B \-m
  37 .I reserved-blocks-percentage
  38 ]
  39 [
  40 .B \-o
  41 .RI [^]mount-options [,...]
  42 ]
  43 [
  44 .B \-r
  45 .I reserved-blocks-count
  46 ]
  47 [
  48 .B \-s
  49 .I sparse-super-flag
  50 ]
  51 [
  52 .B \-u
  53 .I user
  54 ]
  55 [
  56 .B \-g
  57 .I group
  58 ]
  59 [
  60 .B \-C
  61 .I mount-count
  62 ]
  63 [
  64 .B \-L
  65 .I volume-name
  66 ]
  67 [
  68 .B \-M
  69 .I last-mounted-directory
  70 ]
  71 [
  72 .B \-O
  73 .RI [^] feature [,...]
  74 ]
  75 [
  76 .B \-T
  77 .I time-last-checked
  78 ]
  79 [
  80 .B \-U
  81 .I UUID
  82 ]
  83 device
  84 .SH DESCRIPTION
  85 .BI tune2fs
  86 allows the system administrator to adjust various tunable filesystem
  87 parameters on Linux ext2/ext3 filesystems.
  88 .SH OPTIONS
  89 .TP
  90 .BI \-c " max-mount-counts"
  91 Adjust the maximal mounts count between two filesystem checks.  If
  92 .I max-mount-counts
  93 is 0 then the number of times the filesystem is mounted will be disregarded
  94 by
  95 .BR e2fsck (8)
  96 and the kernel.
  97 .sp
  98 Staggering the mount-counts at which filesystems are forcibly
  99 checked will avoid all filesystems being checked at one time
 100 when using journaled filesystems.
 101 .sp
 102 You should strongly consider the consequences of disabling
 103 mount-count-dependent checking entirely.  Bad disk drives, cables,
 104 memory, and kernel bugs could all corrupt a filesystem without
 105 marking the filesystem dirty or in error.  If you are using
 106 journaling on your filesystem, your filesystem will
 107 .B never
 108 be marked dirty, so it will not normally be checked.  A
 109 filesystem error detected by the kernel will still force
 110 an fsck on the next reboot, but it may already be too late
 111 to prevent data loss at that point.
 112 .sp
 113 See also the
 114 .B \-i
 115 option for time-dependent checking.
 116 .TP
 117 .BI \-C " mount-count"
 118 Set the number of times the filesystem has been mounted.
 119 Can be used in conjunction with -c to force an fsck on
 120 the filesystem at the next reboot.
 121 .TP
 122 .BI \-e " error-behavior"
 123 Change the behavior of the kernel code when errors are detected.
 124 In all cases, a filesystem error will cause
 125 .BR e2fsck (8)
 126 to check the filesystem on the next boot.
 127 .I error-behavior
 128 can be one of the following:
 129 .RS 1.2i
 130 .TP 1.2i
 131 .B continue
 132 Continue normal execution.
 133 .TP
 134 .B remount-ro
 135 Remount filesystem read-only.
 136 .TP
 137 .B panic
 138 Cause a kernel panic.
 139 .RE
 140 .TP
 141 .B \-f
 142 Force the tune2fs operation to complete even in the face of errors.  This
 143 option is useful when removing the
 144 .B has_journal
 145 filesystem feature from a filesystem which has
 146 an external journal (or is corrupted
 147 such that it appears to have an external journal), but that
 148 external journal is not available.
 149 .sp
 150 .B WARNING:
 151 Removing an external journal from a filesystem which was not cleanly unmounted
 152 without first replaying the external journal can result in
 153 severe data loss and filesystem corruption.
 154 .TP
 155 .BI \-g " group"
 156 Set the group which can use reserved filesystem blocks.
 157 The
 158 .I group
 159 parameter can be a numerical gid or a group name.  If a group name is given,
 160 it is converted to a numerical gid before it is stored in the superblock.
 161 .TP
 162 .B \-i " \fIinterval-between-checks\fR[\fBd\fR|\fBm\fR|\fBw\fR]"
 163 Adjust the maximal time between two filesystem checks.
 164 No postfix or
 165 .B d
 166 result in days,
 167 .B m
 168 in months, and
 169 .B w
 170 in weeks.  A value of zero will disable the time-dependent checking.
 171 .sp
 172 It is strongly recommended that either
 173 .B \-c
 174 (mount-count-dependent) or
 175 .B \-i
 176 (time-dependent) checking be enabled to force periodic full
 177 .BR e2fsck (8)
 178 checking of the filesystem.  Failure to do so may lead to filesystem
 179 corruption due to bad disks, cables, memory, or kernel bugs to go
 180 unnoticed until they cause data loss or corruption.
 181 .TP
 182 .B \-j
 183 Add an ext3 journal to the filesystem.  If the
 184 .B \-J
 185 option is not specified, the default journal parameters will be used to create
 186 an appropriately sized journal (given the size of the filesystem)
 187 stored within the filesystem.  Note that you must be using a kernel
 188 which has ext3 support in order to actually make use of the journal.
 189 .TP
 190 .BR \-J " journal-options"
 191 Override the default ext3 journal parameters. Journal options are comma
 192 separated, and may take an argument using the equals ('=')  sign.
 193 The following journal options are supported:
 194 .RS 1.2i
 195 .TP
 196 .BI size= journal-size
 197 Create a journal stored in the filesystem of size
 198 .I journal-size
 199 megabytes.   The size of the journal must be at least 1024 filesystem blocks
 200 (i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.)
 201 and may be no more than 102,400 filesystem blocks.
 202 There must be enough free space in the filesystem to create a journal of
 203 that size.
 204 @JDEV@.TP
 205 @JDEV@.BI device= external-journal
 206 @JDEV@Attach the filesystem to the journal block device located on
 207 @JDEV@.IR external-journal .
 208 @JDEV@The external
 209 @JDEV@journal must have been already created using the command
 210 @JDEV@.IP
 211 @JDEV@.B mke2fs -O journal_dev
 212 @JDEV@.I external-journal
 213 @JDEV@.IP
 214 @JDEV@Note that
 215 @JDEV@.I external-journal
 216 @JDEV@must be formatted with the same block
 217 @JDEV@size as filesystems which will be using it.
 218 @JDEV@.IP
 219 @JDEV@Instead of specifying a device name directly,
 220 @JDEV@.I external-journal
 221 @JDEV@can also be specified by either
 222 @JDEV@.BI LABEL= label
 223 @JDEV@or
 224 @JDEV@.BI UUID= UUID
 225 @JDEV@to locate the external journal by either the volume label or UUID
 226 @JDEV@stored in the ext2 superblock at the start of the journal.  Use
 227 @JDEV@.BR dumpe2fs (8)
 228 @JDEV@to display a journal device's volume label and UUID.  See also the
 229 @JDEV@.B -L
 230 @JDEV@option of
 231 @JDEV@.BR tune2fs (8).
 232 .RE
 233 @JDEV@.IP
 234 @JDEV@Only one of the
 235 @JDEV@.BR size " or " device
 236 @JDEV@options can be given for a filesystem.
 237 .TP
 238 .B \-l
 239 List the contents of the filesystem superblock.
 240 .TP
 241 .BI \-L " volume-label"
 242 Set the volume label of the filesystem.
 243 Ext2 filesystem labels can be at most 16 characters long; if
 244 .I volume-label
 245 is longer than 16 characters,
 246 .B tune2fs
 247 will truncate it and print a warning.  The volume label can be used
 248 by
 249 .BR mount (8),
 250 .BR fsck (8),
 251 and
 252 .BR /etc/fstab (5)
 253 (and possibly others) by specifying
 254 .BI LABEL= volume_label
 255 instead of a block special device name like
 256 .BR /dev/hda5 .
 257 .TP
 258 .BI \-m " reserved-blocks-percentage"
 259 Set the percentage of reserved filesystem blocks.
 260 .TP
 261 .BI \-M " last-mounted-directory"
 262 Set the last-mounted directory for the filesystem.
 263 .TP
 264 .BR \-o " [^]\fImount-option\fR[,...]"
 265 Set or clear the indicated default mount options in the filesystem.
 266 Default mount options can be overriden by mount options specified
 267 either in
 268 .BR /etc/fstab (5)
 269 or on the command line arguments to
 270 .BR mount (8).
 271 Older kernels may not support this feature; in particular,
 272 kernels which predate 2.4.20 will almost certainly ignore the
 273 default mount options field in the superblock.
 274 .IP
 275 More than one mount option can be cleared or set by separating
 276 features with commas.  Mount options prefixed with a
 277 caret character ('^') will be cleared in the filesystem's superblock;
 278 mount options without a prefix character or prefixed with a plus
 279 character ('+') will be added to the filesystem.
 280 .IP
 281 The following mount options can be set or cleared using
 282 .BR tune2fs :
 283 .RS 1.2i
 284 .TP
 285 .B debug
 286 Enable debugging code for this filesystem.
 287 .TP
 288 .B bsdgroups
 289 Emulate BSD behaviour when creating new files: they will take the group-id
 290 of the directory in which they were created.  The standard System V behaviour
 291 is the default, where newly created files take on the fsgid of the current
 292 process, unless the directry has the setgid bit set, in which case it takes
 293 the gid from the parent directory, and also gets the setgid bit set if it is
 294 directory itself.
 295 .TP
 296 .B user_xattr
 297 Enable user-specified extended attributes.
 298 .TP
 299 .B acl
 300 Enable Posix Access Control Lists.
 301 .TP
 302 .B uid16
 303 Disables 32-bit UIDs and GIDs.  This is for interoperability with
 304 older kernels which only store and expect 16-bit values.
 305 .TP
 306 .B journal_data
 307 When the filesystem is mounted with journalling enabled, all data
 308 (not just metadata) is committed into the journal prior to being written
 309 into the main filesystem.
 310 .TP
 311 .B journal_data_ordered
 312 When the filesystem is mounted with journalling enabled, all data is forced
 313 directly out to the main file system prior to its metadata being committed
 314 to the journal.
 315 .TP
 316 .B journal_data_writeback
 317 When the filesystem is mounted with journalling enabled, data may be
 318 written into the main filesystem after its metadata has been committed
 319 to the journal.  This may increase throughput, however, it may allow old
 320 data to appear in files after a crash and journal recovery.
 321 .RE
 322 .TP
 323 .BR \-O " [^]\fIfeature\fR[,...]"
 324 Set or clear the indicated filesystem features (options) in the filesystem.
 325 More than one filesystem feature can be cleared or set by separating
 326 features with commas.  Filesystem features prefixed with a
 327 caret character ('^') will be cleared in the filesystem's superblock;
 328 filesystem features without a prefix character or prefixed with a plus
 329 character ('+') will be added to the filesystem.
 330 .IP
 331 The following filesystem features can be set or cleared using
 332 .BR tune2fs :
 333 .RS 1.2i
 334 .TP
 335 .B dir_index
 336 Use hashed b-trees to speed up lookups in large directories.
 337 .TP
 338 .B filetype
 339 Store file type information in directory entries.
 340 .TP
 341 .B has_journal
 342 Use a journal to ensure filesystem consistency even across unclean shutdowns.
 343 Setting the filesystem feature is equivalent to using the
 344 .B \-j
 345 option.
 346 .TP
 347 .B sparse_super
 348 Limit the number of backup superblocks to save space on large filesystems.
 349 .RE
 350 .IP
 351 After setting or clearing
 352 .B sparse_super
 353 and
 354 .B filetype
 355 filesystem features,
 356 .BR e2fsck (8)
 357 must be run on the filesystem to return the filesystem to a consistent state.
 358 .B Tune2fs
 359 will print a message requesting that the system administrator run
 360 .BR e2fsck (8)
 361 if necessary.  After setting the
 362 .B dir_index
 363 feature,
 364 .B e2fsck -D
 365 can be run to convert existing directories to the hashed B-tree format.
 366 .IP
 367 .B Warning:
 368 Linux kernels before 2.0.39 and many 2.1 series kernels do not support
 369 the filesystems that use any of these features.
 370 Enabling certain filesystem features may prevent the filesystem from
 371 being mounted by kernels which do not support those features.
 372 .TP
 373 .BI \-r " reserved-blocks-count"
 374 Set the number of reserved filesystem blocks.
 375 .TP
 376 .BR \-s " [" 0 | 1 ]
 377 Turn the sparse super feature off or on.  Turning this feature on
 378 saves space on really big filesystems.  This is the same as using the
 379 .B "\-O sparse_super"
 380 option.
 381 .IP
 382 .B Warning:
 383 Linux kernels before 2.0.39 do not support this feature.  Neither do
 384 all Linux 2.1 kernels; please don't use this unless you know what you're
 385 doing!  You need to run
 386 .BR e2fsck (8)
 387 on the filesystem after changing this feature in order to have a valid
 388 filesystem.
 389 .TP
 390 .BI \-T " time-last-checked"
 391 Set the time the filesystem was last checked using
 392 .BR  e2fsck .
 393 This can be useful in scripts which use a Logical Volume Manager to make
 394 a consistent snapshot of a filesystem, and then check the filesystem
 395 during off hours to make sure it hasn't been corrupted due to
 396 hardware problems, etc.  If the filesystem was clean, then this option can
 397 be used to set the last checked time on the original filesystem.  The format
 398 of
 399 .I time-last-checked
 400 is the international date format, with an optional time specifier, i.e.
 401 YYYYMMDD[[HHMM]SS].   The keyword
 402 .B now
 403 is also accepted, in which case the last checked time will be set to the
 404 current time.
 405 .TP
 406 .BI \-u " user"
 407 Set the user who can use the reserved filesystem blocks.
 408 .I user
 409 can be a numerical uid or a user name.  If a user name is given, it
 410 is converted to a numerical uid before it is stored in the superblock.
 411 .TP
 412 .BI \-U " UUID"
 413 Set the universally unique identifier (UUID) of the filesystem to
 414 .IR UUID .
 415 The format of the UUID is a series of hex digits separated by hyphens,
 416 like this:
 417 "c1b9d5a2-f162-11cf-9ece-0020afc76f16".
 418 The
 419 .I UUID
 420 parameter may also be one of the following:
 421 .RS 1.2i
 422 .TP
 423 .I clear
 424 clear the filesystem UUID
 425 .TP
 426 .I random
 427 generate a new randomly-generated UUID
 428 .TP
 429 .I time
 430 generate a new time-based UUID
 431 .RE
 432 .IP
 433 The UUID may be used by
 434 .BR mount (8),
 435 .BR fsck (8),
 436 and
 437 .BR /etc/fstab (5)
 438 (and possibly others) by specifying
 439 .BI UUID= uuid
 440 instead of a block special device name like
 441 .BR /dev/hda1 .
 442 .IP
 443 See
 444 .BR uuidgen (8)
 445 for more information.
 446 If the system does not have a good random number generator such as
 447 .I /dev/random
 448 or
 449 .IR /dev/urandom ,
 450 .B tune2fs
 451 will automatically use a time-based UUID instead of a randomly-generated UUID.
 452 .SH BUGS
 453 We haven't found any bugs yet.  That doesn't mean there aren't any...
 454 .SH AUTHOR
 455 .B tune2fs
 456 was written by Remy Card <Remy.Card@linux.org>.  It is currently being
 457 maintained by Theodore Ts'o <tytso@alum.mit.edu>.
 458 .B tune2fs
 459 uses the ext2fs library written by Theodore Ts'o <tytso@mit.edu>.
 460 This manual page was written by Christian Kuhtz <chk@data-hh.Hanse.DE>.
 461 Time-dependent checking was added by Uwe Ohse <uwe@tirka.gun.de>.
 462 .SH AVAILABILITY
 463 .B tune2fs
 464 is part of the e2fsprogs package and is available from
 465 http://e2fsprogs.sourceforge.net.
 466 .SH SEE ALSO
 467 .BR dumpe2fs (8),
 468 .BR e2fsck (8),
 469 .BR mke2fs (8)