Statistics
| Branch: | Revision:

root / qemu-nbd.texi @ 8cfd0495

History | View | Annotate | Download (2.1 kB)

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