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