Add exfatprogs release signing key. ID D58529CC5376E36D6E1E6F6234F230FAF78E48D3 Hyunc...
[sven/exfatprogs.git] / README.md
1
2 ## exfatprogs
3 As new exfat filesystem is merged into linux-5.7 kernel, exfatprogs is
4 created as an official userspace utilities that contain all of the standard
5 utilities for creating and fixing and debugging exfat filesystem in linux
6 system. The goal of exfatprogs is to provide high performance and quality
7 at the level of exfat utilities in windows. And this software is licensed
8 under the GNU General Public License Version 2.
9
10 ## Building exfatprogs
11 Install prerequisite packages:
12 ```
13 For Ubuntu:
14     sudo apt-get install autoconf libtool pkg-config
15
16 For Fedora, RHEL:
17     sudo yum install autoconf automake libtool
18 ```
19
20 Build steps:
21 ```
22     cd into the exfatprogs directory:
23     ./autogen.sh
24     ./configure
25     make
26     make install
27 ```
28
29 ## Using exfatprogs
30 ```
31 - mkfs.exfat:
32     Build a exfat filesystem on a device or partition(e.g. /dev/hda1, dev/sda1).
33
34 Usage example:
35     1. No option(default) : cluster size adjustment as per device size, quick format.
36         mkfs.exfat /dev/sda1
37     2. To change cluster size(KB or MB or Byte) user want
38         mkfs.exfat -c 1048576 /dev/sda1
39         mkfs.exfat -c 1024K /dev/sda1
40         mkfs.exfat -c 1M /dev/sda1
41     3. For full format(zero out)
42         mkfs.exfat -f /dev/sda1
43     4. For set volume label, use -l option with string user want.
44         mkfs.exfat -L "my usb" /dev/sda1
45
46 - fsck.exfat:
47     Check the consistency of your exfat filesystem and optionally repair a corrupted device formatted by exfat.
48
49 Usage example:
50     1. check the consistency.
51         fsck.exfat /dev/sda1
52     2. repair and fix.(preparing)
53
54 - tune.exfat:
55     Adjust tunable filesystem parameters on an exFAT filesystem
56
57 Usage example:
58     1. print current volume label.
59         tune.exfat -l /dev/sda1
60     2. set new volume label.
61         tune.exfat -L "new label" /dev/sda1
62 ```
63
64 ## Sending feedback
65 If you have any issues, please create [issues][1] or contact to [Namjae Jeon](mailto:linkinjeon@kernel.org) and
66 [Hyunchul Lee](mailto:hyc.lee@gmail.com).
67 [Contributions][2] are also welcome.
68
69 [1]: https://github.com/exfatprogs/exfatprogs/issues
70 [2]: https://github.com/exfatprogs/exfatprogs/pulls