qemu-nbd.texi

   1 @example
   2 @c man begin SYNOPSIS
   3 usage: qemu-nbd [OPTION]...  @var{filename}
   4 @c man end
   5 @end example
   6
   7 @c man begin DESCRIPTION
   8
   9 Export QEMU disk image using NBD protocol.
  10
  11 @c man end
  12
  13 @c man begin OPTIONS
  14 @table @option
  15 @item @var{filename}
  16  is a disk image filename
  17 @item -p, --port=@var{port}
  18   port to listen on (default @samp{10809})
  19 @item -o, --offset=@var{offset}
  20   offset into the image
  21 @item -b, --bind=@var{iface}
  22   interface to bind to (default @samp{0.0.0.0})
  23 @item -k, --socket=@var{path}
  24   Use a unix socket with path @var{path}
  25 @item -f, --format=@var{format}
  26   Set image format as @var{format}
  27 @item -r, --read-only
  28   export read-only
  29 @item -P, --partition=@var{num}
  30   only expose partition @var{num}
  31 @item -s, --snapshot
  32   use @var{filename} as an external snapshot, create a temporary
  33   file with backing_file=@var{filename}, redirect the write to
  34   the temporary one
  35 @item -l, --load-snapshot=@var{snapshot_param}
  36   load an internal snapshot inside @var{filename} and export it
  37   as an read-only device, @var{snapshot_param} format is
  38   'snapshot.id=[ID],snapshot.name=[NAME]' or '[ID_OR_NAME]'
  39 @item -n, --nocache
  40 @itemx --cache=@var{cache}
  41   set cache mode to be used with the file.  See the documentation of
  42   the emulator's @code{-drive cache=...} option for allowed values.
  43 @item --aio=@var{aio}
  44   choose asynchronous I/O mode between @samp{threads} (the default)
  45   and @samp{native} (Linux only).
  46 @item --discard=@var{discard}
  47   toggles whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap})
  48   requests are ignored or passed to the filesystem.  The default is no
  49   (@samp{--discard=ignore}).
  50 @item -c, --connect=@var{dev}
  51   connect @var{filename} to NBD device @var{dev}
  52 @item -d, --disconnect
  53   disconnect the specified device
  54 @item -e, --shared=@var{num}
  55   device can be shared by @var{num} clients (default @samp{1})
  56 @item -f, --format=@var{fmt}
  57   force block driver for format @var{fmt} instead of auto-detecting
  58 @item -t, --persistent
  59   don't exit on the last connection
  60 @item -v, --verbose
  61   display extra debugging information
  62 @item -h, --help
  63   display this help and exit
  64 @item -V, --version
  65   output version information and exit
  66 @end table
  67
  68 @c man end
  69
  70 @ignore
  71
  72 @setfilename qemu-nbd
  73 @settitle QEMU Disk Network Block Device Server
  74
  75 @c man begin AUTHOR
  76 Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>.
  77 This is free software; see the source for copying conditions.  There is NO
  78 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  79 @c man end
  80
  81 @c man begin SEEALSO
  82 qemu-img(1)
  83 @c man end
  84
  85 @end ignore