Tuxera NTFS driver
[tomato.git] / release / src-rt-6.x.4708 / router / tuxera / broadcom_arm / exfat / docs / manual / mkexfat.8
blobe8a3d3dab731ea317c8ecf9c61ee95aaf953070a
1 .\" Copyright (c) 2011-2012 Erik Larsson / Tuxera Inc.
2 .\"
3 .TH MKEXFAT 8 "August 2012" "Tuxera exFAT 3013.11.8"
4 .SH NAME
5 mkexfat \- create an exFAT file system
6 .SH SYNOPSIS
7 .B mkexfat
8 [\fIoptions\fR] \fIdevice\fR
9 .SH DESCRIPTION
10 .B mkexfat
11 is used to create an exFAT file system on a device (usually a disk or flash
12 partition) or image.
13 .I device
14 is the special file corresponding to the device (e.g.
15 .IR /dev/sdXX, 
16 .IR /dev/block/mmcblk1p1 )
17 or an image file.
18 .SH OPTIONS
19 Below is a summary of all the options that
20 .B mkexfat
21 accepts.  Nearly all options have two equivalent names.  The short name is
22 preceded by
23 .B \-
24 and the long name is preceded by
25 .BR \-\- .
26 .TP
27 \fB\-a\fR, \fB\-\-alignment\fR ALIGNMENT
28 The alignment of the different exFAT regions, specified in bytes. For instance
29 if a certain type of flash memory might perform best if the internal structures
30 are aligned to 4 MiB boundaries, alignment should be specified as 4194304.
31 .TP
32 \fB\-c\fR, \fB\-\-cluster\-size\fR SIZE
33 Set the cluster size (in bytes) of the volume to \fBSIZE\fR. The default is to
34 determine optimal cluster size automatically.
35 .TP
36 \fB\-f\fR, \fB\-\-force\fR
37 Allow formatting an exFAT volume for which the physical sector size cannot be
38 automatically detected (for example an image file).
39 .TP
40 \fB\-g\fR, \fB\-\-guid\fR GUID
41 Set the volume GUID of the volume to \fBGUID\fR (the default is to not set any
42 volume GUID).
43 .TP
44 \fB\-l\fR, \fB\-\-volume\-label\fR STRING
45 Set the volume label for the filesystem. The volume label can be up to 11
46 UTF\-16 units long, i.e. in most cases 11 characters.
47 .TP
48 \fB\-s\fR, \fB\-\-sector\-size\fR SIZE
49 Set the volume sector size (in bytes) to \fBSIZE\fR. The default is to
50 detect sector size automatically. Note: This option should probably never be
51 used when formatting devices directly as most exFAT drivers won't be able to use
52 an exFAT volume where the volume sector size doesn't match the physical sector
53 size (though exFAT/U can in fact do this).
54 .TP
55 \fB\-v\fR, \fB\-\-verbose\fR
56 Makes
57 .B mkexfat
58 emit certain status messages related to the formatting process.
59 .TP
60 \fB\-\-sda\-strict\fR
61 Forces the formatted volume to adhere to SD Association recommendations.
62 .TP
63 \fB\-\-sda\-whole\fR
64 Performs a whole device formatting, including partition table, according to the
65 SD Association recommendations. This option should only be used with whole
66 devices (e.g. \fI/dev/mmcblk0\fR) and never partitions (e.g. \fI/dev/mmcblk0p1\fR).
67 .TP
68 \fB\-\-sda\-relax\fR
69 Relaxes sanity checks for \fB\-\-sda\-strict\fR and \fB\-\-sda\-whole\fR to
70 allow formatting devices that don't comply to the size specifications of SD
71 cards to be formatted according to the SD Association guidelines.
73 NOTE: This option is only a modifier to \fB\-\-sda\-strict\fR and
74 \fB\-\-sda\-whole\fR and does not do anything on its own.
75 .TP
76 \fB\-\-discard\fR
77 This option sends a 'discard' command, like TRIM, to the device
78 which will zero all data on it.
79 .SH BUGS
80 If you find a bug please send an email describing the problem to 
81 exfat-support@tuxera.com.
82 .SH AUTHORS
83 .B mkexfat
84 was written by Erik Larsson, Tuxera Inc.
85 .SH AVAILABILITY
86 .B mkexfat
87 is part of the
88 .B Tuxera exFAT
89 package.
90 .hy
91 .SH SEE ALSO
92 .BR exfat\-u (8)