Whamcloud - gitweb
e2fsck, tune2fs: fix post-2038 support for s_lastcheck
[tools/e2fsprogs.git] / e2fsck / e2fsck.conf.5.in
index a727932..e82610d 100644 (file)
@@ -11,7 +11,7 @@ is the configuration file for
 .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
@@ -69,9 +69,15 @@ This stanza contains general configuration parameters for
 .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
@@ -83,7 +89,7 @@ stanza.
 .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
@@ -138,12 +144,12 @@ we changed the default, we also renamed this boolean relation to
 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
@@ -169,7 +175,9 @@ defaults to false.
 .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.
@@ -218,6 +226,16 @@ end up delaying the boot process for a long time (potentially hours).
 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
@@ -230,7 +248,7 @@ for more details.
 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
@@ -250,6 +268,19 @@ If this boolean relation is true, e2fsck will run as if the option
 .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]
@@ -267,12 +298,12 @@ not be making changes to this section without referring to source code.
 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
@@ -283,7 +314,7 @@ parameter (set in the options section) for this particular problem.
 .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
@@ -292,14 +323,14 @@ problem (or question) should be "no".
 .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
@@ -336,7 +367,7 @@ data structure, such as pruning an extent tree.
 @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
@@ -422,7 +453,7 @@ 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