1 NBD is a protocol for accessing Block Devices (hard disks and
2 disk-like things) over a Network.
4 'nbdkit' is a toolkit for creating NBD servers.
8 * Multithreaded NBD server written in C with good performance.
10 * Well-documented, simple plugin API with a stable ABI guarantee.
11 Let's you export "unconventional" block devices easily.
13 * Liberal license (BSD) allows nbdkit to be linked to proprietary
14 libraries or included in proprietary code.
16 For documentation, see the docs/ directory.
18 For plugins and examples, see the plugins/ directory.
23 This software is copyright (C) Red Hat Inc. and licensed under a BSD
24 license. See LICENSE for details.
29 By default nbdkit needs nothing except Linux and reasonably recent gcc.
31 However there are some *optional* libraries you may want to install
34 - pod2man (from perl): to build the manual pages
36 - perl development libraries: to build the embedded perl plugin
38 - zlib: to build the gzip plugin
40 - liblzma: to build the xz plugin
42 - libvirt: to build the libvirt plugin
44 - libguestfs: to build the libguestfs plugin, and to run the test suite
46 - guestfish (from libguestfs): to run parts of the test suite
48 - VDDK: see plugins/vddk/README.VDDK
50 After installing any dependencies:
52 To build from tarball: To build from git:
53 ---------------------- ------------------
55 ./configure ./configure
59 Optionally run this as root to install everything:
66 Tarballs are available from:
67 http://libguestfs.org/download/nbdkit
72 For development ideas, see the TODO file.
74 The upstream git repository is:
75 https://github.com/libguestfs/nbdkit
77 Please send patches to the libguestfs mailing list:
78 https://www.redhat.com/mailman/listinfo/libguestfs
80 For further information, see:
81 http://libguestfs.org/