From d04ad325f00b265b62c3e81e53bcd67161c0315b Mon Sep 17 00:00:00 2001 From: Theodore Ts'o Date: Fri, 4 Aug 2017 01:51:50 -0400 Subject: [PATCH] Remove spaces at the end of man pages Addresses-Debian-Bug: #865584 Signed-off-by: Theodore Ts'o --- e2fsck/e2fsck.8.in | 142 ++++++++++++++++---------------- e2fsck/e2fsck.conf.5.in | 68 ++++++++-------- ext2ed/ext2ed.8.in | 2 +- lib/uuid/uuid.3.in | 4 +- lib/uuid/uuid_compare.3.in | 6 +- lib/uuid/uuid_generate.3.in | 16 ++-- lib/uuid/uuid_time.3.in | 6 +- lib/uuid/uuid_unparse.3.in | 10 +-- misc/badblocks.8.in | 46 +++++------ misc/dumpe2fs.8.in | 18 ++-- misc/e2label.8.in | 18 ++-- misc/filefrag.8.in | 4 +- misc/findfs.8.in | 10 +-- misc/fsck.8.in | 158 ++++++++++++++++++------------------ misc/logsave.8.in | 18 ++-- misc/mke2fs.8.in | 4 +- misc/mklost+found.8.in | 2 +- misc/tune2fs.8.in | 118 +++++++++++++-------------- misc/uuidgen.1.in | 24 +++--- 19 files changed, 337 insertions(+), 337 deletions(-) diff --git a/e2fsck/e2fsck.8.in b/e2fsck/e2fsck.8.in index 4ad575f40..786eb15e7 100644 --- a/e2fsck/e2fsck.8.in +++ b/e2fsck/e2fsck.8.in @@ -1,7 +1,7 @@ .\" -*- nroff -*- .\" Copyright 1993, 1994, 1995 by Theodore Ts'o. All Rights Reserved. .\" This file may be copied under the terms of the GNU Public License. -.\" +.\" .TH E2FSCK 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" .SH NAME e2fsck \- check a Linux ext2/ext3/ext4 file system @@ -41,7 +41,7 @@ e2fsck \- check a Linux ext2/ext3/ext4 file system .I device .SH DESCRIPTION .B e2fsck -is used to check the ext2/ext3/ext4 family of file systems. +is used to check the ext2/ext3/ext4 family of file systems. For ext3 and ext4 filesystems that use a journal, if the system has been shut down uncleanly without any errors, normally, after replaying the committed transactions in the journal, the file system should be @@ -51,7 +51,7 @@ will normally replay the journal and exit, unless its superblock indicates that further checking is required. .PP .I device -is a block device (e.g., +is a block device (e.g., .IR /dev/sdc1 ) or file containing the file system. .PP @@ -59,18 +59,18 @@ Note that in general it is not safe to run .B e2fsck on mounted filesystems. The only exception is if the .B \-n -option is specified, and -.BR \-c , +option is specified, and +.BR \-c , .BR \-l , or .B -L -options are +options are .I not specified. However, even if it is safe to do so, the results printed by .B e2fsck -are not valid if the filesystem is mounted. If +are not valid if the filesystem is mounted. If .B e2fsck -asks whether or not you should check a filesystem which is mounted, +asks whether or not you should check a filesystem which is mounted, the only correct answer is ``no''. Only experts who really know what they are doing should consider answering this question in any other way. .PP @@ -88,56 +88,56 @@ Enter will proceed with the default response, which is printed before the question mark. Pressing Control-C terminates e2fsck immediately. .SH OPTIONS .TP -.B \-a -This option does the same thing as the +.B \-a +This option does the same thing as the .B \-p option. It is provided for backwards compatibility only; it is -suggested that people use -.B \-p +suggested that people use +.B \-p option whenever possible. .TP .BI \-b " superblock" Instead of using the normal superblock, use an alternative superblock -specified by +specified by .IR superblock . This option is normally used when the primary superblock has been corrupted. The location of the backup superblock is dependent on the filesystem's blocksize. For filesystems with 1k blocksizes, a backup superblock can be found at block 8193; for filesystems with 2k -blocksizes, at block 16384; and for 4k blocksizes, at block 32768. +blocksizes, at block 16384; and for 4k blocksizes, at block 32768. .IP -Additional backup superblocks can be determined by using the -.B mke2fs -program using the +Additional backup superblocks can be determined by using the +.B mke2fs +program using the .B \-n -option to print out where the superblocks were created. The -.B \-b -option to +option to print out where the superblocks were created. The +.B \-b +option to .BR mke2fs , which specifies blocksize of the filesystem must be specified in order for the superblock locations that are printed out to be accurate. .IP -If an alternative superblock is specified and +If an alternative superblock is specified and the filesystem is not opened read-only, e2fsck will make sure that the -primary superblock is updated appropriately upon completion of the +primary superblock is updated appropriately upon completion of the filesystem check. .TP .BI \-B " blocksize" -Normally, +Normally, .B e2fsck will search for the superblock at various different block sizes in an attempt to find the appropriate block size. -This search can be fooled in some cases. This option forces +This search can be fooled in some cases. This option forces .B e2fsck to only try locating the superblock at a particular blocksize. -If the superblock is not found, -.B e2fsck +If the superblock is not found, +.B e2fsck will terminate with a fatal error. .TP .B \-c -This option causes -.B e2fsck -to use +This option causes +.B e2fsck +to use .BR badblocks (8) program to do a read-only scan of the device in order to find any bad blocks. If any bad blocks are found, they are added to the bad block @@ -148,9 +148,9 @@ using a non-destructive read-write test. .BI \-C " fd" This option causes .B e2fsck -to write completion information to the specified file descriptor -so that the progress of the filesystem -check can be monitored. This option is typically used by programs +to write completion information to the specified file descriptor +so that the progress of the filesystem +check can be monitored. This option is typically used by programs which are running .BR e2fsck . If the file descriptor number is negative, then absolute value of @@ -158,7 +158,7 @@ the file descriptor will be used, and the progress information will be suppressed initially. It can later be enabled by sending the .B e2fsck process a SIGUSR1 signal. -If the file descriptor specified is 0, +If the file descriptor specified is 0, .B e2fsck will print a completion bar as it goes about its business. This requires that e2fsck is running on a video console or terminal. @@ -194,14 +194,14 @@ directory, which e2fsck normally does not enforce for performance reasons. .TP .BI \-E " extended_options" Set e2fsck extended options. Extended options are comma -separated, and may take an argument using the equals ('=') sign. The +separated, and may take an argument using the equals ('=') sign. The following options are supported: .RS 1.2i .TP .BI ea_ver= extended_attribute_version Set the version of the extended attribute blocks which .B e2fsck -will require while checking the filesystem. The version number may +will require while checking the filesystem. The version number may be 1 or 2. The default extended attribute version format is 2. .TP .BI journal_only @@ -251,8 +251,8 @@ Force checking even if the file system seems clean. .TP .B \-F Flush the filesystem device's buffer caches before beginning. Only -really useful for doing -.B e2fsck +really useful for doing +.B e2fsck time trials. @JDEV@.TP @JDEV@.BI \-j " external-journal" @@ -260,35 +260,35 @@ time trials. @JDEV@found. .TP .BI \-k -When combined with the +When combined with the .B \-c option, any existing bad blocks in the bad blocks list are preserved, and any new bad blocks found by running -.BR badblocks (8) +.BR badblocks (8) will be added to the existing bad blocks list. .TP .BI \-l " filename" -Add the block numbers listed in the file specified by +Add the block numbers listed in the file specified by .I filename to the list of bad blocks. The format of this file is the same as the -one generated by the +one generated by the .BR badblocks (8) program. Note that the block numbers are based on the blocksize -of the filesystem. Hence, +of the filesystem. Hence, .BR badblocks (8) must be given the blocksize of the filesystem in order to obtain correct -results. As a result, it is much simpler and safer to use the +results. As a result, it is much simpler and safer to use the .B -c -option to +option to .BR e2fsck , since it will assure that the correct parameters are passed to the .B badblocks program. .TP .BI \-L " filename" -Set the bad blocks list to be the list of blocks specified by +Set the bad blocks list to be the list of blocks specified by .IR filename . -(This option is the same as the +(This option is the same as the .B \-l option, except the bad blocks list is cleared before the blocks listed in the file are added to the bad blocks list.) @@ -298,7 +298,7 @@ Open the filesystem read-only, and assume an answer of `no' to all questions. Allows .B e2fsck to be used non-interactively. This option -may not be specified at the same time as the +may not be specified at the same time as the .B \-p or .B \-y @@ -309,14 +309,14 @@ Automatically repair ("preen") the file system. This option will cause .B e2fsck to automatically fix any filesystem problems that can be safely fixed without human -intervention. If +intervention. If .B e2fsck discovers a problem which may require the system administrator -to take additional corrective action, +to take additional corrective action, .B e2fsck will print a description of the problem and then exit with the value 4 logically or'ed into the exit code. (See the \fBEXIT CODE\fR section.) -This option is normally used by the system's boot scripts. It may not +This option is normally used by the system's boot scripts. It may not be specified at the same time as the .B \-n or @@ -340,10 +340,10 @@ Verbose mode. Print version information and exit. .TP .B \-y -Assume an answer of `yes' to all questions; allows +Assume an answer of `yes' to all questions; allows .B e2fsck to be used non-interactively. This option -may not be specified at the same time as the +may not be specified at the same time as the .B \-n or .B \-p @@ -382,26 +382,26 @@ is the sum of the following conditions: \ 128\ \-\ Shared library error .br .SH SIGNALS -The following signals have the following effect when sent to +The following signals have the following effect when sent to .BR e2fsck . .TP .B SIGUSR1 This signal causes .B e2fsck -to start displaying a completion bar or emitting progress information. -(See discussion of the +to start displaying a completion bar or emitting progress information. +(See discussion of the .B \-C option.) .TP .B SIGUSR2 This signal causes -.B e2fsck +.B e2fsck to stop displaying a completion bar or emitting progress information. .SH REPORTING BUGS Almost any piece of software will have bugs. If you manage to find a -filesystem which causes +filesystem which causes .B e2fsck -to crash, or which +to crash, or which .B e2fsck is unable to repair, please report it to the author. .PP @@ -409,10 +409,10 @@ Please include as much information as possible in your bug report. Ideally, include a complete transcript of the .B e2fsck run, so I can see exactly what error messages are displayed. (Make sure -the messages printed by -.B e2fsck +the messages printed by +.B e2fsck are in English; if your system has been -configured so that +configured so that .BR e2fsck 's messages have been translated into another language, please set the the .B LC_ALL @@ -420,38 +420,38 @@ environment variable to .B C so that the transcript of e2fsck's output will be useful to me.) If you -have a writable filesystem where the transcript can be stored, the +have a writable filesystem where the transcript can be stored, the .BR script (1) program is a handy way to save the output of .B e2fsck to a file. .PP -It is also useful to send the output of +It is also useful to send the output of .BR dumpe2fs (8). -If a specific inode or inodes seems to be giving -.B e2fsck +If a specific inode or inodes seems to be giving +.B e2fsck trouble, try running the .BR debugfs (8) -command and send the output of the +command and send the output of the .BR stat (1u) -command run on the relevant inode(s). If the inode is a directory, the +command run on the relevant inode(s). If the inode is a directory, the .B debugfs .I dump command will allow you to extract the contents of the directory inode, which can sent to me after being first run through -.BR uuencode (1). +.BR uuencode (1). The most useful data you can send to help reproduce the bug is a compressed raw image dump of the filesystem, generated using .BR e2image (8). -See the +See the .BR e2image (8) man page for more details. .PP -Always include the full version string which +Always include the full version string which .B e2fsck displays when it is run, so I know which version you are running. .SH AUTHOR -This version of +This version of .B e2fsck was written by Theodore Ts'o . .SH SEE ALSO diff --git a/e2fsck/e2fsck.conf.5.in b/e2fsck/e2fsck.conf.5.in index 94525baf0..fbde7ef0b 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,23 +49,23 @@ 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 @@ -77,12 +77,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 +135,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 @@ -243,14 +243,14 @@ is always specified. This will cause e2fsck to print some additional information at the end of each full file system check. .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 +262,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 +278,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 @@ -455,7 +455,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) diff --git a/ext2ed/ext2ed.8.in b/ext2ed/ext2ed.8.in index b5d6b333c..008a125db 100644 --- a/ext2ed/ext2ed.8.in +++ b/ext2ed/ext2ed.8.in @@ -6,7 +6,7 @@ ext2ed \- ext2 file system editor .B ext2ed .SH DESCRIPTION .B ext2ed -in an +in an .B editor for the .B second extended filesystem. diff --git a/lib/uuid/uuid.3.in b/lib/uuid/uuid.3.in index 18760fe3c..1c51bd067 100644 --- a/lib/uuid/uuid.3.in +++ b/lib/uuid/uuid.3.in @@ -35,10 +35,10 @@ uuid \- DCE compatible Universally Unique Identifier library .SH SYNOPSIS .B #include .SH DESCRIPTION -The UUID library is used to generate unique identifiers for objects +The UUID library is used to generate unique identifiers for objects that may be accessible beyond the local system. This library generates UUIDs compatible with those created by the Open Software -Foundation (OSF) Distributed Computing Environment (DCE) utility +Foundation (OSF) Distributed Computing Environment (DCE) utility .BR uuidgen . .sp The UUIDs generated by this library can be reasonably expected to be diff --git a/lib/uuid/uuid_compare.3.in b/lib/uuid/uuid_compare.3.in index 7f3296320..4807f3a8e 100644 --- a/lib/uuid/uuid_compare.3.in +++ b/lib/uuid/uuid_compare.3.in @@ -45,10 +45,10 @@ function compares the two supplied uuid variables .IR uu1 " and " uu2 to each other. .SH RETURN VALUE -Returns an integer less than, equal to, or greater than zero if +Returns an integer less than, equal to, or greater than zero if .I uu1 -is found, respectively, to be lexigraphically less than, equal, or -greater than +is found, respectively, to be lexigraphically less than, equal, or +greater than .IR uu2 . .SH AUTHOR Theodore Y. Ts'o diff --git a/lib/uuid/uuid_generate.3.in b/lib/uuid/uuid_generate.3.in index 998e04298..f44900cde 100644 --- a/lib/uuid/uuid_generate.3.in +++ b/lib/uuid/uuid_generate.3.in @@ -44,18 +44,18 @@ uuid_generate, uuid_generate_random, uuid_generate_time \- create a new unique U The .B uuid_generate function creates a new universally unique identifier (UUID). The uuid will -be generated based on high-quality randomness from -.IR /dev/urandom , -if available. If it is not available, then -.B uuid_generate +be generated based on high-quality randomness from +.IR /dev/urandom , +if available. If it is not available, then +.B uuid_generate will use an alternative algorithm which uses the current time, the local ethernet MAC address (if available), and random data generated using a pseudo-random generator. .sp -The +The .B uuid_generate_random function forces the use of the all-random UUID format, even if -a high-quality random number generator (i.e., +a high-quality random number generator (i.e., .IR /dev/urandom ) is not available, in which case a pseudo-random generator will be subsituted. Note that the use of a pseudo-random @@ -63,7 +63,7 @@ generator may compromise the uniqueness of UUID's generated in this fashion. .sp The -.B uuid_generate_time +.B uuid_generate_time function forces the use of the alternative algorithm which uses the current time and the local ethernet MAC address (if available). This algorithm used to be the default one used to generate UUID, but @@ -72,7 +72,7 @@ information about when and where the UUID was generated. This can cause privacy problems in some applications, so the .B uuid_generate function only uses this algorithm if a high-quality source of -randomness is not available. +randomness is not available. .sp The UUID is 16 bytes (128 bits) long, which gives approximately 3.4x10^38 unique values (there are approximately 10^80 elemntary particles in diff --git a/lib/uuid/uuid_time.3.in b/lib/uuid/uuid_time.3.in index 2a4c7000e..2c8ef5b79 100644 --- a/lib/uuid/uuid_time.3.in +++ b/lib/uuid/uuid_time.3.in @@ -43,9 +43,9 @@ The .B uuid_time function extracts the time at which the supplied time-based UUID .I uu -was created. Note that the UUID creation time is only encoded within -certain types of UUIDs. This function can only reasonably expect to -extract the creation time for UUIDs created with the +was created. Note that the UUID creation time is only encoded within +certain types of UUIDs. This function can only reasonably expect to +extract the creation time for UUIDs created with the .BR uuid_generate_time (3) function. It may or may not work with UUIDs created by other mechanisms. .SH "RETURN VALUES" diff --git a/lib/uuid/uuid_unparse.3.in b/lib/uuid/uuid_unparse.3.in index 0e8384515..e8ca9de5f 100644 --- a/lib/uuid/uuid_unparse.3.in +++ b/lib/uuid/uuid_unparse.3.in @@ -46,18 +46,18 @@ The function converts the supplied UUID .I uu from the binary representation into a 36\-byte string (plus tailing '\\0') -of the form 1b4e28ba\-2fa1\-11d2\-883f\-0016d3cca427 and stores this +of the form 1b4e28ba\-2fa1\-11d2\-883f\-0016d3cca427 and stores this value in the character string pointed to by -.IR out . -The case of the hex digits returned by +.IR out . +The case of the hex digits returned by .B uuid_unparse may be upper or lower case, and is -dependent on the system-dependent local default. +dependent on the system-dependent local default. .PP If the case of the hex digits is important then the functions .B uuid_unparse_upper -and +and .B uuid_unparse_lower may be used. .SH "CONFORMING TO" diff --git a/misc/badblocks.8.in b/misc/badblocks.8.in index c0b9ff163..ca4359382 100644 --- a/misc/badblocks.8.in +++ b/misc/badblocks.8.in @@ -60,25 +60,25 @@ for the test, which allows the testing to start in the middle of the disk. If it is not specified the first block on the disk is used as a default. .PP .B Important note: -If the output of +If the output of .B badblocks is going to be fed to the .B e2fsck -or +or .B mke2fs programs, it is important that the block size is properly specified, -since the block numbers which are generated are very dependent on the -block size in use by the filesystem. +since the block numbers which are generated are very dependent on the +block size in use by the filesystem. For this reason, it is strongly recommended that -users +users .B not -run -.B badblocks -directly, but rather use the +run +.B badblocks +directly, but rather use the .B \-c option of the .B e2fsck -and +and .B mke2fs programs. .SH OPTIONS @@ -93,7 +93,7 @@ is the number of blocks which are tested at a time. The default is 64. This parameter, if passed and non-zero, will cause bad blocks to sleep between reads if there were no errors encountered in the read operation; the delay will be calculated as a percentage of the time it -took for the read operation to be performed. In other words, a value of +took for the read operation to be performed. In other words, a value of 100 will cause each read to be delayed by the amount the previous read took, and a value of 200 by twice the amount. .TP @@ -109,9 +109,9 @@ potentially crash and/or damage the filesystem even if it is mounted read-only. This can be overridden using the .B \-f flag, but should almost never be used --- if you think you're smarter -than the +than the .B badblocks -program, you almost certainly aren't. The only time when this option +program, you almost certainly aren't. The only time when this option might be safe to use is if the /etc/mtab file is incorrect, and the device really isn't mounted. .TP @@ -132,8 +132,8 @@ can be used to retrieve the list of blocks currently marked bad on an existing filesystem, in a format suitable for use with this option. .TP .B \-n -Use non-destructive read-write mode. By default only a non-destructive -read-only test is done. This option must not be combined with the +Use non-destructive read-write mode. By default only a non-destructive +read-only test is done. This option must not be combined with the .B \-w option, as they are mutually exclusive. .TP @@ -144,7 +144,7 @@ displays the list on its standard output. The format of this file is suitable for use by the . .B \-l -option in +option in .BR e2fsck (8) or .BR mke2fs (8). @@ -168,7 +168,7 @@ option is requested by the user. .BI \-t " test_pattern" Specify a test pattern to be read (and written) to disk blocks. The .I test_pattern -may either be a numeric value between 0 and ULONG_MAX-1 inclusive, or the word +may either be a numeric value between 0 and ULONG_MAX-1 inclusive, or the word "random", which specifies that the block should be filled with a random bit pattern. For read/write (\fB-w\fR) and non-destructive (\fB-n\fR) modes, @@ -178,9 +178,9 @@ option for each test pattern desired. For read-only mode only a single pattern may be specified and it may not be "random". Read-only testing with a pattern assumes that the specified pattern has previously been written to the disk - if not, large -numbers of blocks will fail verification. +numbers of blocks will fail verification. If multiple patterns -are specified then all blocks will be tested with one pattern +are specified then all blocks will be tested with one pattern before proceeding to the next pattern. .TP .B \-v @@ -191,9 +191,9 @@ corruptions to stderr. Use write-mode test. With this option, .B badblocks scans for bad blocks by writing some patterns (0xaa, 0x55, 0xff, 0x00) on -every block of the device, reading every block and comparing the contents. -This option may not be combined with the -.B \-n +every block of the device, reading every block and comparing the contents. +This option may not be combined with the +.B \-n option, as they are mutually exclusive. .TP .B \-B @@ -212,7 +212,7 @@ option on a device containing an existing file system. This option erases data! If you want to do write-mode testing on an existing file system, use the .B \-n -option instead. It is slower, but it will preserve your data. +option instead. It is slower, but it will preserve your data. .PP The .B \-e @@ -227,7 +227,7 @@ Theodore Ts'o . Non-destructive read/write test implemented by David Beattie . .SH AVAILABILITY .B badblocks -is part of the e2fsprogs package and is available from +is part of the e2fsprogs package and is available from http://e2fsprogs.sourceforge.net. .SH SEE ALSO .BR e2fsck (8), diff --git a/misc/dumpe2fs.8.in b/misc/dumpe2fs.8.in index 8d9a559d9..da78d4fc7 100644 --- a/misc/dumpe2fs.8.in +++ b/misc/dumpe2fs.8.in @@ -35,18 +35,18 @@ print the blocks which are reserved as bad in the filesystem. use the block .I superblock when examining the filesystem. -This option is not usually needed except by a filesystem wizard who +This option is not usually needed except by a filesystem wizard who is examining the remains of a very badly corrupted filesystem. .TP .B \-o blocksize=\fIblocksize use blocks of .I blocksize bytes when examining the filesystem. -This option is not usually needed except by a filesystem wizard who +This option is not usually needed except by a filesystem wizard who is examining the remains of a very badly corrupted filesystem. .TP .B \-f -force dumpe2fs to display a filesystem even though it may have some +force dumpe2fs to display a filesystem even though it may have some filesystem feature flags which dumpe2fs may not understand (and which can cause some of dumpe2fs's display to be suspect). .TP @@ -57,15 +57,15 @@ first block in the group; the superblock location (or -1 if not present); the range of blocks used by the group descriptors (or -1 if not present); the block bitmap location; the inode bitmap location; and the range of blocks used by the inode table. -.TP +.TP .B \-h only display the superblock information and not any of the block group descriptor detail information. .TP .B \-i -display the filesystem data from an image file created by +display the filesystem data from an image file created by .BR e2image , -using +using .I device as the pathname to the image file. .TP @@ -73,19 +73,19 @@ as the pathname to the image file. print the detailed group information block numbers in hexadecimal format .TP .B \-V -print the version number of +print the version number of .B dumpe2fs and exit. .SH BUGS You need to know the physical filesystem structure to understand the output. .SH AUTHOR -.B dumpe2fs +.B dumpe2fs was written by Remy Card . It is currently being maintained by Theodore Ts'o . .SH AVAILABILITY .B dumpe2fs -is part of the e2fsprogs package and is available from +is part of the e2fsprogs package and is available from http://e2fsprogs.sourceforge.net. .SH SEE ALSO .BR e2fsck (8), diff --git a/misc/e2label.8.in b/misc/e2label.8.in index 5d3a11338..2f457072a 100644 --- a/misc/e2label.8.in +++ b/misc/e2label.8.in @@ -15,37 +15,37 @@ e2label \- Change the label on an ext2/ext3/ext4 filesystem .B e2label will display or change the volume label on the ext2, ext3, or ext4 filesystem located on -.I device. +.I device. .PP -If the optional argument +If the optional argument .I volume-label -is not present, +is not present, .B e2label will simply display the current volume label. .PP If the optional argument .I volume-label -is present, then +is present, then .B e2label will set the volume label to be .IR volume-label . Ext2 volume labels can be at most 16 characters long; if .I volume-label -is longer than 16 characters, +is longer than 16 characters, .B e2label -will truncate it and print a warning message. +will truncate it and print a warning message. .PP It is also possible to set the volume label using the .B \-L -option of +option of .BR tune2fs (8). .PP .SH AUTHOR -.B e2label +.B e2label was written by Theodore Ts'o (tytso@mit.edu). .SH AVAILABILITY .B e2label -is part of the e2fsprogs package and is available from +is part of the e2fsprogs package and is available from http://e2fsprogs.sourceforge.net. .SH SEE ALSO .BR mke2fs (8), diff --git a/misc/filefrag.8.in b/misc/filefrag.8.in index a6d7b27cb..292b3b7d2 100644 --- a/misc/filefrag.8.in +++ b/misc/filefrag.8.in @@ -15,11 +15,11 @@ filefrag \- report on file fragmentation ] .SH DESCRIPTION .B filefrag -reports on how badly fragmented a particular file might be. It makes +reports on how badly fragmented a particular file might be. It makes allowances for indirect blocks for ext2 and ext3 filesystems, but can be used on files for any filesystem. .PP -The +The .B filefrag program initially attempts to get the extent information using FIEMAP ioctl which is more efficient and faster. diff --git a/misc/findfs.8.in b/misc/findfs.8.in index d44cbc7a2..3146e0c87 100644 --- a/misc/findfs.8.in +++ b/misc/findfs.8.in @@ -6,27 +6,27 @@ .SH NAME findfs \- Find a filesystem by label or UUID .SH SYNOPSIS -.B findfs +.B findfs .BI LABEL= label .sp .B findfs .BI UUID= uuid .SH DESCRIPTION .B findfs -will search the disks in the system looking for a filesystem which has +will search the disks in the system looking for a filesystem which has a label matching .I label -or a UUID equal to +or a UUID equal to .IR uuid . If the filesystem is found, the device name for the filesystem will be printed on stdout. .PP .SH AUTHOR -.B findfs +.B findfs was written by Theodore Ts'o (tytso@mit.edu). .SH AVAILABILITY .B findfs -is part of the e2fsprogs package and is available from +is part of the e2fsprogs package and is available from http://e2fsprogs.sourceforge.net. .SH SEE ALSO .BR fsck (8) diff --git a/misc/fsck.8.in b/misc/fsck.8.in index 50fd8cef0..e751f8dec 100644 --- a/misc/fsck.8.in +++ b/misc/fsck.8.in @@ -1,7 +1,7 @@ .\" -*- nroff -*- .\" Copyright 1993, 1994, 1995 by Theodore Ts'o. All Rights Reserved. .\" This file may be copied under the terms of the GNU Public License. -.\" +.\" .TH FSCK 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" .SH NAME fsck \- check and repair a Linux file system @@ -19,34 +19,34 @@ fsck \- check and repair a Linux file system [ .B \-t .I fstype -] +] .I [filesys ... ] [\-\-] [ .B fs-specific-options ] .SH DESCRIPTION .B fsck -is used to check and optionally repair one or more Linux file systems. +is used to check and optionally repair one or more Linux file systems. .I filesys can be a device name (e.g. .IR /dev/hdc1 ", " /dev/sdb2 ), a mount point (e.g. .IR / ", " /usr ", " /home ), or an ext2 label or UUID specifier (e.g. -UUID=8868abf6-88c5-4a83-98b8-bfc24057f7bd or LABEL=root). -Normally, the -.B fsck -program will try to handle filesystems on different physical disk drives +UUID=8868abf6-88c5-4a83-98b8-bfc24057f7bd or LABEL=root). +Normally, the +.B fsck +program will try to handle filesystems on different physical disk drives in parallel to reduce the total amount of time needed to check all of the filesystems. .PP -If no filesystems are specified on the command line, and the -.B \-A -option is not specified, +If no filesystems are specified on the command line, and the +.B \-A +option is not specified, .B fsck will default to checking filesystems in .B /etc/fstab -serially. This is equivalent to the +serially. This is equivalent to the .B \-As options. .PP @@ -70,7 +70,7 @@ is the sum of the following conditions: .br \ 128\ \-\ Shared library error .br -The exit code returned when multiple file systems are checked +The exit code returned when multiple file systems are checked is the bit-wise OR of the exit codes for each file system that is checked. .PP @@ -90,37 +90,37 @@ further details. .SH OPTIONS .TP .B \-s -Serialize -.B fsck +Serialize +.B fsck operations. This is a good idea if you are checking multiple filesystems and the checkers are in an interactive mode. (Note: .BR e2fsck (8) -runs in an interactive mode by default. To make +runs in an interactive mode by default. To make .BR e2fsck (8) run in a non-interactive mode, you must either specify the .B \-p or .B \-a -option, if you wish for errors to be corrected automatically, or the +option, if you wish for errors to be corrected automatically, or the .B \-n option if you do not.) .TP .BI \-t " fslist" Specifies the type(s) of file system to be checked. When the -.B \-A -flag is specified, only filesystems that match +.B \-A +flag is specified, only filesystems that match .I fslist are checked. The .I fslist parameter is a comma-separated list of filesystems and options specifiers. All of the filesystems in this comma-separated list may be -prefixed by a negation operator +prefixed by a negation operator .RB ' no ' -or +or .RB ' ! ', which requests that only those filesystems not listed in .I fslist -will be checked. If all of the filesystems in +will be checked. If all of the filesystems in .I fslist are not prefixed by a negation operator, then only those filesystems listed @@ -130,18 +130,18 @@ will be checked. .sp Options specifiers may be included in the comma-separated .IR fslist . -They must have the format +They must have the format .BI opts= fs-option\fR. If an options specifier is present, then only filesystems which contain .I fs-option -in their mount options field of +in their mount options field of .B /etc/fstab will be checked. If the options specifier is prefixed by a negation -operator, then only +operator, then only those filesystems that do not have .I fs-option in their mount options field of -.B /etc/fstab +.B /etc/fstab will be checked. .sp For example, if @@ -149,7 +149,7 @@ For example, if appears in .IR fslist , then only filesystems listed in -.B /etc/fstab +.B /etc/fstab with the .B ro option will be checked. @@ -169,16 +169,16 @@ option. .sp Normally, the filesystem type is deduced by searching for .I filesys -in the -.I /etc/fstab +in the +.I /etc/fstab file and using the corresponding entry. -If the type can not be deduced, and there is only a single filesystem -given as an argument to the -.B \-t -option, +If the type can not be deduced, and there is only a single filesystem +given as an argument to the +.B \-t +option, .B fsck will use the specified filesystem type. If this type is not -available, then the default file system type (currently ext2) is used. +available, then the default file system type (currently ext2) is used. .TP .B \-A Walk through the @@ -191,27 +191,27 @@ a single file system. .sp The root filesystem will be checked first unless the .B \-P -option is specified (see below). After that, -filesystems will be checked in the order specified by the -.I fs_passno -(the sixth) field in the +option is specified (see below). After that, +filesystems will be checked in the order specified by the +.I fs_passno +(the sixth) field in the .I /etc/fstab -file. -Filesystems with a +file. +Filesystems with a .I fs_passno value of 0 are skipped and are not checked at all. Filesystems with a .I fs_passno -value of greater than zero will be checked in order, +value of greater than zero will be checked in order, with filesystems with the lowest -.I fs_passno +.I fs_passno number being checked first. -If there are multiple filesystems with the same pass number, -fsck will attempt to check them in parallel, although it will avoid running -multiple filesystem checks on the same physical disk. +If there are multiple filesystems with the same pass number, +fsck will attempt to check them in parallel, although it will avoid running +multiple filesystem checks on the same physical disk. .sp -Hence, a very common configuration in +Hence, a very common configuration in .I /etc/fstab -files is to set the root filesystem to have a +files is to set the root filesystem to have a .I fs_passno value of 1 and to set all other filesystems to have a @@ -226,9 +226,9 @@ machine in question is short on memory so that excessive paging is a concern. .TP .B \-C\fR [ \fI "fd" \fR ] -Display completion/progress bars for those filesystem checkers (currently +Display completion/progress bars for those filesystem checkers (currently only for ext2 and ext3) which support them. Fsck will manage the -filesystem checkers so that only one of them will display +filesystem checkers so that only one of them will display a progress bar at a time. GUI front-ends may specify a file descriptor .IR fd , in which case the progress bar information will be sent to that file descriptor. @@ -241,12 +241,12 @@ for mounted filesystems. Don't execute, just show what would be done. .TP .B \-P -When the +When the .B \-A flag is set, check the root filesystem in parallel with the other filesystems. This is not the safest thing in the world to do, -since if the root filesystem is in doubt things like the -.BR e2fsck (8) +since if the root filesystem is in doubt things like the +.BR e2fsck (8) executable might be corrupted! This option is mainly provided for those sysadmins who don't want to repartition the root filesystem to be small and compact (which is really the right solution). @@ -264,12 +264,12 @@ Produce verbose output, including all file system-specific commands that are executed. .TP .B fs-specific-options -Options which are not understood by -.B fsck +Options which are not understood by +.B fsck are passed to the filesystem-specific checker. These arguments .B must not take arguments, as there is no -way for +way for .B fsck to be able to properly guess which arguments take options and which don't. @@ -282,13 +282,13 @@ file system-specific checker. Please note that fsck is not designed to pass arbitrarily complicated options to filesystem-specific checkers. If you're doing something complicated, please just -execute the filesystem-specific checker directly. If you pass +execute the filesystem-specific checker directly. If you pass .B fsck some horribly complicated option and arguments, and it doesn't do -what you expect, +what you expect, .B don't bother reporting it as a bug. You're almost certainly doing something that you shouldn't be doing -with +with .BR fsck. .PP Options to different filesystem-specific fsck's are not standardized. @@ -298,46 +298,46 @@ by most file system checkers: .TP .B \-a Automatically repair the file system without any questions (use -this option with caution). Note that +this option with caution). Note that .BR e2fsck (8) -supports +supports .B \-a -for backwards compatibility only. This option is mapped to +for backwards compatibility only. This option is mapped to .BR e2fsck 's .B \-p -option which is safe to use, unlike the -.B \-a +option which is safe to use, unlike the +.B \-a option that some file system checkers support. .TP .B \-n -For some filesystem-specific checkers, the +For some filesystem-specific checkers, the .B \-n -option will cause the fs-specific fsck to avoid attempting to repair any +option will cause the fs-specific fsck to avoid attempting to repair any problems, but simply report such problems to stdout. This is however -not true for all filesystem-specific checkers. In particular, +not true for all filesystem-specific checkers. In particular, .BR fsck.reiserfs (8) will not report any corruption if given this option. .BR fsck.minix (8) -does not support the -.B \-n +does not support the +.B \-n option at all. .TP .B \-r Interactively repair the filesystem (ask for confirmations). Note: It is generally a bad idea to use this option if multiple fsck's are being -run in parallel. Also note that this is +run in parallel. Also note that this is .BR e2fsck 's default behavior; it supports this option for backwards compatibility reasons only. .TP .B \-y -For some filesystem-specific checkers, the -.B \-y +For some filesystem-specific checkers, the +.B \-y option will cause the fs-specific fsck to always attempt to fix any detected filesystem corruption automatically. Sometimes an expert may -be able to do better driving the fsck manually. Note that +be able to do better driving the fsck manually. Note that .B not -all filesystem-specific checkers implement this option. In particular +all filesystem-specific checkers implement this option. In particular .BR fsck.minix (8) and .BR fsck.cramfs (8) @@ -354,7 +354,7 @@ The program's behavior is affected by the following environment variables: .TP .B FSCK_FORCE_ALL_PARALLEL -If this environment variable is set, +If this environment variable is set, .B fsck will attempt to run all of the specified filesystems in parallel, regardless of whether the filesystems appear to be on the same @@ -364,7 +364,7 @@ such as those sold by companies such as IBM or EMC.) .B FSCK_MAX_INST This environment variable will limit the maximum number of file system checkers that can be running at one time. This allows configurations -which have a large number of disks to avoid +which have a large number of disks to avoid .B fsck starting too many file system checkers at once, which might overload CPU and memory resources available on the system. If this value is @@ -375,23 +375,23 @@ may attempt to automatically determine how many file system checks can be run based on gathering accounting data from the operating system. .TP .B PATH -The +The .B PATH environment variable is used to find file system checkers. A set of -system directories are searched first: +system directories are searched first: .BR /sbin , .BR /sbin/fs.d , .BR /sbin/fs , .BR /etc/fs , -and +and .BR /etc . Then the set of directories found in the .B PATH environment are searched. .TP .B FSTAB_FILE -This environment variable allows the system administrator -to override the standard location of the +This environment variable allows the system administrator +to override the standard location of the .B /etc/fstab file. It is also useful for developers who are testing .BR fsck . diff --git a/misc/logsave.8.in b/misc/logsave.8.in index f0fbe4125..cc3ffde3f 100644 --- a/misc/logsave.8.in +++ b/misc/logsave.8.in @@ -1,7 +1,7 @@ .\" -*- nroff -*- .\" Copyright 2003 by Theodore Ts'o. All Rights Reserved. .\" This file may be copied under the terms of the GNU Public License. -.\" +.\" .TH LOGSAVE 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" .SH NAME logsave \- save the output of a command in a logfile @@ -15,17 +15,17 @@ logsave \- save the output of a command in a logfile The .B logsave program will execute -.I cmd_prog +.I cmd_prog with the specified argument(s), and save a copy of its output to .IR logfile . If the containing directory for .I logfile -does not exist, +does not exist, .B logsave will accumulate the output in memory until it can be written out. A copy of the output will also be written to standard output. .PP -If +If .I cmd_prog is a single hyphen ('-'), then instead of executing a program, .B logsave @@ -33,20 +33,20 @@ will take its input from standard input and save it in .I logfile .PP .B logsave -is useful for saving the output of initial boot scripts -until the /var partition is mounted, so the output can be written to +is useful for saving the output of initial boot scripts +until the /var partition is mounted, so the output can be written to /var/log. .SH OPTIONS .TP .B \-a -This option will cause the output to be appended to +This option will cause the output to be appended to .IR logfile , instead of replacing its current contents. .TP .B \-s -This option will cause +This option will cause .B logsave -to skip writing to the log file text which is bracketed with a control-A +to skip writing to the log file text which is bracketed with a control-A (ASCII 001 or Start of Header) and control-B (ASCII 002 or Start of Text). This allows progress bar information to be visible to the user on the console, while not being written to the log file. diff --git a/misc/mke2fs.8.in b/misc/mke2fs.8.in index aba96e254..dc86e67fa 100644 --- a/misc/mke2fs.8.in +++ b/misc/mke2fs.8.in @@ -417,7 +417,7 @@ Specify the number of block groups that will be packed together to create a larger virtual block group (or "flex_bg group") in an ext4 filesystem. This improves meta-data locality and performance on meta-data heavy workloads. The number of groups must be a power -of 2 and may only be specified if the +of 2 and may only be specified if the .B flex_bg filesystem feature is enabled. .TP @@ -452,7 +452,7 @@ earlier vendor kernels it is possible to utilize inodes larger than extended attributes for improved performance. Extended attributes stored in large inodes are not visible with older kernels, and such -filesystems will not be mountable with 2.4 kernels at all. +filesystems will not be mountable with 2.4 kernels at all. .IP The default inode size is controlled by the .BR mke2fs.conf (5) diff --git a/misc/mklost+found.8.in b/misc/mklost+found.8.in index 712740c8d..ba0c1c18b 100644 --- a/misc/mklost+found.8.in +++ b/misc/mklost+found.8.in @@ -36,7 +36,7 @@ maintained by Theodore Ts'o . There are none :-) .SH AVAILABILITY .B mklost+found -is part of the e2fsprogs package and is available from +is part of the e2fsprogs package and is available from http://e2fsprogs.sourceforge.net. .SH SEE ALSO .BR e2fsck (8), diff --git a/misc/tune2fs.8.in b/misc/tune2fs.8.in index eccf27720..b1f43ecf4 100644 --- a/misc/tune2fs.8.in +++ b/misc/tune2fs.8.in @@ -81,7 +81,7 @@ tune2fs \- adjust tunable filesystem parameters on ext2/ext3/ext4 filesystems .I last-mounted-directory ] [ -.B \-O +.B \-O .RI [^] feature [,...] ] [ @@ -103,8 +103,8 @@ tune2fs \- adjust tunable filesystem parameters on ext2/ext3/ext4 filesystems device .SH DESCRIPTION .BI tune2fs -allows the system administrator to adjust various tunable filesystem -parameters on Linux ext2, ext3, or ext4 filesystems. The current values +allows the system administrator to adjust various tunable filesystem +parameters on Linux ext2, ext3, or ext4 filesystems. The current values of these options can be displayed by using the .B -l option to @@ -121,11 +121,11 @@ LABEL=home or UUID=e40486c6-84d5-4f2f-b99c-032281799c9d). .SH OPTIONS .TP .BI \-c " max-mount-counts" -Adjust the number of mounts after which the filesystem will be checked by -.BR e2fsck (8). +Adjust the number of mounts after which the filesystem will be checked by +.BR e2fsck (8). If .I max-mount-counts -is 0 or \-1, the number of times the filesystem is mounted will be disregarded +is 0 or \-1, the number of times the filesystem is mounted will be disregarded by .BR e2fsck (8) and the kernel. @@ -154,10 +154,10 @@ option for time-dependent checking. .BI \-C " mount-count" Set the number of times the filesystem has been mounted. If set to a greater value than the max-mount-counts parameter -set by the +set by the .B \-c option, -.BR e2fsck (8) +.BR e2fsck (8) will check the filesystem at the next reboot. .TP .BI \-e " error-behavior" @@ -256,12 +256,12 @@ using production-level filesystem code. .RE .TP .B \-f -Force the tune2fs operation to complete even in the face of errors. This -option is useful when removing the +Force the tune2fs operation to complete even in the face of errors. This +option is useful when removing the .B has_journal -filesystem feature from a filesystem which has +filesystem feature from a filesystem which has an external journal (or is corrupted -such that it appears to have an external journal), but that +such that it appears to have an external journal), but that external journal is not available. If the filesystem appears to require journal replay, the .B \-f @@ -274,13 +274,13 @@ severe data loss and filesystem corruption. .TP .BI \-g " group" Set the group which can use the reserved filesystem blocks. -The +The .I group parameter can be a numerical gid or a group name. If a group name is given, it is converted to a numerical gid before it is stored in the superblock. .TP .B \-i " \fIinterval-between-checks\fR[\fBd\fR|\fBm\fR|\fBw\fR]" -Adjust the maximal time between two filesystem checks. +Adjust the maximal time between two filesystem checks. No suffix or .B d will interpret the number @@ -306,10 +306,10 @@ corrupted and data lost if it is interrupted while in the middle of converting the file system. .TP .B \-j -Add an ext3 journal to the filesystem. If the +Add an ext3 journal to the filesystem. If the .B \-J option is not specified, the default journal parameters will be used to create -an appropriately sized journal (given the size of the filesystem) +an appropriately sized journal (given the size of the filesystem) stored within the filesystem. Note that you must be using a kernel which has ext3 support in order to actually make use of the journal. .IP @@ -321,9 +321,9 @@ the only safe way to create the journal inode while the filesystem is mounted. While the ext3 journal is visible, it is not safe to delete it, or modify it while the filesystem is mounted; for this reason the file is marked immutable. -While checking unmounted filesystems, +While checking unmounted filesystems, .BR e2fsck (8) -will automatically move +will automatically move .B .journal files to the invisible, reserved journal inode. For all filesystems except for the root filesystem, this should happen automatically and @@ -334,7 +334,7 @@ must be run from a rescue floppy in order to effect this transition. .IP On some distributions, such as Debian, if an initial ramdisk is used, the initrd scripts will automatically convert an ext2 root filesystem -to ext3 if the +to ext3 if the .BR /etc/fstab file specifies the ext3 filesystem for the root filesystem in order to avoid requiring the use of a rescue floppy to add an ext3 journal to @@ -365,10 +365,10 @@ beginning of the file system. @JDEV@.BI device= external-journal @JDEV@Attach the filesystem to the journal block device located on @JDEV@.IR external-journal . -@JDEV@The external +@JDEV@The external @JDEV@journal must have been already created using the command @JDEV@.IP -@JDEV@.B mke2fs -O journal_dev +@JDEV@.B mke2fs -O journal_dev @JDEV@.I external-journal @JDEV@.IP @JDEV@Note that @@ -377,7 +377,7 @@ beginning of the file system. @JDEV@size as filesystems which will be using it. @JDEV@In addition, while there is support for attaching @JDEV@multiple filesystems to a single external journal, -@JDEV@the Linux kernel and +@JDEV@the Linux kernel and @JDEV@.BR e2fsck (8) @JDEV@do not currently support shared external journals yet. @JDEV@.IP @@ -405,10 +405,10 @@ List the contents of the filesystem superblock, including the current values of the parameters that can be set via this program. .TP .BI \-L " volume-label" -Set the volume label of the filesystem. +Set the volume label of the filesystem. Ext2 filesystem labels can be at most 16 characters long; if -.I volume-label -is longer than 16 characters, +.I volume-label +is longer than 16 characters, .B tune2fs will truncate it and print a warning. The volume label can be used by @@ -423,13 +423,13 @@ instead of a block special device name like .TP .BI \-m " reserved-blocks-percentage" Set the percentage of the filesystem which may only be allocated -by privileged processes. Reserving some number of filesystem blocks -for use by privileged processes is done +by privileged processes. Reserving some number of filesystem blocks +for use by privileged processes is done to avoid filesystem fragmentation, and to allow system -daemons, such as +daemons, such as .BR syslogd (8), -to continue to function correctly after non-privileged processes are -prevented from writing to the filesystem. Normally, the default percentage +to continue to function correctly after non-privileged processes are +prevented from writing to the filesystem. Normally, the default percentage of reserved blocks is 5%. .TP .BI \-M " last-mounted-directory" @@ -437,19 +437,19 @@ Set the last-mounted directory for the filesystem. .TP .BR \-o " [^]\fImount-option\fR[,...]" Set or clear the indicated default mount options in the filesystem. -Default mount options can be overridden by mount options specified -either in +Default mount options can be overridden by mount options specified +either in .BR /etc/fstab (5) or on the command line arguments to -.BR mount (8). +.BR mount (8). Older kernels may not support this feature; in particular, kernels which predate 2.4.20 will almost certainly ignore the default mount options field in the superblock. .IP More than one mount option can be cleared or set by separating -features with commas. Mount options prefixed with a -caret character ('^') will be cleared in the filesystem's superblock; -mount options without a prefix character or prefixed with a plus +features with commas. Mount options prefixed with a +caret character ('^') will be cleared in the filesystem's superblock; +mount options without a prefix character or prefixed with a plus character ('+') will be added to the filesystem. .IP The following mount options can be set or cleared using @@ -463,8 +463,8 @@ Enable debugging code for this filesystem. Emulate BSD behavior when creating new files: they will take the group-id of the directory in which they were created. The standard System V behavior is the default, where newly created files take on the fsgid of the current -process, unless the directory has the setgid bit set, in which case it takes -the gid from the parent directory, and also gets the setgid bit set if it is +process, unless the directory has the setgid bit set, in which case it takes +the gid from the parent directory, and also gets the setgid bit set if it is a directory itself. .TP .B user_xattr @@ -484,7 +484,7 @@ into the main filesystem. .TP .B journal_data_ordered When the filesystem is mounted with journalling enabled, all data is forced -directly out to the main file system prior to its metadata being committed +directly out to the main file system prior to its metadata being committed to the journal. .TP .B journal_data_writeback @@ -526,9 +526,9 @@ only supported by the ext4 file system driver in 2.6.35+ kernels.) .BR \-O " [^]\fIfeature\fR[,...]" Set or clear the indicated filesystem features (options) in the filesystem. More than one filesystem feature can be cleared or set by separating -features with commas. Filesystem features prefixed with a -caret character ('^') will be cleared in the filesystem's superblock; -filesystem features without a prefix character or prefixed with a plus +features with commas. Filesystem features prefixed with a +caret character ('^') will be cleared in the filesystem's superblock; +filesystem features without a prefix character or prefixed with a plus character ('+') will be added to the filesystem. For a detailed description of the file system features, please see the man page .BR ext4 (5). @@ -570,7 +570,7 @@ enabled. .TP .B has_journal Use a journal to ensure filesystem consistency even across unclean shutdowns. -Setting the filesystem feature is equivalent to using the +Setting the filesystem feature is equivalent to using the .B \-j option. .TP @@ -615,7 +615,7 @@ full time, but subsequent e2fsck runs will take only a fraction of the original time, depending on how full the file system is. .RE .IP -After setting or clearing +After setting or clearing .BR sparse_super , .BR uninit_bg , .BR filetype , @@ -628,9 +628,9 @@ to return the filesystem to a consistent state. .B Tune2fs will print a message requesting that the system administrator run .BR e2fsck (8) -if necessary. After setting the +if necessary. After setting the .B dir_index -feature, +feature, .B e2fsck -D can be run to convert existing directories to the hashed B-tree format. Enabling certain filesystem features may prevent the filesystem from being @@ -666,31 +666,31 @@ Set the time the filesystem was last checked using .BR e2fsck . The time is interpreted using the current (local) timezone. This can be useful in scripts which use a Logical Volume Manager to make -a consistent snapshot of a filesystem, and then check the filesystem -during off hours to make sure it hasn't been corrupted due to -hardware problems, etc. If the filesystem was clean, then this option can -be used to set the last checked time on the original filesystem. The format -of +a consistent snapshot of a filesystem, and then check the filesystem +during off hours to make sure it hasn't been corrupted due to +hardware problems, etc. If the filesystem was clean, then this option can +be used to set the last checked time on the original filesystem. The format +of .I time-last-checked is the international date format, with an optional time specifier, i.e. -YYYYMMDD[HH[MM[SS]]]. The keyword +YYYYMMDD[HH[MM[SS]]]. The keyword .B now -is also accepted, in which case the last checked time will be set to the +is also accepted, in which case the last checked time will be set to the current time. .TP .BI \-u " user" Set the user who can use the reserved filesystem blocks. .I user -can be a numerical uid or a user name. If a user name is given, it +can be a numerical uid or a user name. If a user name is given, it is converted to a numerical uid before it is stored in the superblock. .TP .BI \-U " UUID" Set the universally unique identifier (UUID) of the filesystem to .IR UUID . -The format of the UUID is a series of hex digits separated by hyphens, -like this: -"c1b9d5a2-f162-11cf-9ece-0020afc76f16". -The +The format of the UUID is a series of hex digits separated by hyphens, +like this: +"c1b9d5a2-f162-11cf-9ece-0020afc76f16". +The .I UUID parameter may also be one of the following: .RS 1.2i @@ -746,7 +746,7 @@ This manual page was written by Christian Kuhtz . Time-dependent checking was added by Uwe Ohse . .SH AVAILABILITY .B tune2fs -is part of the e2fsprogs package and is available from +is part of the e2fsprogs package and is available from http://e2fsprogs.sourceforge.net. .SH SEE ALSO .BR debugfs (8), diff --git a/misc/uuidgen.1.in b/misc/uuidgen.1.in index 985e80d78..cb8b3a836 100644 --- a/misc/uuidgen.1.in +++ b/misc/uuidgen.1.in @@ -1,15 +1,15 @@ .\" Copyright 1999 Andreas Dilger (adilger@enel.ucalgary.ca) .\" .\" This man page was created for libuuid.so.1.1 from e2fsprogs-1.14. -.\" +.\" .\" This file may be copied under the terms of the GNU Public License. -.\" +.\" .\" Created Wed Mar 10 17:42:12 1999, Andreas Dilger .TH UUIDGEN 1 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" .SH NAME uuidgen \- command\-line utility to create a new UUID value .SH SYNOPSIS -.B uuidgen +.B uuidgen [ .B \-r | @@ -18,22 +18,22 @@ uuidgen \- command\-line utility to create a new UUID value .SH DESCRIPTION The .B uuidgen -program creates (and prints) +program creates (and prints) a new universally unique identifier (UUID) using the .BR libuuid (3) -library. The new UUID can reasonably be considered unique among -all UUIDs created on the local system, +library. The new UUID can reasonably be considered unique among +all UUIDs created on the local system, and among UUIDs created on other systems in the past and in the future. .PP -There are two types of UUID's which +There are two types of UUID's which .B uuidgen -can generate: time-based UUID's and random-based UUID's. By -default +can generate: time-based UUID's and random-based UUID's. By +default .B uuidgen will generate a random-based UUID if a high-quality random number -generator is present. Otherwise, it will chose a time-based UUID. It -is possible to force the generation of one of these two +generator is present. Otherwise, it will chose a time-based UUID. It +is possible to force the generation of one of these two UUID types by using the .B \-r or @@ -48,7 +48,7 @@ quality random number generator, such as .IR /dev/random . .TP .B \-t -Generate a time-based UUID. This method creates a UUID based on the system +Generate a time-based UUID. This method creates a UUID based on the system clock plus the system's ethernet hardware address, if present. .SH "CONFORMING TO" OSF DCE 1.1 -- 2.39.5