1nbdkit(1)                           NBDKIT                           nbdkit(1)
2
3
4

NAME

6       nbdkit - toolkit for creating Network Block Device (NBD) servers
7

SYNOPSIS

9        nbdkit [-4|--ipv4-only] [-6|--ipv6-only]
10               [-D|--debug PLUGIN|FILTER|nbdkit.FLAG=N]
11               [--exit-with-parent] [-e|--exportname EXPORTNAME]
12               [--filter=FILTER ...] [-f|--foreground]
13               [-g|--group GROUP] [-i|--ipaddr IPADDR]
14               [--log=stderr|syslog|null] [--mask-handshake=MASK]
15               [-n|--newstyle] [--no-sr] [-o|--oldstyle]
16               [-P|--pidfile PIDFILE] [-p|--port PORT]
17               [-r|--readonly] [--run 'COMMAND ARGS ...']
18               [--selinux-label=LABEL] [-s|--single] [--swap]
19               [-t|--threads THREADS] [--tls=off|on|require]
20               [--tls-certificates=/path/to/certificates]
21               [--tls-psk=/path/to/pskfile] [--tls-verify-peer]
22               [-U|--unix SOCKET|-] [-u|--user USER]
23               [-v|--verbose] [--vsock]
24               PLUGIN [[KEY=]VALUE [KEY=VALUE [...]]]
25
26        nbdkit --dump-config
27
28        nbdkit PLUGIN --dump-plugin
29
30        nbdkit --help
31
32        nbdkit [-V|--version]
33

DESCRIPTION

35       Network Block Device (NBD) is a network protocol for accessing block
36       devices over the network.  Block devices are hard disks and things that
37       behave like hard disks such as disk images and virtual machines.
38
39       nbdkit is both a toolkit for creating NBD servers from “unconventional”
40       sources, and the name of an NBD server.  nbdkit ships with many plugins
41       for performing common tasks like serving local files.
42
43   Plugins and filters
44       nbdkit is different from other NBD servers because you can easily
45       create new Network Block Device sources by writing a few glue
46       functions, possibly in C, or perhaps in a high level language like Perl
47       or Python.  The liberal licensing of nbdkit is meant to allow you to
48       link nbdkit with proprietary libraries or to include nbdkit in
49       proprietary code.
50
51       If you want to write your own nbdkit plugin you should read
52       nbdkit-plugin(3).
53
54       nbdkit also has a concept of filters which can be layered on top of
55       plugins.  Several filters are provided with nbdkit and if you want to
56       write your own you should read nbdkit-filter(3).
57

EXAMPLES

