blob: 6955d903271de24a2c52b544cacdb67183115aeb [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
32 disable host cache
Ryota Ozakibba7be92010-03-04 00:18:43 +090033@item -c, --connect=@var{dev}
34 connect @var{filename} to NBD device @var{dev}
thscd831bd2008-07-03 10:23:51 +000035@item -d, --disconnect
36 disconnect the specified device
aliguori4a6b8192008-09-22 20:41:57 +000037@item -e, --shared=@var{num}
38 device can be shared by @var{num} clients (default @samp{1})
ths75818252008-07-03 13:41:03 +000039@item -t, --persistent
40 don't exit on the last connection
bellard7a5ca862008-05-27 21:13:40 +000041@item -v, --verbose
42 display extra debugging information
43@item -h, --help
44 display this help and exit
45@item -V, --version
46 output version information and exit
47@end table
48
49@c man end
50
51@ignore
52
53@setfilename qemu-nbd
54@settitle QEMU Disk Network Block Device Server
55
56@c man begin AUTHOR
57Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>.
58This is free software; see the source for copying conditions. There is NO
59warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
60@c man end
61
62@c man begin SEEALSO
63qemu-img(1)
64@c man end
65
66@end ignore