ericonr
/
util-linux
mirror of https://github.com/ericonr/util-linux.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
util-linux/disk-utils/mkfs.8

95 lines
2.5 KiB
Groff
Raw Normal View History

docs: uniformize the header and footer lines in man pages Use dates without the day, use the full month name, put "util-linux" in the lower left corner, and "User Commands" or "System Administration" at the top center. Also improve here and there the one-line program description. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-18 15:18:34 -05:00
.TH MKFS 8 "June 2011" "util-linux" "System Administration"
Imported from util-linux-2.2 tarball.
2006-12-06 17:25:32 -06:00
.SH NAME
mkfs: fix small formatting issues in man page Also spell "filesystem" consistently as one word -- this makes things clearer when the word is used as an adjective. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-03 09:10:13 -05:00
mkfs \- build a Linux filesystem
Imported from util-linux-2.2 tarball.
2006-12-06 17:25:32 -06:00
.SH SYNOPSIS
Imported from util-linux-2.5 tarball.
2006-12-06 17:25:33 -06:00
.B mkfs
docs: don't use bold or italics for "[option]" in synopsis of man pages As per the convention shown in Documentation/howto-man-page.txt. Also make a few other tiny adjustments along the way. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2014-12-14 13:45:29 -06:00
[options]
docs: tweak the formatting and wording of several disk-utils man pages Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-28 04:14:42 -05:00
.RB [ \-t
mkfs: indicate that specifying fs-type and fs-options are independent Also standardize and improve the help text, and slice it into strips for ease of later translation maintenance. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2013-01-22 04:56:58 -06:00
.IR type "] [" fs-options ] " device " [ size ]
Imported from util-linux-2.2 tarball.
2006-12-06 17:25:32 -06:00
.SH DESCRIPTION
mkfs: mark this wrapper as DEPRECATED Theodore Ts'o: I'll add that I've never been convinced that the mkfs front end is all that useful. It's probably better for people to explicitly run /sbin/mkfs.xfs, /sbin/mkfs.ext4, etc.., so you don't have to worry about which options get passed down to the file system specific mkfs program, and which ones are interpreted by /sbin/mkfs --- and I don't believe /sbin/mkfs adds enough (err, any?) value that using "/sbin/mkfs -t xxx" vs "/sbin/mkfs.xxx" makes any sense whatsoever. ... and I absolutely agree. Reported-by: Theodore Ts'o <tytso@mit.edu> Signed-off-by: Karel Zak <kzak@redhat.com>
2014-02-21 05:04:18 -06:00
.B This mkfs frontend is deprecated in favour of filesystem specific mkfs.<type> utils.
.PP
Imported from util-linux-2.5 tarball.
2006-12-06 17:25:33 -06:00
.B mkfs
mkfs: fix small formatting issues in man page Also spell "filesystem" consistently as one word -- this makes things clearer when the word is used as an adjective. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-03 09:10:13 -05:00
is used to build a Linux filesystem on a device, usually
a hard disk partition. The
.I device
man pages: Add a comma after "e.g." and "i.e." Add a comma (,) after "e.g." and "i.e.", or use English words (man-pages(7) [package "manpages"]). Abbreviation points should be protected (usually with the non-printing, zero width character '\&') from being interpreted as an end of sentence, if they are not, and that independent of their current place on the line. This is important when typing, as one does not usually know in advance when the editor jumps to a new line. Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
2019-12-14 16:42:47 -06:00
argument is either the device name (e.g.,
Imported from util-linux-2.9v tarball.
2006-12-06 17:25:39 -06:00
.IR /dev/hda1 ,
mkfs.8: incomplete sentence and formatting Signed-off-by: Peter Breitenlohner <peb@mppmu.mpg.de>
2009-07-22 04:13:21 -05:00
.IR /dev/sdb2 ),
mkfs: fix small formatting issues in man page Also spell "filesystem" consistently as one word -- this makes things clearer when the word is used as an adjective. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-03 09:10:13 -05:00
or a regular file that shall contain the filesystem. The
docs: add long options to mkfs.8 Two switches -c and -l where removed from manual, they might be supported by the real file system builder but not necessarily. The -v option was also corrected to be -V. Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-06-28 16:49:34 -05:00
.I size
mkfs: fix small formatting issues in man page Also spell "filesystem" consistently as one word -- this makes things clearer when the word is used as an adjective. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-03 09:10:13 -05:00
argument is the number of blocks to be used for the filesystem.
Imported from util-linux-2.2 tarball.
2006-12-06 17:25:32 -06:00
.PP
Manual pages: use the term "exit status" The manual pages currently use a multitude of terms--"exit code", "error code", "return code", "exit code", and so on--when what is always meant is "exit status" (the POSIX term). This patch fixes as many of these erroneous terms as I could find. Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-05-19 07:54:07 -05:00
The exit status returned by
Imported from util-linux-2.5 tarball.
2006-12-06 17:25:33 -06:00
.B mkfs
is 0 on success and 1 on failure.
Imported from util-linux-2.2 tarball.
2006-12-06 17:25:32 -06:00
.PP
In actuality,
Imported from util-linux-2.5 tarball.
2006-12-06 17:25:33 -06:00
.B mkfs
mkfs: fix small formatting issues in man page Also spell "filesystem" consistently as one word -- this makes things clearer when the word is used as an adjective. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-03 09:10:13 -05:00
is simply a front-end for the various filesystem builders
mkfs.8: incomplete sentence and formatting Signed-off-by: Peter Breitenlohner <peb@mppmu.mpg.de>
2009-07-22 04:13:21 -05:00
(\fBmkfs.\fIfstype\fR)
Imported from util-linux-2.2 tarball.
2006-12-06 17:25:32 -06:00
available under Linux.
mkfs: drop hardcoded search path Rather than maintain a hardcoded search path for looking up tools and override the user's PATH env setting, respect whatever the user has. This matches the convention of just about every other tool out there. It might break on systems that don't have /sbin in their PATH and they try to run /sbin/mkfs directly, but so be it. Signed-off-by: Mike Frysinger <vapier@gentoo.org>
2015-04-12 04:06:51 -05:00
The filesystem-specific builder is searched for via your PATH
environment setting only.
mkfs: fix small formatting issues in man page Also spell "filesystem" consistently as one word -- this makes things clearer when the word is used as an adjective. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-03 09:10:13 -05:00
Please see the filesystem-specific builder manual pages for
Imported from util-linux-2.2 tarball.
2006-12-06 17:25:32 -06:00
further details.
.SH OPTIONS
.TP
docs: tweak the formatting and wording of several disk-utils man pages Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-28 04:14:42 -05:00
.BR \-t , " \-\-type " \fItype\fR
Specify the \fItype\fR of filesystem to be built.
mkfs: fix small formatting issues in man page Also spell "filesystem" consistently as one word -- this makes things clearer when the word is used as an adjective. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-03 09:10:13 -05:00
If not specified, the default filesystem type
Imported from util-linux-2.9i tarball.
2006-12-06 17:25:37 -06:00
(currently ext2) is used.
Imported from util-linux-2.2 tarball.
2006-12-06 17:25:32 -06:00
.TP
mkfs.8: incomplete sentence and formatting Signed-off-by: Peter Breitenlohner <peb@mppmu.mpg.de>
2009-07-22 04:13:21 -05:00
.I fs-options
mkfs: fix small formatting issues in man page Also spell "filesystem" consistently as one word -- this makes things clearer when the word is used as an adjective. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-03 09:10:13 -05:00
Filesystem-specific options to be passed to the real filesystem builder.
Imported from util-linux-2.2 tarball.
2006-12-06 17:25:32 -06:00
.TP
docs: tweak the formatting and wording of several disk-utils man pages Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-28 04:14:42 -05:00
.BR \-V , " \-\-verbose"
mkfs: fix small formatting issues in man page Also spell "filesystem" consistently as one word -- this makes things clearer when the word is used as an adjective. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-03 09:10:13 -05:00
Produce verbose output, including all filesystem-specific commands
docs: add long options to mkfs.8 Two switches -c and -l where removed from manual, they might be supported by the real file system builder but not necessarily. The -v option was also corrected to be -V. Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-06-28 16:49:34 -05:00
that are executed.
Specifying this option more than once inhibits execution of any
mkfs: fix small formatting issues in man page Also spell "filesystem" consistently as one word -- this makes things clearer when the word is used as an adjective. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-03 09:10:13 -05:00
filesystem-specific commands.
docs: add long options to mkfs.8 Two switches -c and -l where removed from manual, they might be supported by the real file system builder but not necessarily. The -v option was also corrected to be -V. Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-06-28 16:49:34 -05:00
This is really only useful for testing.
Imported from util-linux-2.2 tarball.
2006-12-06 17:25:32 -06:00
.TP
docs: tweak the formatting and wording of several disk-utils man pages Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-28 04:14:42 -05:00
.BR \-V , " \-\-version"
Display version information and exit. (Option \fB\-V\fR will display
mkfs: fix small formatting issues in man page Also spell "filesystem" consistently as one word -- this makes things clearer when the word is used as an adjective. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-03 09:10:13 -05:00
version information only when it is the only parameter, otherwise it
docs: tweak the formatting and wording of several disk-utils man pages Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-28 04:14:42 -05:00
will work as \fB\-\-verbose\fR.)
Imported from util-linux-2.2 tarball.
2006-12-06 17:25:32 -06:00
.TP
docs: tweak the formatting and wording of several disk-utils man pages Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-28 04:14:42 -05:00
.BR \-h , " \-\-help"
docs: standardize the phrases for --help and --version in all man pages Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2013-10-14 14:34:39 -05:00
Display help text and exit.
Imported from util-linux-2.2 tarball.
2006-12-06 17:25:32 -06:00
.SH BUGS
All generic options must precede and not be combined with
mkfs: fix small formatting issues in man page Also spell "filesystem" consistently as one word -- this makes things clearer when the word is used as an adjective. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-03 09:10:13 -05:00
filesystem-specific options.
fix mkfs --verbose and man page mkfs did not actually accept the long form --verbose option. Also the man page seemed to indicate that version/verbose/help options were passed to the filesystem specific utility when this is not the case. Signed-off-by: Phillip Susi <psusi@ubuntu.com>
2014-02-07 16:01:20 -06:00
Some filesystem-specific programs do not automatically
Imported from util-linux-2.5 tarball.
2006-12-06 17:25:33 -06:00
detect the device size and require the
docs: tweak the formatting and wording of several disk-utils man pages Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-28 04:14:42 -05:00
.I size
Imported from util-linux-2.5 tarball.
2006-12-06 17:25:33 -06:00
parameter to be specified.
Imported from util-linux-2.2 tarball.
2006-12-06 17:25:32 -06:00
.SH AUTHORS
David Engel (david@ods.com)
.br
mkfs: Some typographical changes to the manual - changed to \- if it means an option A full stop (.), that begins or ends a string, protected with \& No line adjustment used for section "SEE ALSO" (.na/.ad) Signed-off-by: Karel Zak <kzak@redhat.com>
2014-04-02 18:42:06 -05:00
Fred N.\& van Kempen (waltje@uwalt.nl.mugnet.org)
Imported from util-linux-2.2 tarball.
2006-12-06 17:25:32 -06:00
.br
Imported from util-linux-2.5 tarball.
2006-12-06 17:25:33 -06:00
Ron Sommeling (sommel@sci.kun.nl)
.br
Imported from util-linux-2.2 tarball.
2006-12-06 17:25:32 -06:00
The manual page was shamelessly adapted from Remy Card's version
mkfs: fix small formatting issues in man page Also spell "filesystem" consistently as one word -- this makes things clearer when the word is used as an adjective. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-03 09:10:13 -05:00
for the ext2 filesystem.
Imported from util-linux-2.2 tarball.
2006-12-06 17:25:32 -06:00
.SH SEE ALSO
mkfs: Some typographical changes to the manual - changed to \- if it means an option A full stop (.), that begins or ends a string, protected with \& No line adjustment used for section "SEE ALSO" (.na/.ad) Signed-off-by: Karel Zak <kzak@redhat.com>
2014-04-02 18:42:06 -05:00
.na
Imported from util-linux-2.9v tarball.
2006-12-06 17:25:39 -06:00
.BR fs (5),
.BR badblocks (8),
Imported from util-linux-2.5 tarball.
2006-12-06 17:25:33 -06:00
.BR fsck (8),
Imported from util-linux-2.9v tarball.
2006-12-06 17:25:39 -06:00
.BR mkdosfs (8),
.BR mke2fs (8),
Imported from util-linux-2.11t tarball.
2006-12-06 17:25:58 -06:00
.BR mkfs.bfs (8),
Imported from util-linux-2.5 tarball.
2006-12-06 17:25:33 -06:00
.BR mkfs.ext2 (8),
Imported from util-linux-2.11t tarball.
2006-12-06 17:25:58 -06:00
.BR mkfs.ext3 (8),
mkfs: add `mkfs.ext4` to section SEE ALSO of `mkfs.8`. Signed-off-by: Paul Menzel <paulepanter@users.sourceforge.net>
2010-07-28 11:38:55 -05:00
.BR mkfs.ext4 (8),
Imported from util-linux-2.9v tarball.
2006-12-06 17:25:39 -06:00
.BR mkfs.minix (8),
.BR mkfs.msdos (8),
Imported from util-linux-2.11t tarball.
2006-12-06 17:25:58 -06:00
.BR mkfs.vfat (8),
various: erase all traces of the long-obsolete xiafs The xiafs filesystem was removed from the kernel fifteen years ago, and any kernel that contained it reached end of life ten years ago. It's time to stop mentioning it in the mount man page and elsewhere. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2014-07-25 07:55:03 -05:00
.BR mkfs.xfs (8)
mkfs: Some typographical changes to the manual - changed to \- if it means an option A full stop (.), that begins or ends a string, protected with \& No line adjustment used for section "SEE ALSO" (.na/.ad) Signed-off-by: Karel Zak <kzak@redhat.com>
2014-04-02 18:42:06 -05:00
.ad
man pages: add "AVAILABILITY" section Signed-off-by: Karel Zak <kzak@redhat.com>
2007-07-02 18:17:04 -05:00
.SH AVAILABILITY
rename util-linux-ng back to util-linux Signed-off-by: Karel Zak <kzak@redhat.com>
2010-11-30 04:41:59 -06:00
The mkfs command is part of the util-linux package and is available from
docs: replace FTP by HTTPS in kernel.org URLs The links to ftp://ftp.kernel.org/ are replaced by https://www.kernel.org/. Signed-off-by: Karel Zak <kzak@redhat.com>
2016-12-17 02:06:57 -06:00
https://www.kernel.org/pub/linux/utils/util-linux/.