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 buggy_init_scripts
  91 Some buggy distributions (such as Ubuntu) have init scripts and/or
  92 installers which fail to correctly set the system clock before running
  93 e2fsck and/or formatting the filesystem initially.  Normally this
  94 happens because the hardware clock is ticking localtime, instead of the
  95 more proper and less error-prone UTC time.  So while the kernel is
  96 booting, the system time (which in Linux systems always ticks in UTC
  97 time) is set from the hardware clock, but since the hardware clock is
  98 ticking localtime, the system time is incorrect.  Unfortunately, some
  99 buggy distributions do not correct this before running e2fsck.  If this
 100 option is set to a boolean value of true, we attempt to work around this
 101 situation by allowing the superblock last write time, last mount time,
 102 and last check time to be in the future by up to 24 hours.
 103 .TP
 104 .I defer_check_on_battery
 105 This boolean relation controls whether or not the interval between
 106 filesystem checks (either based on time or number of mounts) should
 107 be doubled if the system is running on battery.  It defaults to
 108 true.
 109 .TP
 110 .I clear_test_fs_flag
 111 This boolean relation controls whether or not e2fsck will offer to clear
 112 the test_fs flag if the ext4 filesystem is available on the system.  It
 113 defaults to true.
 114 .SH THE [problems] STANZA
 115 Each tag in the
 116 .I [problems]
 117 stanza names a problem code specified with a leading "0x" followed by
 118 six hex digits.
 119 The value of the tag is a subsection where the relations in that
 120 subsection override the default treatment of that particular problem
 121 code.
 122 .P
 123 Note that inappropriate settings in this stanza may cause
 124 .B e2fsck
 125 to behave incorrectly, or even crash.  Most system administrators should
 126 not be making changes to this section without referring to source code.
 127 .P
 128 Within each problem code's subsection, the following tags may be used:
 129 .TP
 130 .I description
 131 This relation allows the message which is printed when this filesystem
 132 inconsistency is detected to be overridden.
 133 .TP
 134 .I preen_ok
 135 This boolean relation overrides the default behavior controlling
 136 whether this filesystem problem should be automatically fixed when
 137 .B e2fsck
 138 is running in preen mode.
 139 .TP
 140 .I no_ok
 141 This boolean relation overrides the default behavior determining
 142 whether or not the filesystem will be marked as inconsistent if the user
 143 declines to fix the reported problem.
 144 .TP
 145 .I no_default
 146 This boolean relation overrides whether the default answer for this
 147 problem (or question) should be "no".
 148 .TP
 149 .I preen_nomessage
 150 This boolean relation overrides the default behavior controlling
 151 whether or not the description for this filesystem problem should
 152 be suppressed when
 153 .B e2fsck
 154 is running in preen mode.
 155 .TP
 156 .I no_nomsg
 157 This boolean relation overrides the default behavior controlling
 158 whether or not the description for this filesystem problem should
 159 be suppressed when
 160 .B e2fsck
 161 is run with the
 162 .B -n
 163 option.
 164 .SH THE [scratch_files] STANZA
 165 The following relations are defined in the
 166 .I [scratch_files]
 167 stanza.
 168 .TP
 169 .I directory
 170 If the directory named by this relation exists and is writeable, then
 171 e2fsck will attempt to use this directory to store scratch files instead
 172 of using in-memory data structures.
 173 .TP
 174 .I numdirs_threshold
 175 If this relation is set, then in-memory data structures be used if the
 176 number of directories in the filesystem are fewer than amount specified.
 177 .TP
 178 .I dirinfo
 179 This relation controls whether or not the scratch file directory is used
 180 instead of an in-memory data structure for directory information.  It
 181 defaults to true.
 182 .TP
 183 .I icount
 184 This relation controls whether or not the scratch file directory is used
 185 instead of an in-memory data structure when tracking inode counts.  It
 186 defaults to true.
 187 .SH EXAMPLES
 188 The following recipe will prevent e2fsck from aborting during the boot
 189 process when a filesystem contains orphaned files.  (Of course, this is
 190 not always a good idea, since critical files that are needed for the
 191 security of the system could potentially end up in lost+found, and
 192 starting the system without first having a system administrator check
 193 things out may be dangerous.)
 194 .P
 195 .br
 196         [problems]
 197 .br
 198                 0x040002 = {
 199 .br
 200                         preen_ok = true
 201 .br
 202                         description = "@u @i %i.  "
 203 .br
 204                 }
 205 .SH FILES
 206 .TP
 207 .I /etc/e2fsck.conf
 208 The configuration file for
 209 .BR e2fsck (8).
 210 .SH SEE ALSO
 211 .BR e2fsck (8)