a1b51d45b816232528a7461f99c3fa7ba4cb4cbb
[platform/upstream/dosfstools.git] / manpages / de / mkfs.fat.de.8
1 .\" mkfs.fat.8 - manpage for fs.fatck
2 .\"
3 .\" Copyright (C) 2006-2014 Daniel Baumann <daniel@debian.org>
4 .\"
5 .\" This program is free software: you can redistribute it and/or modify
6 .\" it under the terms of the GNU General Public License as published by
7 .\" the Free Software Foundation, either version 3 of the License, or
8 .\" (at your option) any later version.
9 .\"
10 .\" This program is distributed in the hope that it will be useful,
11 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 .\" GNU General Public License for more details.
14 .\"
15 .\" You should have received a copy of the GNU General Public License
16 .\" along with this program. If not, see <http://www.gnu.org/licenses/>.
17 .\"
18 .\" The complete text of the GNU General Public License
19 .\" can be found in /usr/share/common-licenses/GPL-3 file.
20 .\"
21 .\"
22 .\"*******************************************************************
23 .\"
24 .\" This file was generated with po4a. Translate the source file.
25 .\"
26 .\"*******************************************************************
27 .TH MKFS.FAT 8 2015\-05\-16 3.0.28 dosfstools
28 .SH NAME
29 .\" ----------------------------------------------------------------------------
30 \fBmkfs.fat\fP \- create an MS\-DOS filesystem under Linux
31 .SH SYNOPSIS
32 .\" ----------------------------------------------------------------------------
33 \fBmkfs.fat\fP [\fIOPTIONS\fP] \fIDEVICE\fP [\fIBLOCK\-COUNT\fP]
34 .SH DESCRIPTION
35 .\" ----------------------------------------------------------------------------
36 \fBmkfs.fat\fP is used to create an MS\-DOS filesystem under Linux on a device
37 (usually a disk partition).  \fIDEVICE\fP is the special file corresponding to
38 the device (e.g. /dev/sdXX).  \fIBLOCK\-COUNT\fP is the number of blocks on the
39 device.  If omitted, \fBmkfs.fat\fP automatically determines the filesystem
40 size.
41 .SH OPTIONS
42 .IP \fB\-a\fP 4
43 Normally, for any filesystem except very small ones, \fBmkfs.fat\fP will align
44 all the data structures to cluster size, to make sure that as long as the
45 partition is properly aligned, so will all the data structures in the
46 filesystem.  This option disables alignment; this may provide a handful of
47 additional clusters of storage at the expense of a significant performance
48 degradation on RAIDs, flash media or large\-sector hard disks.
49 .IP "\fB \-A\fP" 4
50 Use Atari variation of the MS\-DOS filesystem.  This is default if
51 \fBmkfs.fat\fP is run on an Atari, then this option turns off Atari format.
52 There are some differences when using Atari format: If not directed
53 otherwise by the user, \fBmkfs.fat\fP will always use 2 sectors per cluster,
54 since GEMDOS doesn't like other values very much.  It will also obey the
55 maximum number of sectors GEMDOS can handle.  Larger filesystems are managed
56 by raising the logical sector size.  Under Atari format, an Atari\-compatible
57 serial number for the filesystem is generated, and a 12 bit FAT is used only
58 for filesystems that have one of the usual floppy sizes (720k, 1.2M, 1.44M,
59 2.88M), a 16 bit FAT otherwise.  This can be overridden with the \fB\-F\fP
60 option.  Some PC\-specific boot sector fields aren't written, and a boot
61 message (option \fB\-m\fP) is ignored.
62 .IP "\fB\-b\fP \fISECTOR\-OF\-BACKUP\fP" 4
63 Selects the location of the backup boot sector for FAT32.  Default depends
64 on number of reserved sectors, but usually is sector 6.  The backup must be
65 within the range of reserved sectors.
66 .IP \fB\-c\fP 4
67 Check the device for bad blocks before creating the filesystem.
68 .IP \fB\-C\fP 4
69 Create the file given as \fIDEVICE\fP on the command line, and write the
70 to\-be\-created filesystem to it.  This can be used to create the new
71 filesystem in a file instead of on a real device, and to avoid using \fBdd\fP
72 in advance to create a file of appropriate size.  With this option, the
73 \fIBLOCK\-COUNT\fP must be given, because otherwise the intended size of the
74 filesystem wouldn't be known.  The file created is a sparse file, which
75 actually only contains the meta\-data areas (boot sector, FATs, and root
76 directory).  The data portions won't be stored on the disk, but the file
77 nevertheless will have the correct size.  The resulting file can be copied
78 later to a floppy disk or other device, or mounted through a loop device.
79 .IP "\fB\-D\fP \fIDRIVE\-NUMBER\fP" 4
80 Specify the BIOS drive number to be stored in the FAT boot sector.  This
81 value is usually 0x80 for hard disks and 0x00 for floppy devices or
82 partitions to be used for floppy emulation.
83 .IP "\fB\-f\fP \fINUMBER\-OF\-FATS\fP" 4
84 Specify the number of file allocation tables in the filesystem.  The default
85 is 2.
86 .IP "\fB\-F\fP \fIFAT\-SIZE\fP" 4
87 Specifies the type of file allocation tables used (12, 16 or 32 bit).  If
88 nothing is specified, \fBmkfs.fat\fP will automatically select between 12, 16
89 and 32 bit, whatever fits better for the filesystem size.
90 .IP "\fB\-h\fP \fINUMBER\-OF\-HIDDEN\-SECTORS\fP" 4
91 Select the number of hidden sectors in the volume.  Apparently some digital
92 cameras get indigestion if you feed them a CF card without such hidden
93 sectors, this option allows you to satisfy them.
94 .IP "\fB\-i\fP \fIVOLUME\-ID\fP" 4
95 Sets the volume ID of the newly created filesystem; \fIVOLUME\-ID\fP is a 32\-bit
96 hexadecimal number (for example, 2e24ec82).  The default is a number which
97 depends on the filesystem creation time.
98 .IP \fB\-I\fP 4
99 It is typical for fixed disk devices to be partitioned so, by default, you
100 are not permitted to create a filesystem across the entire device.
101 \fBmkfs.fat\fP will complain and tell you that it refuses to work.  This is
102 different when using MO disks.  One doesn't always need partitions on MO
103 disks.  The filesystem can go directly to the whole disk.  Under other OSes
104 this is known as the 'superfloppy' format.  This switch will force
105 \fBmkfs.fat\fP to work properly.
106 .IP "\fB\-l\fP \fIFILENAME\fP" 4
107 Read the bad blocks list from \fIFILENAME\fP.
108 .IP "\fB\-m\fP \fIMESSAGE\-FILE\fP" 4
109 Sets the message the user receives on attempts to boot this filesystem
110 without having properly installed an operating system.  The message file
111 must not exceed 418 bytes once line feeds have been converted to carriage
112 return\-line feed combinations, and tabs have been expanded.  If the filename
113 is a hyphen (\-), the text is taken from standard input.
114 .IP "\fB\-M\fP \fIFAT\-MEDIA\-TYPE\fP" 4
115 Specify the media type to be stored in the FAT boot sector.  This value is
116 usually 0xF8 for hard disks and is 0xF0 or a value from 0xF9 to 0xFF for
117 floppies or partitions to be used for floppy emulation.
118 .IP "\fB\-n\fP \fIVOLUME\-NAME\fP" 4
119 Sets the volume name (label) of the filesystem.  The volume name can be up
120 to 11 characters long.  The default is no label.
121 .IP "\fB\-r\fP \fIROOT\-DIR\-ENTRIES\fP" 4
122 Select the number of entries available in the root directory.  The default
123 is 112 or 224 for floppies and 512 for hard disks.
124 .IP "\fB\-R\fP \fINUMBER\-OF\-RESERVED\-SECTORS\fP" 4
125 Select the number of reserved sectors.  With FAT32 format at least 2
126 reserved sectors are needed, the default is 32.  Otherwise the default is 1
127 (only the boot sector).
128 .IP "\fB\-s\fP \fISECTORS\-PER\-CLUSTER\fP" 4
129 Specify the number of disk sectors per cluster.  Must be a power of 2,
130 i.e. 1, 2, 4, 8, ... 128.
131 .IP "\fB\-S\fP \fILOGICAL\-SECTOR\-SIZE\fP" 4
132 Specify the number of bytes per logical sector.  Must be a power of 2 and
133 greater than or equal to 512, i.e. 512, 1024, 2048, 4096, 8192, 16384, or
134 32768.
135 .IP \fB\-v\fP 4
136 Verbose execution.
137 .IP \fB\-\-invariant\fP 4
138 Use constants for normally randomly generated or time based data such as
139 volume ID and creation time.  Multiple runs of \fBmkfs.fat\fP on the same
140 device create identical results with this option.  Its main purpose is
141 testing \fBmkfs.fat\fP.
142 .IP \fB\-\-help\fP 4
143 .\" ----------------------------------------------------------------------------
144 Display option summary and exit.
145 .SH BUGS
146 .\" ----------------------------------------------------------------------------
147 \fBmkfs.fat\fP can not create boot\-able filesystems.  This isn't as easy as you
148 might think at first glance for various reasons and has been discussed a lot
149 already.  \fBmkfs.fat\fP simply will not support it ;)
150 .SH "SEE ALSO"
151 \fBfatlabel\fP(8)
152 .br
153 .\" ----------------------------------------------------------------------------
154 \fBfsck.fat\fP(8)
155 .SH HOMEPAGE
156 .\" ----------------------------------------------------------------------------
157 The home for the \fBdosfstools\fP project is its
158 .UR https://github.com/dosfstools/dosfstools
159 GitHub project page
160 .UE .
161 .SH AUTHORS
162 \fBdosfstools\fP were written by
163 .MT werner.almesberger@\:lrc.di.epfl.ch
164 Werner Almesberger
165 .ME ,
166 .MT Roman.Hodek@\:informatik.\:uni-erlangen.de
167 Roman Hodek
168 .ME ,
169 and others.  The current maintainer is
170 .MT aeb@\:debian.org
171 Andreas Bombe
172 .ME .