59   Basic file serving
60       •   Serve file disk.img on port 10809 using nbdkit-file-plugin(1), and
61           connect to it using guestfish(1):
62
63            nbdkit file disk.img
64            guestfish --rw --format=raw -a nbd://localhost
65
66       •   Serve file disk.img on port 10809, requiring clients to use
67           encrypted (TLS) connections:
68
69            nbdkit --tls=require file disk.img
70
71   Other nbdkit plugins
72       •   Create a small disk containing test patterns using
73           nbdkit-data-plugin(1):
74
75            nbdkit data ' ( 0x55 0xAA )*2048 '
76
77       •   Forward an NBD connection to a remote server over HTTPS or SSH
78           using nbdkit-curl-plugin(1) or nbdkit-ssh-plugin(1):
79
80            nbdkit -r curl https://example.com/disk.img
81
82            nbdkit ssh host=example.com /var/tmp/disk.img
83
84       •   Create a sparse 1 terabyte RAM disk using nbdkit-memory-plugin(1)
85           and use it as a loop device (nbdkit-loop(1)):
86
87            nbdkit memory 1T
88            nbd-client localhost /dev/nbd0
89
90       •   Create a floppy disk image containing files from a local directory
91           using nbdkit-floppy-plugin(1):
92
93            nbdkit floppy dir/
94
95   Combining plugins and filters
96       •   Serve only the first partition from compressed disk image
97           disk.img.xz, combining nbdkit-partition-filter(1),
98           nbdkit-xz-filter(1) and nbdkit-file-plugin(1).
99
100            nbdkit --filter=partition --filter=xz file disk.img.xz partition=1
101
102           To understand this command line:
103
104                                        plugin name and plugin parameter
105
106                                                  ┌───────┴──────┐
107                                                  │              │
108            nbdkit --filter=partition --filter=xz file disk.img.xz partition=1
109                            │              │                          │
110                            └──────────────┴────┬─────────────────────┘
111
112                                   filters and filter parameter
113
114       •   Create a scratch, empty nbdkit device and inject errors and delays,
115           for testing clients, using nbdkit-memory-plugin(1),
116           nbdkit-error-filter(1) and nbdkit-delay-filter(1):
117
118            nbdkit --filter=error --filter=delay memory 100M \
119                   error-rate=10% rdelay=1 wdelay=1
120
121   Writing plugins in shell script
122       •   Write a simple, custom plugin in shell script using
123           nbdkit-sh-plugin(3):
124
125            nbdkit sh - <<'EOF'
126              case "$1" in
127                get_size) echo 1M ;;
128                pread) dd if=/dev/zero count=$3 iflag=count_bytes ;;
129                *) exit 2 ;;
130              esac
131            EOF
132
133       •   The same example as above can be written entirely on the command
134           line using nbdkit-eval-plugin(1):
135
136            nbdkit eval get_size='echo 1M' \
137                        pread='dd if=/dev/zero count=$3 iflag=count_bytes'
138
139   Display information
140       Display information about nbdkit or a specific plugin:
141
142        nbdkit --help
143        nbdkit --version
144        nbdkit --dump-config
145        nbdkit example1 --help
146        nbdkit example1 --dump-plugin
147

GLOBAL OPTIONS

