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