New upstream version 1.1.1
[sven/exfatprogs.git] / manpages / mkfs.exfat.8
1 .TH mkfs.exfat 8
2 .SH NAME
3 mkfs.exfat \- create an exFAT filesystem
4 .SH SYNOPSIS
5 .B mkfs.exfat
6 [
7 .B \-b
8 .I boundary_alignment
9 ] [
10 .B \-c
11 .I cluster_size
12 ] [
13 .B \-f
14 ] [
15 .B \-h
16 ] [
17 .B \-L
18 .I volume_label
19 ] [
20 .B \-\-pack\-bitmap
21 ] [
22 .B \-v
23 ]
24 .I device
25 .br
26 .B mkfs.exfat \-V
27 .SH DESCRIPTION
28 .B mkfs.exfat
29 creates an exFAT filesystem by writing on a special
30 file using the values found in the arguments of the command line.
31 It is invoked automatically by
32 .BR mkfs (8)
33 when it is given the
34 .B \-t exfat
35 option.
36 .PP
37 As an example, to make a filesystem on the first partition on the first
38 SCSI disk, use:
39 .IP
40 .B mkfs.exfat /dev/sda1
41 .PP
42 .SH OPTIONS
43 .TP
44 .BR \-b ", " \-\-boundary\-align =\fIalignment\fR
45 Specifies the alignment for the FAT and the start of the cluster heap.
46 The \fIalignment\fR argument is specified in bytes or may be specified with
47 \fBm\fR/\fBM\fR suffix for mebibytes or \fBk\fR/\fBK\fR suffix for kibibytes
48 and should be a power of two.
49 Some media like SD cards need this for optimal performance and endurance,
50 in which case \fIalignment\fR should be set to half of the card's native
51 boundary unit size.
52 If the card's native boundary unit size is not known, refer to the following
53 table of boundary unit sizes recommended by the SD Card Association.
54 .\" source: SD Specifications Part 2: File System Specification Version 3.00
55 .TS
56 center;
57 cb1s6cbcb,nnnn.
58 Card Capacity Range     Cluster Size    Boundary Unit
59 _
60         \[<=]8 MiB      8 KiB   8 KiB
61 >8 MiB  \[<=]64 MiB     16 KiB  16 KiB
62 >64 MiB \[<=]256 MiB    16 KiB  32 KiB
63 >256 MiB        \[<=]1 GiB      16 KiB  64 KiB
64 >1 GiB  \[<=]2 GiB      32 KiB  64 KiB
65 >2 GiB  \[<=]32 GiB     32 KiB  4 MiB
66 >32 GiB \[<=]128 GiB    128 KiB 16 MiB
67 >128 GiB        \[<=]512 GiB    256 KiB 32 MiB
68 >512 GiB        \[<=]2 TiB      512 KiB 64 MiB
69 .TE
70 .TP
71 .BR \-c ", " \-\-cluster\-size =\fIsize\fR
72 Specifies the cluster size of the exFAT file system.
73 The \fIsize\fR argument is specified in bytes or may be specified with
74 \fBm\fR/\fBM\fR suffix for mebibytes or \fBk\fR/\fBK\fR suffix for kibibytes
75 and must be a power of two.
76 .TP
77 .BR \-f ", " \-\-full\-format
78 Performs a full format.
79 This zeros the entire disk device while creating the exFAT filesystem.
80 .TP
81 .BR \-h ", " \-\-help
82 Prints the help and exit.
83 .TP
84 .BR \-L ", " \-\-volume\-label =\fIlabel\fR
85 Specifies the volume label to be associated with the exFAT filesystem.
86 .TP
87 .B \-\-pack\-bitmap
88 Attempts to relocate the exFAT allocation bitmap so that it ends at the
89 alignment boundary immediately following the FAT rather than beginning at that
90 boundary.
91 This strictly violates the SD card specification but may improve performance
92 and endurance on SD cards and other flash media not designed for use with exFAT
93 by allowing file-system metadata updates to touch fewer flash allocation units.
94 Furthermore, many SD cards and other flash devices specially optimize the
95 allocation unit where the FAT resides so as to support tiny writes with reduced
96 write amplification but expect only larger writes in subsequent allocation
97 units \[em] where the exFAT bitmap would be placed by default.
98 Specifying \fB\-\-pack\-bitmap\fR attempts to avoid the potential problems
99 associated with issuing many small writes to the bitmap by making it share an
100 allocation unit with the FAT.
101 If there is insufficient space for the bitmap there, then this option will have
102 no effect, and the bitmap will be aligned at the boundary as by default.
103 .TP
104 .BR \-v ", " \-\-verbose
105 Prints verbose debugging information while creating the exFAT filesystem.
106 .TP
107 .BR \-V ", " \-\-version
108 Prints the version number and exits.
109 .SH SEE ALSO
110 .BR mkfs (8),
111 .BR mount (8),