Merge remote branch 'amit/for-anthony' into staging
[qemu/mdroth.git] / qemu-nbd.texi
blob44996cc650a4c7aac5413e0bde0d245159c895b6
1 @example
2 @c man begin SYNOPSIS
3 usage: qemu-nbd [OPTION]...  @var{filename}
4 @c man end
5 @end example
7 @c man begin DESCRIPTION
9 Export Qemu disk image using NBD protocol.
11 @c man end
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{1024})
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 -r, --read-only
26   export read-only
27 @item -P, --partition=@var{num}
28   only expose partition @var{num}
29 @item -s, --snapshot
30   use snapshot file
31 @item -n, --nocache
32   disable host cache
33 @item -c, --connect=@var{dev}
34   connect @var{filename} to NBD device @var{dev}
35 @item -d, --disconnect
36   disconnect the specified device
37 @item -e, --shared=@var{num}
38   device can be shared by @var{num} clients (default @samp{1})
39 @item -t, --persistent
40   don't exit on the last connection
41 @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
49 @c man end
51 @ignore
53 @setfilename qemu-nbd
54 @settitle QEMU Disk Network Block Device Server
56 @c man begin AUTHOR
57 Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>.
58 This is free software; see the source for copying conditions.  There is NO
59 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
60 @c man end
62 @c man begin SEEALSO
63 qemu-img(1)
64 @c man end
66 @end ignore