149       --help
150           Display brief command line usage information and exit.
151
152       -4
153       --ipv4-only
154       -6
155       --ipv6-only
156           When a non-numeric argument is passed to the -i option (such as a
157           Fully Qualified Domain Name, or a host name from "/etc/hosts"),
158           restrict the name resolution to IPv4 or IPv6 addresses.
159
160           When the -i option is omitted, listen on only the IPv4 or IPv6
161           address of all interfaces (0.0.0.0 or "::", respectively).
162
163           When both -4 and -6 options are present on the command line, the
164           last one takes effect.
165
166       -D PLUGIN.FLAG=N
167       -D FILTER.FLAG=N
168       --debug PLUGIN.FLAG=N
169       --debug FILTER.FLAG=N
170           Set the plugin or filter Debug Flag called "FLAG" to the integer
171           value "N".  See "Debug Flags" in nbdkit-plugin(3).
172
173       -D nbdkit.FLAG=N
174       --debug nbdkit.FLAG=N
175           (nbdkit ≥ 1.18)
176
177           Set the nbdkit server Debug Flag called "FLAG" to the integer value
178           "N".  See "SERVER DEBUG FLAGS" below.
179
180       --dump-config
181           Dump out the compile-time configuration values and exit.  See
182           nbdkit-probing(1).
183
184       --dump-plugin
185           Dump out information about the plugin and exit.  See
186           nbdkit-probing(1).
187
188       --exit-with-parent
189           If the parent process exits, we exit.  This can be used to avoid
190           complicated cleanup or orphaned nbdkit processes.  There are some
191           important caveats with this, see "EXIT WITH PARENT" in
192           nbdkit-captive(1).
193
194           An alternative to this is "CAPTIVE NBDKIT" in nbdkit-captive(1).
195
196           This option implies --foreground.
197
198       -e EXPORTNAME
199       --export=EXPORTNAME
200       --export-name=EXPORTNAME
201       --exportname=EXPORTNAME
202           Set a preferred exportname to expose in the shell environment
203           created during --run.  The use of this option without --run has no
204           effect.  This option does not change what nbdkit advertises as a
205           server, but can aid in writing a captive client that wants to
206           access particular content from a plugin that differentiates content
207           based on the client's choice of export name.
208
209           If not set, the --run environment is set to access the default
210           exportname "" (empty string).
211
212       --filter=FILTER
213           Add a filter before the plugin.  This option may be given one or
214           more times to stack filters in front of the plugin.  They are
215           processed in the order they appear on the command line.  See
216           "FILTERS" and nbdkit-filter(3).
217
218       -f
219       --foreground
220       --no-fork
221           Don't fork into the background.
222
223       -g GROUP
224       --group=GROUP
225           Change group to "GROUP" after starting up.  A group name or numeric
226           group ID can be used.
227
228           The server needs sufficient permissions to be able to do this.
229           Normally this would mean starting the server up as root.
230
231           See also -u.
232
233       -i IPADDR
234       --ip-addr=IPADDR
235       --ipaddr=IPADDR
236           Listen on the specified interface.  The default is to listen on all
237           interfaces.  See also -4, -6, and -p.
238
239       --log=stderr
240       --log=syslog
241       --log=null
242           Send error messages to standard error (--log=stderr), or to the
243           system log (--log=syslog), or discard them completely (--log=null,
244           not recommended for normal use).
245
246           The default is to send error messages to stderr, unless nbdkit
247           forks into the background in which case they are sent to syslog.
248
249           For more details see "LOGGING" in nbdkit-service(1).
250
251       --mask-handshake=MASK
252           This option can be used to mask off particular global features
253           which are advertised during new-style handshake (defaulting to all
254           supported bits set).  See nbdkit-protocol(1).
255
256       -n
257       --new-style
258       --newstyle
259           Use the newstyle NBD protocol.  This is the default in nbdkit ≥
260           1.3.  In earlier versions the default was oldstyle.  See
261           nbdkit-protocol(1).
262
263       --no-sr
264           Do not advertise structured replies.  A client must request
265           structured replies to take advantage of block status and potential
266           sparse reads; however, as structured reads are not a mandatory part
267           of the newstyle NBD protocol, this option can be used to debug
268           client fallbacks for dealing with older servers.  See
269           nbdkit-protocol(1).
270
271       -o
272       --old-style
273       --oldstyle
274           Use the oldstyle NBD protocol.  This was the default in nbdkit ≤
275           1.2, but now the default is newstyle.  Note this is incompatible
276           with newer features such as export names and TLS.  See
277           nbdkit-protocol(1).
278
279       -P PIDFILE
280       --pid-file=PIDFILE
281       --pidfile=PIDFILE
282           Write "PIDFILE" (containing the process ID of the server) after
283           nbdkit becomes ready to accept connections.
284
285           If the file already exists, it is overwritten.  nbdkit does not
286           delete the file when it exits.
287
288       -p PORT
289       --port=PORT
290           Change the TCP/IP port number on which nbdkit serves requests.  The
291           default is 10809.  See also -i.
292
293       -r
294       --read-only
295       --readonly
296           The export will be read-only.  If a client writes, then it will get
297           an error.
298
299           Note that some plugins inherently don't support writes.  With those
300           plugins the -r option is added implicitly.
301
302           nbdkit-cow-filter(1) can be placed over read-only plugins to
303           provide copy-on-write (or "snapshot") functionality.  If you are
304           using qemu as a client then it also supports snapshots.
305
306       --run 'COMMAND ARGS ...'
307           Run nbdkit as a captive subprocess of the command.  When the
308           command exits, nbdkit is killed.  See "CAPTIVE NBDKIT" in
309           nbdkit-captive(1).
310
311           Note that the command is executed by /bin/sh.  On some platforms
312           like Debian this might not be a full-featured shell.
313
314           This option implies --foreground.
315
316       --selinux-label=SOCKET-LABEL
317           Apply the SELinux label "SOCKET-LABEL" to the nbdkit listening
318           socket.
319
320           The common — perhaps only — use of this option is to allow libvirt
321           guests which are using SELinux and sVirt confinement to access
322           nbdkit Unix domain sockets.  The example below shows how to do
323           this.  Note that the socket and filesystem labels are different.
324
325            nbdkit -U /tmp/sock --selinux-label=system_u:object_r:svirt_socket_t:s0 ...
326            chcon system_u:object_r:svirt_image_t:s0 /tmp/sock
327
328       -s
329       --single
330       --stdin
331           Don't fork.  Handle a single NBD connection on stdin/stdout.  After
332           stdin closes, the server exits.
333
334           You can use this option to run nbdkit from inetd or similar
335           superservers; or just for testing; or if you want to run nbdkit in
336           a non-conventional way.  Note that if you want to run nbdkit from
337           systemd, then it may be better to use "SOCKET ACTIVATION" in
338           nbdkit-service(1) instead of this option.
339
340           This option implies --foreground.
341
342       --swap
343           (nbdkit ≥ 1.18)
344
345           Specifies that the NBD device will be used as swap space loop
346           mounted on the same machine which is running nbdkit.  To avoid
347           deadlocks this locks the whole nbdkit process into memory using
348           mlockall(2).  This may require additional permissions, such as
349           starting the server as root or raising the "RLIMIT_MEMLOCK"
350           (ulimit(1) -l) limit on the process.
351
352       -t THREADS
353       --threads=THREADS
354           Set the number of threads to be used per connection, which in turn
355           controls the number of outstanding requests that can be processed
356           at once.  Only matters for plugins with thread_model=parallel
357           (where it defaults to 16).  To force serialized behavior (useful if
358           the client is not prepared for out-of-order responses), set this to
359           1.
360
361       --tls=off
362       --tls=on
363       --tls=require
364           Disable, enable or require TLS (authentication and encryption
365           support).  See nbdkit-tls(1).
366
367       --tls-certificates=/path/to/certificates
368           Set the path to the TLS certificates directory.  If not specified,
369           some built-in paths are checked.  See nbdkit-tls(1) for more
370           details.
371
372       --tls-psk=/path/to/pskfile
373           Set the path to the pre-shared keys (PSK) file.  If used, this
374           overrides certificate authentication.  There is no built-in path.
375           See nbdkit-tls(1) for more details.
376
377       --tls-verify-peer
378           Enables TLS client certificate verification.  The default is not to
379           check the client's certificate.
380
381       -U SOCKET
382       --unix=SOCKET
383       -U -
384       --unix -
385           Accept connections on the Unix domain socket "SOCKET" (which is a
386           path).
387
388           nbdkit creates this socket, but it will probably have incorrect
389           permissions (too permissive).  If it is a problem that some
390           unauthorized user could connect to this socket between the time
391           that nbdkit starts up and the authorized user connects, then put
392           the socket into a directory that has restrictive permissions.
393
394           nbdkit does not delete the socket file when it exits.  The caller
395           should delete the socket file after use (else if you try to start
396           nbdkit up again you will get an "Address already in use" error).
397
398           If the socket name is - then nbdkit generates a randomly named
399           private socket.  This is useful with "CAPTIVE NBDKIT" in
400           nbdkit-captive(1).
401
402       -u USER
403       --user=USER
404           Change user to "USER" after starting up.  A user name or numeric
405           user ID can be used.
406
407           The server needs sufficient permissions to be able to do this.
408           Normally this would mean starting the server up as root.
409
410           See also -g.
411
412       -v
413       --verbose
414           Enable verbose messages.
415
416           It's a good idea to use -f as well so the process does not fork
417           into the background (but not required).
418
419       -V
420       --version
421           Print the version number of nbdkit and exit.
422
423           The --dump-config option provides separate major and minor numbers
424           and may be easier to parse from shell scripts.
425
426       --vsock
427           (nbdkit ≥ 1.16)
428
429           Use the AF_VSOCK protocol (instead of TCP/IP).  You must use this
430           in conjunction with -p/--port.  See "AF_VSOCK" in
431           nbdkit-service(1).
432

