"Fossies" - the Fresh Open Source Software Archive

Member "btrfs-progs-v5.7/INSTALL" (2 Jul 2020, 3068 Bytes) of package /linux/misc/btrfs-progs-v5.7.tar.xz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "INSTALL": v5.6.1_vs_v5.7.

    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 - libzstd - ZSTD data compression library version >= 1.0.0
   11 
   12 For the btrfs-convert utility:
   13 
   14 - e2fsprogs - ext2/ext3/ext4 file system libraries, or called e2fslibs
   15 - libreiserfscore - reiserfs file system library version >= 3.6.27
   16 
   17 Optionally, the checksums based on cryptographic hashes can be implemeted by
   18 external libraries. Builtin implementations are provided in case the library
   19 dependencies are not desired.
   20 
   21 - libgcrypt
   22 - libsodium
   23 - libkcapi
   24 
   25 Generating documentation:
   26 
   27 - asciidoc - text document format tool
   28 - xmlto - text document format tool
   29 - source-highlight - optional, only for generating HTML output
   30 
   31 XATTR library should be provided by the standard C library or by
   32 
   33 - libattr - extended attribute library
   34 
   35 Please note that the package names may differ according to the distribution.
   36 See https://btrfs.wiki.kernel.org/index.php/Btrfs_source_repositories#Dependencies .
   37 
   38 
   39 Building from sources
   40 ---------------------
   41 
   42 To build from git sources you need to generate the configure script using the
   43 autotools:
   44 
   45     $ ./autogen.sh
   46 
   47 To build from the released tarballs:
   48 
   49     $ ./configure
   50     $ make
   51     $ make install
   52 
   53 To install the libbtrfsutil Python bindings:
   54 
   55     $ make install_python
   56 
   57 You may disable building some parts like documentation, btrfs-convert or
   58 backtrace support. See ./configure --help for more.
   59 
   60 Specific CFLAGS or LDFLAGS should be set like
   61 
   62     $ CFLAGS=... LDFLAGS=... ./configure --prefix=/usr
   63 
   64 and not as arguments to make. You can specify additional flags to build via
   65 variables EXTRA_CFLAGS and EXTRA_LDFLAGS that get appended to the predefined
   66 values of the respective variables. There are further build tuning options
   67 documented in the Makefile.
   68 
   69     $ make EXTRA_CFLAGS=-ggdb3
   70 
   71 The build utilizes autotools, dependencies for generating the configure
   72 scripts are:
   73 
   74 * autoconf, autoheader
   75 * automake, aclocal
   76 * pkg-config
   77 
   78 
   79 Statically built binaries
   80 -------------------------
   81 
   82 The makefiles are ready to let you build static binaries of the utilities. This
   83 may be handy in rescue environments. Your system has to provide static version
   84 of the libraries.
   85 
   86     $ make static
   87     $ make btrfs.static
   88     $ make btrfs-convert.static
   89 
   90 The resulting binaries have the '.static' suffix, the intermediate object
   91 files do not conflict with the normal (dynamic) build.
   92 
   93 
   94 All-in-one binary (busybox style)
   95 ---------------------------------
   96 
   97 Since version 5.2 it's possible to build a single binary that can act as other
   98 standalone tools, based on the file name:
   99 
  100     $ make btrfs.box
  101     $ mv btrfs.box btrfs
  102     $ ln -s btrfs mkfs.btrfs
  103 
  104 The list of built-ins can be obtained by
  105 
  106     $ btrfs help --box
  107 
  108 The basic set will always contain: mkfs.btrfs, btrfs-image, btrfs-convert.
  109 
  110 
  111 References:
  112 * https://btrfs.wiki.kernel.org