Tuxera NTFS driver
[tomato.git] / release / src-rt-6.x.4708 / router / tuxera / broadcom_arm / exfat / docs / html / mkexfat.html
blob8d8edbd90750e7eb9f8cfa1d0cbb6859224c9db4
1 <!-- Creator : groff version 1.21 -->
2 <!-- CreationDate: Mon Jul 14 01:50:21 2014 -->
3 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
4 "http://www.w3.org/TR/html4/loose.dtd">
5 <html>
6 <head>
7 <meta name="generator" content="groff -Thtml, see www.gnu.org">
8 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
9 <meta name="Content-Style" content="text/css">
10 <style type="text/css">
11 p { margin-top: 0; margin-bottom: 0; vertical-align: top }
12 pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
13 table { margin-top: 0; margin-bottom: 0; vertical-align: top }
14 h1 { text-align: center }
15 </style>
16 <title>MKEXFAT</title>
18 </head>
19 <body>
21 <h1 align="center">MKEXFAT</h1>
23 <a href="#NAME">NAME</a><br>
24 <a href="#SYNOPSIS">SYNOPSIS</a><br>
25 <a href="#DESCRIPTION">DESCRIPTION</a><br>
26 <a href="#OPTIONS">OPTIONS</a><br>
27 <a href="#BUGS">BUGS</a><br>
28 <a href="#AUTHORS">AUTHORS</a><br>
29 <a href="#AVAILABILITY">AVAILABILITY</a><br>
30 <a href="#SEE ALSO">SEE ALSO</a><br>
32 <hr>
35 <h2>NAME
36 <a name="NAME"></a>
37 </h2>
40 <p style="margin-left:11%; margin-top: 1em">mkexfat &minus;
41 create an exFAT file system</p>
43 <h2>SYNOPSIS
44 <a name="SYNOPSIS"></a>
45 </h2>
48 <p style="margin-left:11%; margin-top: 1em"><b>mkexfat</b>
49 [<i>options</i>] <i>device</i></p>
51 <h2>DESCRIPTION
52 <a name="DESCRIPTION"></a>
53 </h2>
57 <p style="margin-left:11%; margin-top: 1em"><i><b>mkexfat</b></i>
58 is used to create an exFAT file system on a device (usually
59 a disk or flash partition) or image. <i>device</i> is the
60 special file corresponding to the device (e.g. <i>/dev/sdXX,
61 /dev/block/mmcblk1p1</i>) or an image file.</p>
63 <h2>OPTIONS
64 <a name="OPTIONS"></a>
65 </h2>
68 <p style="margin-left:11%; margin-top: 1em">Below is a
69 summary of all the options that <b>mkexfat</b> accepts.
70 Nearly all options have two equivalent names. The short name
71 is preceded by <b>&minus;</b> and the long name is preceded
72 by <b>&minus;&minus;</b>. <b><br>
73 &minus;a</b>, <b>&minus;&minus;alignment</b> ALIGNMENT</p>
75 <p style="margin-left:22%;">The alignment of the different
76 exFAT regions, specified in bytes. For instance if a certain
77 type of flash memory might perform best if the internal
78 structures are aligned to 4 MiB boundaries, alignment should
79 be specified as 4194304.</p>
81 <p style="margin-left:11%;"><b>&minus;c</b>,
82 <b>&minus;&minus;cluster&minus;size</b> SIZE</p>
84 <p style="margin-left:22%;">Set the cluster size (in bytes)
85 of the volume to <b>SIZE</b>. The default is to determine
86 optimal cluster size automatically.</p>
88 <p style="margin-left:11%;"><b>&minus;f</b>,
89 <b>&minus;&minus;force</b></p>
91 <p style="margin-left:22%;">Allow formatting an exFAT
92 volume for which the physical sector size cannot be
93 automatically detected (for example an image file).</p>
95 <p style="margin-left:11%;"><b>&minus;g</b>,
96 <b>&minus;&minus;guid</b> GUID</p>
98 <p style="margin-left:22%;">Set the volume GUID of the
99 volume to <b>GUID</b> (the default is to not set any volume
100 GUID).</p>
102 <p style="margin-left:11%;"><b>&minus;l</b>,
103 <b>&minus;&minus;volume&minus;label</b> STRING</p>
105 <p style="margin-left:22%;">Set the volume label for the
106 filesystem. The volume label can be up to 11 UTF&minus;16
107 units long, i.e. in most cases 11 characters.</p>
109 <p style="margin-left:11%;"><b>&minus;s</b>,
110 <b>&minus;&minus;sector&minus;size</b> SIZE</p>
112 <p style="margin-left:22%;">Set the volume sector size (in
113 bytes) to <b>SIZE</b>. The default is to detect sector size
114 automatically. Note: This option should probably never be
115 used when formatting devices directly as most exFAT drivers
116 won&rsquo;t be able to use an exFAT volume where the volume
117 sector size doesn&rsquo;t match the physical sector size
118 (though exFAT/U can in fact do this).</p>
120 <p style="margin-left:11%;"><b>&minus;v</b>,
121 <b>&minus;&minus;verbose</b></p>
123 <p style="margin-left:22%;">Makes <b>mkexfat</b> emit
124 certain status messages related to the formatting
125 process.</p>
128 <p style="margin-left:11%;"><b>&minus;&minus;sda&minus;strict</b></p>
130 <p style="margin-left:22%;">Forces the formatted volume to
131 adhere to SD Association recommendations.</p>
134 <p style="margin-left:11%;"><b>&minus;&minus;sda&minus;whole</b></p>
136 <p style="margin-left:22%;">Performs a whole device
137 formatting, including partition table, according to the SD
138 Association recommendations. This option should only be used
139 with whole devices (e.g. <i>/dev/mmcblk0</i>) and never
140 partitions (e.g. <i>/dev/mmcblk0p1</i>).</p>
143 <p style="margin-left:11%;"><b>&minus;&minus;sda&minus;relax</b></p>
145 <p style="margin-left:22%;">Relaxes sanity checks for
146 <b>&minus;&minus;sda&minus;strict</b> and
147 <b>&minus;&minus;sda&minus;whole</b> to allow formatting
148 devices that don&rsquo;t comply to the size specifications
149 of SD cards to be formatted according to the SD Association
150 guidelines.</p>
152 <p style="margin-left:22%; margin-top: 1em">NOTE: This
153 option is only a modifier to
154 <b>&minus;&minus;sda&minus;strict</b> and
155 <b>&minus;&minus;sda&minus;whole</b> and does not do
156 anything on its own.</p>
159 <p style="margin-left:11%;"><b>&minus;&minus;discard</b></p>
161 <p style="margin-left:22%;">This option sends a
162 &rsquo;discard&rsquo; command, like TRIM, to the device
163 which will zero all data on it.</p>
165 <h2>BUGS
166 <a name="BUGS"></a>
167 </h2>
170 <p style="margin-left:11%; margin-top: 1em">If you find a
171 bug please send an email describing the problem to
172 exfat-support@tuxera.com.</p>
174 <h2>AUTHORS
175 <a name="AUTHORS"></a>
176 </h2>
179 <p style="margin-left:11%; margin-top: 1em"><b>mkexfat</b>
180 was written by Erik Larsson, Tuxera Inc.</p>
182 <h2>AVAILABILITY
183 <a name="AVAILABILITY"></a>
184 </h2>
187 <p style="margin-left:11%; margin-top: 1em"><b>mkexfat</b>
188 is part of the <b>Tuxera exFAT</b> package.</p>
190 <h2>SEE ALSO
191 <a name="SEE ALSO"></a>
192 </h2>
196 <p style="margin-left:11%; margin-top: 1em"><b>exfat&minus;u</b>(8)</p>
197 <hr>
198 </body>
199 </html>