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 .TP
  76 .I [scratch_files]
  77 This stanza controls when e2fsck will attempt to use scratch files to
  78 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.  However, it's still possible, despite the
 101 best efforts of init script and installer authors to not be
 102 able to detect this misconfiguration, usually due to a
 103 buggy or misconfigured virtualization manager or the
 104 installer not having access to a network time server
 105 during the installation process.  So by default, we allow
 106 the superblock times to be fudged by up to 24 hours.
 107 This can be disabled by setting
 108 .I accept_time_fudge
 109 to the
 110 boolean value of false.  This setting defaults to true.
 111 .TP
 112 .I broken_system_clock
 113 The
 114 .BR e2fsck (8)
 115 program has some heuristics that assume that the system clock is
 116 correct.  In addition, many system programs make similar assumptions.
 117 For example, the UUID library depends on time not going backwards in
 118 order for it to be able to make its guarantees about issuing universally
 119 unique ID's.  Systems with broken system clocks, are well, broken.
 120 However, broken system clocks, particularly in embedded systems, do
 121 exist.  E2fsck will attempt to use heuristics to determine if the time
 122 can not be trusted; and to skip time-based checks if this is true.  If
 123 this boolean is set to true, then e2fsck will always assume that the
 124 system clock can not be trusted.
 125 .TP
 126 .I buggy_init_scripts
 127 This boolean relation is an alias for
 128 .I accept_time_fudge
 129 for backwards compatibility; it used to
 130 be that the behavior defined by
 131 .I accept_time_fudge
 132 above defaulted to false, and
 133 .I buggy_init_scripts
 134 would enable superblock time field to be wrong by up to 24 hours.  When
 135 we changed the default, we also renamed this boolean relation to
 136 .IR accept_time_fudge.
 137 .TP
 138 .I clear_test_fs_flag
 139 This boolean relation controls whether or not
 140 .BR e2fsck (8)
 141 will offer to clear
 142 the test_fs flag if the ext4 filesystem is available on the system.  It
 143 defaults to true.
 144 .TP
 145 .I defer_check_on_battery
 146 This boolean relation controls whether or not the interval between
 147 filesystem checks (either based on time or number of mounts) should
 148 be doubled if the system is running on battery.  This setting defaults to
 149 true.
 150 .TP
 151 .I log_dir
 152 If the
 153 .I log_filename
 154 relation contains a relative pathname, then the log file will be placed
 155 in the directory named by the
 156 .I log_dir
 157 relation.
 158 .TP
 159 .I log_dir_fallback
 160 This relation contains an alternate directory that will be used if the
 161 directory specified by
 162 .I log_dir
 163 is not available or is not writeable.
 164 .TP
 165 .I log_dir_wait
 166 If this boolean relation is true, them if the directories specified by
 167 .I log_dir
 168 or
 169 .I log_dir_fallback
 170 are not available or are not yet writeable, e2fsck will save the output
 171 in a memory buffer, and a child process will periodically test to see if
 172 the log directory has become available after the boot sequence has
 173 mounted the requiste filesytem for reading/writing.  This implements the
 174 functionality provided by
 175 .BR logsave (8)
 176 for e2fsck log files.
 177 .TP
 178 .I log_filename
 179 This relation specifies the file name where a copy of e2fsck's output
 180 will be written.   If certain problem reports are suppressed using the
 181 .I max_count_problems
 182 relation, (or on a per-problem basis using the
 183 .I max_count
 184 relation), the full set of problem reports will be written to the log
 185 file.  The filename may contain various percent-expressions (%D, %T, %N,
 186 etc.) which will be expanded so that the file name for the log file can
 187 include things like date, time, device name, and other run-time
 188 parameters.  See the
 189 .B LOGGING
 190 section for more details.
 191 .TP
 192 .I max_count_problems
 193 This relation specifies the maximum number of problem reports of a
 194 particular type will be printed to stdout before further problem reports
 195 of that type are squelched.  This can be useful if the console is slow
 196 (i.e., connected to a serial port) and so a large amount of output could
 197 end up delaying the boot process for a long time (potentially hours).
 198 .TP
 199 .I indexed_dir_slack_percentage
 200 When
 201 .BR e2fsck (8)
 202 repacks a indexed directory, reserve the specified percentage of
 203 empty space in each leaf nodes so that a few new entries can
 204 be added to the directory without splitting leaf nodes, so that
 205 the average fill ratio of directories can be maintained at a
 206 higher, more efficient level.  This relation defaults to 20
 207 percent.
 208 .SH THE [problems] STANZA
 209 Each tag in the
 210 .I [problems]
 211 stanza names a problem code specified with a leading "0x" followed by
 212 six hex digits.
 213 The value of the tag is a subsection where the relations in that
 214 subsection override the default treatment of that particular problem
 215 code.
 216 .P
 217 Note that inappropriate settings in this stanza may cause
 218 .B e2fsck
 219 to behave incorrectly, or even crash.  Most system administrators should
 220 not be making changes to this section without referring to source code.
 221 .P
 222 Within each problem code's subsection, the following tags may be used:
 223 .TP
 224 .I description
 225 This relation allows the message which is printed when this filesystem
 226 inconsistency is detected to be overridden.
 227 .TP
 228 .I preen_ok
 229 This boolean relation overrides the default behavior controlling
 230 whether this filesystem problem should be automatically fixed when
 231 .B e2fsck
 232 is running in preen mode.
 233 .TP
 234 .I max_count
 235 This integer relation overrides the
 236 .I max_count_problems
 237 parameter (set in the options section) for this particular problem.
 238 .TP
 239 .I no_ok
 240 This boolean relation overrides the default behavior determining
 241 whether or not the filesystem will be marked as inconsistent if the user
 242 declines to fix the reported problem.
 243 .TP
 244 .I no_default
 245 This boolean relation overrides whether the default answer for this
 246 problem (or question) should be "no".
 247 .TP
 248 .I preen_nomessage
 249 This boolean relation overrides the default behavior controlling
 250 whether or not the description for this filesystem problem should
 251 be suppressed when
 252 .B e2fsck
 253 is running in preen mode.
 254 .TP
 255 .I no_nomsg
 256 This boolean relation overrides the default behavior controlling
 257 whether or not the description for this filesystem problem should
 258 be suppressed when a problem forced not to be fixed, either because
 259 .B e2fsck
 260 is run with the
 261 .B -n
 262 option or because the
 263 .I force_no
 264 flag has been set for the problem.
 265 .TP
 266 .I force_no
 267 This boolean option, if set to true, forces a problem to never be fixed.
 268 That is, it will be as if the user problem responds 'no' to the question
 269 of 'should this problem be fixed?'.  The
 270 .I force_no
 271 option even overrides the
 272 .B -y
 273 option given on the command-line (just for the specific problem, of course).
 274 .SH THE [scratch_files] STANZA
 275 The following relations are defined in the
 276 .I [scratch_files]
 277 stanza.
 278 .TP
 279 .I directory
 280 If the directory named by this relation exists and is writeable, then
 281 e2fsck will attempt to use this directory to store scratch files instead
 282 of using in-memory data structures.
 283 .TP
 284 .I numdirs_threshold
 285 If this relation is set, then in-memory data structures be used if the
 286 number of directories in the filesystem are fewer than amount specified.
 287 .TP
 288 .I dirinfo
 289 This relation controls whether or not the scratch file directory is used
 290 instead of an in-memory data structure for directory information.  It
 291 defaults to true.
 292 .TP
 293 .I icount
 294 This relation controls whether or not the scratch file directory is used
 295 instead of an in-memory data structure when tracking inode counts.  It
 296 defaults to true.
 297 .SH LOGGING
 298 E2fsck has the facility to save the information from an e2fsck run in a
 299 directory so that a system administrator can review its output at their
 300 leisure.  This allows information captured during the automatic e2fsck
 301 preen run, as well as a manually started e2fsck run, to be saved for
 302 posterity.  This facility is controlled by the
 303 .IR log_filename ,
 304 .IR log_dir ,
 305 .IR log_dir_fallback ,
 306 and
 307 .I log_dir_wait
 308 relations in the
 309 .I [options]
 310 stanza.
 311 .PP
 312 The filename in
 313 .I log_filename
 314 may contain the following percent-expressions that will be expanded as
 315 follows.
 316 .TP
 317 .B %d
 318 The current day of the month
 319 .TP
 320 .B %D
 321 The current date; this is a equivalent of
 322 .B %Y%m%d
 323 .TP
 324 .B %h
 325 The hostname of the system.
 326 .TP
 327 .B %H
 328 The current hour in 24-hour format (00..23)
 329 .TP
 330 .B %m
 331 The current month as a two-digit number (01..12)
 332 .TP
 333 .B %M
 334 The current minute (00..59)
 335 .TP
 336 .B %N
 337 The name of the block device containing the file system, with any
 338 directory pathname stripped off.
 339 .TP
 340 .B %p
 341 The pid of the e2fsck process
 342 .TP
 343 .B %s
 344 The current time expressed as the number of seconds since 1970-01-01
 345 00:00:00 UTC
 346 .TP
 347 .B %S
 348 The current second (00..59)
 349 .TP
 350 .B %T
 351 The current time; this is equivalent of
 352 .B %H%M%S
 353 .TP
 354 .B %u
 355 The name of the user running e2fsck.
 356 .TP
 357 .B %U
 358 This percent expression does not expand to anything, but it signals that
 359 any following date or time expressions should be expressed in UTC time
 360 instead of the local timzeone.
 361 .TP
 362 .B %y
 363 The last two digits of the current year (00..99)
 364 .TP
 365 .B %Y
 366 The current year (i.e., 2012).
 367 .SH EXAMPLES
 368 The following recipe will prevent e2fsck from aborting during the boot
 369 process when a filesystem contains orphaned files.  (Of course, this is
 370 not always a good idea, since critical files that are needed for the
 371 security of the system could potentially end up in lost+found, and
 372 starting the system without first having a system administrator check
 373 things out may be dangerous.)
 374 .P
 375 .br
 376         [problems]
 377 .br
 378                 0x040002 = {
 379 .br
 380                         preen_ok = true
 381 .br
 382                         description = "@u @i %i.  "
 383 .br
 384                 }
 385 .P
 386 The following recipe will cause an e2fsck logfile to be written to the
 387 directory /var/log/e2fsck, with a filename that contains the device
 388 name, the hostname of the system, the date, and time: e.g.,
 389 "e2fsck-sda3.server.INFO.20120314-112142".  If the directory containing
 390 /var/log is located on the root file system
 391 which is initially mounted read-only, then the output will be saved in
 392 memory and written out once the root file system has been remounted
 393 read/write.   To avoid too much detail from being written to the serial
 394 console (which could potentially slow down the boot sequence), only print
 395 no more than 16 instances of each type of file system corruption.
 396 .P
 397 .br
 398         [options]
 399 .br
 400                 max_count_problems = 16
 401 .br
 402                 log_dir = /var/log/e2fsck
 403 .br
 404                 log_filename = e2fsck-%N.%h.INFO.%D-%T
 405 .br
 406                 log_dir_wait = true
 407 .P
 408 .SH FILES
 409 .TP
 410 .I /etc/e2fsck.conf
 411 The configuration file for
 412 .BR e2fsck (8).
 413 .SH SEE ALSO
 414 .BR e2fsck (8)