Merge remote-tracking branch 'kwolf/for-anthony' into staging

[qemu.git] / qemu-nbd.texi

diff --git a/qemu-nbd.texi b/qemu-nbd.texi
index 7b6d0cbb59185c3c286d70e8e8634d85bc305179..6055ec693b81b8e495ca575c9b246ed0e0e5012e 100644 (file)
--- a/qemu-nbd.texi
+++ b/qemu-nbd.texi
@@ -6,24 +6,49 @@ usage: qemu-nbd [OPTION]...  @var{filename}
 
 @c man begin DESCRIPTION
 
-Export Qemu disk image using NBD protocol.
+Export QEMU disk image using NBD protocol.
 
 @c man end
 
 @c man begin OPTIONS
-@table @var
-@item filename
+@table @option
+@item @var{filename}
  is a disk image filename
-@item -p, --port=PORT
-  port to listen on (default `1024')
-@item -o, --offset=OFFSET
+@item -p, --port=@var{port}
+  port to listen on (default @samp{1024})
+@item -o, --offset=@var{offset}
   offset into the image
-@item -b, --bind=IFACE
-  interface to bind to (default `0.0.0.0')
+@item -b, --bind=@var{iface}
+  interface to bind to (default @samp{0.0.0.0})
+@item -k, --socket=@var{path}
+  Use a unix socket with path @var{path}
 @item -r, --read-only
   export read-only
-@item -P, --partition=NUM
-  only expose partition NUM
+@item -P, --partition=@var{num}
+  only expose partition @var{num}
+@item -s, --snapshot
+  use snapshot file
+@item -n, --nocache
+@itemx --cache=@var{cache}
+  set cache mode to be used with the file.  See the documentation of
+  the emulator's @code{-drive cache=...} option for allowed values.
+@item --aio=@var{aio}
+  choose asynchronous I/O mode between @samp{threads} (the default)
+  and @samp{native} (Linux only).
+@item --discard=@var{discard}
+  toggles whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap})
+  requests are ignored or passed to the filesystem.  The default is no
+  (@samp{--discard=ignore}).
+@item -c, --connect=@var{dev}
+  connect @var{filename} to NBD device @var{dev}
+@item -d, --disconnect
+  disconnect the specified device
+@item -e, --shared=@var{num}
+  device can be shared by @var{num} clients (default @samp{1})
+@item -f, --format=@var{fmt}
+  force block driver for format @var{fmt} instead of auto-detecting
+@item -t, --persistent
+  don't exit on the last connection
 @item -v, --verbose
   display extra debugging information
 @item -h, --help