]> git.proxmox.com Git - mirror_qemu.git/blob - qemu-nbd.texi
qemu-nbd: document --cache and --aio options
[mirror_qemu.git] / qemu-nbd.texi
1 @example
2 @c man begin SYNOPSIS
3 usage: qemu-nbd [OPTION]... @var{filename}
4 @c man end
5 @end example
6
7 @c man begin DESCRIPTION
8
9 Export QEMU disk image using NBD protocol.
10
11 @c man end
12
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 @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).
38 @item -c, --connect=@var{dev}
39 connect @var{filename} to NBD device @var{dev}
40 @item -d, --disconnect
41 disconnect the specified device
42 @item -e, --shared=@var{num}
43 device can be shared by @var{num} clients (default @samp{1})
44 @item -t, --persistent
45 don't exit on the last connection
46 @item -v, --verbose
47 display extra debugging information
48 @item -h, --help
49 display this help and exit
50 @item -V, --version
51 output version information and exit
52 @end table
53
54 @c man end
55
56 @ignore
57
58 @setfilename qemu-nbd
59 @settitle QEMU Disk Network Block Device Server
60
61 @c man begin AUTHOR
62 Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>.
63 This is free software; see the source for copying conditions. There is NO
64 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
65 @c man end
66
67 @c man begin SEEALSO
68 qemu-img(1)
69 @c man end
70
71 @end ignore