PLUGIN NAME

434       You can give the full path to the plugin, like this:
435
436        nbdkit $libdir/nbdkit/plugins/nbdkit-file-plugin.so [...]
437
438       but it is usually more convenient to use this equivalent syntax:
439
440        nbdkit file [...]
441
442       $libdir is set at compile time.  To print it out, do:
443
444        nbdkit --dump-config
445

PLUGIN CONFIGURATION

447       After specifying the plugin name you can (optionally, it depends on the
448       plugin) give plugin configuration on the command line in the form of
449       "key=value".  For example:
450
451        nbdkit file file=disk.img
452
453       To list all the options supported by a plugin, do:
454
455        nbdkit --help file
456
457       To dump information about a plugin, do:
458
459        nbdkit file --dump-plugin
460
461   Magic parameters
462       Some plugins declare a special "magic config key".  This is a key which
463       is assumed if no "key=" part is present.  For example:
464
465        nbdkit file disk.img
466
467       is assumed to be "file=disk.img" because the file plugin declares
468       "file" as its magic config key.  There can be ambiguity in the parsing
469       of magic config keys if the value might look like a "key=value".  If
470       there could be ambiguity then modify the value, eg. by prefixing it
471       with "./"
472
473       There is also a special exception for plugins which do not declare a
474       magic config key, but where the first plugin argument does not contain
475       an '=' character: it is assumed to be "script=value".  This is used by
476       scripting language plugins:
477
478        nbdkit perl foo.pl [args...]
479
480       has the same meaning as:
481
482        nbdkit perl script=foo.pl [args...]
483
484   Shebang scripts
485       You can use "#!" to run nbdkit plugins written in most scripting
486       languages.  The file should be executable.  For example:
487
488        #!/usr/sbin/nbdkit perl
489        sub open {
490          # etc
491        }
492
493       (see nbdkit-perl-plugin(3) for a full example).
494

