X-Git-Url: https://repo.jachan.dev/qemu.git/blobdiff_plain/2f7264888ab4a9595a40bd045f58101e5ccd2f0a..e5a5604f8fdabfc788fbf75354b7f92eb349dcff:/qemu-nbd.texi diff --git a/qemu-nbd.texi b/qemu-nbd.texi index 3a4cb92545..46fd483eb8 100644 --- a/qemu-nbd.texi +++ b/qemu-nbd.texi @@ -6,34 +6,57 @@ 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{10809}) +@item -o, --offset=@var{offset} offset into the image -@item -b, --bind=IFACE - interface to bind to (default `0.0.0.0') -@item -k, --socket=PATH - Use a unix socket with path PATH +@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 -f, --format=@var{format} + Set image format as @var{format} @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 + 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} + 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 - disable host cache -@item -c, --connect - connect FILE to NBD device DEV +@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