OSDN Git Service

Use rbtree bitmaps for dumpe2fs, debugfs, and tune2fs
[android-x86/external-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 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 \-f
22 .I fragment-size
23 ]
24 [
25 .B \-g
26 .I blocks-per-group
27 ]
28 [
29 .B \-G
30 .I number-of-groups
31 ]
32 [
33 .B \-i
34 .I bytes-per-inode
35 ]
36 [
37 .B \-I
38 .I inode-size
39 ]
40 [
41 .B \-j
42 ]
43 [
44 .B \-J
45 .I journal-options
46 ]
47 [
48 .B \-N
49 .I number-of-inodes
50 ]
51 [
52 .B \-n
53 ]
54 [
55 .B \-m
56 .I reserved-blocks-percentage
57 ]
58 [
59 .B \-o
60 .I creator-os
61 ]
62 [
63 .B \-O
64 .IR feature [,...]
65 ]
66 [
67 .B \-q
68 ]
69 [
70 .B \-r
71 .I fs-revision-level
72 ]
73 [
74 .B \-E
75 .I extended-options
76 ]
77 [
78 .B \-v
79 ]
80 [
81 .B \-F
82 ]
83 [
84 .B \-L
85 .I volume-label
86 ]
87 [
88 .B \-M
89 .I last-mounted-directory
90 ]
91 [
92 .B \-S
93 ]
94 [
95 .B \-t
96 .I fs-type
97 ]
98 [
99 .B \-T
100 .I usage-type
101 ]
102 [
103 .B \-U
104 .I UUID
105 ]
106 [
107 .B \-V
108 ]
109 .I device
110 [
111 .I blocks-count
112 ]
113 @JDEV@.sp
114 @JDEV@.B "mke2fs \-O journal_dev"
115 @JDEV@[
116 @JDEV@.B \-b
117 @JDEV@.I block-size
118 @JDEV@]
119 .\" No external-journal specific journal options yet (size is ignored)
120 .\" @JDEV@[
121 .\" @JDEV@.B \-J
122 .\" @JDEV@.I journal-options
123 .\" @JDEV@]
124 @JDEV@[
125 @JDEV@.B \-L
126 @JDEV@.I volume-label
127 @JDEV@]
128 @JDEV@[
129 @JDEV@.B \-n
130 @JDEV@]
131 @JDEV@[
132 @JDEV@.B \-q
133 @JDEV@]
134 @JDEV@[
135 @JDEV@.B \-v
136 @JDEV@]
137 @JDEV@.I external-journal
138 @JDEV@[
139 @JDEV@.I blocks-count
140 @JDEV@]
141 .SH DESCRIPTION
142 .B mke2fs
143 is used to create an ext2, ext3, or ext4 filesystem, usually in a disk
144 partition.
145 .I device
146 is the special file corresponding to the device (e.g
147 .IR /dev/hdXX ).
148 .I blocks-count
149 is the number of blocks on the device.  If omitted,
150 .B mke2fs
151 automagically figures the file system size.  If called as
152 .B mkfs.ext3
153 a journal is created as if the
154 .B \-j
155 option was specified.
156 .PP
157 The defaults of the parameters for the newly created filesystem, if not
158 overridden by the options listed below, are controlled by the
159 .B /etc/mke2fs.conf
160 configuration file.  See the
161 .BR mke2fs.conf (5)
162 manual page for more details.
163 .SH OPTIONS
164 .TP
165 .BI \-b " block-size"
166 Specify the size of blocks in bytes.  Valid block-size values are 1024,
167 2048 and 4096 bytes per block.  If omitted,
168 block-size is heuristically determined by the filesystem size and
169 the expected usage of the filesystem (see the
170 .B \-T
171 option).  If
172 .I block-size
173 is preceded by a negative sign ('-'), then
174 .B mke2fs
175 will use heuristics to determine the
176 appropriate block size, with the constraint that the block size will be
177 at least
178 .I block-size
179 bytes.  This is useful for certain hardware devices which require that
180 the blocksize be a multiple of 2k.
181 .TP
182 .B \-c
183 Check the device for bad blocks before creating the file system.  If
184 this option is specified twice, then a slower read-write
185 test is used instead of a fast read-only test.
186 .TP
187 .BI \-E " extended-options"
188 Set extended options for the filesystem.  Extended options are comma
189 separated, and may take an argument using the equals ('=') sign.  The
190 .B \-E
191 option used to be
192 .B \-R
193 in earlier versions of
194 .BR mke2fs .
195 The
196 .B \-R
197 option is still accepted for backwards compatibility.   The
198 following extended options are supported:
199 .RS 1.2i
200 .TP
201 .BI mmp_update_interval= interval
202 Adjust the initial MMP update interval to
203 .I interval
204 seconds.  Specifying an
205 .I interval
206 of 0 means to use the default interval.  The specified interval must
207 be less than 300 seconds.  Requires that the
208 .B mmp
209 feature be enabled.
210 .TP
211 .BI stride= stride-size
212 Configure the filesystem for a RAID array with
213 .I stride-size
214 filesystem blocks. This is the number of blocks read or written to disk
215 before moving to the next disk, which is sometimes referred to as the
216 .I chunk size.
217 This mostly affects placement of filesystem metadata like bitmaps at
218 .B mke2fs
219 time to avoid placing them on a single disk, which can hurt performance.
220 It may also be used by the block allocator.
221 .TP
222 .BI stripe_width= stripe-width
223 Configure the filesystem for a RAID array with
224 .I stripe-width
225 filesystem blocks per stripe. This is typically stride-size * N, where
226 N is the number of data-bearing disks in the RAID (e.g. for RAID 5 there is one
227 parity disk, so N will be the number of disks in the array minus 1).
228 This allows the block allocator to prevent read-modify-write of the
229 parity in a RAID stripe if possible when the data is written.
230 .TP
231 .BI resize= max-online-resize
232 Reserve enough space so that the block group descriptor table can grow
233 to support a filesystem that has
234 .I max-online-resize
235 blocks.
236 .TP
237 .B lazy_itable_init\fR[\fB= \fI<0 to disable, 1 to enable>\fR]
238 If enabled and the uninit_bg feature is enabled, the inode table will
239 not be fully initialized by
240 .BR mke2fs .
241 This speeds up filesystem
242 initialization noticeably, but it requires the kernel to finish
243 initializing the filesystem in the background when the filesystem is
244 first mounted.  If the option value is omitted, it defaults to 1 to
245 enable lazy inode table zeroing.
246 .TP
247 .B lazy_journal_init\fR[\fB= \fI<0 to disable, 1 to enable>\fR]
248 If enabled, the journal inode will not be fully zeroed out by
249 .BR mke2fs .
250 This speeds up filesystem initialization noticeably, but carries some
251 small risk if the system crashes before the journal has been overwritten
252 entirely one time.  If the option value is omitted, it defaults to 1 to
253 enable lazy journal inode zeroing.
254 .TP
255 .B test_fs
256 Set a flag in the filesystem superblock indicating that it may be
257 mounted using experimental kernel code, such as the ext4dev filesystem.
258 .TP
259 .BI discard
260 Attempt to discard blocks at mkfs time (discarding blocks initially is useful
261 on solid state devices and sparse / thin-provisioned storage). When the device
262 advertises that discard also zeroes data (any subsequent read after the discard
263 and before write returns zero), then mark all not-yet-zeroed inode tables as
264 zeroed. This significantly speeds up filesystem initialization. This is set
265 as default.
266 .TP
267 .BI nodiscard
268 Do not attempt to discard blocks at mkfs time.
269 .TP
270 .BI quotatype
271 Specify which quota type ('usr' or 'grp') is to be initialized. This
272 option has any effect only if
273 .B quota
274 feature is set. Without this extended option, the default behavior is to
275 initialize both user and group quotas.
276 .RE
277 .TP
278 .BI \-f " fragment-size"
279 Specify the size of fragments in bytes.
280 .TP
281 .B \-F
282 Force
283 .B mke2fs
284 to create a filesystem, even if the specified device is not a partition
285 on a block special device, or if other parameters do not make sense.
286 In order to force
287 .B mke2fs
288 to create a filesystem even if the filesystem appears to be in use
289 or is mounted (a truly dangerous thing to do), this option must be
290 specified twice.
291 .TP
292 .BI \-g " blocks-per-group"
293 Specify the number of blocks in a block group.  There is generally no
294 reason for the user to ever set this parameter, as the default is optimal
295 for the filesystem.  (For administrators who are creating
296 filesystems on RAID arrays, it is preferable to use the
297 .I stride
298 RAID parameter as part of the
299 .B \-E
300 option rather than manipulating the number of blocks per group.)
301 This option is generally used by developers who
302 are developing test cases.
303 .TP
304 .BI \-G " number-of-groups"
305 Specify the number of block groups that will be packed together to
306 create a larger virtual block group (or "flex_bg group") in an
307 ext4 filesystem.  This improves meta-data locality and performance
308 on meta-data heavy workloads.  The number of groups must be a power
309 of 2 and may only be specified if the 
310 .B flex_bg
311 filesystem feature is enabled.
312 .TP
313 .BI \-i " bytes-per-inode"
314 Specify the bytes/inode ratio.
315 .B mke2fs
316 creates an inode for every
317 .I bytes-per-inode
318 bytes of space on the disk.  The larger the
319 .I bytes-per-inode
320 ratio, the fewer inodes will be created.  This value generally shouldn't
321 be smaller than the blocksize of the filesystem, since in that case more
322 inodes would be made than can ever be used.  Be warned that it is not
323 possible to expand the number
324 of inodes on a filesystem after it is created, so be careful deciding the
325 correct value for this parameter.
326 .TP
327 .BI \-I " inode-size"
328 Specify the size of each inode in bytes.
329 .B mke2fs
330 creates 256-byte inodes by default.  In kernels after 2.6.10 and some
331 earlier vendor kernels it is possible to utilize inodes larger than
332 128 bytes to store
333 extended attributes for improved performance.  The
334 .I inode-size
335 value must be a power of 2 larger or equal to 128.  The larger the
336 .I inode-size
337 the more space the inode table will consume, and this reduces the usable
338 space in the filesystem and can also negatively impact performance.
339 Extended attributes
340 stored in large inodes are not visible with older kernels, and such
341 filesystems will not be mountable with 2.4 kernels at all.  It is not
342 possible to change this value after the filesystem is created.
343 .TP
344 .B \-j
345 Create the filesystem with an ext3 journal.  If the
346 .B \-J
347 option is not specified, the default journal parameters will be used to
348 create an appropriately sized journal (given the size of the filesystem)
349 stored within the filesystem.  Note that you must be using a kernel
350 which has ext3 support in order to actually make use of the journal.
351 .TP
352 .BI \-J " journal-options"
353 Create the ext3 journal using options specified on the command-line.
354 Journal options are comma
355 separated, and may take an argument using the equals ('=')  sign.
356 The following journal options are supported:
357 .RS 1.2i
358 .TP
359 .BI size= journal-size
360 Create an internal journal (i.e., stored inside the filesystem) of size
361 .I journal-size
362 megabytes.
363 The size of the journal must be at least 1024 filesystem blocks
364 (i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.)
365 and may be no more than 10,240,000 filesystem blocks or half the total
366 file system size (whichever is smaller)
367 @JDEV@.TP
368 @JDEV@.BI device= external-journal
369 @JDEV@Attach the filesystem to the journal block device located on
370 @JDEV@.IR external-journal .
371 @JDEV@The external
372 @JDEV@journal must already have been created using the command
373 @JDEV@.IP
374 @JDEV@.B mke2fs -O journal_dev
375 @JDEV@.I external-journal
376 @JDEV@.IP
377 @JDEV@Note that
378 @JDEV@.I external-journal
379 @JDEV@must have been created with the
380 @JDEV@same block size as the new filesystem.
381 @JDEV@In addition, while there is support for attaching
382 @JDEV@multiple filesystems to a single external journal,
383 @JDEV@the Linux kernel and
384 @JDEV@.BR e2fsck (8)
385 @JDEV@do not currently support shared external journals yet.
386 @JDEV@.IP
387 @JDEV@Instead of specifying a device name directly,
388 @JDEV@.I external-journal
389 @JDEV@can also be specified by either
390 @JDEV@.BI LABEL= label
391 @JDEV@or
392 @JDEV@.BI UUID= UUID
393 @JDEV@to locate the external journal by either the volume label or UUID
394 @JDEV@stored in the ext2 superblock at the start of the journal.  Use
395 @JDEV@.BR dumpe2fs (8)
396 @JDEV@to display a journal device's volume label and UUID.  See also the
397 @JDEV@.B -L
398 @JDEV@option of
399 @JDEV@.BR tune2fs (8).
400 .RE
401 @JDEV@.IP
402 @JDEV@Only one of the
403 @JDEV@.BR size " or " device
404 @JDEV@options can be given for a filesystem.
405 .TP
406 .BI \-l " filename"
407 Read the bad blocks list from
408 .IR filename .
409 Note that the block numbers in the bad block list must be generated
410 using the same block size as used by
411 .BR mke2fs .
412 As a result, the
413 .B \-c
414 option to
415 .B mke2fs
416 is a much simpler and less error-prone method of checking a disk for bad
417 blocks before formatting it, as
418 .B mke2fs
419 will automatically pass the correct parameters to the
420 .B badblocks
421 program.
422 .TP
423 .BI \-L " new-volume-label"
424 Set the volume label for the filesystem to
425 .IR new-volume-label .
426 The maximum length of the
427 volume label is 16 bytes.
428 .TP
429 .BI \-m " reserved-blocks-percentage"
430 Specify the percentage of the filesystem blocks reserved for
431 the super-user.  This avoids fragmentation, and allows root-owned
432 daemons, such as
433 .BR syslogd (8),
434 to continue to function correctly after non-privileged processes are
435 prevented from writing to the filesystem.  The default percentage
436 is 5%.
437 .TP
438 .BI \-M " last-mounted-directory"
439 Set the last mounted directory for the filesystem.  This might be useful
440 for the sake of utilities that key off of the last mounted directory to
441 determine where the filesystem should be mounted.
442 .TP
443 .B \-n
444 Causes
445 .B mke2fs
446 to not actually create a filesystem, but display what it
447 would do if it were to create a filesystem.  This can be used to
448 determine the location of the backup superblocks for a particular
449 filesystem, so long as the
450 .B mke2fs
451 parameters that were passed when the
452 filesystem was originally created are used again.  (With the
453 .B \-n
454 option added, of course!)
455 .TP
456 .BI \-N " number-of-inodes"
457 Overrides the default calculation of the number of inodes that should be
458 reserved for the filesystem (which is based on the number of blocks and
459 the
460 .I bytes-per-inode
461 ratio).  This allows the user to specify the number
462 of desired inodes directly.
463 .TP
464 .BI \-o " creator-os"
465 Overrides the default value of the "creator operating system" field of the
466 filesystem.  The creator field is set by default to the name of the OS the
467 .B mke2fs
468 executable was compiled for.
469 .TP
470 .B "\-O \fIfeature\fR[,...]"
471 Create a filesystem with the given features (filesystem options),
472 overriding the default filesystem options.  The features that are
473 enabled by default are specified by the
474 .I base_features
475 relation, either in the
476 .I [defaults]
477 section in the
478 .B /etc/mke2fs.conf
479 configuration file,
480 or in the
481 .I [fs_types]
482 subsections for the usage types as specified by the
483 .B \-T
484 option, further modified by the
485 .I features
486 relation found in the
487 .I [fs_types]
488 subsections for the filesystem and usage types.  See the
489 .BR mke2fs.conf (5)
490 manual page for more details.
491 The filesystem type-specific configuration setting found in the
492 .I [fs_types]
493 section will override the global default found in
494 .IR [defaults] .
495 .sp
496 The filesystem feature set will be further edited
497 using either the feature set specified by this option,
498 or if this option is not given, by the
499 .I default_features
500 relation for the filesystem type being created, or in the
501 .I [defaults]
502 section of the configuration file.
503 .sp
504 The filesystem feature set is comprised of a list of features, separated
505 by commas, that are to be enabled.  To disable a feature, simply
506 prefix the feature name with a  caret ('^') character.  The
507 pseudo-filesystem feature "none" will clear all filesystem features.
508 .RS 1.2i
509 .TP
510 .B dir_index
511 Use hashed b-trees to speed up lookups in large directories.
512 .TP
513 .B extent
514 Instead of using the indirect block scheme for storing the location of
515 data blocks in an inode, use extents instead.  This is a much more
516 efficient encoding which speeds up filesystem access, especially for
517 large files.
518 .TP
519 .B filetype
520 Store file type information in directory entries.
521 .TP
522 .B flex_bg
523 Allow the per-block group metadata (allocation bitmaps and inode tables)
524 to be placed anywhere on the storage media.  In addition,
525 .B mke2fs
526 will place the per-block group metadata together starting at the first
527 block group of each "flex_bg group".   The size of the flex_bg group
528 can be specified using the 
529 .B \-G
530 option.
531 .TP
532 .B has_journal
533 Create an ext3 journal (as if using the
534 .B \-j
535 option).
536 @JDEV@.TP
537 @JDEV@.B journal_dev
538 @JDEV@Create an external ext3 journal on the given device
539 @JDEV@instead of a regular ext2 filesystem.
540 @JDEV@Note that
541 @JDEV@.I external-journal
542 @JDEV@must be created with the same
543 @JDEV@block size as the filesystems that will be using it.
544 .TP
545 .B large_file
546 Filesystem can contain files that are greater than 2GB.  (Modern kernels
547 set this feature automatically when a file > 2GB is created.)
548 .TP
549 .B quota
550 Create quota inodes (inode# 3 for userquota and inode# 4 for group quota) and
551 set them in the superblock.  With this feature, the quotas will be enabled
552 automatically when the filesystem is mounted.
553 .TP
554 .B resize_inode
555 Reserve space so the block group descriptor table may grow in the future.
556 Useful for online resizing using
557 .BR resize2fs .
558 By default
559 .B mke2fs
560 will attempt to reserve enough space so that the
561 filesystem may grow to 1024 times its initial size.  This can be changed
562 using the
563 .B resize
564 extended option.
565 .TP
566 .B sparse_super
567 Create a filesystem with fewer superblock backup copies
568 (saves space on large filesystems).
569 .TP
570 .B uninit_bg
571 Create a filesystem without initializing all of the block groups.  This
572 feature also enables checksums and highest-inode-used statistics in each
573 blockgroup.  This feature can
574 speed up filesystem creation time noticeably (if lazy_itable_init is
575 enabled), and can also reduce
576 .BR e2fsck
577 time dramatically.  It is only supported by the ext4 filesystem in
578 recent Linux kernels.
579 .RE
580 .TP
581 .B \-q
582 Quiet execution.  Useful if
583 .B mke2fs
584 is run in a script.
585 .TP
586 .BI \-r " revision"
587 Set the filesystem revision for the new filesystem.  Note that 1.2
588 kernels only support revision 0 filesystems.  The default is to
589 create revision 1 filesystems.
590 .TP
591 .B \-S
592 Write superblock and group descriptors only.  This is useful if all of
593 the superblock and backup superblocks are corrupted, and a last-ditch
594 recovery method is desired.  It causes
595 .B mke2fs
596 to reinitialize the
597 superblock and group descriptors, while not touching the inode table
598 and the block and inode bitmaps.  The
599 .B e2fsck
600 program should be run immediately after this option is used, and there
601 is no guarantee that any data will be salvageable.  It is critical to
602 specify the correct filesystem blocksize when using this option,
603 or there is no chance of recovery.
604 .\" .TP
605 .\" .BI \-t " test"
606 .\" Check the device for bad blocks before creating the file system
607 .\" using the specified test.
608 .TP
609 .BI \-t " fs-type"
610 Specify the filesystem type (i.e., ext2, ext3, ext4, etc.) that is to be created.
611 If this option is not specified,
612 .B mke2fs
613 will pick a default either via how
614 the command was run (for example, using a name of the form mkfs.ext2,
615 mkfs.ext3, etc.) or via a default as defined by the
616 .BR /etc/mke2fs.conf (5)
617 file.   This option controls which filesystem options are used by
618 default, based on the
619 .B fstypes
620 configuration stanza in
621 .BR /etc/mke2fs.conf (5).
622 .sp
623 If the
624 .B \-O
625 option is used to explicitly add or remove filesystem options that
626 should be set in the newly created filesystem, the
627 resulting filesystem may not be supported by the requested
628 .IR fs-type .
629 (e.g., "\fBmke2fs \-t ext3 \-O extent /dev/sdXX\fR" will create a
630 filesystem that is not supported by the ext3 implementation as found in
631 the Linux kernel; and "\fBmke2fs \-t ext3 \-O ^has_journal /dev/hdXX\fR"
632 will create a filesystem that does not have a journal and hence will not
633 be supported by the ext3 filesystem code in the Linux kernel.)
634 .TP
635 .BI \-T " usage-type[,...]"
636 Specify how the filesystem is going to be used, so that
637 .B mke2fs
638 can choose optimal filesystem parameters for that use.  The usage
639 types that are supported are defined in the configuration file
640 .BR /etc/mke2fs.conf (5).
641 The user may specify one or more usage types
642 using a comma separated list.
643 .sp
644 If this option is is not specified,
645 .B mke2fs
646 will pick a single default usage type based on the size of the filesystem to
647 be created.  If the filesystem size is less than or equal to 3 megabytes,
648 .B mke2fs
649 will use the filesystem type
650 .IR floppy .
651 If the filesystem size is greater than 3 but less than or equal to
652 512 megabytes,
653 .BR mke2fs (8)
654 will use the filesystem type
655 .IR small .
656 If the filesystem size is greater than or equal to 4 terabytes but less than
657 16 terabytes,
658 .BR mke2fs (8)
659 will use the filesystem type
660 .IR big .
661 If the filesystem size is greater than or equal to 16 terabytes,
662 .BR mke2fs (8)
663 will use the filesystem type
664 .IR huge .
665 Otherwise,
666 .BR mke2fs (8)
667 will use the default filesystem type
668 .IR default .
669 .TP
670 .BI \-U " UUID"
671 Create the filesystem with the specified UUID.
672 .TP
673 .B \-v
674 Verbose execution.
675 .TP
676 .B \-V
677 Print the version number of
678 .B mke2fs
679 and exit.
680 .SH ENVIRONMENT
681 .TP
682 .BI MKE2FS_SYNC
683 If set to non-zero integer value, its value is used to determine how often
684 .BR sync (2)
685 is called during inode table initialization.
686 .TP
687 .BI MKE2FS_CONFIG
688 Determines the location of the configuration file (see
689 .BR mke2fs.conf (5)).
690 .TP
691 .BI MKE2FS_FIRST_META_BG
692 If set to non-zero integer value, its value is used to determine first meta
693 block group. This is mostly for debugging purposes.
694 .TP
695 .BI MKE2FS_DEVICE_SECTSIZE
696 If set to non-zero integer value, its value is used to determine physical
697 sector size of the
698 .IR device .
699 .TP
700 .BI MKE2FS_SKIP_CHECK_MSG
701 If set, do not show the message of filesystem automatic check caused by
702 mount count or check interval.
703 .SH AUTHOR
704 This version of
705 .B mke2fs
706 has been written by Theodore Ts'o <tytso@mit.edu>.
707 .SH BUGS
708 .B mke2fs
709 accepts the
710 .B \-f
711 option but currently ignores it because the second
712 extended file system does not support fragments yet.
713 .br
714 There may be other ones.  Please, report them to the author.
715 .SH AVAILABILITY
716 .B mke2fs
717 is part of the e2fsprogs package and is available from
718 http://e2fsprogs.sourceforge.net.
719 .SH SEE ALSO
720 .BR mke2fs.conf (5),
721 .BR badblocks (8),
722 .BR dumpe2fs (8),
723 .BR e2fsck (8),
724 .BR tune2fs (8)