Commit 0c61ebb0 authored by Eric Blake's avatar Eric Blake
Browse files

docs: Update preferred NBD device syntax 

Mention the preferred URI form, especially since NBD is trying to
standardize that form: https://lists.debian.org/nbd/2019/06/msg00012.html



Signed-off-by: default avatarEric Blake <eblake@redhat.com>
Message-Id: <20190903145634.20237-1-eblake@redhat.com>
Reviewed-by: default avatarJohn Snow <jsnow@redhat.com>
parent 294682cc

qemu-doc.texi

+9 −2
Original line number Diff line number Diff line
@@ -297,9 +297,16 @@ qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 


@item NBD

QEMU supports NBD (Network Block Devices) both using TCP protocol as well

as Unix Domain Sockets.

as Unix Domain Sockets.  With TCP, the default port is 10809.



Syntax for specifying a NBD device using TCP

Syntax for specifying a NBD device using TCP, in preferred URI form:

``nbd://<server-ip>[:<port>]/[<export>]''



Syntax for specifying a NBD device using Unix Domain Sockets; remember

that '?' is a shell glob character and may need quoting:

``nbd+unix:///[<export>]?socket=<domain-socket>''



Older syntax that is also recognized:

``nbd:<server-ip>:<port>[:exportname=<export>]''



Syntax for specifying a NBD device using Unix Domain Sockets