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