| 1 |
.\" mkfs.fat.8 - manpage for fs.fatck |
| 2 |
.\" |
| 3 |
.\" Copyright (C) 2006-2014 Daniel Baumann <[email protected]> |
| 4 |
.\" Copyright (C) 2016 Andreas Bombe <[email protected]> |
| 5 |
.\" Copyright (C) 2018-2021 Pali Rohár <[email protected]> |
| 6 |
.\" |
| 7 |
.\" This program is free software: you can redistribute it and/or modify |
| 8 |
.\" it under the terms of the GNU General Public License as published by |
| 9 |
.\" the Free Software Foundation, either version 3 of the License, or |
| 10 |
.\" (at your option) any later version. |
| 11 |
.\" |
| 12 |
.\" This program is distributed in the hope that it will be useful, |
| 13 |
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 |
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 |
.\" GNU General Public License for more details. |
| 16 |
.\" |
| 17 |
.\" You should have received a copy of the GNU General Public License |
| 18 |
.\" along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 19 |
.\" |
| 20 |
.\" The complete text of the GNU General Public License |
| 21 |
.\" can be found in /usr/share/common-licenses/GPL-3 file. |
| 22 |
.\" |
| 23 |
.\" |
| 24 |
.TH MKFS.FAT 8 2021-01-31 "dosfstools 4.2" |
| 25 |
.SH NAME |
| 26 |
mkfs.fat \- create an MS-DOS FAT filesystem |
| 27 |
.\" ---------------------------------------------------------------------------- |
| 28 |
.SH SYNOPSIS |
| 29 |
\fBmkfs.fat\fP [\fIOPTIONS\fP] \fIDEVICE\fP [\fIBLOCK-COUNT\fP] |
| 30 |
.\" ---------------------------------------------------------------------------- |
| 31 |
.SH DESCRIPTION |
| 32 |
\fBmkfs.fat\fP is used to create a FAT filesystem on a device or in an image |
| 33 |
file. |
| 34 |
\fIDEVICE\fP is the special file corresponding to the device (e.g. /dev/sdXX) or |
| 35 |
the image file (which does not need to exist when the option \fB-C\fP is given). |
| 36 |
\fIBLOCK-COUNT\fP is the number of blocks on the device and size of one block is |
| 37 |
always 1024 bytes, independently of the sector size or the cluster size. |
| 38 |
Therefore \fIBLOCK-COUNT\fP specifies size of filesystem in KiB unit and not in |
| 39 |
the number of sectors (like for all other \fBmkfs.fat\fP options). |
| 40 |
If omitted, \fBmkfs.fat\fP automatically chooses a filesystem size to fill the |
| 41 |
available space. |
| 42 |
.PP |
| 43 |
Two different variants of the FAT filesystem are supported. |
| 44 |
Standard is the FAT12, FAT16 and FAT32 filesystems as defined by Microsoft and |
| 45 |
widely used on hard disks and removable media like USB sticks and SD cards. |
| 46 |
The other is the legacy Atari variant used on Atari ST. |
| 47 |
.PP |
| 48 |
In Atari mode, if not directed otherwise by the user, \fBmkfs.fat\fP will |
| 49 |
always use 2 sectors per cluster, since GEMDOS doesn't like other values very |
| 50 |
much. |
| 51 |
It will also obey the maximum number of sectors GEMDOS can handle. |
| 52 |
Larger filesystems are managed by raising the logical sector size. |
| 53 |
An Atari-compatible serial number for the filesystem is generated, and a 12 bit |
| 54 |
FAT is used only for filesystems that have one of the usual floppy sizes (720k, |
| 55 |
1.2M, 1.44M, 2.88M), a 16 bit FAT otherwise. |
| 56 |
This can be overridden with the \fB\-F\fP option. |
| 57 |
Some PC-specific boot sector fields aren't written, and a boot message (option |
| 58 |
\fB\-m\fP) is ignored. |
| 59 |
.\" ---------------------------------------------------------------------------- |
| 60 |
.SH OPTIONS |
| 61 |
.IP "\fB\-a\fP" 4 |
| 62 |
Normally, for any filesystem except very small ones, \fBmkfs.fat\fP will align |
| 63 |
all the data structures to cluster size, to make sure that as long as the |
| 64 |
partition is properly aligned, so will all the data structures in the |
| 65 |
filesystem. |
| 66 |
This option disables alignment; this may provide a handful of additional |
| 67 |
clusters of storage at the expense of a significant performance degradation on |
| 68 |
RAIDs, flash media or large-sector hard disks. |
| 69 |
.IP "\fB\-A\fP" 4 |
| 70 |
Select using the Atari variation of the FAT filesystem if that isn't active |
| 71 |
already, otherwise select standard FAT filesystem. |
| 72 |
This is selected by default if \fBmkfs.fat\fP is run on 68k Atari Linux. |
| 73 |
.IP "\fB\-b\fP \fISECTOR-OF-BACKUP\fP" 4 |
| 74 |
Selects the location of the backup boot sector for FAT32. |
| 75 |
Default depends on number of reserved sectors, but usually is sector 6. |
| 76 |
If there is a free space available after the backup boot sector then backup of |
| 77 |
the FAT32 info sector is put after the backup boot sector, usually at sector 7. |
| 78 |
The backup must be within the range of reserved sectors. |
| 79 |
Value 0 completely disables creating of backup boot and info FAT32 sectors. |
| 80 |
.IP "\fB\-c" 4 |
| 81 |
Check the device for bad blocks before creating the filesystem. |
| 82 |
.IP "\fB\-C\fP" 4 |
| 83 |
Create the file given as \fIDEVICE\fP on the command line, and write the |
| 84 |
to-be-created filesystem to it. |
| 85 |
This can be used to create the new filesystem in a file instead of on a real |
| 86 |
device, and to avoid using \fBdd\fP in advance to create a file of appropriate |
| 87 |
size. |
| 88 |
With this option, the \fIBLOCK-COUNT\fP must be given, because otherwise the |
| 89 |
intended size of the filesystem wouldn't be known. |
| 90 |
The file created is a sparse file, which actually only contains the meta-data |
| 91 |
areas (boot sector, FATs, and root directory). |
| 92 |
The data portions won't be stored on the disk, but the file nevertheless will |
| 93 |
have the correct size. |
| 94 |
The resulting file can be copied later to a floppy disk or other device, or |
| 95 |
mounted through a loop device. |
| 96 |
.IP "\fB\-D\fP \fIDRIVE-NUMBER\fP" 4 |
| 97 |
Specify the BIOS drive number to be stored in the FAT boot sector. |
| 98 |
For hard disks and removable medias it is usually 0x80\(en0xFF (0x80 is first |
| 99 |
hard disk C:, 0x81 is second hard disk D:, ...), for floppy devices or |
| 100 |
partitions to be used for floppy emulation it is 0x00\(en0x7F (0x00 is first |
| 101 |
floppy A:, 0x01 is second floppy B:). |
| 102 |
.IP "\fB\-f\fP \fINUMBER-OF-FATS\fP" 4 |
| 103 |
Specify the number of file allocation tables in the filesystem. |
| 104 |
The default is 2. |
| 105 |
.IP "\fB\-F\fP \fIFAT-SIZE\fP" 4 |
| 106 |
Specifies the type of file allocation tables used (12, 16 or 32 bit). |
| 107 |
If nothing is specified, \fBmkfs.fat\fP will automatically select between 12, 16 |
| 108 |
and 32 bit, whatever fits better for the filesystem size. |
| 109 |
.IP "\fB\-g\fP \fIHEADS\fP/\fISECTORS-PER-TRACK\fP" 4 |
| 110 |
Specify \fIHEADS\fP and \fISECTORS-PER-TRACK\fP numbers which represents |
| 111 |
disk geometry of \fIDEVICE\fP. |
| 112 |
Both numbers are stored into the FAT boot sector. |
| 113 |
Number \fISECTORS-PER-TRACK\fP is used also for aligning the total count of FAT |
| 114 |
sectors. |
| 115 |
By default disk geometry is read from \fIDEVICE\fP itself. |
| 116 |
If it is not available then \fILBA-Assist Translation\fP and translation table |
| 117 |
from the \fISD Card Part 2 File System Specification\fP based on total number |
| 118 |
of disk sectors is used. |
| 119 |
.IP "\fB\-h\fP \fINUMBER-OF-HIDDEN-SECTORS\fP" 4 |
| 120 |
Specify the number of so-called \fIhidden sectors\fP, as stored in the FAT boot |
| 121 |
sector: this number represents the beginning sector of the partition containing |
| 122 |
the file system. |
| 123 |
Normally this is an offset (in sectors) relative to the start of the disk, |
| 124 |
although for MBR logical volumes contained in an extended partition of type 0x05 |
| 125 |
(a non-LBA extended partition), a quirk in the MS-DOS implementation of FAT |
| 126 |
requires it to be relative to the partition's immediate containing Extended Boot |
| 127 |
Record. |
| 128 |
Boot code and other software handling FAT volumes may also rely on this field |
| 129 |
being set up correctly; most modern FAT implementations will ignore it. |
| 130 |
By default, if the \fIDEVICE\fP is a partition block device, \fBmkfs.fat\fP uses |
| 131 |
the partition offset relative to disk start. |
| 132 |
Otherwise, \fBmkfs.fat\fP assumes zero. |
| 133 |
Use this option to override this behaviour. |
| 134 |
.IP "\fB\-i\fP \fIVOLUME-ID\fP" 4 |
| 135 |
Sets the volume ID of the newly created filesystem; \fIVOLUME-ID\fP is a 32-bit |
| 136 |
hexadecimal number (for example, 2e24ec82). |
| 137 |
The default is a number which depends on the filesystem creation time. |
| 138 |
.IP "\fB\-I\fP" 4 |
| 139 |
Ignore and disable safety checks. |
| 140 |
By default \fBmkfs.fat\fP refuses to create a filesystem on a device with |
| 141 |
partitions or virtual mapping. |
| 142 |
\fBmkfs.fat\fP will complain and tell you that it refuses to work. |
| 143 |
This is different when using MO disks. |
| 144 |
One doesn't always need partitions on MO disks. |
| 145 |
The filesystem can go directly to the whole disk. |
| 146 |
Under other OSes this is known as the \fIsuperfloppy\fP format. |
| 147 |
This switch will force \fBmkfs.fat\fP to work properly. |
| 148 |
.IP "\fB\-l\fP \fIFILENAME\fP" 4 |
| 149 |
Read the bad blocks list from \fIFILENAME\fP. |
| 150 |
.IP "\fB\-m\fP \fIMESSAGE-FILE\fP" 4 |
| 151 |
Sets the message the user receives on attempts to boot this filesystem without |
| 152 |
having properly installed an operating system. |
| 153 |
The message file must not exceed 418 bytes once line feeds have been converted |
| 154 |
to carriage return-line feed combinations, and tabs have been expanded. |
| 155 |
If the filename is a hyphen (-), the text is taken from standard input. |
| 156 |
.IP "\fB\-M\fP \fIFAT-MEDIA-TYPE\fP" 4 |
| 157 |
Specify the media type to be stored in the FAT boot sector. |
| 158 |
This value is usually 0xF8 for hard disks and is 0xF0 or a value from 0xF9 to |
| 159 |
0xFF for floppies or partitions to be used for floppy emulation. |
| 160 |
.IP "\fB\-\-mbr\fP[=\fIy\fP|\fIyes\fP|\fIn\fP|\fIno\fP|\fIa\fP|\fIauto\fP]" 4 |
| 161 |
Fill (fake) MBR table with disk signature one partition which starts at sector |
| 162 |
0 (includes MBR itself) and spans whole disk device. |
| 163 |
It is needed only for non-removable disks used on Microsoft Windows systems and |
| 164 |
only when formatting whole unpartitioned disk. |
| 165 |
Location of the disk signature and partition table overlaps with the end of the |
| 166 |
first FAT sector (boot code location), therefore there is no additional space |
| 167 |
usage. |
| 168 |
Default is \fIauto\fP mode in which \fBmkfs.fat\fP put MBR table only for |
| 169 |
non-removable disks when formatting whole unpartitioned disk. |
| 170 |
.IP "\fB\-n\fP \fIVOLUME-NAME\fP" 4 |
| 171 |
Sets the volume name (label) of the filesystem. |
| 172 |
The volume name can be up to 11 characters long. |
| 173 |
Supplying an empty string, a string consisting only of white space or the |
| 174 |
string "NO NAME" as \fIVOLUME-NAME\fP has the same effect as not giving the |
| 175 |
\fB\-n\fP option. |
| 176 |
The default is no label. |
| 177 |
.IP "\fB\-\-codepage\fP=\fIPAGE\fP" 4 |
| 178 |
Use DOS codepage \fIPAGE\fP to encode label. |
| 179 |
By default codepage 850 is used. |
| 180 |
.IP "\fB\-r\fP \fIROOT-DIR-ENTRIES\fP" 4 |
| 181 |
Select the minimal number of entries available in the root directory. |
| 182 |
The default is 112 or 224 for floppies and 512 for hard disks. |
| 183 |
Note that this is minimal number and it may be increased by \fBmkfs.fat\fP |
| 184 |
due to alignment of structures. |
| 185 |
See also \fBmkfs.fat\fP option \fB\-a\fP. |
| 186 |
.IP "\fB\-R\fP \fINUMBER-OF-RESERVED-SECTORS\fP" 4 |
| 187 |
Select the minimal number of reserved sectors. |
| 188 |
With FAT32 format at least 2 reserved sectors are needed, the default is 32. |
| 189 |
Otherwise the default is 1 (only the boot sector). |
| 190 |
Note that this is minimal number and it may be increased by \fBmkfs.fat\fP |
| 191 |
due to alignment of structures. |
| 192 |
See also \fBmkfs.fat\fP option \fB\-a\fP. |
| 193 |
.IP "\fB\-s\fP \fISECTORS-PER-CLUSTER\fP" 4 |
| 194 |
Specify the number of disk sectors per cluster. |
| 195 |
Must be a power of 2, i.e. 1, 2, 4, 8, ... 128. |
| 196 |
.IP "\fB\-S\fP \fILOGICAL-SECTOR-SIZE\fP" 4 |
| 197 |
Specify the number of bytes per logical sector. |
| 198 |
Must be a power of 2 and greater than or equal to 512, i.e. 512, 1024, 2048, |
| 199 |
4096, 8192, 16384, or 32768. |
| 200 |
Values larger than 4096 are not conforming to the FAT file system specification |
| 201 |
and may not work everywhere. |
| 202 |
.IP "\fB\-v\fP" 4 |
| 203 |
Verbose execution. |
| 204 |
.IP "\fB\-\-offset\fP \fISECTOR\fP" 4 |
| 205 |
Write the filesystem at a specific sector into the device file. |
| 206 |
This is useful for creating a filesystem in a partitioned disk image without |
| 207 |
having to set up a loop device. |
| 208 |
.IP "\fB\-\-variant\fP \fITYPE\fP" 4 |
| 209 |
Create a filesystem of variant \fITYPE\fP. |
| 210 |
Acceptable values are \fIstandard\fP and \fIatari\fP (in any combination of |
| 211 |
upper/lower case). |
| 212 |
See above under DESCRIPTION for the differences. |
| 213 |
.IP "\fB\-\-help\fP" 4 |
| 214 |
Display option summary and exit. |
| 215 |
.IP "\fB\-\-invariant\fP" 4 |
| 216 |
Use constants for normally randomly generated or time based data such as |
| 217 |
volume ID and creation time. |
| 218 |
Multiple runs of \fBmkfs.fat\fP on the same device create identical results |
| 219 |
with this option. |
| 220 |
Its main purpose is testing \fBmkfs.fat\fP. |
| 221 |
.\" ---------------------------------------------------------------------------- |
| 222 |
.SH BUGS |
| 223 |
\fBmkfs.fat\fP can not create boot-able filesystems. |
| 224 |
This isn't as easy as you might think at first glance for various reasons and |
| 225 |
has been discussed a lot already. |
| 226 |
\fBmkfs.fat\fP simply will not support it ;) |
| 227 |
.\" ---------------------------------------------------------------------------- |
| 228 |
.SH SEE ALSO |
| 229 |
.BR fatlabel (8), |
| 230 |
.BR fsck.fat (8) |
| 231 |
.\" ---------------------------------------------------------------------------- |
| 232 |
.SH HOMEPAGE |
| 233 |
The home for the \fBdosfstools\fP project is its |
| 234 |
.UR https://github.com/dosfstools/dosfstools |
| 235 |
GitHub project page |
| 236 |
.UE . |
| 237 |
.\" ---------------------------------------------------------------------------- |
| 238 |
.SH AUTHORS |
| 239 |
\fBdosfstools\fP were written by |
| 240 |
.MT werner.almesberger@\:lrc.di.epfl.ch |
| 241 |
Werner Almesberger |
| 242 |
.ME , |
| 243 |
.MT Roman.Hodek@\:informatik.\:uni-erlangen.de |
| 244 |
Roman Hodek |
| 245 |
.ME , |
| 246 |
and others. |
| 247 |
Current maintainers are |
| 248 |
.MT aeb@\:debian.org |
| 249 |
Andreas Bombe |
| 250 |
.ME |
| 251 |
and |
| 252 |
.MT pali.rohar@\:gmail.com |
| 253 |
Pali Rohár |
| 254 |
.ME . |