misc/mke2fs.conf.5.in

   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
  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,
  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
  26         [section1]
  27 .br
  28                 tag1 = value_a
  29 .br
  30                 tag1 = value_b
  31 .br
  32                 tag2 = value_c
  33 .P
  34         [section 2]
  35 .br
  36                 tag3 = {
  37 .br
  38                         subtag1 = subtag_value_a
  39 .br
  40                         subtag1 = subtag_value_b
  41 .br
  42                         subtag2 = subtag_value_c
  43 .br
  44                 }
  45 .br
  46                 tag1 = value_d
  47 .br
  48                 tag2 = value_e
  49 .br
  50         }
  51 .P
  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
  62 The following stanzas are used in the
  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
  73 stanza, or by an command-line option provided by the user.
  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).
  82 .SH THE [defaults] STANZA
  83 The following relations are defined in the
  84 .I [defaults]
  85 stanza.
  86 .TP
  87 .I base_features
  88 This relation specifies the filesystems features which are enabled in
  89 newly created filesystems.  It may be overridden by the
  90 .I base_features
  91 relation found in the filesystem or usage type subsection of
  92 the
  93 .I [fs_types]
  94 stanza.
  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
 100 relation.  It may be overridden by the filesystem-specific
 101 .I default_features
 102 in the filesystem or usage type subsection of
 103 .IR [fs_types] ,
 104 and by the
 105 .B -O
 106 command-line option
 107 to
 108 .BR mke2fs (8).
 109 .TP
 110 .I force_undo
 111 This relation, if set to a boolean value of true, forces
 112 .B mke2fs
 113 to always try to create an undo file, even if the undo file might be
 114 huge and it might extend the time to create the filesystem image
 115 because the inode table isn't being initialized lazily.
 116 .TP
 117 .I fs_type
 118 This relation specifies the default filesystem type if the user does not
 119 specify it via the
 120 .B \-t
 121 option, or if
 122 .B mke2fs
 123 is not started using a program name of the form
 124 .BI mkfs. fs-type\fR.
 125 If both the user and the
 126 .B mke2fs.conf
 127 file does not specify a default filesystem type, mke2fs will use a
 128 default filesystem type of
 129 .IR ext3
 130 if a journal was requested via a command-line option, or
 131 .I ext2
 132 if not.
 133 .TP
 134 .I blocksize
 135 This relation specifies the default blocksize if the user does not
 136 specify a blocksize on the command line, and the filesystem-type
 137 specific section of the configuration file does not specify a blocksize.
 138 .TP
 139 .I inode_ratio
 140 This relation specifies the default inode ratio if the user does not
 141 specify one on the command line, and the filesystem-type
 142 specific section of the configuration file does not specify a default
 143 inode ratio.
 144 .TP
 145 .I inode_size
 146 This relation specifies the default inode size if the user does not
 147 specify one on the command line, and the filesystem-type
 148 specific section of the configuration file does not specify a default
 149 inode size.
 150 .TP
 151 .I undo_dir
 152 This relation specifies the directory where the undo file should be
 153 stored.  It can be overriden via the
 154 .B E2FSPROGS_UNDO_DIR
 155 environemnt variable.  If the directory location is set to the value
 156 .IR none ,
 157 .B mke2fs
 158 will not create an undo file.
 159 .SH THE [fs_types] STANZA
 160 Each tag in the
 161 .I [fs_types]
 162 stanza names a filesystem type or usage type which can be specified via the
 163 .B \-t
 164 or
 165 .B \-T
 166 options to
 167 .BR mke2fs (8),
 168 respectively.
 169 .P
 170 The
 171 .B mke2fs
 172 program constructs a list of fs_types by concatenating the filesystem
 173 type (i.e., ext2, ext3, etc.) with the usage type list.  For most
 174 configuration options,
 175 .B mke2fs
 176 will look for a subsection in the
 177 .I [fs_types]
 178 stanza corresponding with each entry in the constructed list, with later
 179 entries overriding earlier filesystem or usage types.
 180 For
 181 example, consider the following
 182 .B mke2fs.conf
 183 fragment:
 184 .P
 185 [defaults]
 186 .br
 187         base_features = sparse_super,filetype,resize_inode,dir_index
 188 .br
 189         blocksize = 4096
 190 .br
 191         inode_size = 256
 192 .br
 193         inode_ratio = 16384
 194 .br
 195
 196 .br
 197 [fs_types]
 198 .br
 199         ext3 = {
 200 .br
 201                 features = has_journal
 202 .br
 203         }
 204 .br
 205         ext4 = {
 206 .br
 207                 features = extents,flex_bg
 208 .br
 209                 inode_size = 256
 210 .br
 211         }
 212 .br
 213         small = {
 214 .br
 215                 blocksize = 1024
 216 .br
 217                 inode_ratio = 4096
 218 .br
 219         }
 220 .br
 221         floppy = {
 222 .br
 223                 features = ^resize_inode
 224 .br
 225                 blocksize = 1024
 226 .br
 227                 inode_size = 128
 228 .br
 229         }
 230 .P
 231 If mke2fs started with a program name of
 232 .BR mke2fs.ext4 ,
 233 then the filesystem type of ext4 will be used.  If the filesystem is
 234 smaller than 3 megabytes, and no usage type is specified, then
 235 .B mke2fs
 236 will use a default
 237 usage type of
 238 .IR floppy .
 239 This results in an fs_types list of "ext4, floppy".   Both the ext4
 240 subsection and the floppy subsection define an
 241 .I inode_size
 242 relation, but since the later entries in the fs_types list supercede
 243 earlier ones, the configuration parameter for fs_types.floppy.inode_size
 244 will be used, so the filesystem  will have an inode size of 128.
 245 .P
 246 The exception to this resolution is the
 247 .I features
 248 tag, which is specifies a set of changes to the features used by the
 249 filesystem, and which is cumulative.  So in the above example, first
 250 the configuration relation defaults.base_features would enable an
 251 initial feature set with the sparse_super, filetype, resize_inode, and
 252 dir_index features enabled.  Then configuration relation
 253 fs_types.ext4.features would enable the extents and flex_bg
 254 features, and finally the configuration relation
 255 fs_types.floppy.features would remove
 256 the resize_inode feature, resulting in a filesystem feature set
 257 consisting of the sparse_super, filetype, resize_inode, dir_index,
 258 extents_and flex_bg features.
 259 .P
 260 For each filesystem type, the following tags may be used in that
 261 fs_type's subsection:
 262 .TP
 263 .I base_features
 264 This relation specifies the features which are initially enabled for this
 265 filesystem type.  Only one
 266 .I base_features
 267 will be used, so if there are multiple entries in the fs_types list
 268 whose subsections define the
 269 .I base_features
 270 relation, only the last will be used by
 271 .BR mke2fs (8).
 272 .TP
 273 .I features
 274 This relation specifies a comma-separated list of features edit
 275 requests which modify the feature set
 276 used by the newly constructed filesystem.  The syntax is the same as the
 277 .B -O
 278 command-line option to
 279 .BR mke2fs (8);
 280 that is, a feature can be prefixed by a caret ('^') symbol to disable
 281 a named feature.  Each
 282 .I feature
 283 relation specified in the fs_types list will be applied in the order
 284 found in the fs_types list.
 285 .TP
 286 .I default_features
 287 This relation specifies set of features which should be enabled or
 288 disabled after applying the features listed in the
 289 .I base_features
 290 and
 291 .I features
 292 relations.  It may be overridden by the
 293 .B -O
 294 command-line option to
 295 .BR mke2fs (8).
 296 .TP
 297 .I blocksize
 298 This relation specifies the default blocksize if the user does not
 299 specify a blocksize on the command line.
 300 .TP
 301 .I lazy_itable_init
 302 This relation is a boolean which specifies whether the inode table should
 303 be lazily initialized.  It only has meaning if the uninit_bg feature is
 304 enabled.  If lazy_itable_init is true and the uninit_bg feature is
 305 enabled,  the inode table will
 306 not fully initialized by
 307 .BR mke2fs (8).
 308 This speeds up filesystem
 309 initialization noitceably, but it requires the kernel to finish
 310 initializing the filesystem in the background when the filesystem is
 311 first mounted.
 312 .TP
 313 .I inode_ratio
 314 This relation specifies the default inode ratio if the user does not
 315 specify one on the command line.
 316 .TP
 317 .I inode_size
 318 This relation specifies the default inode size if the user does not
 319 specify one on the command line.
 320 .TP
 321 .I flex_bg_size
 322 This relation specifies the number of block goups that will be packed
 323 together to create one large virtual block group on an ext4 filesystem.
 324 This improves meta-data locality and performance on meta-data heavy
 325 workloads.  The number of goups must be a power of 2 and may only be
 326 specified if the flex_bg filesystem feature is enabled.
 327 .SH FILES
 328 .TP
 329 .I /etc/mke2fs.conf
 330 The configuration file for
 331 .BR mke2fs (8).
 332 .SH SEE ALSO
 333 .BR mke2fs (8)