releasing package exfat-utils version 1.2.6-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 * OpenBSD
11
12 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.
13
14 Compiling
15 ---------
16
17 To build this project on GNU/Linux you need to install the following packages:
18
19 * [pkg-config][7]
20 * fuse-devel (or libfuse-dev)
21 * [gcc][8]
22 * [make][9]
23
24 On Mac OS X:
25
26 * pkg-config
27 * [OSXFUSE][10]
28 * [Xcode][11] (legacy versions include autotools but their versions are too old)
29
30 On OpenBSD:
31
32
33 Get the source code, change directory and compile:
34
35     ./configure
36     make
37
38 Then install driver and utilities (from root):
39
40     make install
41
42 You can remove them using this command (from root):
43
44     make uninstall
45
46 Mounting
47 --------
48
49 Modern GNU/Linux distributions (with [util-linux][12] 2.18 or later) will mount exFAT volumes automatically. Anyway, you can mount manually (from root):
50
51     mount.exfat-fuse /dev/spec /mnt/exfat
52
53 where /dev/spec is the [device file][13], /mnt/exfat is a mountpoint.
54
55 Feedback
56 --------
57
58 If you have any questions, issues, suggestions, bug reports, etc. please create an [issue][3]. Pull requests are also welcome!
59
60 [1]: https://en.wikipedia.org/wiki/ExFAT
61 [2]: https://en.wikipedia.org/wiki/Filesystem_in_Userspace
62 [3]: https://github.com/relan/exfat/issues
63 [7]: http://www.freedesktop.org/wiki/Software/pkg-config/
64 [8]: https://gcc.gnu.org/
65 [9]: https://www.gnu.org/software/make/
66 [10]: https://osxfuse.github.io/
67 [11]: https://en.wikipedia.org/wiki/Xcode
68 [12]: https://www.kernel.org/pub/linux/utils/util-linux/
69 [13]: https://en.wikipedia.org/wiki/Device_file