]> git.ipfire.org Git - thirdparty/e2fsprogs.git/blobdiff - misc/mke2fs.8.in
Change "filesystem" to "file system" in the man pages
[thirdparty/e2fsprogs.git] / misc / mke2fs.8.in
index 84248ffc9e1d52de33de2d8c4eceb5ba7dc223d1..c0b5324569a186bafe6e6d39f04a2e73c3c194d2 100644 (file)
@@ -4,7 +4,7 @@
 .\"
 .TH MKE2FS 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
 .SH NAME
-mke2fs \- create an ext2/ext3/ext4 filesystem
+mke2fs \- create an ext2/ext3/ext4 file system
 .SH SYNOPSIS
 .B mke2fs
 [
@@ -155,7 +155,7 @@ mke2fs \- create an ext2/ext3/ext4 filesystem
 @JDEV@]
 .SH DESCRIPTION
 .B mke2fs
-is used to create an ext2, ext3, or ext4 filesystem, usually in a disk
+is used to create an ext2, ext3, or ext4 file system, usually in a disk
 partition (or file) named by
 .IR device .
 .PP
@@ -198,7 +198,7 @@ will create a file system for use with ext3,
 .B mkfs.ext4
 will create a file system for use with ext4, and so on.
 .PP
-The defaults of the parameters for the newly created filesystem, if not
+The defaults of the parameters for the newly created file system, if not
 overridden by the options listed below, are controlled by the
 .B /etc/mke2fs.conf
 configuration file.  See the
@@ -209,10 +209,10 @@ manual page for more details.
 .BI \-b " block-size"
 Specify the size of blocks in bytes.  Valid block-size values are powers of two
 from 1024 up to 65536 (however note that the kernel is able to mount only
-filesystems with block-size smaller or equal to the system page size - 4k on
+file systems with block-size smaller or equal to the system page size - 4k on
 x86 systems, up to 64k on ppc64 or aarch64 depending on kernel configuration).
