misc/mke2fs.8.in

   1 .\" -*- nroff -*-
   2 .\" Copyright 1993, 1994, 1995 by Theodore Ts'o.  All Rights Reserved.
   3 .\" This file may be copied under the terms of the GNU Public License.
   4 .\"
   5 .TH MKE2FS 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
   6 .SH NAME
   7 mke2fs \- create an ext2/ext3/ext4 filesystem
   8 .SH SYNOPSIS
   9 .B mke2fs
  10 [
  11 .B \-c
  12 |
  13 .B \-l
  14 .I filename
  15 ]
  16 [
  17 .B \-b
  18 .I block-size
  19 ]
  20 [
  21 .B \-C
  22 .I cluster-size
  23 ]
  24 [
  25 .B \-d
  26 .I root-directory
  27 ]
  28 [
  29 .B \-D
  30 ]
  31 [
  32 .B \-g
  33 .I blocks-per-group
  34 ]
  35 [
  36 .B \-G
  37 .I number-of-groups
  38 ]
  39 [
  40 .B \-i
  41 .I bytes-per-inode
  42 ]
  43 [
  44 .B \-I
  45 .I inode-size
  46 ]
  47 [
  48 .B \-j
  49 ]
  50 [
  51 .B \-J
  52 .I journal-options
  53 ]
  54 [
  55 .B \-N
  56 .I number-of-inodes
  57 ]
  58 [
  59 .B \-d
  60 .I root-directory
  61 ]
  62 [
  63 .B \-n
  64 ]
  65 [
  66 .B \-m
  67 .I reserved-blocks-percentage
  68 ]
  69 [
  70 .B \-o
  71 .I creator-os
  72 ]
  73 [
  74 .B \-O
  75 [^]\fIfeature\fR[,...]
  76 ]
  77 [
  78 .B \-q
  79 ]
  80 [
  81 .B \-r
  82 .I fs-revision-level
  83 ]
  84 [
  85 .B \-E
  86 .I extended-options
  87 ]
  88 [
  89 .B \-v
  90 ]
  91 [
  92 .B \-F
  93 ]
  94 [
  95 .B \-L
  96 .I volume-label
  97 ]
  98 [
  99 .B \-M
 100 .I last-mounted-directory
 101 ]
 102 [
 103 .B \-S
 104 ]
 105 [
 106 .B \-t
 107 .I fs-type
 108 ]
 109 [
 110 .B \-T
 111 .I usage-type
 112 ]
 113 [
 114 .B \-U
 115 .I UUID
 116 ]
 117 [
 118 .B \-V
 119 ]
 120 [
 121 .B \-e
 122 .I errors-behavior
 123 ]
 124 [
 125 .B \-z
 126 .I undo_file
 127 ]
 128 .I device
 129 [
 130 .I fs-size
 131 ]
 132 @JDEV@.sp
 133 @JDEV@.B "mke2fs \-O journal_dev"
 134 @JDEV@[
 135 @JDEV@.B \-b
 136 @JDEV@.I block-size
 137 @JDEV@]
 138 .\" No external-journal specific journal options yet (size is ignored)
 139 .\" @JDEV@[
 140 .\" @JDEV@.B \-J
 141 .\" @JDEV@.I journal-options
 142 .\" @JDEV@]
 143 @JDEV@[
 144 @JDEV@.B \-L
 145 @JDEV@.I volume-label
 146 @JDEV@]
 147 @JDEV@[
 148 @JDEV@.B \-n
 149 @JDEV@]
 150 @JDEV@[
 151 @JDEV@.B \-q
 152 @JDEV@]
 153 @JDEV@[
 154 @JDEV@.B \-v
 155 @JDEV@]
 156 @JDEV@.I external-journal
 157 @JDEV@[
 158 @JDEV@.I fs-size
 159 @JDEV@]
 160 .SH DESCRIPTION
 161 .B mke2fs
 162 is used to create an ext2, ext3, or ext4 filesystem, usually in a disk
 163 partition (or file) named by
 164 .IR device .
 165 .PP
 166 The file system size is specified by
 167 .IR fs-size .
 168 If
 169 .I fs-size
 170 does not have a suffix, it is interpreted as power-of-two kilobytes,
 171 unless the
 172 .B \-b
 173 .I blocksize
 174 option is specified, in which case
 175 .I fs-size
 176 is interpreted as the number of
 177 .I blocksize
 178 blocks.   If the fs-size is suffixed by 'k', 'm', 'g', 't'
 179 (either upper-case or lower-case), then it is interpreted in
 180 power-of-two kilobytes, megabytes, gigabytes, terabytes, etc.
 181 If
 182 .I fs-size
 183 is omitted,
 184 .B mke2fs
 185 will create the file system based on the device size.
 186 .PP
 187 If
 188 .B mke2fs
 189 is run as
 190 .B mkfs.XXX
 191 (i.e.,
 192 .BR mkfs.ext2 ,
 193 .BR mkfs.ext3 ,
 194 or
 195 .BR mkfs.ext4 )
 196 the option
 197 .B \-t
 198 .I XXX
 199 is implied; so
 200 .B mkfs.ext3
 201 will create a file system for use with ext3,
 202 .B mkfs.ext4
 203 will create a file system for use with ext4, and so on.
 204 .PP
 205 The defaults of the parameters for the newly created filesystem, if not
 206 overridden by the options listed below, are controlled by the
 207 .B /etc/mke2fs.conf
 208 configuration file.  See the
 209 .BR mke2fs.conf (5)
 210 manual page for more details.
 211 .SH OPTIONS
 212 .TP
 213 .BI \-b " block-size"
 214 Specify the size of blocks in bytes.  Valid block-size values are powers of two
 215 from 1024 up to 65536 (however note that the kernel is able to mount only
 216 filesystems with block-size smaller or equal to the system page size - 4k on
 217 x86 systems, up to 64k on ppc64 or aarch64 depending on kernel configuration).
 218 If omitted, block-size is heuristically determined by the filesystem size and
 219 the expected usage of the filesystem (see the
 220 .B \-T
 221 option).  In most common cases, the default block size is 4k. If
 222 .I block-size
 223 is preceded by a negative sign ('-'), then
 224 .B mke2fs
 225 will use heuristics to determine the
 226 appropriate block size, with the constraint that the block size will be
 227 at least
 228 .I block-size
 229 bytes.  This is useful for certain hardware devices which require that
 230 the blocksize be a multiple of 2k.
 231 .TP
 232 .B \-c
 233 Check the device for bad blocks before creating the file system.  If
 234 this option is specified twice, then a slower read-write
 235 test is used instead of a fast read-only test.
 236 .TP
 237 .B \-C " cluster-size"
 238 Specify the size of cluster in bytes for filesystems using the bigalloc
 239 feature.  Valid cluster-size values are from 2048 to 256M bytes per
 240 cluster.  This can only be specified if the bigalloc feature is
 241 enabled.  (See the
 242 .B ext4 (5)
 243 man page for more details about bigalloc.)   The default cluster size if
 244 bigalloc is enabled is 16 times the block size.
 245 .TP
 246 .BI \-d " root-directory"
 247 Copy the contents of the given directory into the root directory of the
 248 filesystem.
 249 .TP
 250 .B \-D
 251 Use direct I/O when writing to the disk.  This avoids mke2fs dirtying a
 252 lot of buffer cache memory, which may impact other applications running
 253 on a busy server.  This option will cause mke2fs to run much more
 254 slowly, however, so there is a tradeoff to using direct I/O.
 255 .TP
 256 .BI \-e " error-behavior"
 257 Change the behavior of the kernel code when errors are detected.
 258 In all cases, a filesystem error will cause
 259 .BR e2fsck (8)
 260 to check the filesystem on the next boot.
 261 .I error-behavior
 262 can be one of the following:
 263 .RS 1.2i
 264 .TP 1.2i
 265 .B continue
 266 Continue normal execution.
 267 .TP
 268 .B remount-ro
 269 Remount filesystem read-only.
 270 .TP
 271 .B panic
 272 Cause a kernel panic.
 273 .RE
 274 .TP
 275 .BI \-E " extended-options"
 276 Set extended options for the filesystem.  Extended options are comma
 277 separated, and may take an argument using the equals ('=') sign.  The
 278 .B \-E
 279 option used to be
 280 .B \-R
 281 in earlier versions of
 282 .BR mke2fs .
 283 The
 284 .B \-R
 285 option is still accepted for backwards compatibility, but is deprecated.
 286 The following extended options are supported:
 287 .RS 1.2i
 288 .TP
 289 .BI encoding= encoding-name
 290 Enable the
 291 .I casefold
 292 feature in the super block and set
 293 .I encoding-name
 294 as the encoding to be used.  If
 295 .I encoding-name
 296 is not specified, the encoding defined in
 297 .BR mke2fs.conf (5)
 298 is used.
 299 .TP
 300 .BI encoding_flags= encoding-flags
 301 Define parameters for file name character encoding operations.  If a
 302 flag is not changed using this parameter, its default value is used.
 303 .I encoding-flags
 304 should be a comma-separated lists of flags to be enabled.  To disable a
 305 flag, add it to the list with the prefix "no".
 306
 307 The only flag that can be set right now is
 308 .I strict
 309 which means that invalid strings should be rejected by the file system.
 310 In the default configuration, the
 311 .I strict
 312 flag is disabled.
 313 .TP
 314 .BI mmp_update_interval= interval
 315 Adjust the initial MMP update interval to
 316 .I interval
 317 seconds.  Specifying an
 318 .I interval
 319 of 0 means to use the default interval.  The specified interval must
 320 be less than 300 seconds.  Requires that the
 321 .B mmp
 322 feature be enabled.
 323 .TP
 324 .BI stride= stride-size
 325 Configure the filesystem for a RAID array with
 326 .I stride-size
 327 filesystem blocks. This is the number of blocks read or written to disk
 328 before moving to the next disk, which is sometimes referred to as the
 329 .I chunk size.
 330 This mostly affects placement of filesystem metadata like bitmaps at
 331 .B mke2fs
 332 time to avoid placing them on a single disk, which can hurt performance.
 333 It may also be used by the block allocator.
 334 .TP
 335 .BI stripe_width= stripe-width
 336 Configure the filesystem for a RAID array with
 337 .I stripe-width
 338 filesystem blocks per stripe. This is typically stride-size * N, where
 339 N is the number of data-bearing disks in the RAID (e.g. for RAID 5 there is one
 340 parity disk, so N will be the number of disks in the array minus 1).
 341 This allows the block allocator to prevent read-modify-write of the
 342 parity in a RAID stripe if possible when the data is written.
 343 .TP
 344 .BI offset= offset
 345 Create the filesystem at an offset from the beginning of the device or
 346 file.  This can be useful when creating disk images for virtual machines.
 347 .TP
 348 .BI resize= max-online-resize
 349 Reserve enough space so that the block group descriptor table can grow
 350 to support a filesystem that has
 351 .I max-online-resize
 352 blocks.
 353 .TP
 354 .B lazy_itable_init\fR[\fB= \fI<0 to disable, 1 to enable>\fR]
 355 If enabled and the uninit_bg feature is enabled, the inode table will
 356 not be fully initialized by
 357 .BR mke2fs .
 358 This speeds up filesystem
 359 initialization noticeably, but it requires the kernel to finish
 360 initializing the filesystem in the background when the filesystem is
 361 first mounted.  If the option value is omitted, it defaults to 1 to
 362 enable lazy inode table zeroing.
 363 .TP
 364 .B lazy_journal_init\fR[\fB= \fI<0 to disable, 1 to enable>\fR]
 365 If enabled, the journal inode will not be fully zeroed out by
 366 .BR mke2fs .
 367 This speeds up filesystem initialization noticeably, but carries some
 368 small risk if the system crashes before the journal has been overwritten
 369 entirely one time.  If the option value is omitted, it defaults to 1 to
 370 enable lazy journal inode zeroing.
 371 .TP
 372 .B no_copy_xattrs
 373 Normally
 374 .B mke2fs
 375 will copy the extended attributes of the files in the directory
 376 hierarchy specified via the (optional)
 377 .B \-d
 378 option.  This will disable the copy and leaves the files in the newly
 379 created file system without any extended attributes.
 380 .TP
 381 .BI num_backup_sb= <0|1|2>
 382 If the
 383 .B sparse_super2
 384 file system feature is enabled this option controls whether there will
 385 be 0, 1, or 2 backup superblocks created in the file system.
 386 .TP
 387 .B packed_meta_blocks\fR[\fB= \fI<0 to disable, 1 to enable>\fR]
 388 Place the allocation bitmaps and the inode table at the beginning of the
 389 disk.  This option requires that the flex_bg file system feature to be
 390 enabled in order for it to have effect, and will also create the journal
 391 at the beginning of the file system.  This option is useful for flash
 392 devices that use SLC flash at the beginning of the disk.
 393 It also maximizes the range of contiguous data blocks, which
 394 can be useful for certain specialized use cases, such as supported
 395 Shingled Drives.
 396 .TP
 397 .BI root_owner [=uid:gid]
 398 Specify the numeric user and group ID of the root directory.  If no UID:GID
 399 is specified, use the user and group ID of the user running \fBmke2fs\fR.
 400 In \fBmke2fs\fR 1.42 and earlier the UID and GID of the root directory were
 401 set by default to the UID and GID of the user running the mke2fs command.
 402 The \fBroot_owner=\fR option allows explicitly specifying these values,
 403 and avoid side-effects for users that do not expect the contents of the
 404 filesystem to change based on the user running \fBmke2fs\fR.
 405 .TP
 406 .B test_fs
 407 Set a flag in the filesystem superblock indicating that it may be
 408 mounted using experimental kernel code, such as the ext4dev filesystem.
 409 .TP
 410 .B discard
 411 Attempt to discard blocks at mkfs time (discarding blocks initially is useful
 412 on solid state devices and sparse / thin-provisioned storage). When the device
 413 advertises that discard also zeroes data (any subsequent read after the discard
 414 and before write returns zero), then mark all not-yet-zeroed inode tables as
 415 zeroed. This significantly speeds up filesystem initialization. This is set
 416 as default.
 417 .TP
 418 .B nodiscard
 419 Do not attempt to discard blocks at mkfs time.
 420 .TP
 421 .B quotatype
 422 Specify the which  quota types (usrquota, grpquota, prjquota) which
 423 should be enabled in the created file system.  The argument of this
 424 extended option should be a colon separated list.  This option has
 425 effect only if the
 426 .B quota
 427 feature is set.   The default quota types to be initialized if this
 428 option is not specified is both user and group quotas.  If the project
 429 feature is enabled that project quotas will be initialized as well.
 430 .RE
 431 .TP
 432 .B \-F
 433 Force
 434 .B mke2fs
 435 to create a filesystem, even if the specified device is not a partition
 436 on a block special device, or if other parameters do not make sense.
 437 In order to force
 438 .B mke2fs
 439 to create a filesystem even if the filesystem appears to be in use
 440 or is mounted (a truly dangerous thing to do), this option must be
 441 specified twice.
 442 .TP
 443 .BI \-g " blocks-per-group"
 444 Specify the number of blocks in a block group.  There is generally no
 445 reason for the user to ever set this parameter, as the default is optimal
 446 for the filesystem.  (For administrators who are creating
 447 filesystems on RAID arrays, it is preferable to use the
 448 .I stride
 449 RAID parameter as part of the
 450 .B \-E
 451 option rather than manipulating the number of blocks per group.)
 452 This option is generally used by developers who
 453 are developing test cases.
 454 .IP
 455 If the bigalloc feature is enabled, the
 456 .B \-g
 457 option will specify the number of clusters in a block group.
 458 .TP
 459 .BI \-G " number-of-groups"
 460 Specify the number of block groups that will be packed together to
 461 create a larger virtual block group (or "flex_bg group") in an
 462 ext4 filesystem.  This improves meta-data locality and performance
 463 on meta-data heavy workloads.  The number of groups must be a power
 464 of 2 and may only be specified if the
 465 .B flex_bg
 466 filesystem feature is enabled.
 467 .TP
 468 .BI \-i " bytes-per-inode"
 469 Specify the bytes/inode ratio.
 470 .B mke2fs
 471 creates an inode for every
 472 .I bytes-per-inode
 473 bytes of space on the disk.  The larger the
 474 .I bytes-per-inode
 475 ratio, the fewer inodes will be created.  This value generally shouldn't
 476 be smaller than the blocksize of the filesystem, since in that case more
 477 inodes would be made than can ever be used.  Be warned that it is not
 478 possible to change this ratio on a filesystem after it is created, so be
 479 careful deciding the correct value for this parameter.  Note that resizing
 480 a filesystem changes the number of inodes to maintain this ratio.
 481 .TP
 482 .BI \-I " inode-size"
 483 Specify the size of each inode in bytes.
 484 The
 485 .I inode-size
 486 value must be a power of 2 larger or equal to 128.  The larger the
 487 .I inode-size
 488 the more space the inode table will consume, and this reduces the usable
 489 space in the filesystem and can also negatively impact performance.
 490 It is not
 491 possible to change this value after the filesystem is created.
 492 .IP
 493 File systems with an inode size of 128 bytes do not support timestamps
 494 beyond January 19, 2038.  Inodes which are 256 bytes or larger will
 495 support extended timestamps, project id's, and the ability to store some
 496 extended attributes in the inode table for improved performance.
 497 .IP
 498 The default inode size is controlled by the
 499 .BR mke2fs.conf (5)
 500 file.  In the
 501 .B mke2fs.conf
 502 file shipped with e2fsprogs, the default inode size is 256 bytes for
 503 most file systems, except for small file systems where the inode size
 504 will be 128 bytes.
 505 .TP
 506 .B \-j
 507 Create the filesystem with an ext3 journal.  If the
 508 .B \-J
 509 option is not specified, the default journal parameters will be used to
 510 create an appropriately sized journal (given the size of the filesystem)
 511 stored within the filesystem.  Note that you must be using a kernel
 512 which has ext3 support in order to actually make use of the journal.
 513 .TP
 514 .BI \-J " journal-options"
 515 Create the ext3 journal using options specified on the command-line.
 516 Journal options are comma
 517 separated, and may take an argument using the equals ('=')  sign.
 518 The following journal options are supported:
 519 .RS 1.2i
 520 .TP
 521 .BI size= journal-size
 522 Create an internal journal (i.e., stored inside the filesystem) of size
 523 .I journal-size
 524 megabytes.
 525 The size of the journal must be at least 1024 filesystem blocks
 526 (i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.)
 527 and may be no more than 10,240,000 filesystem blocks or half the total
 528 file system size (whichever is smaller)
 529 .TP
 530 .BI fast_commit_size= fast-commit-size
 531 Create an additional fast commit journal area of size
 532 .I fast-commit-size
 533 kilobytes.
 534 This option is only valid if
 535 .B fast_commit
 536 feature is enabled
 537 on the file system. If this option is not specified and if
 538 .B fast_commit
 539 feature is turned on, fast commit area size defaults to
 540 .I journal-size
 541 / 64 megabytes. The total size of the journal with
 542 .B fast_commit
 543 feature set is
 544 .I journal-size
 545 + (
 546 .I fast-commit-size
 547 * 1024) megabytes. The total journal size may be no more than
 548 10,240,000 filesystem blocks or half the total file system size
 549 (whichever is smaller).
 550 .TP
 551 .BI location =journal-location
 552 Specify the location of the journal.  The argument
 553 .I journal-location
 554 can either be specified as a block number, or if the number has a units
 555 suffix (e.g., 'M', 'G', etc.) interpret it as the offset from the
 556 beginning of the file system.
 557 @JDEV@.TP
 558 @JDEV@.BI device= external-journal
 559 @JDEV@Attach the filesystem to the journal block device located on
 560 @JDEV@.IR external-journal .
 561 @JDEV@The external
 562 @JDEV@journal must already have been created using the command
 563 @JDEV@.IP
 564 @JDEV@.B mke2fs -O journal_dev
 565 @JDEV@.I external-journal
 566 @JDEV@.IP
 567 @JDEV@Note that
 568 @JDEV@.I external-journal
 569 @JDEV@must have been created with the
 570 @JDEV@same block size as the new filesystem.
 571 @JDEV@In addition, while there is support for attaching
 572 @JDEV@multiple filesystems to a single external journal,
 573 @JDEV@the Linux kernel and
 574 @JDEV@.BR e2fsck (8)
 575 @JDEV@do not currently support shared external journals yet.
 576 @JDEV@.IP
 577 @JDEV@Instead of specifying a device name directly,
 578 @JDEV@.I external-journal
 579 @JDEV@can also be specified by either
 580 @JDEV@.BI LABEL= label
 581 @JDEV@or
 582 @JDEV@.BI UUID= UUID
 583 @JDEV@to locate the external journal by either the volume label or UUID
 584 @JDEV@stored in the ext2 superblock at the start of the journal.  Use
 585 @JDEV@.BR dumpe2fs (8)
 586 @JDEV@to display a journal device's volume label and UUID.  See also the
 587 @JDEV@.B -L
 588 @JDEV@option of
 589 @JDEV@.BR tune2fs (8).
 590 .RE
 591 @JDEV@.IP
 592 @JDEV@Only one of the
 593 @JDEV@.BR size " or " device
 594 @JDEV@options can be given for a filesystem.
 595 .TP
 596 .BI \-l " filename"
 597 Read the bad blocks list from
 598 .IR filename .
 599 Note that the block numbers in the bad block list must be generated
 600 using the same block size as used by
 601 .BR mke2fs .
 602 As a result, the
 603 .B \-c
 604 option to
 605 .B mke2fs
 606 is a much simpler and less error-prone method of checking a disk for bad
 607 blocks before formatting it, as
 608 .B mke2fs
 609 will automatically pass the correct parameters to the
 610 .B badblocks
 611 program.
 612 .TP
 613 .BI \-L " new-volume-label"
 614 Set the volume label for the filesystem to
 615 .IR new-volume-label .
 616 The maximum length of the
 617 volume label is 16 bytes.
 618 .TP
 619 .BI \-m " reserved-blocks-percentage"
 620 Specify the percentage of the filesystem blocks reserved for
 621 the super-user.  This avoids fragmentation, and allows root-owned
 622 daemons, such as
 623 .BR syslogd (8),
 624 to continue to function correctly after non-privileged processes are
 625 prevented from writing to the filesystem.  The default percentage
 626 is 5%.
 627 .TP
 628 .BI \-M " last-mounted-directory"
 629 Set the last mounted directory for the filesystem.  This might be useful
 630 for the sake of utilities that key off of the last mounted directory to
 631 determine where the filesystem should be mounted.
 632 .TP
 633 .B \-n
 634 Causes
 635 .B mke2fs
 636 to not actually create a filesystem, but display what it
 637 would do if it were to create a filesystem.  This can be used to
 638 determine the location of the backup superblocks for a particular
 639 filesystem, so long as the
 640 .B mke2fs
 641 parameters that were passed when the
 642 filesystem was originally created are used again.  (With the
 643 .B \-n
 644 option added, of course!)
 645 .TP
 646 .BI \-N " number-of-inodes"
 647 Overrides the default calculation of the number of inodes that should be
 648 reserved for the filesystem (which is based on the number of blocks and
 649 the
 650 .I bytes-per-inode
 651 ratio).  This allows the user to specify the number
 652 of desired inodes directly.
 653 .TP
 654 .BI \-d " root-directory"
 655 Add the files from the root-directory to the filesystem.
 656 .TP
 657 .BI \-o " creator-os"
 658 Overrides the default value of the "creator operating system" field of the
 659 filesystem.  The creator field is set by default to the name of the OS the
 660 .B mke2fs
 661 executable was compiled for.
 662 .TP
 663 .B "\-O \fR[^]\fIfeature\fR[,...]"
 664 Create a filesystem with the given features (filesystem options),
 665 overriding the default filesystem options.  The features that are
 666 enabled by default are specified by the
 667 .I base_features
 668 relation, either in the
 669 .I [defaults]
 670 section in the
 671 .B /etc/mke2fs.conf
 672 configuration file,
 673 or in the
 674 .I [fs_types]
 675 subsections for the usage types as specified by the
 676 .B \-T
 677 option, further modified by the
 678 .I features
 679 relation found in the
 680 .I [fs_types]
 681 subsections for the filesystem and usage types.  See the
 682 .BR mke2fs.conf (5)
 683 manual page for more details.
 684 The filesystem type-specific configuration setting found in the
 685 .I [fs_types]
 686 section will override the global default found in
 687 .IR [defaults] .
 688 .sp
 689 The filesystem feature set will be further edited
 690 using either the feature set specified by this option,
 691 or if this option is not given, by the
 692 .I default_features
 693 relation for the filesystem type being created, or in the
 694 .I [defaults]
 695 section of the configuration file.
 696 .sp
 697 The filesystem feature set is comprised of a list of features, separated
 698 by commas, that are to be enabled.  To disable a feature, simply
 699 prefix the feature name with a caret ('^') character.
 700 Features with dependencies will not be removed successfully.
 701 The pseudo-filesystem feature "none" will clear all filesystem features.
 702 .TP
 703 For more information about the features which can be set, please see
 704 the manual page
 705 .BR ext4 (5).
 706 .TP
 707 .B \-q
 708 Quiet execution.  Useful if
 709 .B mke2fs
 710 is run in a script.
 711 .TP
 712 .BI \-r " revision"
 713 Set the filesystem revision for the new filesystem.  Note that 1.2
 714 kernels only support revision 0 filesystems.  The default is to
 715 create revision 1 filesystems.
 716 .TP
 717 .B \-S
 718 Write superblock and group descriptors only.  This is an extreme
 719 measure to be taken only in the very unlikely case that all of
 720 the superblock and backup superblocks are corrupted, and a last-ditch
 721 recovery method is desired by experienced users.  It causes
 722 .B mke2fs
 723 to reinitialize the superblock and group descriptors, while not
 724 touching the inode table and the block and inode bitmaps.  The
 725 .B e2fsck
 726 program should be run immediately after this option is used, and there
 727 is no guarantee that any data will be salvageable.  Due to the wide
 728 variety of possible options to
 729 .B mke2fs
 730 that affect the on-disk layout, it is critical to specify exactly
 731 the same format options, such as blocksize, fs-type, feature flags, and
 732 other tunables when using this option, or the filesystem will be further
 733 corrupted.  In some cases, such as filesystems that have been resized,
 734 or have had features enabled after format time, it is impossible to
 735 overwrite all of the superblocks correctly, and at least some filesystem
 736 corruption will occur.  It is best to run this on a full copy of the
 737 filesystem so other options can be tried if this doesn't work.
 738 .\" .TP
 739 .\" .BI \-t " test"
 740 .\" Check the device for bad blocks before creating the file system
 741 .\" using the specified test.
 742 .TP
 743 .BI \-t " fs-type"
 744 Specify the filesystem type (i.e., ext2, ext3, ext4, etc.) that is
 745 to be created.
 746 If this option is not specified,
 747 .B mke2fs
 748 will pick a default either via how
 749 the command was run (for example, using a name of the form mkfs.ext2,
 750 mkfs.ext3, etc.) or via a default as defined by the
 751 .B /etc/mke2fs.conf
 752 file.   This option controls which filesystem options are used by
 753 default, based on the
 754 .B fstypes
 755 configuration stanza in
 756 .BR /etc/mke2fs.conf .
 757 .sp
 758 If the
 759 .B \-O
 760 option is used to explicitly add or remove filesystem options that
 761 should be set in the newly created filesystem, the
 762 resulting filesystem may not be supported by the requested
 763 .IR fs-type .
 764 (e.g., "\fBmke2fs \-t ext3 \-O extent /dev/sdXX\fR" will create a
 765 filesystem that is not supported by the ext3 implementation as found in
 766 the Linux kernel; and "\fBmke2fs \-t ext3 \-O ^has_journal /dev/hdXX\fR"
 767 will create a filesystem that does not have a journal and hence will not
 768 be supported by the ext3 filesystem code in the Linux kernel.)
 769 .TP
 770 .BI \-T " usage-type[,...]"
 771 Specify how the filesystem is going to be used, so that
 772 .B mke2fs
 773 can choose optimal filesystem parameters for that use.  The usage
 774 types that are supported are defined in the configuration file
 775 .BR /etc/mke2fs.conf .
 776 The user may specify one or more usage types
 777 using a comma separated list.
 778 .sp
 779 If this option is is not specified,
 780 .B mke2fs
 781 will pick a single default usage type based on the size of the filesystem to
 782 be created.  If the filesystem size is less than 3 megabytes,
 783 .B mke2fs
 784 will use the filesystem type
 785 .IR floppy .
 786 If the filesystem size is greater than or equal to 3 but less than
 787 512 megabytes,
 788 .BR mke2fs (8)
 789 will use the filesystem type
 790 .IR small .
 791 If the filesystem size is greater than or equal to 4 terabytes but less than
 792 16 terabytes,
 793 .BR mke2fs (8)
 794 will use the filesystem type
 795 .IR big .
 796 If the filesystem size is greater than or equal to 16 terabytes,
 797 .BR mke2fs (8)
 798 will use the filesystem type
 799 .IR huge .
 800 Otherwise,
 801 .BR mke2fs (8)
 802 will use the default filesystem type
 803 .IR default .
 804 .TP
 805 .BI \-U " UUID"
 806 Set the universally unique identifier (UUID) of the filesystem to
 807 .IR UUID .
 808 The format of the UUID is a series of hex digits separated by hyphens,
 809 like this:
 810 "c1b9d5a2-f162-11cf-9ece-0020afc76f16".
 811 The
 812 .I UUID
 813 parameter may also be one of the following:
 814 .RS 1.2i
 815 .TP
 816 .I clear
 817 clear the filesystem UUID
 818 .TP
 819 .I random
 820 generate a new randomly-generated UUID
 821 .TP
 822 .I time
 823 generate a new time-based UUID
 824 .RE
 825 .TP
 826 .B \-v
 827 Verbose execution.
 828 .TP
 829 .B \-V
 830 Print the version number of
 831 .B mke2fs
 832 and exit.
 833 .TP
 834 .BI \-z " undo_file"
 835 Before overwriting a file system block, write the old contents of the block to
 836 an undo file.  This undo file can be used with e2undo(8) to restore the old
 837 contents of the file system should something go wrong.  If the empty string is
 838 passed as the undo_file argument, the undo file will be written to a file named
 839 mke2fs-\fIdevice\fR.e2undo in the directory specified via the
 840 \fIE2FSPROGS_UNDO_DIR\fR environment variable or the \fIundo_dir\fR directive
 841 in the configuration file.
 842
 843 WARNING: The undo file cannot be used to recover from a power or system crash.
 844 .SH ENVIRONMENT
 845 .TP
 846 .B MKE2FS_SYNC
 847 If set to non-zero integer value, its value is used to determine how often
 848 .BR sync (2)
 849 is called during inode table initialization.
 850 .TP
 851 .B MKE2FS_CONFIG
 852 Determines the location of the configuration file (see
 853 .BR mke2fs.conf (5)).
 854 .TP
 855 .B MKE2FS_FIRST_META_BG
 856 If set to non-zero integer value, its value is used to determine first meta
 857 block group. This is mostly for debugging purposes.
 858 .TP
 859 .B MKE2FS_DEVICE_SECTSIZE
 860 If set to non-zero integer value, its value is used to determine logical
 861 sector size of the
 862 .IR device .
 863 .TP
 864 .B MKE2FS_DEVICE_PHYS_SECTSIZE
 865 If set to non-zero integer value, its value is used to determine physical
 866 sector size of the
 867 .IR device .
 868 .TP
 869 .B MKE2FS_SKIP_CHECK_MSG
 870 If set, do not show the message of filesystem automatic check caused by
 871 mount count or check interval.
 872 .SH AUTHOR
 873 This version of
 874 .B mke2fs
 875 has been written by Theodore Ts'o <tytso@mit.edu>.
 876 .SH AVAILABILITY
 877 .B mke2fs
 878 is part of the e2fsprogs package and is available from
 879 http://e2fsprogs.sourceforge.net.
 880 .SH SEE ALSO
 881 .BR mke2fs.conf (5),
 882 .BR badblocks (8),
 883 .BR dumpe2fs (8),
 884 .BR e2fsck (8),
 885 .BR tune2fs (8),
 886 .BR ext4 (5)