Imported Upstream version 1.2.1
[sven/exfat-utils.git] / README
1 About
2 -----
3
4 This project aims to provide a full-featured [exFAT][1] file system implementation for Unix-like systems. It consists of a [FUSE][2] module (fuse-exfat) and a set of utilities (exfat-utils).
5
6 Supported operating systems:
7
8 * GNU/Linux
9 * Mac OS X 10.5 or later
10 * FreeBSD
11 * OpenBSD
12
13 Most GNU/Linux distributions already have fuse-exfat and exfat-utils in their repositories, so you can just install and use them. The next chapter describes how to compile them from source.
14
15 Compiling
16 ---------
17
18 To build this project under GNU/Linux you need to install the following packages:
19
20 * pkg-config
21 * fuse-devel (or libfuse-dev)
22 * gcc
23 * make
24
25 Get the source code, change directory and compile:
26
27     ./configure --prefix=/usr
28     make
29
30 Then install driver and utilities:
31
32     sudo make install
33
34 Mounting
35 --------
36
37 Modern GNU/Linux distributions will mount exFAT volumes automatically—util-linux-ng 2.18 (was renamed to util-linux in 2.19) is required for this. Anyway, you can mount manually (you will need root privileges):
38
39     sudo mount.exfat-fuse /dev/sdXn /mnt/exfat
40
41 where /dev/sdXn is the partition special file, /mnt/exfat is a mountpoint.
42
43 Feedback
44 --------
45
46 If you have any questions, issues, suggestions, bug reports, etc. please create an [issue][3]. Pull requests are also welcome!
47
48 [1]: http://en.wikipedia.org/wiki/ExFAT
49 [2]: http://en.wikipedia.org/wiki/Filesystem_in_Userspace
50 [3]: https://github.com/relan/exfat/issues