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