SERVER DEBUG FLAGS

496       As well as enabling or disabling debugging in the server using
497       --verbose you can control extra debugging in the server using the
498       -D nbdkit.* flags listed in this section.  Note these flags are an
499       internal implementation detail of the server and may be changed or
500       removed at any time in the future.
501
502       -D nbdkit.backend.controlpath=0
503       -D nbdkit.backend.controlpath=1
504       -D nbdkit.backend.datapath=0
505       -D nbdkit.backend.datapath=1
506           These flags control the verbosity of nbdkit backend debugging
507           messages (the ones which show every request processed by the
508           server).  The default for both settings is 1 (normal debugging) but
509           you can set them to 0 to suppress these messages.
510
511           -D nbdkit.backend.datapath=0 is the more useful setting which lets
512           you suppress messages about pread, pwrite, zero, trim, etc.
513           commands.  When transferring large amounts of data these messages
514           are numerous and not usually very interesting.
515
516           -D nbdkit.backend.controlpath=0 suppresses the non-datapath
517           commands (config, open, close, can_write, etc.)
518
519       -D nbdkit.tls.log=N
520           Enable TLS logging.  "N" can be in the range 0 (no logging) to 99.
521           See gnutls_global_set_log_level(3).
522
523       -D nbdkit.tls.session=1
524           Print additional information about the TLS session, such as the
525           type of authentication and encryption, and client certificate
526           information.
527

SIGNALS

529       nbdkit responds to the following signals:
530
531       "SIGINT"
532       "SIGQUIT"
533       "SIGTERM"
534           The server exits cleanly.
535
536       "SIGPIPE"
537           This signal is ignored.
538

ENVIRONMENT VARIABLES

540       "LISTEN_FDS"
541       "LISTEN_PID"
542           If present in the environment when nbdkit starts up, these trigger
543           "SOCKET ACTIVATION" in nbdkit-service(1).
544

SEE ALSO

