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, ext3, or ext4 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 Some relations expect a boolean value.  The parser is quite liberal on
  63 recognizing ``yes'', '`y'', ``true'', ``t'', ``1'', ``on'', etc. as a
  64 boolean true value, and ``no'', ``n'', ``false'', ``nil'', ``0'',
  65 ``off'' as a boolean false value.
  66 .P
  67 The following stanzas are used in the
  68 .I mke2fs.conf
  69 file.  They will be described in more detail in future sections of this
  70 document.
  71 .TP
  72 .I [options]
  73 Contains relations which influence how mke2fs behaves.
  74 .TP
  75 .I [defaults]
  76 Contains relations which define the default parameters
  77 used by
  78 .BR mke2fs (8).
  79 In general, these defaults may be overridden by a definition in the
  80 .B fs_types
  81 stanza, or by an command-line option provided by the user.
  82 .TP
  83 .I [fs_types]
  84 Contains relations which define defaults that should be used for specific
  85 filesystem types.  The filesystem type can be specified explicitly using
  86 the
  87 .B -T
  88 option to
  89 .BR mke2fs (8).
  90 .SH THE [options] STANZA
  91 The following relations are defined in the
  92 .I [options]
  93 stanza.
  94 .TP
  95 .I proceed_delay
  96 If this relation is set to a positive integer, then if mke2fs will
  97 proceed after waiting
  98 .I proceed_delay
  99 seconds, after asking the user for permission to proceed, even if the
 100 user has not answered the question.  Defaults to 0, which means to wait
 101 until the user answers the question one way or another.
 102 .SH THE [defaults] STANZA
 103 The following relations are defined in the
 104 .I [defaults]
 105 stanza.
 106 .TP
 107 .I base_features
 108 This relation specifies the filesystems features which are enabled in
 109 newly created filesystems.  It may be overridden by the
 110 .I base_features
 111 relation found in the filesystem or usage type subsection of
 112 the
 113 .I [fs_types]
 114 stanza.
 115 .TP
 116 .I default_features
 117 This relation specifies a set of features that should be added or
 118 removed to the features listed in the
 119 .I base_features
 120 relation.  It may be overridden by the filesystem-specific
 121 .I default_features
 122 in the filesystem or usage type subsection of
 123 .IR [fs_types] ,
 124 and by the
 125 .B -O
 126 command-line option
 127 to
 128 .BR mke2fs (8).
 129 .TP
 130 .I enable_periodic_fsck
 131 This boolean relation specifies whether periodic filesystem checks should be
 132 enforced at boot time.  If set to true, checks will be forced every
 133 180 days, or after a random number of mounts.  These values may
 134 be changed later via the
 135 .B -i
 136 and
 137 .B -c
 138 command-line options to
 139 .BR tune2fs (8).
 140 .TP
 141 .I force_undo
 142 This boolean relation, if set to a value of true, forces
 143 .B mke2fs
 144 to always try to create an undo file, even if the undo file might be
 145 huge and it might extend the time to create the filesystem image
 146 because the inode table isn't being initialized lazily.
 147 .TP
 148 .I fs_type
 149 This relation specifies the default filesystem type if the user does not
 150 specify it via the
 151 .B \-t
 152 option, or if
 153 .B mke2fs
 154 is not started using a program name of the form
 155 .BI mkfs. fs-type\fR.
 156 If both the user and the
 157 .B mke2fs.conf
 158 file does not specify a default filesystem type, mke2fs will use a
 159 default filesystem type of
 160 .IR ext3
 161 if a journal was requested via a command-line option, or
 162 .I ext2
 163 if not.
 164 .TP
 165 .I blocksize
 166 This relation specifies the default blocksize if the user does not
 167 specify a blocksize on the command line, and the filesystem-type
 168 specific section of the configuration file does not specify a blocksize.
 169 .TP
 170 .I hash_alg
 171 This relation specifies the default hash algorithm used for the
 172 new filesystems with hashed b-tree directories.  Valid algorithms
 173 accepted are:
 174 .IR legacy ,
 175 .IR half_md4 ,
 176 and
 177 .IR tea .
 178 .TP
 179 .I inode_ratio
 180 This relation specifies the default inode ratio if the user does not
 181 specify one on the command line, and the filesystem-type
 182 specific section of the configuration file does not specify a default
 183 inode ratio.
 184 .TP
 185 .I inode_size
 186 This relation specifies the default inode size if the user does not
 187 specify one on the command line, and the filesystem-type
 188 specific section of the configuration file does not specify a default
 189 inode size.
 190 .TP
 191 .I reserved_ratio
 192 This relation specifies the default percentage of filesystem blocks
 193 reserved for the super-user, if the user does not
 194 specify one on the command line, and the filesystem-type
 195 specific section of the configuration file does not specify a default
 196 reserved ratio. This value can be a floating point number.
 197 .TP
 198 .I undo_dir
 199 This relation specifies the directory where the undo file should be
 200 stored.  It can be overridden via the
 201 .B E2FSPROGS_UNDO_DIR
 202 environment variable.  If the directory location is set to the value
 203 .IR none ,
 204 .B mke2fs
 205 will not create an undo file.
 206 .SH THE [fs_types] STANZA
 207 Each tag in the
 208 .I [fs_types]
 209 stanza names a filesystem type or usage type which can be specified via the
 210 .B \-t
 211 or
 212 .B \-T
 213 options to
 214 .BR mke2fs (8),
 215 respectively.
 216 .P
 217 The
 218 .B mke2fs
 219 program constructs a list of fs_types by concatenating the filesystem
 220 type (i.e., ext2, ext3, etc.) with the usage type list.  For most
 221 configuration options,
 222 .B mke2fs
 223 will look for a subsection in the
 224 .I [fs_types]
 225 stanza corresponding with each entry in the constructed list, with later
 226 entries overriding earlier filesystem or usage types.
 227 For
 228 example, consider the following
 229 .B mke2fs.conf
 230 fragment:
 231 .P
 232 [defaults]
 233 .br
 234         base_features = sparse_super,filetype,resize_inode,dir_index
 235 .br
 236         blocksize = 4096
 237 .br
 238         inode_size = 256
 239 .br
 240         inode_ratio = 16384
 241 .br
 242
 243 .br
 244 [fs_types]
 245 .br
 246         ext3 = {
 247 .br
 248                 features = has_journal
 249 .br
 250         }
 251 .br
 252         ext4 = {
 253 .br
 254                 features = extents,flex_bg
 255 .br
 256                 inode_size = 256
 257 .br
 258         }
 259 .br
 260         small = {
 261 .br
 262                 blocksize = 1024
 263 .br
 264                 inode_ratio = 4096
 265 .br
 266         }
 267 .br
 268         floppy = {
 269 .br
 270                 features = ^resize_inode
 271 .br
 272                 blocksize = 1024
 273 .br
 274                 inode_size = 128
 275 .br
 276         }
 277 .P
 278 If mke2fs started with a program name of
 279 .BR mke2fs.ext4 ,
 280 then the filesystem type of ext4 will be used.  If the filesystem is
 281 smaller than 3 megabytes, and no usage type is specified, then
 282 .B mke2fs
 283 will use a default
 284 usage type of
 285 .IR floppy .
 286 This results in an fs_types list of "ext4, floppy".   Both the ext4
 287 subsection and the floppy subsection define an
 288 .I inode_size
 289 relation, but since the later entries in the fs_types list supersede
 290 earlier ones, the configuration parameter for fs_types.floppy.inode_size
 291 will be used, so the filesystem  will have an inode size of 128.
 292 .P
 293 The exception to this resolution is the
 294 .I features
 295 tag, which is specifies a set of changes to the features used by the
 296 filesystem, and which is cumulative.  So in the above example, first
 297 the configuration relation defaults.base_features would enable an
 298 initial feature set with the sparse_super, filetype, resize_inode, and
 299 dir_index features enabled.  Then configuration relation
 300 fs_types.ext4.features would enable the extents and flex_bg
 301 features, and finally the configuration relation
 302 fs_types.floppy.features would remove
 303 the resize_inode feature, resulting in a filesystem feature set
 304 consisting of the sparse_super, filetype, resize_inode, dir_index,
 305 extents_and flex_bg features.
 306 .P
 307 For each filesystem type, the following tags may be used in that
 308 fs_type's subsection:
 309 .TP
 310 .I base_features
 311 This relation specifies the features which are initially enabled for this
 312 filesystem type.  Only one
 313 .I base_features
 314 will be used, so if there are multiple entries in the fs_types list
 315 whose subsections define the
 316 .I base_features
 317 relation, only the last will be used by
 318 .BR mke2fs (8).
 319 .TP
 320 .I errors
 321 Change the behavior of the kernel code when errors are detected.
 322 In all cases, a filesystem error will cause
 323 .BR e2fsck (8)
 324 to check the filesystem on the next boot.
 325 .I errors
 326 can be one of the following:
 327 .RS 1.2i
 328 .TP 1.2i
 329 .B continue
 330 Continue normal execution.
 331 .TP
 332 .B remount-ro
 333 Remount filesystem read-only.
 334 .TP
 335 .B panic
 336 Cause a kernel panic.
 337 .RE
 338 .TP
 339 .I features
 340 This relation specifies a comma-separated list of features edit
 341 requests which modify the feature set
 342 used by the newly constructed filesystem.  The syntax is the same as the
 343 .B -O
 344 command-line option to
 345 .BR mke2fs (8);
 346 that is, a feature can be prefixed by a caret ('^') symbol to disable
 347 a named feature.  Each
 348 .I feature
 349 relation specified in the fs_types list will be applied in the order
 350 found in the fs_types list.
 351 .TP
 352 .I default_features
 353 This relation specifies set of features which should be enabled or
 354 disabled after applying the features listed in the
 355 .I base_features
 356 and
 357 .I features
 358 relations.  It may be overridden by the
 359 .B -O
 360 command-line option to
 361 .BR mke2fs (8).
 362 .TP
 363 .I auto_64-bit_support
 364 This relation is a boolean which specifies whether
 365 .BR mke2fs (8)
 366 should automatically add the 64bit feature if the number of blocks for
 367 the file system requires this feature to be enabled.  The resize_inode
 368 feature is also automatically disabled since it doesn't support 64-bit
 369 block numbers.
 370 .TP
 371 .I default_mntopts
 372 This relation specifies the set of mount options which should be enabled
 373 by default.  These may be changed at a later time with the
 374 .B -o
 375 command-line option to
 376 .BR tune2fs (8).
 377 .TP
 378 .I blocksize
 379 This relation specifies the default blocksize if the user does not
 380 specify a blocksize on the command line.
 381 .TP
 382 .I lazy_itable_init
 383 This boolean relation specifies whether the inode table should
 384 be lazily initialized.  It only has meaning if the uninit_bg feature is
 385 enabled.  If lazy_itable_init is true and the uninit_bg feature is
 386 enabled,  the inode table will
 387 not fully initialized by
 388 .BR mke2fs (8).
 389 This speeds up filesystem
 390 initialization noticeably, but it requires the kernel to finish
 391 initializing the filesystem in the background when the filesystem is
 392 first mounted.
 393 .TP
 394 .I journal_location
 395 This relation specifies the location of the journal.
 396 .TP
 397 .I num_backup_sb
 398 This relation indicates whether file systems with the
 399 .B sparse_super2
 400 feature enabled should be created with 0, 1, or 2 backup superblocks.
 401 .TP
 402 .I packed_meta_blocks
 403 This boolean relation specifes whether the allocation bitmaps, inode
 404 table, and journal should be located at the beginning of the file system.
 405 .TP
 406 .I inode_ratio
 407 This relation specifies the default inode ratio if the user does not
 408 specify one on the command line.
 409 .TP
 410 .I inode_size
 411 This relation specifies the default inode size if the user does not
 412 specify one on the command line.
 413 .TP
 414 .I reserved_ratio
 415 This relation specifies the default percentage of filesystem blocks
 416 reserved for the super-user, if the user does not specify one on the command
 417 line.
 418 .TP
 419 .I hash_alg
 420 This relation specifies the default hash algorithm used for the
 421 new filesystems with hashed b-tree directories.  Valid algorithms
 422 accepted are:
 423 .IR legacy ,
 424 .IR half_md4 ,
 425 and
 426 .IR tea .
 427 .TP
 428 .I flex_bg_size
 429 This relation specifies the number of block groups that will be packed
 430 together to create one large virtual block group on an ext4 filesystem.
 431 This improves meta-data locality and performance on meta-data heavy
 432 workloads.  The number of groups must be a power of 2 and may only be
 433 specified if the flex_bg filesystem feature is enabled.
 434 .TP
 435 .I options
 436 This relation specifies additional extended options which should be
 437 treated by
 438 .BR mke2fs (8)
 439 as if they were prepended to the argument of the
 440 .B -E
 441 option.  This can be used to configure the default extended options used
 442 by
 443 .BR mke2fs (8)
 444 on a per-filesystem type basis.
 445 .TP
 446 .I discard
 447 This boolean relation specifies whether the
 448 .BR mke2fs (8)
 449 should attempt to discard device prior to filesystem creation.
 450 .TP
 451 .I cluster_size
 452 This relation specifies the default cluster size if the bigalloc file
 453 system feature is enabled.  It can be overridden via the
 454 .B \-C
 455 command line option to
 456 .BR mke2fs (8)
 457 .TP
 458 .I make_hugefiles
 459 This boolean relation enables the creation of pre-allocated files as
 460 part of formatting the file system.
 461 .TP
 462 .I hugefiles_uid
 463 This relation controls the user ownership for all of the files and
 464 directories created by the
 465 .I make_hugefiles
 466 feature.
 467 .TP
 468 .I hugefiles_gid
 469 This relation controls the group ownership for all of the files and
 470 directories created by the
 471 .I make_hugefiles
 472 feature.
 473 .TP
 474 .I hugefiles_umask
 475 This relation specifies the umask used when creating the files and
 476 directories by the
 477 .I make_hugefiles
 478 feature.
 479 .TP
 480 .I num_hugefiles
 481 This relation specifies the number of huge files to be created.  If this
 482 relation is not specified, or is set to zero, and the
 483 .I hugefiles_size
 484 relation is non-zero, then
 485 .I make_hugefiles
 486 will create as many huge files as can fit to fill the entire file system.
 487 .TP
 488 .I hugefiles_slack
 489 This relation specifies how much space should be reserved for other
 490 files.
 491 .TP
 492 .I hugefiles_size
 493 This relation specifies the size of the huge files.  If this relation is
 494 not specified, the default is to fill the entire file system.
 495 .TP
 496 .I hugefiles_align
 497 This relation specifies the alignment for the start block of the huge
 498 files.  It also forces the size of huge files to be a multiple of the
 499 requested alignment.  If this relation is not specified, no alignment
 500 requirement will be imposed on the huge files.
 501 .TP
 502 .I hugefiles_align_disk
 503 Thie relations specifies whether the alignment should be relative to the
 504 beginning of the hard drive (assuming that the starting offset of the
 505 partition is available to mke2fs).  The default value is false, which
 506 if will cause hugefile alignment to be relative to the beginning of the
 507 file system.
 508 .TP
 509 .I hugefiles_name
 510 This relation specifies the base file name for the huge files.
 511 .TP
 512 .I hugefiles_digits
 513 This relation specifies the (zero-padded) width of the field for the
 514 huge file number.
 515 .TP
 516 .I zero_hugefiles
 517 This boolean relation specifies whether or not zero blocks will be
 518 written to the hugefiles while
 519 .BR mke2fs(8)
 520 is creating them.  By default, zero blocks will be written to the huge
 521 files to avoid stale data from being made available to potentially
 522 untrusted user programs, unless the device supports a discard/trim
 523 operation which will take care of zeroing the device blocks.  By
 524 .I zero_hugefiles
 525 to false, this step will always be skipped, which can be useful if it is
 526 known that the disk has been previously erased, or if the user programs
 527 that will have access to the huge files are trusted to not reveal stale
 528 data.
 529 .SH THE [devices] STANZA
 530 Each tag in the
 531 .I [devices]
 532 stanza names device name so that per-device defaults can be specified.
 533 .TP
 534 .I fs_type
 535 This relation specifies the default parameter for the
 536 .B \-t
 537 option, if this option isn't specified on the command line.
 538 .TP
 539 .I usage_types
 540 This relation specifies the default parameter for the
 541 .B \-T
 542 option, if this option isn't specified on the command line.
 543 .SH FILES
 544 .TP
 545 .I /etc/mke2fs.conf
 546 The configuration file for
 547 .BR mke2fs (8).
 548 .SH SEE ALSO
 549 .BR mke2fs (8)