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