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 or ext3 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 clear_test_fs_flag
 113 This boolean relation controls whether or not
 114 .BR e2fsck (8)
 115 will offer to clear
 116 the test_fs flag if the ext4 filesystem is available on the system.  It
 117 defaults to true.
 118 .TP
 119 .I defer_check_on_battery
 120 This boolean relation controls whether or not the interval between
 121 filesystem checks (either based on time or number of mounts) should
 122 be doubled if the system is running on battery.  This setting defaults to
 123 true.
 124 .TP
 125 .I indexed_dir_slack_percentage
 126 When
 127 .BR e2fsck (8)
 128 repacks a indexed directory, reserve the specified percentage of
 129 empty space in each leaf nodes so that a few new entries can
 130 be added to the directory without splitting leaf nodes, so that
 131 the average fill ratio of directories can be maintained at a
 132 higher, more efficient level.  This relation defaults to 20
 133 percent.
 134 .SH THE [problems] STANZA
 135 Each tag in the
 136 .I [problems]
 137 stanza names a problem code specified with a leading "0x" followed by
 138 six hex digits.
 139 The value of the tag is a subsection where the relations in that
 140 subsection override the default treatment of that particular problem
 141 code.
 142 .P
 143 Note that inappropriate settings in this stanza may cause
 144 .B e2fsck
 145 to behave incorrectly, or even crash.  Most system administrators should
 146 not be making changes to this section without referring to source code.
 147 .P
 148 Within each problem code's subsection, the following tags may be used:
 149 .TP
 150 .I description
 151 This relation allows the message which is printed when this filesystem
 152 inconsistency is detected to be overridden.
 153 .TP
 154 .I preen_ok
 155 This boolean relation overrides the default behavior controlling
 156 whether this filesystem problem should be automatically fixed when
 157 .B e2fsck
 158 is running in preen mode.
 159 .TP
 160 .I no_ok
 161 This boolean relation overrides the default behavior determining
 162 whether or not the filesystem will be marked as inconsistent if the user
 163 declines to fix the reported problem.
 164 .TP
 165 .I no_default
 166 This boolean relation overrides whether the default answer for this
 167 problem (or question) should be "no".
 168 .TP
 169 .I preen_nomessage
 170 This boolean relation overrides the default behavior controlling
 171 whether or not the description for this filesystem problem should
 172 be suppressed when
 173 .B e2fsck
 174 is running in preen mode.
 175 .TP
 176 .I no_nomsg
 177 This boolean relation overrides the default behavior controlling
 178 whether or not the description for this filesystem problem should
 179 be suppressed when
 180 .B e2fsck
 181 is run with the
 182 .B -n
 183 option.
 184 .SH THE [scratch_files] STANZA
 185 The following relations are defined in the
 186 .I [scratch_files]
 187 stanza.
 188 .TP
 189 .I directory
 190 If the directory named by this relation exists and is writeable, then
 191 e2fsck will attempt to use this directory to store scratch files instead
 192 of using in-memory data structures.
 193 .TP
 194 .I numdirs_threshold
 195 If this relation is set, then in-memory data structures be used if the
 196 number of directories in the filesystem are fewer than amount specified.
 197 .TP
 198 .I dirinfo
 199 This relation controls whether or not the scratch file directory is used
 200 instead of an in-memory data structure for directory information.  It
 201 defaults to true.
 202 .TP
 203 .I icount
 204 This relation controls whether or not the scratch file directory is used
 205 instead of an in-memory data structure when tracking inode counts.  It
 206 defaults to true.
 207 .SH EXAMPLES
 208 The following recipe will prevent e2fsck from aborting during the boot
 209 process when a filesystem contains orphaned files.  (Of course, this is
 210 not always a good idea, since critical files that are needed for the
 211 security of the system could potentially end up in lost+found, and
 212 starting the system without first having a system administrator check
 213 things out may be dangerous.)
 214 .P
 215 .br
 216         [problems]
 217 .br
 218                 0x040002 = {
 219 .br
 220                         preen_ok = true
 221 .br
 222                         description = "@u @i %i.  "
 223 .br
 224                 }
 225 .SH FILES
 226 .TP
 227 .I /etc/e2fsck.conf
 228 The configuration file for
 229 .BR e2fsck (8).
 230 .SH SEE ALSO
 231 .BR e2fsck (8)