README

   1 NBD is a protocol for accessing Block Devices (hard disks and
   2 disk-like things) over a Network.
   3
   4 'nbdkit' is a toolkit for creating NBD servers.
   5
   6 The key features are:
   7
   8 * Multithreaded NBD server written in C with good performance.
   9
  10 * Well-documented, simple plugin API with a stable ABI guarantee.
  11   Let's you export "unconventional" block devices easily.
  12
  13 * Liberal license (BSD) allows nbdkit to be linked to proprietary
  14   libraries or included in proprietary code.
  15
  16 For documentation, see the docs/ directory.
  17
  18 For plugins and examples, see the plugins/ directory.
  19
  20 License
  21 -------
  22
  23 This software is copyright (C) Red Hat Inc. and licensed under a BSD
  24 license.  See LICENSE for details.
  25
  26 Building from source
  27 --------------------
  28
  29 By default nbdkit needs nothing except Linux and reasonably recent gcc.
  30
  31 However there are some *optional* libraries you may want to install
  32 for the plugins:
  33
  34  - pod2man (from perl): to build the manual pages
  35
  36  - zlib: to build the gzip plugin
  37
  38  - liblzma: to build the xz plugin
  39
  40  - libvirt: to build the libvirt plugin
  41
  42  - libguestfs: to build the libguestfs plugin, and to run the test suite
  43
  44  - guestfish (from libguestfs): to run parts of the test suite
  45
  46  - VDDK: see plugins/vddk/README.VDDK
  47
  48 After installing any dependencies:
  49
  50   To build from tarball:         To build from git:
  51   ----------------------         ------------------
  52                                  autoreconf -i
  53   ./configure                    ./configure
  54   make                           make
  55   make check                     make check
  56
  57 Optionally run this as root to install everything:
  58
  59   make install
  60
  61 Packager information
  62 --------------------
  63
  64 Tarballs are available from:
  65 http://libguestfs.org/download/nbdkit
  66
  67 Developer information
  68 ---------------------
  69
  70 For development ideas, see the TODO file.
  71
  72 The upstream git repository is:
  73 https://github.com/libguestfs/nbdkit
  74
  75 Please send patches to the libguestfs mailing list:
  76 https://www.redhat.com/mailman/listinfo/libguestfs
  77
  78 For further information, see:
  79 http://libguestfs.org/