README.md

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