aboutsummaryrefslogtreecommitdiff
path: root/qemu-doc.texi
diff options
context:
space:
mode:
authorEric Blake <eblake@redhat.com>2019-09-03 09:56:34 -0500
committerEric Blake <eblake@redhat.com>2019-09-05 16:01:47 -0500
commit0c61ebb0cdf66343c45f1337d8cd985b6c4ab25e (patch)
tree8cea4e13f3f346f3fa13bac3605b8cc8fc77e4dc /qemu-doc.texi
parent294682cc3a7c5b3d1b2d45b686e2d8523750ce64 (diff)
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: Eric Blake <eblake@redhat.com> Message-Id: <20190903145634.20237-1-eblake@redhat.com> Reviewed-by: John Snow <jsnow@redhat.com>
Diffstat (limited to 'qemu-doc.texi')
-rw-r--r--qemu-doc.texi11
1 files changed, 9 insertions, 2 deletions
diff --git a/qemu-doc.texi b/qemu-doc.texi
index 577d1e8376..ec460f1d7a 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -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