nbd: enable use of TLS with qemu-nbd server

[qemu.git] / qemu-nbd.texi

diff --git a/qemu-nbd.texi b/qemu-nbd.texi
index 0a7e01385c44699f5aa4e5f23b191853aa179e57..227a73ca369989c053cffd1f8890895af2c505e2 100644 (file)
--- a/qemu-nbd.texi
+++ b/qemu-nbd.texi
@@ -1,68 +1,92 @@
 @example
 @c man begin SYNOPSIS
 @example
 @c man begin SYNOPSIS

-usage: qemu-nbd [OPTION]...  @var{filename}
+@command{qemu-nbd} [OPTION]... @var{filename}
+
+@command{qemu-nbd} @option{-d} @var{dev}

 @c man end
 @end example
 
 @c man begin DESCRIPTION
 
 @c man end
 @end example
 
 @c man begin DESCRIPTION
 

-Export QEMU disk image using NBD protocol.
+Export a QEMU disk image using the NBD protocol.

 
 @c man end
 
 @c man begin OPTIONS
 
 @c man end
 
 @c man begin OPTIONS

+@var{filename} is a disk image filename.
+
+@var{dev} is an NBD device.
+

 @table @option
 @table @option

-@item @var{filename}
- is a disk image filename
+@item --object type,id=@var{id},...props...
+Define a new instance of the @var{type} object class identified by @var{id}.
+See the @code{qemu(1)} manual page for full details of the properties
+supported. The common object types that it makes sense to define are the
+@code{secret} object, which is used to supply passwords and/or encryption
+keys, and the @code{tls-creds} object, which is used to supply TLS
+credentials for the qemu-nbd server.

 @item -p, --port=@var{port}
 @item -p, --port=@var{port}

-  port to listen on (default @samp{1024})
+The TCP port to listen on (default @samp{10809})

 @item -o, --offset=@var{offset}
 @item -o, --offset=@var{offset}

-  offset into the image
+The offset into the image

 @item -b, --bind=@var{iface}
 @item -b, --bind=@var{iface}

-  interface to bind to (default @samp{0.0.0.0})
+The interface to bind to (default @samp{0.0.0.0})

 @item -k, --socket=@var{path}
 @item -k, --socket=@var{path}

-  Use a unix socket with path @var{path}
-@item -f, --format=@var{format}
-  Set image format as @var{format}
+Use a unix socket with path @var{path}
+@item -f, --format=@var{fmt}
+Force the use of the block driver for format @var{fmt} instead of
+auto-detecting

 @item -r, --read-only
 @item -r, --read-only

-  export read-only
+Export the disk as read-only

 @item -P, --partition=@var{num}
 @item -P, --partition=@var{num}

-  only expose partition @var{num}
+Only expose partition @var{num}

 @item -s, --snapshot
 @item -s, --snapshot

-  use @var{filename} as an external snapshot, create a temporary
-  file with backing_file=@var{filename}, redirect the write to
-  the temporary one
+Use @var{filename} as an external snapshot, create a temporary
+file with backing_file=@var{filename}, redirect the write to
+the temporary one

 @item -l, --load-snapshot=@var{snapshot_param}
 @item -l, --load-snapshot=@var{snapshot_param}

-  load an internal snapshot inside @var{filename} and export it
-  as an read-only device, @var{snapshot_param} format is
-  'snapshot.id=[ID],snapshot.name=[NAME]' or '[ID_OR_NAME]'
+Load an internal snapshot inside @var{filename} and export it
+as an read-only device, @var{snapshot_param} format is
+'snapshot.id=[ID],snapshot.name=[NAME]' or '[ID_OR_NAME]'

 @item -n, --nocache
 @itemx --cache=@var{cache}
 @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.
+The 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}
 @item --aio=@var{aio}

-  choose asynchronous I/O mode between @samp{threads} (the default)
-  and @samp{native} (Linux only).
+Set the asynchronous I/O mode between @samp{threads} (the default)
+and @samp{native} (Linux only).

 @item --discard=@var{discard}
 @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}).
+Control whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap})
+requests are ignored or passed to the filesystem.  @var{discard} is one of
+@samp{ignore} (or @samp{off}), @samp{unmap} (or @samp{on}).  The default is
+@samp{ignore}.
+@item --detect-zeroes=@var{detect-zeroes}
+Control the automatic conversion of plain zero writes by the OS to
+driver-specific optimized zero write commands.  @var{detect-zeroes} is one of
+@samp{off}, @samp{on} or @samp{unmap}.  @samp{unmap}
+converts a zero write to an unmap operation and can only be used if
+@var{discard} is set to @samp{unmap}.  The default is @samp{off}.

 @item -c, --connect=@var{dev}
 @item -c, --connect=@var{dev}

-  connect @var{filename} to NBD device @var{dev}
+Connect @var{filename} to NBD device @var{dev}

 @item -d, --disconnect
 @item -d, --disconnect

-  disconnect the specified device
+Disconnect the device @var{dev}

 @item -e, --shared=@var{num}
 @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
+Allow up to @var{num} clients to share the device (default @samp{1})

 @item -t, --persistent
 @item -t, --persistent

-  don't exit on the last connection
+Don't exit on the last connection
+@item -x NAME, --export-name=NAME
+Set the NBD volume export name. This switches the server to use
+the new style NBD protocol negotiation
+@item --tls-creds=ID
+Enable mandatory TLS encryption for the server by setting the ID
+of the TLS credentials object previously created with the --object
+option.

 @item -v, --verbose
 @item -v, --verbose

-  display extra debugging information
+Display extra debugging information

 @item -h, --help
 @item -h, --help

-  display this help and exit
+Display this help and exit

 @item -V, --version
 @item -V, --version

-  output version information and exit
+Display version information and exit

 @end table
 
 @c man end
 @end table
 
 @c man end


@@ -79,7 +103,7 @@ warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 @c man end
 
 @c man begin SEEALSO
 @c man end
 
 @c man begin SEEALSO

-qemu-img(1)
+qemu(1), qemu-img(1)

 @c man end
 
 @end ignore
 @c man end
 
 @end ignore