README.md: Updated. Added code coverage.
[rrq/fuse_xattrs.git] / README.md
1 ## Abstract
2
3 This filesystem provides xattr support using sidecar files.
4
5 ## Latest version
6
7 The latest version and more information can be found on
8 http://github.com/fbarriga/fuse_xattrs
9
10
11 ## How to mount a filesystem
12
13 Once fuse_xattrs is installed (see next section) running it is very simple:
14
15     fuse_xattrs mountpoint
16
17 To unmount the filesystem:
18
19     fusermount -u mountpoint
20
21
22 ## Building
23
24 First you need to download FUSE 2.9 or later from
25 http://github.com/libfuse/libfuse.
26
27     mkdir build && cd build
28     cmake ..
29     make
30
31 ## Code Coverage
32
33     mkdir build && cd build
34     cmake -DENABLE_CODECOVERAGE=1 -DCMAKE_C_COMPILER=/usr/bin/gcc -DCMAKE_BUILD_TYPE=Debug ..
35     make
36     make fuse_xattrs_coverage
37
38 ## Installing
39
40     make install
41
42 ## Links
43
44 - http://man7.org/linux/man-pages/man2/setxattr.2.html
45 - http://man7.org/linux/man-pages/man2/listxattr.2.html
46 - http://man7.org/linux/man-pages/man2/getxattr.2.html
47 - http://man7.org/linux/man-pages/man3/errno.3.html
48 - https://www.freedesktop.org/wiki/CommonExtendedAttributes/