docs: Link to plugin man pages from nbdkit(1).
[nbdkit/ericb.git] / README
blob44ba04b749b6b498f1dac2f71bfbfd2001e2a612
1 NBD is a protocol for accessing block devices (hard disks and
2 disk-like things) over the network.
4 'nbdkit' is a toolkit for creating NBD servers.
6 The key features are:
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.
20 License
21 -------
23 This software is copyright (C) Red Hat Inc. and licensed under a BSD
24 license.  See LICENSE for details.
26 Packager information
27 --------------------
29 Tarballs are available from:
30 http://libguestfs.org/download/nbdkit
32 Developer information
33 ---------------------
35 For development ideas, see the TODO file.
37 The upstream git repository is:
38 https://github.com/libguestfs/nbdkit
40 Please send patches to the libguestfs mailing list:
41 https://www.redhat.com/mailman/listinfo/libguestfs
43 For further information, see:
44 http://libguestfs.org/