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 To build the man pages, you will need to install:
  32
  33  - pod2man (included with perl)
  34
  35 There are some *optional* libraries you may want to install for the
  36 plugins.
  37
  38 For the gzip plugin:
  39
  40  - zlib
  41
  42 For the xz plugin:
  43
  44  - liblzma
  45
  46 For the libvirt plugin:
  47
  48  - libvirt
  49
  50 For the libguestfs plugin, and to run the test suite:
  51
  52  - libguestfs
  53
  54  - guestfish (from libguestfs)
  55
  56 For the VDDK plugin:
  57
  58  - VDDK (see plugins/vddk/README.VDDK)
  59
  60 For the Perl plugin:
  61
  62  - perl development libraries
  63
  64  - perl module ExtUtils::Embed
  65
  66 For the Python plugin:
  67
  68  - python development libraries
  69
  70 After installing any dependencies:
  71
  72   To build from tarball:         To build from git:
  73   ----------------------         ------------------
  74                                  autoreconf -i
  75   ./configure                    ./configure
  76   make                           make
  77   make check                     make check
  78
  79 Optionally run this as root to install everything:
  80
  81   make install
  82
  83 Tests
  84 -----
  85
  86 You will need to install libguestfs to run the test suite.
  87
  88 The test suite ('make check') is fairly comprehensive.  It runs the
  89 newly built nbdkit + plugin as a captive process, and tests it using
  90 libguestfs.
  91
  92 If there is a failure, look at the corresponding tests/*.log file for
  93 debug information.
  94
  95 Packager information
  96 --------------------
  97
  98 Tarballs are available from:
  99 http://libguestfs.org/download/nbdkit
 100
 101 Developer information
 102 ---------------------
 103
 104 For development ideas, see the TODO file.
 105
 106 The upstream git repository is:
 107 https://github.com/libguestfs/nbdkit
 108
 109 Please send patches to the libguestfs mailing list:
 110 https://www.redhat.com/mailman/listinfo/libguestfs
 111
 112 For further information, see:
 113 http://libguestfs.org/