]>
Commit | Line | Data |
---|---|---|
3839e657 | 1 | .\" -*- nroff -*- |
a418d3ad TT |
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 | .\" | |
74becf3c | 5 | .TH MKE2FS 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" |
3839e657 | 6 | .SH NAME |
a7ac1df3 | 7 | mke2fs \- create an ext2/ext3 filesystem |
3839e657 TT |
8 | .SH SYNOPSIS |
9 | .B mke2fs | |
10 | [ | |
11 | .B \-c | |
12 | | | |
3839e657 | 13 | .B \-l |
1e3472c5 | 14 | .I filename |
3839e657 TT |
15 | ] |
16 | [ | |
17 | .B \-b | |
1e3472c5 | 18 | .I block-size |
3839e657 TT |
19 | ] |
20 | [ | |
21 | .B \-f | |
1e3472c5 | 22 | .I fragment-size |
3839e657 TT |
23 | ] |
24 | [ | |
5e05541a TT |
25 | .B \-g |
26 | .I blocks-per-group | |
27 | ] | |
28 | [ | |
3839e657 | 29 | .B \-i |
1e3472c5 | 30 | .I bytes-per-inode |
3839e657 TT |
31 | ] |
32 | [ | |
85ef4ae8 | 33 | .B \-j |
dc2ec525 TT |
34 | ] |
35 | [ | |
36 | .B \-J | |
8ddaa66b | 37 | .I journal-options |
85ef4ae8 TT |
38 | ] |
39 | [ | |
5515e6b4 TT |
40 | .B \-N |
41 | .I number-of-inodes | |
42 | ] | |
43 | [ | |
2740156b TT |
44 | .B -n |
45 | ] | |
46 | [ | |
3839e657 | 47 | .B \-m |
1e3472c5 TT |
48 | .I reserved-blocks-percentage |
49 | ] | |
50 | [ | |
51 | .B \-o | |
52 | .I creator-os | |
3839e657 TT |
53 | ] |
54 | [ | |
896938d5 TT |
55 | .B \-O |
56 | .IR feature [,...] | |
57 | ] | |
58 | [ | |
f3db3566 TT |
59 | .B \-q |
60 | ] | |
61 | [ | |
caf8ce4c TT |
62 | .B \-r |
63 | .I fs-revision-level | |
a29f4d30 TT |
64 | ] |
65 | [ | |
c6a44136 TT |
66 | .B \-E |
67 | .I extended-options | |
521e3685 TT |
68 | ] |
69 | [ | |
3839e657 TT |
70 | .B \-v |
71 | ] | |
f3db3566 | 72 | [ |
74becf3c TT |
73 | .B \-F |
74 | ] | |
75 | [ | |
1e3472c5 TT |
76 | .B \-L |
77 | .I volume-label | |
78 | ] | |
79 | [ | |
80 | .B \-M | |
81 | .I last-mounted-directory | |
82 | ] | |
83 | [ | |
f3db3566 TT |
84 | .B \-S |
85 | ] | |
818180cd | 86 | [ |
50787ea2 TT |
87 | .B \-T |
88 | .I filesystem-type | |
89 | ] | |
90 | [ | |
818180cd TT |
91 | .B \-V |
92 | ] | |
1e3472c5 | 93 | .I device |
3839e657 | 94 | [ |
1e3472c5 | 95 | .I blocks-count |
3839e657 | 96 | ] |
48015ced | 97 | @JDEV@.sp |
8d641749 | 98 | @JDEV@.B "mke2fs \-O journal_dev" |
48015ced TT |
99 | @JDEV@[ |
100 | @JDEV@.B \-b | |
101 | @JDEV@.I block-size | |
102 | @JDEV@] | |
8d641749 | 103 | .\" No external-journal specific journal options yet (size is ignored) |
48015ced TT |
104 | .\" @JDEV@[ |
105 | .\" @JDEV@.B \-J | |
106 | .\" @JDEV@.I journal-options | |
107 | .\" @JDEV@] | |
108 | @JDEV@[ | |
109 | @JDEV@.B \-L | |
110 | @JDEV@.I volume-label | |
111 | @JDEV@] | |
112 | @JDEV@[ | |
113 | @JDEV@.B \-n | |
114 | @JDEV@] | |
115 | @JDEV@[ | |
116 | @JDEV@.B \-q | |
117 | @JDEV@] | |
118 | @JDEV@[ | |
119 | @JDEV@.B \-v | |
120 | @JDEV@] | |
8d641749 | 121 | @JDEV@.I external-journal |
2d15576d AD |
122 | @JDEV@[ |
123 | @JDEV@.I blocks-count | |
124 | @JDEV@] | |
3839e657 TT |
125 | .SH DESCRIPTION |
126 | .B mke2fs | |
f0865ce4 | 127 | is used to create an ext2/ext3 filesystem (usually in a disk partition). |
3839e657 | 128 | .I device |
caf8ce4c TT |
129 | is the special file corresponding to the device (e.g |
130 | .IR /dev/hdXX ). | |
3839e657 TT |
131 | .I blocks-count |
132 | is the number of blocks on the device. If omitted, | |
133 | .B mke2fs | |
0072f8de AD |
134 | automagically figures the file system size. If called as |
135 | .B mkfs.ext3 | |
136 | a journal is created as if the | |
137 | .B \-j | |
138 | option was specified. | |
3839e657 TT |
139 | .SH OPTIONS |
140 | .TP | |
caf8ce4c | 141 | .BI \-b " block-size" |
2740156b | 142 | Specify the size of blocks in bytes. Valid block size vales are 1024, |
06968e7e TT |
143 | 2048 and 4096 bytes per block. If omitted, |
144 | .B mke2fs | |
6750877c | 145 | block-size is heuristically determined by the file system size and |
c5290fae | 146 | the expected usage of the filesystem (see the |
06968e7e | 147 | .B \-T |
c5290fae TT |
148 | option). If |
149 | .I block-size | |
c6a44136 TT |
150 | is negative, then |
151 | .B mke2fs | |
152 | will use heuristics to determine the | |
c5290fae TT |
153 | appropriate block size, with the constraint that the block size will be |
154 | at least | |
155 | .I block-size | |
156 | bytes. This is useful for certain hardware devices which require that | |
157 | the blocksize be a multiple of 2k. | |
3839e657 | 158 | .TP |
caf8ce4c | 159 | .B \-c |
3ed57c27 | 160 | Check the device for bad blocks before creating the file system. If |
3a03c2ca | 161 | this option is specified twice, then a slower, read-write |
3ed57c27 | 162 | test is used instead of a fast read-only test. |
3839e657 | 163 | .TP |
c6a44136 TT |
164 | .BI \-E " extended-options" |
165 | Set extended options for the filesystem. Extended options are comma | |
166 | separated, and may take an argument using the equals ('=') sign. The | |
167 | .B -E | |
168 | option used to be | |
169 | .B -R | |
170 | in earlier versions of | |
171 | .BR mke2fs . | |
172 | The | |
173 | .B -R | |
174 | option is still accepted for backwards compatibility. The | |
175 | following extended options are supported: | |
176 | .RS 1.2i | |
177 | .TP | |
178 | .BI stride= stripe-size | |
179 | Configure the filesystem for a RAID array with | |
180 | .I stripe-size | |
181 | filesystem blocks per stripe. | |
182 | .TP | |
183 | .BI resize= max-online-resize | |
184 | Reserve enough space so that the block group descriptor table can grow | |
185 | to support a filesystem that has max-online-resize blocks. | |
186 | .RE | |
187 | .TP | |
caf8ce4c | 188 | .BI \-f " fragment-size" |
3839e657 TT |
189 | Specify the size of fragments in bytes. |
190 | .TP | |
48015ced TT |
191 | .B \-F |
192 | Force | |
193 | .B mke2fs | |
194 | to run, even if the specified device is not a | |
195 | block special device, or appears to be mounted. | |
196 | .TP | |
5e05541a TT |
197 | .BI \-g " blocks-per-group" |
198 | Specify the number of blocks in a block group. There is generally no | |
199 | reason the user to ever set this parameter, as the default is optimal | |
200 | for the filesystem. (For administrators who are creating | |
201 | filesystems on RAID arrays, it is preferable to use the | |
202 | .I stride | |
203 | RAID parameter as part of the | |
204 | .B \-R | |
205 | option rather than manipulating the number of blocks per group.) | |
206 | This option is generally used by developers who | |
207 | are developing test cases. | |
208 | .TP | |
caf8ce4c | 209 | .BI \-i " bytes-per-inode" |
3839e657 TT |
210 | Specify the bytes/inode ratio. |
211 | .B mke2fs | |
212 | creates an inode for every | |
213 | .I bytes-per-inode | |
48015ced | 214 | bytes of space on the disk. The larger the |
caf8ce4c | 215 | .I bytes-per-inode |
48015ced TT |
216 | ratio, the fewer inodes will be created. This value generally shouldn't |
217 | be smaller than the blocksize of the filesystem, since then too many | |
218 | inodes will be made. Be warned that is not possible to expand the number | |
219 | of inodes on a filesystem after it is created, so be careful deciding the | |
220 | correct value for this parameter. | |
dc2ec525 | 221 | .TP |
48015ced TT |
222 | .B \-j |
223 | Create the filesystem with an ext3 journal. If the | |
dc2ec525 | 224 | .B \-J |
48015ced TT |
225 | option is not specified, the default journal parameters will be used to |
226 | create an appropriately sized journal (given the size of the filesystem) | |
227 | stored within the filesystem. Note that you must be using a kernel | |
228 | which has ext3 support in order to actually make use of the journal. | |
dc2ec525 | 229 | .TP |
48015ced | 230 | .BI \-J " journal-options" |
dc2ec525 | 231 | Create the ext3 journal using options specified on the command-line. |
8ddaa66b TT |
232 | Journal options are comma |
233 | separated, and may take an argument using the equals ('=') sign. | |
48015ced TT |
234 | The following journal options are supported: |
235 | .RS 1.2i | |
dc2ec525 | 236 | .TP |
48015ced | 237 | .BI size= journal-size |
f0865ce4 | 238 | Create an internal journal (i.e., stored inside the filesystem) of size |
8d641749 TT |
239 | .I journal-size |
240 | megabytes. | |
2537b6d0 TT |
241 | The size of the journal must be at least 1024 filesystem blocks |
242 | (i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.) | |
8d641749 | 243 | and may be no more than 102,400 filesystem blocks. |
48015ced TT |
244 | @JDEV@.TP |
245 | @JDEV@.BI device= external-journal | |
8d641749 TT |
246 | @JDEV@Attach the filesystem to the journal block device located on |
247 | @JDEV@.IR external-journal . | |
248 | @JDEV@The external | |
249 | @JDEV@journal must already have been created using the command | |
250 | @JDEV@.IP | |
2d15576d AD |
251 | @JDEV@.B mke2fs -O journal_dev |
252 | @JDEV@.I external-journal | |
8d641749 TT |
253 | @JDEV@.IP |
254 | @JDEV@Note that | |
255 | @JDEV@.I external-journal | |
256 | @JDEV@must have been created with the | |
257 | @JDEV@same block size as the new filesystem. | |
3024d887 TT |
258 | @JDEV@In addition, while there is support for attaching |
259 | @JDEV@multiple filesystems to a single external journal, | |
260 | @JDEV@the Linux kernel and | |
261 | @JDEV@.BR e2fsck (8) | |
262 | @JDEV@do not currently support shared external journals yet. | |
2d15576d AD |
263 | @JDEV@.IP |
264 | @JDEV@Instead of specifying a device name directly, | |
265 | @JDEV@.I external-journal | |
266 | @JDEV@can also be specified by either | |
267 | @JDEV@.BI LABEL= label | |
268 | @JDEV@or | |
269 | @JDEV@.BI UUID= UUID | |
270 | @JDEV@to locate the external journal by either the volume label or UUID | |
271 | @JDEV@stored in the ext2 superblock at the start of the journal. Use | |
272 | @JDEV@.BR dumpe2fs (8) | |
273 | @JDEV@to display a journal device's volume label and UUID. See also the | |
274 | @JDEV@.B -L | |
275 | @JDEV@option of | |
276 | @JDEV@.BR tune2fs (8). | |
8d641749 TT |
277 | .RE |
278 | @JDEV@.IP | |
48015ced TT |
279 | @JDEV@Only one of the |
280 | @JDEV@.BR size " or " device | |
281 | @JDEV@options can be given for a filesystem. | |
48015ced TT |
282 | .TP |
283 | .BI \-l " filename" | |
284 | Read the bad blocks list from | |
3ed57c27 TT |
285 | .IR filename . |
286 | Note that the block numbers in the bad block list must be generated | |
287 | using the same block size as used by mke2fs. As a result, the | |
288 | .B \-c | |
289 | option to | |
290 | .B mke2fs | |
291 | is a much simpler and less error-prone method of checking a disk for bad | |
292 | blocks before formatting it, as | |
293 | .B mke2fs | |
294 | will automatically pass the correct parameters to the | |
295 | .B badblocks | |
296 | program. | |
48015ced | 297 | .TP |
6a7075df TT |
298 | .BI \-L " new-volume-label" |
299 | Set the volume label for the filesystem to | |
300 | .IR new-volume-label . | |
301 | The maximum length of the | |
302 | volume label is 16 bytes. | |
48015ced TT |
303 | .TP |
304 | .BI \-m " reserved-blocks-percentage" | |
305 | Specify the percentage of the filesystem blocks reserved for | |
029de632 TT |
306 | the super-user. This avoids fragmentation, and allows root-owned |
307 | daemons, such as | |
308 | .BR syslogd (8), | |
309 | to continue to function correctly after non-privileged processes are | |
310 | prevented from writing to the filesystem. The default percentage | |
311 | is 5%. | |
dc2ec525 | 312 | .TP |
48015ced TT |
313 | .B \-M |
314 | Set the last mounted directory for the filesystem. This might be useful | |
315 | for the sake of utilities that key off of the last mounted directory to | |
bcf5aea2 | 316 | determine where the filesystem should be mounted. |
85ef4ae8 | 317 | .TP |
caf8ce4c | 318 | .B \-n |
1f22ce34 TT |
319 | causes mke2fs to not actually create a filesystem, but display what it |
320 | would do if it were to create a filesystem. This can be used to | |
321 | determine the location of the backup superblocks for a particular | |
322 | filesystem, so long as the mke2fs parameters that were passed when the | |
323 | filesystem was originally created are used again. (With the | |
324 | .B \-n | |
325 | option added, of course!) | |
2740156b | 326 | .TP |
caf8ce4c | 327 | .BI \-N " number-of-inodes" |
5515e6b4 TT |
328 | overrides the default calculation of the number of inodes that should be |
329 | reserved for the filesystem (which is based on the number of blocks and | |
caf8ce4c TT |
330 | the |
331 | .I bytes-per-inode | |
332 | ratio). This allows the user to specify the number | |
5515e6b4 TT |
333 | of desired inodes directly. |
334 | .TP | |
48015ced | 335 | .BI \-o " creator-os" |
1e3472c5 TT |
336 | Manually override the default value of the "creator os" field of the |
337 | filesystem. Normally the creator field is set by default to the native OS | |
583ccdc3 TT |
338 | of the |
339 | .B mke2fs | |
340 | executable. | |
1e3472c5 | 341 | .TP |
8d641749 | 342 | .B "\-O \fIfeature\fR[,...]" |
e02bb6d6 | 343 | Create filesystem with given features (filesystem options), overriding |
9dc6ad1e TT |
344 | the default filesystem options. The default features which are |
345 | enabled by default are specified by the | |
346 | .I base_features | |
347 | relation, either in the | |
348 | .I [libdefaults] | |
349 | section in the | |
350 | .B /etc/mke2fs.conf | |
351 | configuration file, or in the subsection of the | |
352 | .I [fs_types] | |
353 | section for the filesystem type as specified by the | |
354 | .B -T | |
355 | option. The filesystem type-specific configuration setting found in | |
356 | the | |
357 | .I [fs_types] | |
358 | section will override the global default found in | |
359 | .IR [libdefaults] . | |
48015ced | 360 | .sp |
9dc6ad1e TT |
361 | The filesystem feature set will be further edited |
362 | using either the feature set specification specified by this option, | |
363 | or if this option is not specified, by the | |
364 | .I default_features | |
365 | relation for the filesystem type being created, or in the | |
366 | .I [libdefaults] | |
367 | section of the configuration file. | |
368 | .sp | |
369 | The filesystem feature set is comprised of a list of features, separated | |
370 | by commas, that are to be enabled. To disable a feature, simply | |
371 | prefix the feature name with a caret ('^') character. The | |
372 | pseudo-filesystem feature "none" will clear all filesystem features. | |
48015ced | 373 | .RS 1.2i |
7f88b043 | 374 | .TP |
ccbed85a TT |
375 | .B dir_index |
376 | Use hashed b-trees to speed up lookups in large directories. | |
f3db3566 | 377 | .TP |
48015ced TT |
378 | .B filetype |
379 | Store file type information in directory entries. | |
1e3472c5 | 380 | .TP |
48015ced TT |
381 | .B has_journal |
382 | Create an ext3 journal (as if using the | |
383 | .B \-j | |
384 | option). | |
385 | @JDEV@.TP | |
8d641749 | 386 | @JDEV@.B journal_dev |
48015ced | 387 | @JDEV@Create an external ext3 journal on the given device |
8d641749 TT |
388 | @JDEV@instead of a regular ext2 filesystem. |
389 | @JDEV@Note that | |
390 | @JDEV@.I external-journal | |
391 | @JDEV@must be created with the same | |
392 | @JDEV@block size as the filesystems that will be using it. | |
ccbed85a | 393 | .TP |
59571a51 TT |
394 | .B resize_inode |
395 | Reserve space so the block group descriptor table may grow in the future. | |
396 | Useful for online resizing using | |
397 | .BR resize2fs . | |
398 | By default | |
399 | .B mke2fs | |
400 | will attempt to reserve enough space so that the | |
401 | filesystem may grow to 1024 times its initial size. This can be changed | |
402 | using | |
403 | .B resize | |
404 | extended option. | |
405 | .TP | |
ccbed85a TT |
406 | .B sparse_super |
407 | Create a filesystem with fewer superblock backup copies | |
408 | (saves space on large filesystems). | |
48015ced | 409 | .RE |
1e3472c5 | 410 | .TP |
8d641749 TT |
411 | .B \-q |
412 | Quiet execution. Useful if | |
413 | .B mke2fs | |
414 | is run in a script. | |
415 | .TP | |
48015ced | 416 | .BI \-r " revision" |
a29f4d30 | 417 | Set the filesystem revision for the new filesystem. Note that 1.2 |
48015ced TT |
418 | kernels only support revision 0 filesystems. The default is to |
419 | create revision 1 filesystems. | |
a29f4d30 | 420 | .TP |
caf8ce4c | 421 | .B \-S |
f3db3566 TT |
422 | Write superblock and group descriptors only. This is useful if all of |
423 | the superblock and backup superblocks are corrupted, and a last-ditch | |
583ccdc3 TT |
424 | recovery method is desired. It causes |
425 | .B mke2fs | |
426 | to reinitialize the | |
f3db3566 TT |
427 | superblock and group descriptors, while not touching the inode table |
428 | and the block and inode bitmaps. The | |
429 | .B e2fsck | |
430 | program should be run immediately after this option is used, and there | |
48015ced TT |
431 | is no guarantee that any data will be salvageable. It is critical to |
432 | specify the correct filesystem blocksize when using this option, | |
433 | or there is no chance of recovery. | |
8d641749 TT |
434 | .\" .TP |
435 | .\" .BI \-t " test" | |
436 | .\" Check the device for bad blocks before creating the file system | |
437 | .\" using the specified test. | |
818180cd | 438 | .TP |
caf8ce4c | 439 | .BI \-T " fs-type" |
fb733f8e TT |
440 | Specify how the filesystem is going to be used, so that |
441 | .B mke2fs | |
364f9410 TT |
442 | can choose optimal filesystem parameters for that use. The filesystem |
443 | types that are can be supported are defined in the configuration file | |
444 | .BR /etc/mke2fs.conf (5). | |
445 | The default configuration file contains definitions for the filesystem | |
446 | types: small, floppy, news, largefile, and largefile4. | |
48015ced TT |
447 | .TP |
448 | .B \-v | |
449 | Verbose execution. | |
50787ea2 | 450 | .TP |
caf8ce4c | 451 | .B \-V |
50787ea2 | 452 | Print the version number of |
818180cd TT |
453 | .B mke2fs |
454 | and exit. | |
3839e657 TT |
455 | .SH AUTHOR |
456 | This version of | |
457 | .B mke2fs | |
a418d3ad | 458 | has been written by Theodore Ts'o <tytso@mit.edu>. |
3839e657 TT |
459 | .SH BUGS |
460 | .B mke2fs | |
caf8ce4c TT |
461 | accepts the |
462 | .B \-f | |
463 | option but currently ignores it because the second | |
3839e657 TT |
464 | extended file system does not support fragments yet. |
465 | .br | |
48015ced | 466 | There may be other ones. Please, report them to the author. |
3839e657 TT |
467 | .SH AVAILABILITY |
468 | .B mke2fs | |
12da49c9 | 469 | is part of the e2fsprogs package and is available from |
348e43dc | 470 | http://e2fsprogs.sourceforge.net. |
3839e657 | 471 | .SH SEE ALSO |
9dc6ad1e | 472 | .BR mke2fs.conf (5), |
e72a9ba3 | 473 | .BR badblocks (8), |
3839e657 TT |
474 | .BR dumpe2fs (8), |
475 | .BR e2fsck (8), | |
476 | .BR tune2fs (8) |