blob: 6055ec693b81b8e495ca575c9b246ed0e0e5012e [file] [log] [blame]
bellard7a5ca862008-05-27 21:13:40 +00001@example
2@c man begin SYNOPSIS
3usage: qemu-nbd [OPTION]... @var{filename}
4@c man end
5@end example
6
7@c man begin DESCRIPTION
8
Stefan Weil071c9392012-04-07 09:23:36 +02009Export QEMU disk image using NBD protocol.
bellard7a5ca862008-05-27 21:13:40 +000010
11@c man end
12
13@c man begin OPTIONS
aliguori4a6b8192008-09-22 20:41:57 +000014@table @option
15@item @var{filename}
bellard7a5ca862008-05-27 21:13:40 +000016 is a disk image filename
aliguori4a6b8192008-09-22 20:41:57 +000017@item -p, --port=@var{port}
18 port to listen on (default @samp{1024})
19@item -o, --offset=@var{offset}
bellard7a5ca862008-05-27 21:13:40 +000020 offset into the image
aliguori4a6b8192008-09-22 20:41:57 +000021@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}
bellard7a5ca862008-05-27 21:13:40 +000025@item -r, --read-only
26 export read-only
aliguori4a6b8192008-09-22 20:41:57 +000027@item -P, --partition=@var{num}
28 only expose partition @var{num}
ths2f726482008-07-03 11:47:46 +000029@item -s, --snapshot
30 use snapshot file
31@item -n, --nocache
Paolo Bonzini0eb256a2013-02-08 13:19:07 +010032@itemx --cache=@var{cache}
33 set cache mode to be used with the file. See the documentation of
34 the emulator's @code{-drive cache=...} option for allowed values.
35@item --aio=@var{aio}
36 choose asynchronous I/O mode between @samp{threads} (the default)
37 and @samp{native} (Linux only).
Paolo Bonzinided9d2d2013-02-08 14:06:13 +010038@item --discard=@var{discard}
39 toggles whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap})
40 requests are ignored or passed to the filesystem. The default is no
41 (@samp{--discard=ignore}).
Ryota Ozakibba7be92010-03-04 00:18:43 +090042@item -c, --connect=@var{dev}
43 connect @var{filename} to NBD device @var{dev}
thscd831bd2008-07-03 10:23:51 +000044@item -d, --disconnect
45 disconnect the specified device
aliguori4a6b8192008-09-22 20:41:57 +000046@item -e, --shared=@var{num}
47 device can be shared by @var{num} clients (default @samp{1})
Daniel P. Berrangee6b63672013-03-19 11:20:20 +000048@item -f, --format=@var{fmt}
49 force block driver for format @var{fmt} instead of auto-detecting
ths75818252008-07-03 13:41:03 +000050@item -t, --persistent
51 don't exit on the last connection
bellard7a5ca862008-05-27 21:13:40 +000052@item -v, --verbose
53 display extra debugging information
54@item -h, --help
55 display this help and exit
56@item -V, --version
57 output version information and exit
58@end table
59
60@c man end
61
62@ignore
63
64@setfilename qemu-nbd
65@settitle QEMU Disk Network Block Device Server
66
67@c man begin AUTHOR
68Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>.
69This is free software; see the source for copying conditions. There is NO
70warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
71@c man end
72
73@c man begin SEEALSO
74qemu-img(1)
75@c man end
76
77@end ignore