Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 1 | .\" -*- nroff -*- |
| 2 | .\" Copyright 2006 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.conf 5 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" |
| 6 | .SH NAME |
| 7 | mke2fs.conf \- Configuration file for mke2fs |
| 8 | .SH DESCRIPTION |
| 9 | .I mke2fs.conf |
| 10 | is the configuration file for |
| 11 | .BR mke2fs (8). |
| 12 | It controls the default parameters used by |
| 13 | .BR mke2fs (8) |
| 14 | when it is creating ext2 or ext3 filesystems. |
| 15 | .PP |
| 16 | The |
| 17 | .I mke2fs.conf |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 18 | file uses an INI-style format. Stanzas, or top-level sections, are |
| 19 | delimited by square braces: [ ]. Within each section, each line |
| 20 | defines a relation, which assigns tags to values, or to a subsection, |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 21 | which contains further relations or subsections. |
| 22 | .\" Tags can be assigned multiple values |
| 23 | An example of the INI-style format used by this configuration file |
| 24 | follows below: |
| 25 | .P |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 26 | [section1] |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 27 | .br |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 28 | tag1 = value_a |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 29 | .br |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 30 | tag1 = value_b |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 31 | .br |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 32 | tag2 = value_c |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 33 | .P |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 34 | [section 2] |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 35 | .br |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 36 | tag3 = { |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 37 | .br |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 38 | subtag1 = subtag_value_a |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 39 | .br |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 40 | subtag1 = subtag_value_b |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 41 | .br |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 42 | subtag2 = subtag_value_c |
| 43 | .br |
| 44 | } |
| 45 | .br |
| 46 | tag1 = value_d |
| 47 | .br |
| 48 | tag2 = value_e |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 49 | .br |
| 50 | } |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 51 | .P |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 52 | Comments are delimited by a semicolon (';') or a hash ('#') character |
| 53 | at the beginning of the comment, and are terminated by the end of |
| 54 | line character. |
| 55 | .P |
| 56 | Tags and values must be quoted using double quotes if they contain |
| 57 | spaces. Within a quoted string, the standard backslash interpretations |
| 58 | apply: "\en" (for the newline character), |
| 59 | "\et" (for the tab character), "\eb" (for the backspace character), |
| 60 | and "\e\e" (for the backslash character). |
| 61 | .P |
Theodore Ts'o | 9447f38 | 2006-05-22 17:59:37 -0400 | [diff] [blame] | 62 | The following stanzas are used in the |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 63 | .I mke2fs.conf |
| 64 | file. They will be described in more detail in future sections of this |
| 65 | document. |
| 66 | .TP |
| 67 | .I [defaults] |
| 68 | Contains relations which define the default parameters |
| 69 | used by |
| 70 | .BR mke2fs (8). |
| 71 | In general, these defaults may be overridden by a definition in the |
| 72 | .B fs_types |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 73 | stanza, or by an command-line option provided by the user. |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 74 | .TP |
| 75 | .I [fs_types] |
| 76 | Contains relations which define defaults that should be used for specific |
| 77 | filesystem types. The filesystem type can be specified explicitly using |
| 78 | the |
| 79 | .B -T |
| 80 | option to |
| 81 | .BR mke2fs (8). |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 82 | .SH THE [defaults] STANZA |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 83 | The following relations are defined in the |
| 84 | .I [defaults] |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 85 | stanza. |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 86 | .TP |
| 87 | .I base_features |
| 88 | This relation specifies the filesystems features which are enabled in |
Theodore Ts'o | 9447f38 | 2006-05-22 17:59:37 -0400 | [diff] [blame] | 89 | newly created filesystems. It may be overridden by the |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 90 | .I base_features |
Theodore Ts'o | 3d43836 | 2008-02-19 08:32:58 -0500 | [diff] [blame] | 91 | relation found in the filesystem or usage type subsection of |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 92 | the |
| 93 | .I [fs_types] |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 94 | stanza. |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 95 | .TP |
| 96 | .I default_features |
| 97 | This relation specifies a set of features that should be added or |
| 98 | removed to the features listed in the |
| 99 | .I base_features |
Theodore Ts'o | 9447f38 | 2006-05-22 17:59:37 -0400 | [diff] [blame] | 100 | relation. It may be overridden by the filesystem-specific |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 101 | .I default_features |
Theodore Ts'o | 3d43836 | 2008-02-19 08:32:58 -0500 | [diff] [blame] | 102 | in the filesystem or usage type subsection of |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 103 | .IR [fs_types] , |
| 104 | and by the |
| 105 | .B -O |
| 106 | command-line option |
| 107 | to |
| 108 | .BR mke2fs (8). |
| 109 | .TP |
Theodore Ts'o | 3d43836 | 2008-02-19 08:32:58 -0500 | [diff] [blame] | 110 | .I fs_type |
| 111 | This relation specifies the default filesystem type if the user does not |
| 112 | specify it via the |
| 113 | .B \-t |
| 114 | option, or if |
| 115 | .B mke2fs |
| 116 | is not started using a program name of the form |
| 117 | .BI mkfs. fs-type\fR. |
| 118 | If both the user and the |
| 119 | .B mke2fs.conf |
| 120 | file does not specify a default filesystem type, mke2fs will use a |
| 121 | default filesystem type of |
| 122 | .IR ext3 |
| 123 | if a journal was requested via a command-line option, or |
| 124 | .I ext2 |
| 125 | if not. |
| 126 | .TP |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 127 | .I blocksize |
| 128 | This relation specifies the default blocksize if the user does not |
| 129 | specify a blocksize on the command line, and the filesystem-type |
| 130 | specific section of the configuration file does not specify a blocksize. |
| 131 | .TP |
| 132 | .I inode_ratio |
| 133 | This relation specifies the default inode ratio if the user does not |
| 134 | specify one on the command line, and the filesystem-type |
| 135 | specific section of the configuration file does not specify a default |
| 136 | inode ratio. |
Andreas Dilger | 067911a | 2006-07-15 22:08:20 -0400 | [diff] [blame] | 137 | .TP |
| 138 | .I inode_size |
| 139 | This relation specifies the default inode size if the user does not |
| 140 | specify one on the command line, and the filesystem-type |
| 141 | specific section of the configuration file does not specify a default |
| 142 | inode size. |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 143 | .SH THE [fs_types] STANZA |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 144 | Each tag in the |
| 145 | .I [fs_types] |
Theodore Ts'o | 3d43836 | 2008-02-19 08:32:58 -0500 | [diff] [blame] | 146 | stanza names a filesystem type or usage type which can be specified via the |
| 147 | .B \-t |
| 148 | or |
| 149 | .B \-T |
| 150 | options to |
| 151 | .BR mke2fs (8), |
| 152 | respectively. |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 153 | .P |
Theodore Ts'o | 3d43836 | 2008-02-19 08:32:58 -0500 | [diff] [blame] | 154 | The |
| 155 | .B mke2fs |
| 156 | program constructs a list of fs_types by concatenating the filesystem |
| 157 | type (i.e., ext2, ext3, etc.) with the usage type list. For most |
| 158 | configuration options, |
| 159 | .B mke2fs |
| 160 | will look for a subsection in the |
| 161 | .I [fs_types] |
| 162 | stanza corresponding with each entry in the constructed list, with later |
| 163 | entries overriding earlier filesystem or usage types. |
| 164 | For |
| 165 | example, consider the following |
| 166 | .B mke2fs.conf |
| 167 | fragment: |
| 168 | .P |
| 169 | [defaults] |
| 170 | .br |
| 171 | base_features = sparse_super,filetype,resize_inode,dir_index |
| 172 | .br |
| 173 | blocksize = 4096 |
| 174 | .br |
| 175 | inode_size = 256 |
| 176 | .br |
| 177 | inode_ratio = 16384 |
| 178 | .br |
| 179 | |
| 180 | .br |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 181 | [fs_types] |
| 182 | .br |
Theodore Ts'o | 3d43836 | 2008-02-19 08:32:58 -0500 | [diff] [blame] | 183 | ext3 = { |
| 184 | .br |
| 185 | features = has_journal |
| 186 | .br |
| 187 | } |
| 188 | .br |
| 189 | ext4 = { |
| 190 | .br |
| 191 | features = extents,flex_bg |
| 192 | .br |
| 193 | inode_size = 256 |
| 194 | .br |
| 195 | } |
| 196 | .br |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 197 | small = { |
| 198 | .br |
| 199 | blocksize = 1024 |
| 200 | .br |
| 201 | inode_ratio = 4096 |
| 202 | .br |
| 203 | } |
| 204 | .br |
| 205 | floppy = { |
| 206 | .br |
Theodore Ts'o | 3d43836 | 2008-02-19 08:32:58 -0500 | [diff] [blame] | 207 | features = ^resize_inode |
| 208 | .br |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 209 | blocksize = 1024 |
| 210 | .br |
Theodore Ts'o | 3d43836 | 2008-02-19 08:32:58 -0500 | [diff] [blame] | 211 | inode_size = 128 |
| 212 | .br |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 213 | } |
| 214 | .P |
Theodore Ts'o | 3d43836 | 2008-02-19 08:32:58 -0500 | [diff] [blame] | 215 | If mke2fs started with a program name of |
| 216 | .BR mke2fs.ext4 , |
| 217 | then the filesystem type of ext4 will be used. If the filesystem is |
| 218 | smaller than 3 megabytes, and no usage type is specified, then |
| 219 | .B mke2fs |
| 220 | will use a default |
| 221 | usage type of |
| 222 | .IR floppy . |
| 223 | This results in an fs_types list of "ext4, floppy". Both the ext4 |
| 224 | subsection and the floppy subsection define an |
| 225 | .I inode_size |
| 226 | relation, but since the later entries in the fs_types list supercede |
| 227 | earlier ones, the configuration parameter for fs_types.floppy.inode_size |
| 228 | will be used, so the filesystem will have an inode size of 128. |
| 229 | .P |
| 230 | The exception to this resolution is the |
| 231 | .I features |
| 232 | tag, which is specifies a set of changes to the features used by the |
| 233 | filesystem, and which is cumulative. So in the above example, first |
| 234 | the configuration relation defaults.base_features would enable an |
| 235 | initial feature set with the sparse_super, filetype, resize_inode, and |
| 236 | dir_index features enabled. Then configuration relation |
| 237 | fs_types.ext4.features would enable the extents and flex_bg |
| 238 | features, and finally the configuration relation |
| 239 | fs_types.floppy.features would remove |
| 240 | the resize_inode feature, resulting in a filesystem feature set |
| 241 | consisting of the sparse_super, filetype, resize_inode, dir_index, |
| 242 | extents_and flex_bg features. |
| 243 | .P |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 244 | For each filesystem type, the following tags may be used in that |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 245 | fs_type's subsection: |
| 246 | .TP |
| 247 | .I base_features |
Theodore Ts'o | 3d43836 | 2008-02-19 08:32:58 -0500 | [diff] [blame] | 248 | This relation specifies the features which are initially enabled for this |
| 249 | filesystem type. Only one |
| 250 | .I base_features |
| 251 | will be used, so if there are multiple entries in the fs_types list |
| 252 | whose subsections define the |
| 253 | .I base_features |
| 254 | relation, only the last will be used by |
| 255 | .BR mke2fs (8). |
| 256 | .TP |
| 257 | .I features |
| 258 | This relation specifies a comma-separated list of features edit |
| 259 | requests which modify the feature set |
| 260 | used by the newly constructed filesystem. The syntax is the same as the |
| 261 | .B -O |
| 262 | command-line option to |
| 263 | .BR mke2fs (8); |
| 264 | that is, a feature can be prefixed by a caret ('^') symbol to disable |
| 265 | a named feature. Each |
| 266 | .I feature |
| 267 | relation specified in the fs_types list will be applied in the order |
| 268 | found in the fs_types list. |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 269 | .TP |
| 270 | .I default_features |
| 271 | This relation specifies set of features which should be enabled or |
Theodore Ts'o | 3d43836 | 2008-02-19 08:32:58 -0500 | [diff] [blame] | 272 | disabled after applying the features listed in the |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 273 | .I base_features |
Theodore Ts'o | 3d43836 | 2008-02-19 08:32:58 -0500 | [diff] [blame] | 274 | and |
| 275 | .I features |
| 276 | relations. It may be overridden by the |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 277 | .B -O |
| 278 | command-line option to |
| 279 | .BR mke2fs (8). |
| 280 | .TP |
| 281 | .I blocksize |
| 282 | This relation specifies the default blocksize if the user does not |
| 283 | specify a blocksize on the command line. |
| 284 | .TP |
Theodore Ts'o | a4396e9 | 2008-04-18 10:19:27 -0400 | [diff] [blame^] | 285 | .I lazy_itable_init |
| 286 | This relation is a boolean which specifies whether the inode table should |
| 287 | be lazily initialized. It only has meaning if the uninit_bg feature is |
| 288 | enabled. If lazy_itable_init is true and the uninit_bg feature is |
| 289 | enabled, the inode table will |
| 290 | not fully initialized by |
| 291 | .BR mke2fs (8). |
| 292 | This speeds up filesystem |
| 293 | initialization noitceably, but it requires the kernel to finish |
| 294 | initializing the filesystem in the background when the filesystem is |
| 295 | first mounted. |
| 296 | .TP |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 297 | .I inode_ratio |
| 298 | This relation specifies the default inode ratio if the user does not |
| 299 | specify one on the command line. |
Andreas Dilger | 067911a | 2006-07-15 22:08:20 -0400 | [diff] [blame] | 300 | .TP |
| 301 | .I inode_size |
| 302 | This relation specifies the default inode size if the user does not |
| 303 | specify one on the command line. |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 304 | .SH FILES |
| 305 | .TP |
| 306 | .I /etc/mke2fs.conf |
| 307 | The configuration file for |
| 308 | .BR mke2fs (8). |
| 309 | .SH SEE ALSO |
| 310 | .BR mke2fs (8) |