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