btrfs-progs: update INSTALL
[platform/upstream/btrfs-progs.git] / INSTALL
1 Installation instructions
2 =========================
3
4 The Btrfs utility programs require the following libraries/tools to build:
5
6 - libuuid - provided by util-linux, e2fsprogs/e2fslibs or libuuid
7 - libblkid - block device id library
8 - liblzo2 - LZO data compression library
9 - zlib - ZLIB data compression library
10
11 For the btrfs-convert utility:
12
13 - e2fsprogs - ext2/ext3/ext4 file system libraries, or called e2fslibs
14
15 Generating documentation:
16
17 - asciidoc - text document format tool
18 - xmlto - text document format tool
19
20 XATTR and ACL libraries should be provided by the standard C library or by
21
22 - libattr - extended attribute library
23 - libacl - access control list library
24
25 Please note that the package names may differ according to the distribution.
26 See https://btrfs.wiki.kernel.org/index.php/Btrfs_source_repositories#Dependencies .
27
28 To build from git sources you need to generate the confiture script using the
29 autools:
30
31  $ ./autogen.sh
32
33 To build from the released tarballs:
34
35  $ ./configure
36  $ make
37  $ make install
38
39 You may disable building some parts like documentation, btrfs-convert or
40 backtrace support. See ./configure --help for more.
41
42 Specific CFLAGS or LDFLAGS should be set like
43
44  $ CFLAGS=... LDFLAGS=... ./configure --prefix=/usr
45
46 and not as arguments to make.
47
48 References:
49 * https://btrfs.wiki.kernel.org