.BR e2fsck (8).
It controls the default behavior of
.BR e2fsck (8)
-while it is checking ext2, ext3, or ext4 filesystems.
+while it is checking ext2, ext3, or ext4 file systems.
.PP
The
.I e2fsck.conf
.BR e2fsck 's
behavior.
.TP
+.I [defaults]
+Contains relations which define the default parameters used by
+.BR e2fsck (8).
+In general, these defaults may be overridden by command-line options
+provided by the user.
+.TP
.I [problems]
This stanza allows the administrator to reconfigure how e2fsck handles
-various filesystem inconsistencies.
+various file system inconsistencies.
@TDB_MAN_COMMENT@.TP
@TDB_MAN_COMMENT@.I [scratch_files]
@TDB_MAN_COMMENT@This stanza controls when e2fsck will attempt to use
.TP
.I allow_cancellation
If this relation is set to a boolean value of true, then if the user
-interrupts e2fsck using ^C, and the filesystem is not explicitly flagged
+interrupts e2fsck using ^C, and the file system is not explicitly flagged
as containing errors, e2fsck will exit with an exit status of 0 instead
of 32. This setting defaults to false.
.TP
This boolean relation controls whether or not
.BR e2fsck (8)
will offer to clear
-the test_fs flag if the ext4 filesystem is available on the system. It
+the test_fs flag if the ext4 file system is available on the system. It
defaults to true.
.TP
.I defer_check_on_battery
This boolean relation controls whether or not the interval between
-filesystem checks (either based on time or number of mounts) should
+file system checks (either based on time or number of mounts) should
be doubled if the system is running on battery. This setting defaults to
true.
.TP
.I log_dir
If the
.I log_filename
-relation contains a relative pathname, then the log file will be placed
+or
+.I problem_log_filename
+relations contains a relative pathname, then the log file will be placed
in the directory named by the
.I log_dir
relation.
This relation contains an alternate directory that will be used if the
directory specified by
.I log_dir
-is not available or is not writeable.
+is not available or is not writable.
.TP
.I log_dir_wait
If this boolean relation is true, them if the directories specified by
.I log_dir
or
.I log_dir_fallback
-are not available or are not yet writeable, e2fsck will save the output
+are not available or are not yet writable, e2fsck will save the output
in a memory buffer, and a child process will periodically test to see if
the log directory has become available after the boot sequence has
-mounted the requiste file system for reading/writing. This implements the
+mounted the requested file system for reading/writing. This implements the
functionality provided by
.BR logsave (8)
for e2fsck log files.
If this boolean relation is true, do not offer to optimize the extent
tree by reducing the tree's width or depth. This setting defaults to false.
.TP
+.I problem_log_filename
+This relation specifies the file name where a log of problem codes
+found by e2fsck be written. The filename may contain various
+percent-expressions (%D, %T, %N,
+etc.) which will be expanded so that the file name for the log file can
+include things like date, time, device name, and other run-time
+parameters. See the
+.B LOGGING
+section for more details.
+.TP
.I readahead_mem_pct
Use this percentage of memory to try to read in metadata blocks ahead of the
main e2fsck thread. This should reduce run times, depending on the speed of
Use this amount of memory to read in metadata blocks ahead of the main checking
thread. Setting this value to zero disables readahead entirely. By default,
this is set the size of two block groups' inode tables (typically 4MiB on a
-regular ext4 filesystem); if this amount is more than 1/50th of total physical
+regular ext4 file system); if this amount is more than 1/50th of total physical
memory, readahead is disabled.
.TP
.I report_features
.B -v
is always specified. This will cause e2fsck to print some additional
information at the end of each full file system check.
+.SH THE [defaults] STANZA
+The following relations are defined in the
+.I [defaults]
+stanza.
+.TP
+.I undo_dir
+This relation specifies the directory where the undo file should be
+stored. It can be overridden via the
+.B E2FSPROGS_UNDO_DIR
+environment variable. If the directory location is set to the value
+.IR none ,
+.B e2fsck
+will not create an undo file.
.SH THE [problems] STANZA
Each tag in the
.I [problems]
Within each problem code's subsection, the following tags may be used:
.TP
.I description
-This relation allows the message which is printed when this filesystem
+This relation allows the message which is printed when this file system
inconsistency is detected to be overridden.
.TP
.I preen_ok
This boolean relation overrides the default behavior controlling
-whether this filesystem problem should be automatically fixed when
+whether this file system problem should be automatically fixed when
.B e2fsck
is running in preen mode.
.TP
.TP
.I no_ok
This boolean relation overrides the default behavior determining
-whether or not the filesystem will be marked as inconsistent if the user
+whether or not the file system will be marked as inconsistent if the user
declines to fix the reported problem.
.TP
.I no_default
.TP
.I preen_nomessage
This boolean relation overrides the default behavior controlling
-whether or not the description for this filesystem problem should
+whether or not the description for this file system problem should
be suppressed when
.B e2fsck
is running in preen mode.
.TP
.I no_nomsg
This boolean relation overrides the default behavior controlling
-whether or not the description for this filesystem problem should
+whether or not the description for this file system problem should
be suppressed when a problem forced not to be fixed, either because
.B e2fsck
is run with the
@TDB_MAN_COMMENT@.TP
@TDB_MAN_COMMENT@.I numdirs_threshold
@TDB_MAN_COMMENT@If this relation is set, then in-memory data structures
-@TDB_MAN_COMMENT@be used if the number of directories in the filesystem
+@TDB_MAN_COMMENT@will be used if the number of directories in the file system
@TDB_MAN_COMMENT@are fewer than amount specified.
@TDB_MAN_COMMENT@.TP
@TDB_MAN_COMMENT@.I dirinfo
.B %U
This percent expression does not expand to anything, but it signals that
any following date or time expressions should be expressed in UTC time
-instead of the local timzeone.
+instead of the local timezone.
.TP
.B %y
The last two digits of the current year (00..99)
The current year (i.e., 2012).
.SH EXAMPLES
The following recipe will prevent e2fsck from aborting during the boot
-process when a filesystem contains orphaned files. (Of course, this is
+process when a file system contains orphaned files. (Of course, this is
not always a good idea, since critical files that are needed for the
security of the system could potentially end up in lost+found, and
starting the system without first having a system administrator check
git://git.whamcloud.com / tools / e2fsprogs.git / blobdiff