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