qemu-nbd.texi 2.51 KB
Newer Older
1 2 3 4 5 6 7 8
@example
@c man begin SYNOPSIS
usage: qemu-nbd [OPTION]...  @var{filename}
@c man end
@end example

@c man begin DESCRIPTION

9
Export QEMU disk image using NBD protocol.
10 11 12 13

@c man end

@c man begin OPTIONS
14 15
@table @option
@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 22 23 24
@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}
25 26
@item -f, --format=@var{format}
  Set image format as @var{format}
27 28
@item -r, --read-only
  export read-only
29 30
@item -P, --partition=@var{num}
  only expose partition @var{num}
31
@item -s, --snapshot
32 33 34 35 36 37 38
  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]'
39
@item -n, --nocache
40 41 42 43 44 45
@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).
46 47 48 49
@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}).
50 51
@item -c, --connect=@var{dev}
  connect @var{filename} to NBD device @var{dev}
52 53
@item -d, --disconnect
  disconnect the specified device
54 55
@item -e, --shared=@var{num}
  device can be shared by @var{num} clients (default @samp{1})
56 57
@item -f, --format=@var{fmt}
  force block driver for format @var{fmt} instead of auto-detecting
58 59
@item -t, --persistent
  don't exit on the last connection
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
@item -v, --verbose
  display extra debugging information
@item -h, --help
  display this help and exit
@item -V, --version
  output version information and exit
@end table

@c man end

@ignore

@setfilename qemu-nbd
@settitle QEMU Disk Network Block Device Server

@c man begin AUTHOR
Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>.
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
@c man end

@c man begin SEEALSO
qemu-img(1)
@c man end

@end ignore