aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRonnie Sahlberg <ronniesahlberg@gmail.com>2011-10-27 20:33:21 +1100
committerKevin Wolf <kwolf@redhat.com>2011-10-28 19:25:49 +0200
commit08ae330e1754bf03df1388065ea508dc089ab3fd (patch)
tree6b4a2355bbf16897da30247137d92b4f3ff01d81
parent93897b9fd43548e9c15cf8bece2d9e5174b01fc7 (diff)
Documentation: Describe NBD URL syntax
This patch adds a short description of how to specify a NBD device to QEMU. Syntax for both TCP and Unix Domain Sockets are provided as well as examples. Signed-off-by: Ronnie Sahlberg <ronniesahlberg@gmail.com> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
-rw-r--r--qemu-options.hx21
1 files changed, 21 insertions, 0 deletions
diff --git a/qemu-options.hx b/qemu-options.hx
index 424bae9cf0..c55080c041 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -1757,6 +1757,27 @@ qemu --drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
iSCSI support is an optional feature of QEMU and only available when
compiled and linked against libiscsi.
+@item NBD
+QEMU supports NBD (Network Block Devices) both using TCP protocol as well
+as Unix Domain Sockets.
+
+Syntax for specifying a NBD device using TCP
+``nbd:<server-ip>:<port>[:exportname=<export>]''
+
+Syntax for specifying a NBD device using Unix Domain Sockets
+``nbd:unix:<domain-socket>[:exportname=<export>]''
+
+
+Example for TCP
+@example
+qemu --drive file=nbd:192.0.2.1:30000
+@end example
+
+Example for Unix Domain Sockets
+@example
+qemu --drive file=nbd:unix:/tmp/nbd-socket
+@end example
+
@end table
ETEXI