Whamcloud - gitweb
ChangeLog, mke2fs.8.in:
authorTheodore Ts'o <tytso@mit.edu>
Sun, 22 Apr 2001 03:58:32 +0000 (03:58 +0000)
committerTheodore Ts'o <tytso@mit.edu>
Sun, 22 Apr 2001 03:58:32 +0000 (03:58 +0000)
  mke2fs.8.in: Manual page cleanups.  Temporarily comment out the
   documentation for the extern journal device support.

misc/ChangeLog
misc/mke2fs.8.in

index 4d06bf3..997cad2 100644 (file)
@@ -1,5 +1,8 @@
 2001-04-21  Theodore Tso  <tytso@valinux.com>
 
+       * mke2fs.8.in: Manual page cleanups.  Temporarily comment out the
+               documentation for the extern journal device support.
+
        * mke2fs.c (usage): Remove the deprecated -s option from the usage
                message.
 
index 03f3283..9be1429 100644 (file)
@@ -10,9 +10,6 @@ mke2fs \- create a Linux second extended file system
 [
 .B \-c
 | 
-.\" .B \-t
-.\" .I test
-.\" |
 .B \-l
 .I filename
 ]
@@ -63,11 +60,7 @@ mke2fs \- create a Linux second extended file system
 ]
 [
 .B \-R
-.I raid_options
-]
-[
-.B \-s
-.I sparse-super-flag
+.I raid-options
 ]
 [
 .B \-v
@@ -97,6 +90,31 @@ mke2fs \- create a Linux second extended file system
 [
 .I blocks-count
 ]
+@JDEV@.sp
+@JDEV@.B "mke2fs \-O journal-dev"
+@JDEV@[
+@JDEV@.B \-b
+@JDEV@.I block-size
+@JDEV@]
+.\" No journal-device specific journal options yet (size is ignored)
+.\" @JDEV@[
+.\" @JDEV@.B \-J
+.\" @JDEV@.I journal-options
+.\" @JDEV@]
+@JDEV@[
+@JDEV@.B \-L
+@JDEV@.I volume-label
+@JDEV@]
+@JDEV@[
+@JDEV@.B \-n
+@JDEV@]
+@JDEV@[
+@JDEV@.B \-q
+@JDEV@]
+@JDEV@[
+@JDEV@.B \-v
+@JDEV@]
+@JDEV@.I journal-device
 .SH DESCRIPTION
 .B mke2fs
 is used to create a Linux second extended file system on a device (usually
@@ -126,55 +144,81 @@ fast read-only test.
 .BI \-f " fragment-size"
 Specify the size of fragments in bytes.
 .TP
+.B \-F
+Force 
+.B mke2fs
+to run, even if the specified device is not a 
+block special device, or appears to be mounted.
+.TP
 .BI \-i " bytes-per-inode"
 Specify the bytes/inode ratio. 
 .B mke2fs
 creates an inode for every
 .I bytes-per-inode
-bytes of space on the disk.  
-The larger the 
+bytes of space on the disk.  The larger the 
 .I bytes-per-inode
-ratio, the fewer inodes will be created.
-This value generally shouldn't be smaller than
-the blocksize of the filesystem, since then too many inodes will be made.  
-Be warned that is not possible to expand the number of inodes on a 
-filesystem after it is created, so be careful deciding the correct
-value for this parameter. 
+ratio, the fewer inodes will be created.  This value generally shouldn't
+be smaller than the blocksize of the filesystem, since then too many
+inodes will be made.  Be warned that is not possible to expand the number 
+of inodes on a filesystem after it is created, so be careful deciding the
+correct value for this parameter. 
 .TP 
-.B -j
-Build the ext2 filesystem with the ext3 journaling feature enabled.  
-If the 
+.B \-j
+Create the filesystem with an ext3 journal.  If the
 .B \-J
-option is not specified, the default journal parameters will used will create
-an appropriately sized journal (given the size of the filesystem) 
-stored internally in the filesystem.
+option is not specified, the default journal parameters will be used to
+create 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.
 .TP
-.BI \-J " journal options"
+.BI \-J " journal-options"
 Create the ext3 journal using options specified on the command-line.
 Journal options are comma
 separated, and may take an argument using the equals ('=')  sign.
-Currently two (mutually exclusive) options are supported,
-.I size
-and
-.IR device .
+The following journal options are supported:
+.RS 1.2i
 .TP
-.BI "\-J size=" journal-size
+.BI size= journal-size
 Create a journal stored in the filesystem of size
 .IR journal-size .
 The size of the journal must be at least 1024 filesystem blocks 
 (i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.) 
 and may be no more than 10,240 filesystem blocks.  
 The journal must fit within the newly created filesystem.  
+@JDEV@.TP
+@JDEV@.BI device= external-journal
+@JDEV@Add an external journal found on a block device named by 
+@JDEV@.I external-journal 
+@JDEV@to the filesystem.  The external 
+@JDEV@journal must have been already created using the command
+@JDEV@.sp
+@JDEV@.B mke2fs \-O journal-dev 
+@JDEV@.IR journal\-device
+@JDEV@.sp
+@JDEV@Only one of the
+@JDEV@.BR size " or " device
+@JDEV@options can be given for a filesystem.
+.RE
+.TP
+.BI \-l " filename"
+Read the bad blocks list from
+.IR filename .
+.TP
+.B \-L
+Set the volume label for the filesystem.
+.TP
+.BI \-m " reserved-blocks-percentage"
+Specify the percentage of the filesystem blocks reserved for 
+the super-user.  This value defaults to 5%.
+.\" .TP
+.\" .BI \-t " test"
+.\" Check the device for bad blocks before creating the file system
+.\" using the specified test.
 .TP
-.BI "\-J device=" external-journal
-Add an external journal found on a block device
-named by 
-.I external-journal 
-to the filesystem.
-The external 
-journal must have been already created using the command
-.B mke2fs -O journal_dev 
-.IR journal-device.
+.B \-M
+Set the last mounted directory for the filesystem.  This might be useful 
+for the sake of utilities that key off of the last mounted directory to 
+determine where the filesytem should be mounted.
 .TP
 .B \-n
 causes mke2fs to not actually create a filesystem, but display what it 
@@ -188,88 +232,76 @@ the
 ratio).  This allows the user to specify the number 
 of desired inodes directly.
 .TP
-.BI \-O " feature\fR[,...]"
-Create the filesystem with the listed set of features 
-(filesystem options).  The following features are supported: 
-.IR sparse_super ,
-which cause the filesystem to use sparse superblocks, and
-.IR filetype ,
-which will cause the filesystem to store file type information in 
-directory entries.   Currently, both features are turned on by default
-unless 
-.B mke2fs
-is run on a system with a pre-2.2 Linux kernel.
-.B Warning:
-Pre-2.2 Linux kernels do not properly 
-support the filesystems that use either of these two features.   Filesystems 
-that may need to mounted on pre-2.2 kernels should be created with 
-.B -O
-.I none
-which will disable both of these features, even if 
-.B mke2fs 
-is run on a system which can support these features.
-.TP
-.BI \-l " filename"
-Read the bad blocks list from
-.I filename.
-\.
-.TP
-.BI -m " reserved-blocks-percentage"
-Specify the percentage of reserved blocks for the super-user.  This value
-defaults to 5%.
-.\" .TP
-.\" .BI \-t " test"
-.\" Check the device for bad blocks before creating the file system
-.\" using the specified test.
-.TP
-.B \-o
+.BI \-o " creator-os"
 Manually override the default value of the "creator os" field of the 
 filesystem.  Normally the creator field is set by default to the native OS
 of the
 .B mke2fs
 executable.
 .TP
-.B \-q
-Quiet execution.  Useful if 
+.B \-O "\fIfeature\fR[,...]"
+Create filesystem with given features (filesystem options).
+Currently, the
+.B sparse_super
+and
+.B filetype
+features are turned on by default unless 
 .B mke2fs
-is run in a script.
-.TP
-.BI \-s " sparse-super-flag"
-If 
-.I sparse-super-flag
-is 1, then turn on the sparse superblock flag in the superblock.  
-.B Note:
-This option is deprecated; use the 
-.B \-O
-option instead.
-.TP
-.B \-v
-Verbose execution.
+is run on a system with a pre-2.2 Linux kernel.
+.sp
+.B Warning:
+Linux kernels before 2.0.39 and many 2.1 series kernels do not support
+filesystems that use any of these features.  Filesystems that
+may need to mounted on pre-2.2 kernels should be created with the
+.B "\-O none"
+(or
+.B "\-r 0"
+for 1.2 kernels) which will disable these features, even if 
+.B mke2fs 
+is run on a system which can support them.
+.sp
+The following filesystem options are supported:
+.RS 1.2i
 .TP
-.B \-F
-Force 
-.B mke2fs
-to run, even if the specified device is not a 
-block special device, or appears to be mounted.
+.B sparse_super
+Create a filesystem with fewer superblock backup copies
+(saves space on large filesystems).
 .TP
-.B \-L
-Set the volume label for the filesystem.
+.B filetype
+Store file type information in directory entries.
 .TP
-.B \-M
-Set the last mounted directory for the filesystem.  This might be useful 
-for the sake of utilities that key off of the last mounted directory to 
-determine where the filesytem should be mounted.
+.B has_journal
+Create an ext3 journal (as if using the
+.B \-j
+option).
+@JDEV@.TP
+@JDEV@.B journal-dev
+@JDEV@Create an external ext3 journal on the given device
+@JDEV@instead of a regular ext2 filesystem.  The external ext3
+@JDEV@journal can be shared by multiple ext2 filesystems.
+.RE
 .TP
-.BI -r " revision"
+.BI \-r " revision"
 Set the filesystem revision for the new filesystem.  Note that 1.2
-kernels only support revision 0 filesystems.
+kernels only support revision 0 filesystems.  The default is to 
+create revision 1 filesystems.
 .TP
-.BI \-R " raid_options"
+.BI \-R " raid-options"
 Set raid-related options for the filesystem.  Raid options are comma
-separated, and may take an argument using the equals ('=')  sign.
-Currently the only supported argument is 
-.I stride
-which takes as its argument the number of blocks in a RAID stripe.
+separated, and may take an argument using the equals ('=')  sign.  The 
+following options are supported:
+.RS 1.2i
+.TP
+.BI stride= stripe-size
+Configure the filesystem for a RAID array with
+.I strip-size
+filesystem blocks per stripe.
+.RE
+.TP
+.B \-q
+Quiet execution.  Useful if 
+.B mke2fs
+is run in a script.
 .TP
 .B \-S
 Write superblock and group descriptors only.  This is useful if all of
@@ -281,18 +313,28 @@ superblock and group descriptors, while not touching the inode table
 and the block and inode bitmaps.  The
 .B e2fsck
 program should be run immediately after this option is used, and there
-is no guarantee that any data will be salvageable.
+is no guarantee that any data will be salvageable.  It is critical to
+specify the correct filesystem blocksize when using this option,
+or there is no chance of recovery.
 .TP
 .BI \-T " fs-type"
 Specify how the filesystem is going to be used, so that mke2fs can 
-chose optimal filesystem parameters for that use.  The only
-currently supported filesystem types are:
-.BR news ,
-which reserves space for  one inode per 4kb block,
-.BR largefile
-which allocates one inode per megabyte, and
-.BR largefile4
-which allocates one inode per 4 megabytes.  
+chose optimal filesystem parameters for that use.  The supported
+filesystem types are:
+.RS 1.2i
+.TP 1.2i
+news
+one inode per 4kb block
+.TP
+largefile
+one inode per megabyte
+.TP
+largefile4
+one inode per 4 megabytes
+.RE
+.TP
+.B \-v
+Verbose execution.
 .TP
 .B \-V
 Print the version number of 
@@ -309,7 +351,7 @@ accepts the
 option but currently ignores it because the second
 extended file system does not support fragments yet.
 .br
-There may be some other ones.  Please, report them to the author.
+There may be other ones.  Please, report them to the author.
 .SH AVAILABILITY
 .B mke2fs
 is part of the e2fsprogs package and is available for anonymous