-If omitted, block-size is heuristically determined by the filesystem size and
-the expected usage of the filesystem (see the
+If omitted, block-size is heuristically determined by the file system size and
+the expected usage of the file system (see the
 .B \-T
 option).  In most common cases, the default block size is 4k. If
 .I block-size
@@ -231,7 +231,7 @@ this option is specified twice, then a slower read-write
 test is used instead of a fast read-only test.
 .TP
 .B \-C " cluster-size"
-Specify the size of cluster in bytes for filesystems using the bigalloc
+Specify the size of cluster in bytes for file systems using the bigalloc
 feature.  Valid cluster-size values are from 2048 to 256M bytes per
 cluster.  This can only be specified if the bigalloc feature is
 enabled.  (See the
@@ -241,7 +241,7 @@ bigalloc is enabled is 16 times the block size.
 .TP
 .BI \-d " root-directory"
 Copy the contents of the given directory into the root directory of the
-filesystem.
+file system.
 .TP
 .B \-D
 Use direct I/O when writing to the disk.  This avoids mke2fs dirtying a
@@ -251,9 +251,9 @@ slowly, however, so there is a tradeoff to using direct I/O.
 .TP
 .BI \-e " error-behavior"
 Change the behavior of the kernel code when errors are detected.
-In all cases, a filesystem error will cause
+In all cases, a file system error will cause
 .BR e2fsck (8)
-to check the filesystem on the next boot.
+to check the file system on the next boot.
 .I error-behavior
 can be one of the following:
 .RS 1.2i
@@ -262,14 +262,14 @@ can be one of the following:
 Continue normal execution.
 .TP
 .B remount-ro
-Remount filesystem read-only.
+Remount file system read-only.
 .TP
 .B panic
 Cause a kernel panic.
 .RE
 .TP
 .BI \-E " extended-options"
-Set extended options for the filesystem.  Extended options are comma
+Set extended options for the file system.  Extended options are comma
 separated, and may take an argument using the equals ('=') sign.  The
 .B \-E
 option used to be
@@ -318,32 +318,32 @@ be less than 300 seconds.  Requires that the
 feature be enabled.
 .TP
 .BI stride= stride-size
-Configure the filesystem for a RAID array with
+Configure the file system for a RAID array with
 .I stride-size
-filesystem blocks. This is the number of blocks read or written to disk
+file system blocks. This is the number of blocks read or written to disk
 before moving to the next disk, which is sometimes referred to as the
 .I chunk size.
-This mostly affects placement of filesystem metadata like bitmaps at
+This mostly affects placement of file system metadata like bitmaps at
 .B mke2fs
 time to avoid placing them on a single disk, which can hurt performance.
 It may also be used by the block allocator.
 .TP
 .BI stripe_width= stripe-width
-Configure the filesystem for a RAID array with
+Configure the file system for a RAID array with
 .I stripe-width
-filesystem blocks per stripe. This is typically stride-size * N, where
+file system blocks per stripe. This is typically stride-size * N, where
 N is the number of data-bearing disks in the RAID (e.g. for RAID 5 there is one
 parity disk, so N will be the number of disks in the array minus 1).
 This allows the block allocator to prevent read-modify-write of the
 parity in a RAID stripe if possible when the data is written.
 .TP
 .BI offset= offset
-Create the filesystem at an offset from the beginning of the device or
+Create the file system at an offset from the beginning of the device or
 file.  This can be useful when creating disk images for virtual machines.
 .TP
 .BI resize= max-online-resize
 Reserve enough space so that the block group descriptor table can grow
-to support a filesystem that has
+to support a file system that has
 .I max-online-resize
 blocks.
 .TP
@@ -351,16 +351,16 @@ blocks.
 If enabled and the uninit_bg feature is enabled, the inode table will
 not be fully initialized by
 .BR mke2fs .
-This speeds up filesystem
+This speeds up file system
 initialization noticeably, but it requires the kernel to finish
-initializing the filesystem in the background when the filesystem is
+initializing the file system in the background when the file system is
 first mounted.  If the option value is omitted, it defaults to 1 to
 enable lazy inode table zeroing.
 .TP
 .B lazy_journal_init\fR[\fB= \fI<0 to disable, 1 to enable>\fR]
 If enabled, the journal inode will not be fully zeroed out by
 .BR mke2fs .
-This speeds up filesystem initialization noticeably, but carries some
+This speeds up file system initialization noticeably, but carries some
 small risk if the system crashes before the journal has been overwritten
 entirely one time.  If the option value is omitted, it defaults to 1 to
 enable lazy journal inode zeroing.
@@ -397,18 +397,18 @@ In \fBmke2fs\fR 1.42 and earlier the UID and GID of the root directory were
 set by default to the UID and GID of the user running the mke2fs command.
 The \fBroot_owner=\fR option allows explicitly specifying these values,
 and avoid side-effects for users that do not expect the contents of the
-filesystem to change based on the user running \fBmke2fs\fR.
+file system to change based on the user running \fBmke2fs\fR.
 .TP
 .B test_fs
-Set a flag in the filesystem superblock indicating that it may be
-mounted using experimental kernel code, such as the ext4dev filesystem.
+Set a flag in the file system superblock indicating that it may be
+mounted using experimental kernel code, such as the ext4dev file system.
 .TP
 .B discard
 Attempt to discard blocks at mkfs time (discarding blocks initially is useful
 on solid state devices and sparse / thin-provisioned storage). When the device
 advertises that discard also zeroes data (any subsequent read after the discard
 and before write returns zero), then mark all not-yet-zeroed inode tables as
-zeroed. This significantly speeds up filesystem initialization. This is set
+zeroed. This significantly speeds up file system initialization. This is set
 as default.
 .TP
 .B nodiscard
@@ -428,19 +428,19 @@ feature is enabled that project quotas will be initialized as well.
 .B \-F
 Force
 .B mke2fs
-to create a filesystem, even if the specified device is not a partition
+to create a file system, even if the specified device is not a partition
 on a block special device, or if other parameters do not make sense.
 In order to force
 .B mke2fs
-to create a filesystem even if the filesystem appears to be in use
+to create a file system even if the file system appears to be in use
 or is mounted (a truly dangerous thing to do), this option must be
 specified twice.
 .TP
 .BI \-g " blocks-per-group"
 Specify the number of blocks in a block group.  There is generally no
 reason for the user to ever set this parameter, as the default is optimal
-for the filesystem.  (For administrators who are creating
-filesystems on RAID arrays, it is preferable to use the
+for the file system.  (For administrators who are creating
+file systems on RAID arrays, it is preferable to use the
 .I stride
 RAID parameter as part of the
 .B \-E
@@ -455,11 +455,11 @@ option will specify the number of clusters in a block group.
 .BI \-G " number-of-groups"
 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
+ext4 file system.  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
 .B flex_bg
-filesystem feature is enabled.
+file system feature is enabled.
 .TP
 .BI \-i " bytes-per-inode"
 Specify the bytes/inode ratio.
@@ -469,11 +469,11 @@ creates an inode for every
 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 in that case more
+be smaller than the blocksize of the file system, since in that case more
 inodes would be made than can ever be used.  Be warned that it is not
-possible to change this ratio on a filesystem after it is created, so be
+possible to change this ratio on a file system after it is created, so be
 careful deciding the correct value for this parameter.  Note that resizing
-a filesystem changes the number of inodes to maintain this ratio.
+a file system changes the number of inodes to maintain this ratio.
 .TP
 .BI \-I " inode-size"
 Specify the size of each inode in bytes.
@@ -482,9 +482,9 @@ The
 value must be a power of 2 larger or equal to 128.  The larger the
 .I inode-size
 the more space the inode table will consume, and this reduces the usable
-space in the filesystem and can also negatively impact performance.
+space in the file system and can also negatively impact performance.
 It is not
-possible to change this value after the filesystem is created.
+possible to change this value after the file system is created.
 .IP
 File systems with an inode size of 128 bytes do not support timestamps
 beyond January 19, 2038.  Inodes which are 256 bytes or larger will
@@ -500,11 +500,11 @@ most file systems, except for small file systems where the inode size
 will be 128 bytes.
 .TP
 .B \-j
-Create the filesystem with an ext3 journal.  If the
+Create the file system with an ext3 journal.  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)
-stored within the filesystem.  Note that you must be using a kernel
+create an appropriately sized journal (given the size of the file system)
+stored within the file system.  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"
@@ -515,12 +515,12 @@ The following journal options are supported:
 .RS 1.2i
 .TP
 .BI size= journal-size
-Create an internal journal (i.e., stored inside the filesystem) of size
+Create an internal journal (i.e., stored inside the file system) of size
 .I journal-size
 megabytes.
-The size of the journal must be at least 1024 filesystem blocks
+The size of the journal must be at least 1024 file system blocks
 (i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.)
-and may be no more than 10,240,000 filesystem blocks or half the total
+and may be no more than 10,240,000 file system blocks or half the total
 file system size (whichever is smaller)
 .TP
 .BI fast_commit_size= fast-commit-size
@@ -541,7 +541,7 @@ feature set is
 + (
 .I fast-commit-size
 * 1024) megabytes. The total journal size may be no more than
-10,240,000 filesystem blocks or half the total file system size
+10,240,000 file system blocks or half the total file system size
 (whichever is smaller).
 .TP
 .BI location =journal-location
@@ -552,7 +552,7 @@ suffix (e.g., 'M', 'G', etc.) interpret it as the offset from the
 beginning of the file system.
 @JDEV@.TP
 @JDEV@.BI device= external-journal
-@JDEV@Attach the filesystem to the journal block device located on
+@JDEV@Attach the file system to the journal block device located on
 @JDEV@.IR external-journal .
 @JDEV@The external
 @JDEV@journal must already have been created using the command
@@ -563,9 +563,9 @@ beginning of the file system.
 @JDEV@Note that
 @JDEV@.I external-journal
 @JDEV@must have been created with the
-@JDEV@same block size as the new filesystem.
+@JDEV@same block size as the new file system.
 @JDEV@In addition, while there is support for attaching
-@JDEV@multiple filesystems to a single external journal,
+@JDEV@multiple file systems to a single external journal,
 @JDEV@the Linux kernel and
 @JDEV@.BR e2fsck (8)
 @JDEV@do not currently support shared external journals yet.
@@ -587,7 +587,7 @@ beginning of the file system.
 @JDEV@.IP
 @JDEV@Only one of the
 @JDEV@.BR size " or " device
-@JDEV@options can be given for a filesystem.
+@JDEV@options can be given for a file system.
 .TP
 .BI \-l " filename"
 Read the bad blocks list from
@@ -607,41 +607,41 @@ will automatically pass the correct parameters to the
 program.
 .TP
 .BI \-L " new-volume-label"
-Set the volume label for the filesystem to
+Set the volume label for the file system to
 .IR new-volume-label .
 The maximum length of the
 volume label is 16 bytes.
 .TP
 .BI \-m " reserved-blocks-percentage"
-Specify the percentage of the filesystem blocks reserved for
+Specify the percentage of the file system blocks reserved for
 the super-user.  This avoids fragmentation, and allows root-owned
 daemons, such as
 .BR syslogd (8),
 to continue to function correctly after non-privileged processes are
-prevented from writing to the filesystem.  The default percentage
+prevented from writing to the file system.  The default percentage
 is 5%.
 .TP
 .BI \-M " last-mounted-directory"
-Set the last mounted directory for the filesystem.  This might be useful
+Set the last mounted directory for the file system.  This might be useful
 for the sake of utilities that key off of the last mounted directory to
-determine where the filesystem should be mounted.
+determine where the file system should be mounted.
 .TP
 .B \-n
 Causes
 .B mke2fs
-to not actually create a filesystem, but display what it
-would do if it were to create a filesystem.  This can be used to
+to not actually create a file system, but display what it
+would do if it were to create a file system.  This can be used to
 determine the location of the backup superblocks for a particular
-filesystem, so long as the
+file system, so long as the
 .B mke2fs
 parameters that were passed when the
-filesystem was originally created are used again.  (With the
+file system was originally created are used again.  (With the
 .B \-n
 option added, of course!)
 .TP
 .BI \-N " number-of-inodes"
 Overrides the default calculation of the number of inodes that should be
-reserved for the filesystem (which is based on the number of blocks and
+reserved for the file system (which is based on the number of blocks and
 the
 .I bytes-per-inode
 ratio).  This allows the user to specify the number
@@ -649,13 +649,13 @@ of desired inodes directly.
 .TP
 .BI \-o " creator-os"
 Overrides the default value of the "creator operating system" field of the
-filesystem.  The creator field is set by default to the name of the OS the
+file system.  The creator field is set by default to the name of the OS the
 .B mke2fs
 executable was compiled for.
 .TP
 .B "\-O \fR[^]\fIfeature\fR[,...]"
-Create a filesystem with the given features (filesystem options),
-overriding the default filesystem options.  The features that are
+Create a file system with the given features (file system options),
+overriding the default file system options.  The features that are
 enabled by default are specified by the
 .I base_features
 relation, either in the
@@ -671,27 +671,27 @@ option, further modified by the
 .I features
 relation found in the
 .I [fs_types]
-subsections for the filesystem and usage types.  See the
+subsections for the file system and usage types.  See the
 .BR mke2fs.conf (5)
 manual page for more details.
-The filesystem type-specific configuration setting found in the
+The file system type-specific configuration setting found in the
 .I [fs_types]
 section will override the global default found in
 .IR [defaults] .
 .sp
-The filesystem feature set will be further edited
+The file system feature set will be further edited
 using either the feature set specified by this option,
 or if this option is not given, by the
 .I default_features
-relation for the filesystem type being created, or in the
+relation for the file system type being created, or in the
 .I [defaults]
 section of the configuration file.
 .sp
-The filesystem feature set is comprised of a list of features, separated
+The file system feature set is comprised of a list of features, separated
 by commas, that are to be enabled.  To disable a feature, simply
 prefix the feature name with a caret ('^') character.
 Features with dependencies will not be removed successfully.
-The pseudo-filesystem feature "none" will clear all filesystem features.
+The pseudo-file system feature "none" will clear all file system features.
 .TP
 For more information about the features which can be set, please see
 the manual page
@@ -703,9 +703,9 @@ Quiet execution.  Useful if
 is run in a script.
 .TP
 .BI \-r " revision"
-Set the filesystem revision for the new filesystem.  Note that 1.2
-kernels only support revision 0 filesystems.  The default is to
-create revision 1 filesystems.
+Set the file system revision for the new file system.  Note that 1.2
+kernels only support revision 0 file systems.  The default is to
+create revision 1 file systems.
 .TP
 .B \-S
 Write superblock and group descriptors only.  This is an extreme
@@ -722,19 +722,19 @@ variety of possible options to
 .B mke2fs
 that affect the on-disk layout, it is critical to specify exactly
 the same format options, such as blocksize, fs-type, feature flags, and
-other tunables when using this option, or the filesystem will be further
-corrupted.  In some cases, such as filesystems that have been resized,
+other tunables when using this option, or the file system will be further
+corrupted.  In some cases, such as file systems that have been resized,
 or have had features enabled after format time, it is impossible to
-overwrite all of the superblocks correctly, and at least some filesystem
+overwrite all of the superblocks correctly, and at least some file system
 corruption will occur.  It is best to run this on a full copy of the
-filesystem so other options can be tried if this doesn't work.
+file system so other options can be tried if this doesn't work.
 .\" .TP
 .\" .BI \-t " test"
 .\" Check the device for bad blocks before creating the file system
 .\" using the specified test.
 .TP
 .BI \-t " fs-type"
-Specify the filesystem type (i.e., ext2, ext3, ext4, etc.) that is
+Specify the file system type (i.e., ext2, ext3, ext4, etc.) that is
 to be created.
 If this option is not specified,
 .B mke2fs
@@ -742,7 +742,7 @@ will pick a default either via how
 the command was run (for example, using a name of the form mkfs.ext2,
 mkfs.ext3, etc.) or via a default as defined by the
 .B /etc/mke2fs.conf
-file.   This option controls which filesystem options are used by
+file.   This option controls which file system options are used by
 default, based on the
 .B fstypes
 configuration stanza in
@@ -750,20 +750,20 @@ configuration stanza in
 .sp
 If the
 .B \-O
-option is used to explicitly add or remove filesystem options that
-should be set in the newly created filesystem, the
-resulting filesystem may not be supported by the requested
+option is used to explicitly add or remove file system options that
+should be set in the newly created file system, the
+resulting file system may not be supported by the requested
 .IR fs-type .
 (e.g., "\fBmke2fs \-t ext3 \-O extent /dev/sdXX\fR" will create a
-filesystem that is not supported by the ext3 implementation as found in
+file system that is not supported by the ext3 implementation as found in
 the Linux kernel; and "\fBmke2fs \-t ext3 \-O ^has_journal /dev/hdXX\fR"
-will create a filesystem that does not have a journal and hence will not
-be supported by the ext3 filesystem code in the Linux kernel.)
+will create a file system that does not have a journal and hence will not
+be supported by the ext3 file system code in the Linux kernel.)
 .TP
 .BI \-T " usage-type[,...]"
-Specify how the filesystem is going to be used, so that
+Specify how the file system is going to be used, so that
 .B mke2fs
-can choose optimal filesystem parameters for that use.  The usage
+can choose optimal file system parameters for that use.  The usage
 types that are supported are defined in the configuration file
 .BR /etc/mke2fs.conf .
 The user may specify one or more usage types
@@ -771,32 +771,32 @@ using a comma separated list.
 .sp
 If this option is is not specified,
 .B mke2fs
-will pick a single default usage type based on the size of the filesystem to
-be created.  If the filesystem size is less than 3 megabytes,
+will pick a single default usage type based on the size of the file system to
+be created.  If the file system size is less than 3 megabytes,
 .B mke2fs
-will use the filesystem type
+will use the file system type
 .IR floppy .
-If the filesystem size is greater than or equal to 3 but less than
+If the file system size is greater than or equal to 3 but less than
 512 megabytes,
 .BR mke2fs (8)
-will use the filesystem type
+will use the file system type
 .IR small .
-If the filesystem size is greater than or equal to 4 terabytes but less than
+If the file system size is greater than or equal to 4 terabytes but less than
 16 terabytes,
 .BR mke2fs (8)
-will use the filesystem type
+will use the file system type
 .IR big .
-If the filesystem size is greater than or equal to 16 terabytes,
+If the file system size is greater than or equal to 16 terabytes,
 .BR mke2fs (8)
-will use the filesystem type
+will use the file system type
 .IR huge .
 Otherwise,
 .BR mke2fs (8)
-will use the default filesystem type
+will use the default file system type
 .IR default .
 .TP
 .BI \-U " UUID"
-Set the universally unique identifier (UUID) of the filesystem to
+Set the universally unique identifier (UUID) of the file system to
 .IR UUID .
 The format of the UUID is a series of hex digits separated by hyphens,
 like this:
@@ -807,7 +807,7 @@ parameter may also be one of the following:
 .RS 1.2i
 .TP
 .I clear
-clear the filesystem UUID
+clear the file system UUID
 .TP
 .I random
 generate a new randomly-generated UUID
@@ -860,7 +860,7 @@ sector size of the
 .IR device .
 .TP
 .B MKE2FS_SKIP_CHECK_MSG
-If set, do not show the message of filesystem automatic check caused by
+If set, do not show the message of file system automatic check caused by
 mount count or check interval.
 .SH AUTHOR
 This version of