manual/e2fsprogs/original/man5/e2fsck.conf.5

   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 "May 2006" "E2fsprogs version 1.39"
   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 parameters used by
  13 .BR e2fsck (8)
  14 when it is creating 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 .I [problems]
  72 This stanza allows the administrator to reconfigure how e2fsck handles
  73 various filesystem inconsistencies.
  74 .SH THE [options] STANZA
  75 The following relations are defined in the
  76 .I [options]
  77 stanza.
  78 .TP
  79 .I allow_cancellation
  80 If this relation is set to a boolean value of true, then if the user
  81 interrupts e2fsck using ^C, and the filesystem is not explicitly flagged
  82 as containing errors, e2fsck will exit with an exit status of 0 instead
  83 of 32.  This setting defaults to false.
  84 .TP
  85 .I defer_check_on_battery
  86 This boolean relation controls whether or not the interval between
  87 filesystem checks (either based on time or number of mounts) should
  88 be doubled if the system is running on battery.  It defaults to
  89 true.
  90 .SH THE [problems] STANZA
  91 Each tag in the
  92 .I [problems]
  93 stanza names a problem code specified with a leading "0x" followed by
  94 six hex digits.
  95 The value of the tag is a subsection where the relations in that
  96 subsection override the default treatment of that particular problem
  97 code.
  98 .P
  99 Note that inappropriate settings in this stanza may cause
 100 .B e2fsck
 101 to behave incorrectly, or even crash.  Most system administrators should
 102 not be making changes to this section without referring to source code.
 103 .P
 104 Within each problem code's subsection, the following tags may be used:
 105 .TP
 106 .I description
 107 This relation allows the message which is printed when this filesystem
 108 inconsistency is detected to be overridden.
 109 .TP
 110 .I preen_ok
 111 This boolean relation overrides the default behavior controlling
 112 whether this filesystem problem should be automatically fixed when
 113 .B e2fsck
 114 is running in preen mode.
 115 .TP
 116 .I no_ok
 117 This boolean relation overrides the default behavior determining
 118 whether or not the filesystem will be marked as inconsistent if the user
 119 declines to fix the reported problem.
 120 .TP
 121 .I no_default
 122 This boolean relation overrides whether the default answer for this
 123 problem (or question) should be "no".
 124 .TP
 125 .I preen_nomessage
 126 This boolean relation overrides the default behavior controlling
 127 whether or not the description for this filesystem problem should
 128 be suppressed when
 129 .B e2fsck
 130 is running in preen mode.
 131 .TP
 132 .I no_nomsg
 133 This boolean relation overrides the default behavior controlling
 134 whether or not the description for this filesystem problem should
 135 be suppressed when
 136 .B e2fsck
 137 is run with the
 138 .B -n
 139 option.
 140 .SH EXAMPLES
 141 The following recipe will prevent e2fsck from aborting during the boot
 142 process when a filesystem contains orphaned files.  (Of course, this is
 143 not always a good idea, since critical files that are needed for the
 144 security of the system could potentially end up in lost+found, and
 145 starting the system without first having a system administrator check
 146 things out may be dangerous.)
 147 .P
 148 .br
 149         [problems]
 150 .br
 151                 0x040002 = {
 152 .br
 153                         preen_ok = true
 154 .br
 155                         description = "@u @i %i.  "
 156 .br
 157                 }
 158 .SH FILES
 159 .TP
 160 .I /etc/e2fsck.conf
 161 The configuration file for
 162 .BR e2fsck (8).
 163 .SH SEE ALSO
 164 .BR e2fsck (8)