97da5ee921fba0f3a3b0565b556235218a53bdd5
[rrq/fuse_xattrs.git] / README.md
1 # fuse_xattrs
2
3 This is a fuse filesystem that provides extended attribute (xattr)
4 support over any filesystem by using "sidecar files", i.e. separate
5 files that hold the extended attributes only, named by the same
6 pathname as the attributed file or directory with an additional
7 extension ".xattr".
8
9 ## Original upstream version
10
11 This software originated as version 0.4 of
12 http://github.com/fbarriga/fuse_xattrs
13
14 ## How to mount a filesystem
15
16 Once fuse_xattrs is installed (see next section) running it is very simple:
17
18     fuse_xattrs source_directory mountpoint
19
20 To unmount the filesystem:
21
22     fusermount -u mountpoint
23
24 ## Building
25
26 First you need to download FUSE 2.9 or later from
27 http://github.com/libfuse/libfuse.
28
29     $ mkdir build
30     $ cd build
31     build$ cmake ..
32     build$ make
33
34 Dependencies:
35
36     cmake
37     osxfuse (macOS only)
38