546   Other topics
547       nbdkit-captive(1) — Run nbdkit under another process and have it
548       reliably cleaned up.
549
550       nbdkit-client(1) — How to mount NBD filesystems on a client machine.
551
552       nbdkit-loop(1) — Use nbdkit with the Linux kernel client to create loop
553       devices and loop mounts.
554
555       nbdkit-probing(1) — How to probe for nbdkit configuration and plugins.
556
557       nbdkit-protocol(1) — Which parts of the NBD protocol nbdkit supports.
558
559       nbdkit-security(1) — Lists past security issues in nbdkit.
560
561       nbdkit-service(1) — Running nbdkit as a service, and systemd socket
562       activation.
563
564       nbdkit-tls(1) — Authentication and encryption of NBD connections
565       (sometimes incorrectly called "SSL").
566
567   Plugins
568       nbdkit-blkio-plugin(1), nbdkit-cdi-plugin(1), nbdkit-curl-plugin(1),
569       nbdkit-data-plugin(1), nbdkit-eval-plugin(1),
570       nbdkit-example1-plugin(1), nbdkit-example2-plugin(1),
571       nbdkit-example3-plugin(1), nbdkit-example4-plugin(1),
572       nbdkit-file-plugin(1), nbdkit-floppy-plugin(1), nbdkit-full-plugin(1),
573       nbdkit-guestfs-plugin(1), nbdkit-info-plugin(1), nbdkit-iso-plugin(1),
574       nbdkit-libvirt-plugin(1), nbdkit-linuxdisk-plugin(1),
575       nbdkit-memory-plugin(1), nbdkit-nbd-plugin(1), nbdkit-null-plugin(1),
576       nbdkit-ondemand-plugin(1), nbdkit-partitioning-plugin(1),
577       nbdkit-pattern-plugin(1), nbdkit-random-plugin(1), nbdkit-S3-plugin(1),
578       nbdkit-sparse-random-plugin(1), nbdkit-split-plugin(1),
579       nbdkit-ssh-plugin(1), nbdkit-tmpdisk-plugin(1),
580       nbdkit-torrent-plugin(1), nbdkit-vddk-plugin(1), nbdkit-zero-plugin(1)
581       ; nbdkit-cc-plugin(3), nbdkit-golang-plugin(3), nbdkit-lua-plugin(3),
582       nbdkit-ocaml-plugin(3), nbdkit-perl-plugin(3), nbdkit-python-plugin(3),
583       nbdkit-ruby-plugin(3), nbdkit-rust-plugin(3), nbdkit-sh-plugin(3),
584       nbdkit-tcl-plugin(3) .
585
586   Filters
587       nbdkit-blocksize-filter(1), nbdkit-blocksize-policy-filter(1),
588       nbdkit-cache-filter(1), nbdkit-cacheextents-filter(1),
589       nbdkit-checkwrite-filter(1), nbdkit-cow-filter(1),
590       nbdkit-ddrescue-filter(1), nbdkit-delay-filter(1),
591       nbdkit-error-filter(1), nbdkit-exitlast-filter(1),
592       nbdkit-exitwhen-filter(1), nbdkit-exportname-filter(1),
593       nbdkit-ext2-filter(1), nbdkit-extentlist-filter(1),
594       nbdkit-fua-filter(1), nbdkit-gzip-filter(1), nbdkit-ip-filter(1),
595       nbdkit-limit-filter(1), nbdkit-log-filter(1), nbdkit-luks-filter(1),
596       nbdkit-multi-conn-filter(1), nbdkit-nocache-filter(1),
597       nbdkit-noextents-filter(1), nbdkit-nofilter-filter(1),
598       nbdkit-noparallel-filter(1), nbdkit-nozero-filter(1),
599       nbdkit-offset-filter(1), nbdkit-partition-filter(1),
600       nbdkit-pause-filter(1), nbdkit-protect-filter(1),
601       nbdkit-rate-filter(1), nbdkit-readahead-filter(1),
602       nbdkit-retry-filter(1), nbdkit-retry-request-filter(1),
603       nbdkit-scan-filter(1), nbdkit-stats-filter(1), nbdkit-swab-filter(1),
604       nbdkit-tar-filter(1), nbdkit-tls-fallback-filter(1),
605       nbdkit-truncate-filter(1), nbdkit-xz-filter(1) .
606
607   For developers
608       nbdkit-plugin(3), nbdkit-filter(3).
609
610   Writing plugins in other programming languages
611       nbdkit-cc-plugin(3), nbdkit-golang-plugin(3), nbdkit-lua-plugin(3),
612       nbdkit-ocaml-plugin(3), nbdkit-perl-plugin(3), nbdkit-python-plugin(3),
613       nbdkit-ruby-plugin(3), nbdkit-rust-plugin(3), nbdkit-sh-plugin(3),
614       nbdkit-tcl-plugin(3) .
615
616   Release notes for previous releases of nbdkit
617       nbdkit-release-notes-1.34(1), nbdkit-release-notes-1.32(1),
618       nbdkit-release-notes-1.30(1), nbdkit-release-notes-1.28(1),
619       nbdkit-release-notes-1.26(1), nbdkit-release-notes-1.24(1),
620       nbdkit-release-notes-1.22(1), nbdkit-release-notes-1.20(1),
621       nbdkit-release-notes-1.18(1), nbdkit-release-notes-1.16(1),
622       nbdkit-release-notes-1.14(1), nbdkit-release-notes-1.12(1),
623       nbdkit-release-notes-1.10(1), nbdkit-release-notes-1.8(1),
624       nbdkit-release-notes-1.6(1), nbdkit-release-notes-1.4(1).
625
626   NBD clients
627       guestfish(1), libnbd(3), nbd-client(1), nbdcopy(1), nbdfuse(1),
628       nbdinfo(1), nbdsh(1), qemu(1).
629
630   nbdkit links
631       http://gitlab.com/nbdkit/nbdkit — Source code.
632
633   Other NBD servers
634       qemu-nbd(1), nbd-server(1), https://github.com/bignaux/lwNBD,
635       https://bitbucket.org/hirofuchi/xnbd.
636
637   Documentation for the NBD protocol
638       https://github.com/NetworkBlockDevice/nbd/blob/master/doc/proto.md,
639       https://nbd.sourceforge.io/.
640
641   Similar protocols
642       https://en.wikipedia.org/wiki/iSCSI,
643       https://en.wikipedia.org/wiki/ATA_over_Ethernet,
644       https://en.wikipedia.org/wiki/Fibre_Channel_over_Ethernet.
645
646   Other manual pages of interest
647       gnutls_priority_init(3), qemu-img(1), psktool(1), systemd.socket(5).
648

AUTHORS

650       Eric Blake
651
652       Laszlo Ersek
653
654       Richard W.M. Jones
655
656       Yann E. MORIN
657
658       Nikolaus Rath
659
660       François Revol
661
662       Nir Soffer
663
664       Alan Somers
665
666       Pino Toscano
667
669       Copyright Red Hat
670

LICENSE

672       Redistribution and use in source and binary forms, with or without
673       modification, are permitted provided that the following conditions are
674       met:
675
676       •   Redistributions of source code must retain the above copyright
677           notice, this list of conditions and the following disclaimer.
678
679       •   Redistributions in binary form must reproduce the above copyright
680           notice, this list of conditions and the following disclaimer in the
681           documentation and/or other materials provided with the
682           distribution.
683
684       •   Neither the name of Red Hat nor the names of its contributors may
685           be used to endorse or promote products derived from this software
686           without specific prior written permission.
687
688       THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY
689       EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
690       IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
691       PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE
692       LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
693       CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
694       SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
695       BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
696       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
697       OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
698       ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
699
700
701
702nbdkit-1.34.4                     2023-09-26                         nbdkit(1)
Impressum