]> git.ipfire.org Git - thirdparty/util-linux.git/blame - disk-utils/mkfs.8.adoc
mkfs.cramfs: (man) Fix markup in makefs.cramfs.8.adoc
[thirdparty/util-linux.git] / disk-utils / mkfs.8.adoc
CommitLineData
295b3979 1//po4a: entry man manual
c6a568fc
MB
2= mkfs(8)
3:doctype: manpage
4:man manual: System Administration
5:man source: util-linux {release-version}
6:page-layout: base
7:command: mkfs
8
9== NAME
10
11mkfs - build a Linux filesystem
12
13== SYNOPSIS
14
4d297435 15*mkfs* [options] [*-t* _type_] [_fs-options_] _device_ [_size_]
c6a568fc
MB
16
17== DESCRIPTION
18
19*This mkfs frontend is deprecated in favour of filesystem specific mkfs.<type> utils.*
20
21*mkfs* is used to build a Linux filesystem on a device, usually a hard disk partition. The _device_ argument is either the device name (e.g., _/dev/hda1_, _/dev/sdb2_), or a regular file that shall contain the filesystem. The _size_ argument is the number of blocks to be used for the filesystem.
22
23The exit status returned by *mkfs* is 0 on success and 1 on failure.
24
25In actuality, *mkfs* is simply a front-end for the various filesystem builders (**mkfs.**__fstype__) available under Linux. The filesystem-specific builder is searched for via your *PATH* environment setting only. Please see the filesystem-specific builder manual pages for further details.
26
27== OPTIONS
28
29*-t*, *--type* _type_::
299604dd 30Specify the _type_ of filesystem to be built. If not specified, the default filesystem type (currently ext2) is used.
c6a568fc
MB
31
32_fs-options_::
299604dd 33Filesystem-specific options to be passed to the real filesystem builder.
c6a568fc
MB
34
35*-V*, *--verbose*::
299604dd 36Produce verbose output, including all filesystem-specific commands that are executed. Specifying this option more than once inhibits execution of any filesystem-specific commands. This is really only useful for testing.
c6a568fc 37
2b2d3172
MB
38include::man-common/help-version.adoc[]
39(Option *-V* will display version information only when it is the only parameter, otherwise it will work as *--verbose*.)
c6a568fc
MB
40
41== BUGS
42
43All generic options must precede and not be combined with filesystem-specific options. Some filesystem-specific programs do not automatically detect the device size and require the _size_ parameter to be specified.
44
45== AUTHORS
46
299604dd
MB
47mailto:david@ods.com[David Engel],
48mailto:waltje@uwalt.nl.mugnet.org[Fred N. van Kempen],
49mailto:sommel@sci.kun.nl[Ron Sommeling].
50
c6a568fc
MB
51The manual page was shamelessly adapted from Remy Card's version for the ext2 filesystem.
52
53== SEE ALSO
54
55*fs*(5),
56*badblocks*(8),
57*fsck*(8),
58*mkdosfs*(8),
59*mke2fs*(8),
60*mkfs.bfs*(8),
61*mkfs.ext2*(8),
62*mkfs.ext3*(8),
63*mkfs.ext4*(8),
64*mkfs.minix*(8),
65*mkfs.msdos*(8),
66*mkfs.vfat*(8),
67*mkfs.xfs*(8)
68
625e9c61 69include::man-common/bugreports.adoc[]
c6a568fc 70
625e9c61 71include::man-common/footer.adoc[]
c6a568fc
MB
72
73ifdef::translation[]
625e9c61 74include::man-common/translation.adoc[]
c6a568fc 75endif::[]