e2fsck/e2fsck.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 e2fsck.conf 5 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
   6 .SH NAME
   7 e2fsck.conf \- Configuration file for e2fsck
   8 .SH DESCRIPTION
   9 .I e2fsck.conf
  10 is the configuration file for
  11 .BR e2fsck (8).
  12 It controls the default behavior of
  13 .BR e2fsck (8)
  14 while it is checking ext2, ext3, or ext4 filesystems.
  15 .PP
  16 The
  17 .I e2fsck.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 e2fsck.conf
  64 file.  They will be described in more detail in future sections of this
  65 document.
  66 .TP
  67 .I [options]
  68 This stanza contains general configuration parameters for
  69 .BR e2fsck 's
  70 behavior.
  71 .TP
  72 .I [problems]
  73 This stanza allows the administrator to reconfigure how e2fsck handles
  74 various filesystem inconsistencies.
  75 @TDB_MAN_COMMENT@.TP
  76 @TDB_MAN_COMMENT@.I [scratch_files]
  77 @TDB_MAN_COMMENT@This stanza controls when e2fsck will attempt to use
  78 @TDB_MAN_COMMENT@scratch files to reduce the need for memory.
  79 .SH THE [options] STANZA
  80 The following relations are defined in the
  81 .I [options]
  82 stanza.
  83 .TP
  84 .I allow_cancellation
  85 If this relation is set to a boolean value of true, then if the user
  86 interrupts e2fsck using ^C, and the filesystem is not explicitly flagged
  87 as containing errors, e2fsck will exit with an exit status of 0 instead
  88 of 32.  This setting defaults to false.
  89 .TP
  90 .I accept_time_fudge
  91 Unfortunately, due to Windows' unfortunate design decision
  92 to configure the hardware clock to tick localtime, instead
  93 of the more proper and less error-prone UTC time, many
  94 users end up in the situation where the system clock is
  95 incorrectly set at the time when e2fsck is run.
  96 .IP
  97 Historically this was usually due to some distributions
  98 having buggy init scripts and/or installers that didn't
  99 correctly detect this case and take appropriate
 100 countermeasures.  Unfortunately, this is occasionally
 101 true even today, usually due to a
 102 buggy or misconfigured virtualization manager or the
 103 installer not having access to a network time server
 104 during the installation process.  So by default, we allow
 105 the superblock times to be fudged by up to 24 hours.
 106 This can be disabled by setting
 107 .I accept_time_fudge
 108 to the
 109 boolean value of false.  This setting defaults to true.
 110 .TP
 111 .I broken_system_clock
 112 The
 113 .BR e2fsck (8)
 114 program has some heuristics that assume that the system clock is
 115 correct.  In addition, many system programs make similar assumptions.
 116 For example, the UUID library depends on time not going backwards in
 117 order for it to be able to make its guarantees about issuing universally
 118 unique ID's.  Systems with broken system clocks, are well, broken.
 119 However, broken system clocks, particularly in embedded systems, do
 120 exist.  E2fsck will attempt to use heuristics to determine if the time
 121 can not be trusted; and to skip time-based checks if this is true.  If
 122 this boolean is set to true, then e2fsck will always assume that the
 123 system clock can not be trusted.
 124 .TP
 125 .I buggy_init_scripts
 126 This boolean relation is an alias for
 127 .I accept_time_fudge
 128 for backwards compatibility; it used to
 129 be that the behavior defined by
 130 .I accept_time_fudge
 131 above defaulted to false, and
 132 .I buggy_init_scripts
 133 would enable superblock time field to be wrong by up to 24 hours.  When
 134 we changed the default, we also renamed this boolean relation to
 135 .IR accept_time_fudge.
 136 .TP
 137 .I clear_test_fs_flag
 138 This boolean relation controls whether or not
 139 .BR e2fsck (8)
 140 will offer to clear
 141 the test_fs flag if the ext4 filesystem is available on the system.  It
 142 defaults to true.
 143 .TP
 144 .I defer_check_on_battery
 145 This boolean relation controls whether or not the interval between
 146 filesystem checks (either based on time or number of mounts) should
 147 be doubled if the system is running on battery.  This setting defaults to
 148 true.
 149 .TP
 150 .I indexed_dir_slack_percentage
 151 When
 152 .BR e2fsck (8)
 153 repacks a indexed directory, reserve the specified percentage of
 154 empty space in each leaf nodes so that a few new entries can
 155 be added to the directory without splitting leaf nodes, so that
 156 the average fill ratio of directories can be maintained at a
 157 higher, more efficient level.  This relation defaults to 20
 158 percent.
 159 .TP
 160 .I log_dir
 161 If the
 162 .I log_filename
 163 relation contains a relative pathname, then the log file will be placed
 164 in the directory named by the
 165 .I log_dir
 166 relation.
 167 .TP
 168 .I log_dir_fallback
 169 This relation contains an alternate directory that will be used if the
 170 directory specified by
 171 .I log_dir
 172 is not available or is not writeable.
 173 .TP
 174 .I log_dir_wait
 175 If this boolean relation is true, them if the directories specified by
 176 .I log_dir
 177 or
 178 .I log_dir_fallback
 179 are not available or are not yet writeable, e2fsck will save the output
 180 in a memory buffer, and a child process will periodically test to see if
 181 the log directory has become available after the boot sequence has
 182 mounted the requiste file system for reading/writing.  This implements the
 183 functionality provided by
 184 .BR logsave (8)
 185 for e2fsck log files.
 186 .TP
 187 .I log_filename
 188 This relation specifies the file name where a copy of e2fsck's output
 189 will be written.   If certain problem reports are suppressed using the
 190 .I max_count_problems
 191 relation, (or on a per-problem basis using the
 192 .I max_count
 193 relation), the full set of problem reports will be written to the log
 194 file.  The filename may contain various percent-expressions (%D, %T, %N,
 195 etc.) which will be expanded so that the file name for the log file can
 196 include things like date, time, device name, and other run-time
 197 parameters.  See the
 198 .B LOGGING
 199 section for more details.
 200 .TP
 201 .I max_count_problems
 202 This relation specifies the maximum number of problem reports of a
 203 particular type will be printed to stdout before further problem reports
 204 of that type are squelched.  This can be useful if the console is slow
 205 (i.e., connected to a serial port) and so a large amount of output could
 206 end up delaying the boot process for a long time (potentially hours).
 207 .TP
 208 .I readahead_mem_pct
 209 Use this percentage of memory to try to read in metadata blocks ahead of the
 210 main e2fsck thread.  This should reduce run times, depending on the speed of
 211 the underlying storage and the amount of free memory.  There is no default, but
 212 see
 213 .B readahead_kb
 214 for more details.
 215 .TP
 216 .I readahead_kb
 217 Use this amount of memory to read in metadata blocks ahead of the main checking
 218 thread.  Setting this value to zero disables readahead entirely.  By default,
 219 this is set the size of two block groups' inode tables (typically 4MiB on a
 220 regular ext4 filesystem); if this amount is more than 1/50th of total physical
 221 memory, readahead is disabled.
 222 .TP
 223 .I report_features
 224 If this boolean relation is true, e2fsck will print the file system
 225 features as part of its verbose reporting (i.e., if the
 226 .B -v
 227 option is specified)
 228 .TP
 229 .I report_time
 230 If this boolean relation is true, e2fsck will run as if the options
 231 .B -tt
 232 are always specified.  This will cause e2fsck to print timing statistics
 233 on a pass by pass basis for full file system checks.
 234 .TP
 235 .I report_verbose
 236 If this boolean relation is true, e2fsck will run as if the option
 237 .B -v
 238 is always specified.  This will cause e2fsck to print some additional
 239 information at the end of each full file system check.
 240 .SH THE [problems] STANZA
 241 Each tag in the
 242 .I [problems]
 243 stanza names a problem code specified with a leading "0x" followed by
 244 six hex digits.
 245 The value of the tag is a subsection where the relations in that
 246 subsection override the default treatment of that particular problem
 247 code.
 248 .P
 249 Note that inappropriate settings in this stanza may cause
 250 .B e2fsck
 251 to behave incorrectly, or even crash.  Most system administrators should
 252 not be making changes to this section without referring to source code.
 253 .P
 254 Within each problem code's subsection, the following tags may be used:
 255 .TP
 256 .I description
 257 This relation allows the message which is printed when this filesystem
 258 inconsistency is detected to be overridden.
 259 .TP
 260 .I preen_ok
 261 This boolean relation overrides the default behavior controlling
 262 whether this filesystem problem should be automatically fixed when
 263 .B e2fsck
 264 is running in preen mode.
 265 .TP
 266 .I max_count
 267 This integer relation overrides the
 268 .I max_count_problems
 269 parameter (set in the options section) for this particular problem.
 270 .TP
 271 .I no_ok
 272 This boolean relation overrides the default behavior determining
 273 whether or not the filesystem will be marked as inconsistent if the user
 274 declines to fix the reported problem.
 275 .TP
 276 .I no_default
 277 This boolean relation overrides whether the default answer for this
 278 problem (or question) should be "no".
 279 .TP
 280 .I preen_nomessage
 281 This boolean relation overrides the default behavior controlling
 282 whether or not the description for this filesystem problem should
 283 be suppressed when
 284 .B e2fsck
 285 is running in preen mode.
 286 .TP
 287 .I no_nomsg
 288 This boolean relation overrides the default behavior controlling
 289 whether or not the description for this filesystem problem should
 290 be suppressed when a problem forced not to be fixed, either because
 291 .B e2fsck
 292 is run with the
 293 .B -n
 294 option or because the
 295 .I force_no
 296 flag has been set for the problem.
 297 .TP
 298 .I force_no
 299 This boolean option, if set to true, forces a problem to never be fixed.
 300 That is, it will be as if the user problem responds 'no' to the question
 301 of 'should this problem be fixed?'.  The
 302 .I force_no
 303 option even overrides the
 304 .B -y
 305 option given on the command-line (just for the specific problem, of course).
 306 .TP
 307 .I not_a_fix
 308 This boolean option, it set to true, marks the problem as
 309 one where if the user gives permission to make the requested change,
 310 it does not mean that the file system had a problem which has since
 311 been fixed.  This is used for requests to optimize the file system's
 312 data structure, such as pruning an extent tree.
 313 @TDB_MAN_COMMENT@.SH THE [scratch_files] STANZA
 314 @TDB_MAN_COMMENT@The following relations are defined in the
 315 @TDB_MAN_COMMENT@.I [scratch_files]
 316 @TDB_MAN_COMMENT@stanza.
 317 @TDB_MAN_COMMENT@.TP
 318 @TDB_MAN_COMMENT@.I directory
 319 @TDB_MAN_COMMENT@If the directory named by this relation exists and is
 320 @TDB_MAN_COMMENT@writeable, then e2fsck will attempt to use this
 321 @TDB_MAN_COMMENT@directory to store scratch files instead of using
 322 @TDB_MAN_COMMENT@in-memory data structures.
 323 @TDB_MAN_COMMENT@.TP
 324 @TDB_MAN_COMMENT@.I numdirs_threshold
 325 @TDB_MAN_COMMENT@If this relation is set, then in-memory data structures
 326 @TDB_MAN_COMMENT@be used if the number of directories in the filesystem
 327 @TDB_MAN_COMMENT@are fewer than amount specified.
 328 @TDB_MAN_COMMENT@.TP
 329 @TDB_MAN_COMMENT@.I dirinfo
 330 @TDB_MAN_COMMENT@This relation controls whether or not the scratch file
 331 @TDB_MAN_COMMENT@directory is used instead of an in-memory data
 332 @TDB_MAN_COMMENT@structure for directory information.  It defaults to
 333 @TDB_MAN_COMMENT@true.
 334 @TDB_MAN_COMMENT@.TP
 335 @TDB_MAN_COMMENT@.I icount
 336 @TDB_MAN_COMMENT@This relation controls whether or not the scratch file
 337 @TDB_MAN_COMMENT@directory is used instead of an in-memory data
 338 @TDB_MAN_COMMENT@structure when tracking inode counts.  It defaults to
 339 @TDB_MAN_COMMENT@true.
 340 .SH LOGGING
 341 E2fsck has the facility to save the information from an e2fsck run in a
 342 directory so that a system administrator can review its output at their
 343 leisure.  This allows information captured during the automatic e2fsck
 344 preen run, as well as a manually started e2fsck run, to be saved for
 345 posterity.  This facility is controlled by the
 346 .IR log_filename ,
 347 .IR log_dir ,
 348 .IR log_dir_fallback ,
 349 and
 350 .I log_dir_wait
 351 relations in the
 352 .I [options]
 353 stanza.
 354 .PP
 355 The filename in
 356 .I log_filename
 357 may contain the following percent-expressions that will be expanded as
 358 follows.
 359 .TP
 360 .B %d
 361 The current day of the month
 362 .TP
 363 .B %D
 364 The current date; this is a equivalent of
 365 .B %Y%m%d
 366 .TP
 367 .B %h
 368 The hostname of the system.
 369 .TP
 370 .B %H
 371 The current hour in 24-hour format (00..23)
 372 .TP
 373 .B %m
 374 The current month as a two-digit number (01..12)
 375 .TP
 376 .B %M
 377 The current minute (00..59)
 378 .TP
 379 .B %N
 380 The name of the block device containing the file system, with any
 381 directory pathname stripped off.
 382 .TP
 383 .B %p
 384 The pid of the e2fsck process
 385 .TP
 386 .B %s
 387 The current time expressed as the number of seconds since 1970-01-01
 388 00:00:00 UTC
 389 .TP
 390 .B %S
 391 The current second (00..59)
 392 .TP
 393 .B %T
 394 The current time; this is equivalent of
 395 .B %H%M%S
 396 .TP
 397 .B %u
 398 The name of the user running e2fsck.
 399 .TP
 400 .B %U
 401 This percent expression does not expand to anything, but it signals that
 402 any following date or time expressions should be expressed in UTC time
 403 instead of the local timzeone.
 404 .TP
 405 .B %y
 406 The last two digits of the current year (00..99)
 407 .TP
 408 .B %Y
 409 The current year (i.e., 2012).
 410 .SH EXAMPLES
 411 The following recipe will prevent e2fsck from aborting during the boot
 412 process when a filesystem contains orphaned files.  (Of course, this is
 413 not always a good idea, since critical files that are needed for the
 414 security of the system could potentially end up in lost+found, and
 415 starting the system without first having a system administrator check
 416 things out may be dangerous.)
 417 .P
 418 .br
 419         [problems]
 420 .br
 421                 0x040002 = {
 422 .br
 423                         preen_ok = true
 424 .br
 425                         description = "@u @i %i.  "
 426 .br
 427                 }
 428 .P
 429 The following recipe will cause an e2fsck logfile to be written to the
 430 directory /var/log/e2fsck, with a filename that contains the device
 431 name, the hostname of the system, the date, and time: e.g.,
 432 "e2fsck-sda3.server.INFO.20120314-112142".  If the directory containing
 433 /var/log is located on the root file system
 434 which is initially mounted read-only, then the output will be saved in
 435 memory and written out once the root file system has been remounted
 436 read/write.   To avoid too much detail from being written to the serial
 437 console (which could potentially slow down the boot sequence), only print
 438 no more than 16 instances of each type of file system corruption.
 439 .P
 440 .br
 441         [options]
 442 .br
 443                 max_count_problems = 16
 444 .br
 445                 log_dir = /var/log/e2fsck
 446 .br
 447                 log_filename = e2fsck-%N.%h.INFO.%D-%T
 448 .br
 449                 log_dir_wait = true
 450 .P
 451 .SH FILES
 452 .TP
 453 .I /etc/e2fsck.conf
 454 The configuration file for
 455 .BR e2fsck (8).
 456 .SH SEE ALSO
 457 .BR e2fsck (8)