X-Git-Url: https://git.whamcloud.com/?a=blobdiff_plain;f=e2fsck%2Fe2fsck.conf.5.in;h=48ad0fde1a6bcf7d5614c1d38e319ab7760379d7;hb=0320e063baa2a97c6b6e4f7cede95ce95facdb9e;hp=94525baf0e318caf7f36404b7e9f8f929d4746fd;hpb=0b76d709f459eb0bca0d453289defc297a64f581;p=tools%2Fe2fsprogs.git

diff --git a/e2fsck/e2fsck.conf.5.in b/e2fsck/e2fsck.conf.5.in
index 94525ba..48ad0fd 100644
--- a/e2fsck/e2fsck.conf.5.in
+++ b/e2fsck/e2fsck.conf.5.in
@@ -1,26 +1,26 @@
 .\" -*- nroff -*-
 .\" Copyright 2006 by Theodore Ts'o.  All Rights Reserved.
 .\" This file may be copied under the terms of the GNU Public License.
-.\" 
+.\"
 .TH e2fsck.conf 5 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
 .SH NAME
 e2fsck.conf \- Configuration file for e2fsck
 .SH DESCRIPTION
 .I e2fsck.conf
-is the configuration file for 
-.BR e2fsck (8).  
-It controls the default behavior of 
+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.
 .PP
 The
 .I e2fsck.conf
-file uses an INI-style format.  Stanzas, or top-level sections, are 
-delimited by square braces: [ ].  Within each section, each line 
+file uses an INI-style format.  Stanzas, or top-level sections, are
+delimited by square braces: [ ].  Within each section, each line
 defines a relation, which assigns tags to values, or to a subsection,
-which contains further relations or subsections.   
+which contains further relations or subsections.
 .\" Tags can be assigned multiple values
-An example of the INI-style format used by this configuration file 
+An example of the INI-style format used by this configuration file
 follows below:
 .P
 	[section1]
@@ -49,26 +49,32 @@ follows below:
 .br
 	}
 .P
-Comments are delimited by a semicolon (';') or a hash ('#') character 
-at the beginning of the comment, and are terminated by the end of 
+Comments are delimited by a semicolon (';') or a hash ('#') character
+at the beginning of the comment, and are terminated by the end of
 line character.
 .P
 Tags and values must be quoted using double quotes if they contain
-spaces.  Within a quoted string, the standard backslash interpretations 
-apply: "\en" (for the newline character), 
-"\et" (for the tab character), "\eb" (for the backspace character), 
+spaces.  Within a quoted string, the standard backslash interpretations
+apply: "\en" (for the newline character),
+"\et" (for the tab character), "\eb" (for the backspace character),
 and "\e\e" (for the backslash character).
 .P
-The following stanzas are used in the 
+The following stanzas are used in the
 .I e2fsck.conf
 file.  They will be described in more detail in future sections of this
 document.
-.TP 
+.TP
 .I [options]
-This stanza contains general configuration parameters for 
+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.
@@ -77,12 +83,12 @@ various filesystem inconsistencies.
 @TDB_MAN_COMMENT@This stanza controls when e2fsck will attempt to use
 @TDB_MAN_COMMENT@scratch files to reduce the need for memory.
 .SH THE [options] STANZA
-The following relations are defined in the 
+The following relations are defined in the
 .I [options]
 stanza.
 .TP
 .I allow_cancellation
-If this relation is set to a boolean value of true, then if the user 
+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
 as containing errors, e2fsck will exit with an exit status of 0 instead
 of 32.  This setting defaults to false.
@@ -135,16 +141,16 @@ we changed the default, we also renamed this boolean relation to
 .IR accept_time_fudge.
 .TP
 .I clear_test_fs_flag
-This boolean relation controls whether or not 
+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
 defaults to true.
-.TP 
+.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 
-be doubled if the system is running on battery.  This setting defaults to 
+This boolean relation controls whether or not the interval between
+filesystem 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 indexed_dir_slack_percentage
@@ -157,10 +163,21 @@ the average fill ratio of directories can be maintained at a
 higher, more efficient level.  This relation defaults to 20
 percent.
 .TP
+.I inode_count_fullmap
+If this boolean relation is true, trade off using memory for speed when
+checking a file system with a large number of hard-linked files.  The
+amount of memory required is proportional to the number of inodes in the
+file system.  For large file systems, this can be gigabytes of memory.
+(For example a 40TB file system with 2.8 billion inodes will consume an
+additional 5.7 GB memory if this optimization is enabled.)  This setting
+defaults to false.
+.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.
@@ -169,17 +186,17 @@ 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.
@@ -206,8 +223,18 @@ of that type are squelched.  This can be useful if the console is slow
 end up delaying the boot process for a long time (potentially hours).
 .TP
 .I no_optimize_extents
-Do not offer to optimize the extent tree by eliminating unnecessary
-width or depth.
+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
@@ -241,16 +268,29 @@ 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] 
+.I [problems]
 stanza names a problem code specified with a leading "0x" followed by
-six hex digits.   
+six hex digits.
 The value of the tag is a subsection where the relations in that
-subsection override the default treatment of that particular problem 
+subsection override the default treatment of that particular problem
 code.
 .P
-Note that inappropriate settings in this stanza may cause 
+Note that inappropriate settings in this stanza may cause
 .B e2fsck
 to behave incorrectly, or even crash.  Most system administrators should
 not be making changes to this section without referring to source code.
@@ -262,13 +302,13 @@ This relation allows the message which is printed when this filesystem
 inconsistency is detected to be overridden.
 .TP
 .I preen_ok
-This boolean relation overrides the default behavior controlling 
+This boolean relation overrides the default behavior controlling
 whether this filesystem problem should be automatically fixed when
 .B e2fsck
 is running in preen mode.
 .TP
 .I max_count
-This integer relation overrides the 
+This integer relation overrides the
 .I max_count_problems
 parameter (set in the options section) for this particular problem.
 .TP
@@ -278,18 +318,18 @@ whether or not the filesystem will be marked as inconsistent if the user
 declines to fix the reported problem.
 .TP
 .I no_default
-This boolean relation overrides whether the default answer for this 
+This boolean relation overrides whether the default answer for this
 problem (or question) should be "no".
-.TP 
+.TP
 .I preen_nomessage
-This boolean relation overrides the default behavior controlling 
+This boolean relation overrides the default behavior controlling
 whether or not the description for this filesystem problem should
 be suppressed when
 .B e2fsck
 is running in preen mode.
 .TP
 .I no_nomsg
-This boolean relation overrides the default behavior controlling 
+This boolean relation overrides the default behavior controlling
 whether or not the description for this filesystem problem should
 be suppressed when a problem forced not to be fixed, either because
 .B e2fsck
@@ -327,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 filesystem
 @TDB_MAN_COMMENT@are fewer than amount specified.
 @TDB_MAN_COMMENT@.TP
 @TDB_MAN_COMMENT@.I dirinfo
@@ -404,7 +444,7 @@ The name of the user running e2fsck.
 .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)
@@ -455,7 +495,7 @@ no more than 16 instances of each type of file system corruption.
 .SH FILES
 .TP
 .I /etc/e2fsck.conf
-The configuration file for 
+The configuration file for
 .BR e2fsck (8).
 .SH SEE ALSO
 .BR e2fsck (8)