]>
Commit | Line | Data |
---|---|---|
7a5ca864 FB |
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 | ||
071c9394 | 9 | Export QEMU disk image using NBD protocol. |
7a5ca864 FB |
10 | |
11 | @c man end | |
12 | ||
13 | @c man begin OPTIONS | |
4a6b819c AL |
14 | @table @option |
15 | @item @var{filename} | |
b9dbb617 | 16 | is a disk image filename |
4a6b819c | 17 | @item -p, --port=@var{port} |
b9dbb617 | 18 | port to listen on (default @samp{10809}) |
4a6b819c | 19 | @item -o, --offset=@var{offset} |
b9dbb617 | 20 | offset into the image |
4a6b819c | 21 | @item -b, --bind=@var{iface} |
b9dbb617 | 22 | interface to bind to (default @samp{0.0.0.0}) |
4a6b819c | 23 | @item -k, --socket=@var{path} |
b9dbb617 | 24 | Use a unix socket with path @var{path} |
4323fdcf | 25 | @item -f, --format=@var{format} |
b9dbb617 | 26 | Set image format as @var{format} |
7a5ca864 | 27 | @item -r, --read-only |
b9dbb617 | 28 | export read-only |
4a6b819c | 29 | @item -P, --partition=@var{num} |
b9dbb617 | 30 | only expose partition @var{num} |
2f726488 | 31 | @item -s, --snapshot |
b9dbb617 SW |
32 | use @var{filename} as an external snapshot, create a temporary |
33 | file with backing_file=@var{filename}, redirect the write to | |
34 | the temporary one | |
8c116b0e | 35 | @item -l, --load-snapshot=@var{snapshot_param} |
b9dbb617 SW |
36 | load an internal snapshot inside @var{filename} and export it |
37 | as an read-only device, @var{snapshot_param} format is | |
38 | 'snapshot.id=[ID],snapshot.name=[NAME]' or '[ID_OR_NAME]' | |
2f726488 | 39 | @item -n, --nocache |
0eb256a2 | 40 | @itemx --cache=@var{cache} |
b9dbb617 SW |
41 | set cache mode to be used with the file. See the documentation of |
42 | the emulator's @code{-drive cache=...} option for allowed values. | |
0eb256a2 | 43 | @item --aio=@var{aio} |
b9dbb617 SW |
44 | choose asynchronous I/O mode between @samp{threads} (the default) |
45 | and @samp{native} (Linux only). | |
ded9d2d5 | 46 | @item --discard=@var{discard} |
b9dbb617 SW |
47 | toggles whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap}) |
48 | requests are ignored or passed to the filesystem. The default is no | |
49 | (@samp{--discard=ignore}). | |
bba7be96 | 50 | @item -c, --connect=@var{dev} |
b9dbb617 | 51 | connect @var{filename} to NBD device @var{dev} |
cd831bd7 | 52 | @item -d, --disconnect |
b9dbb617 | 53 | disconnect the specified device |
4a6b819c | 54 | @item -e, --shared=@var{num} |
b9dbb617 | 55 | device can be shared by @var{num} clients (default @samp{1}) |
e6b63677 | 56 | @item -f, --format=@var{fmt} |
b9dbb617 | 57 | force block driver for format @var{fmt} instead of auto-detecting |
75818250 | 58 | @item -t, --persistent |
b9dbb617 | 59 | don't exit on the last connection |
7a5ca864 | 60 | @item -v, --verbose |
b9dbb617 | 61 | display extra debugging information |
7a5ca864 | 62 | @item -h, --help |
b9dbb617 | 63 | display this help and exit |
7a5ca864 | 64 | @item -V, --version |
b9dbb617 | 65 | output version information and exit |
7a5ca864 FB |
66 | @end table |
67 | ||
68 | @c man end | |
69 | ||
70 | @ignore | |
71 | ||
72 | @setfilename qemu-nbd | |
73 | @settitle QEMU Disk Network Block Device Server | |
74 | ||
75 | @c man begin AUTHOR | |
76 | Copyright (C) 2006 Anthony Liguori <[email protected]>. | |
77 | This is free software; see the source for copying conditions. There is NO | |
78 | warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
79 | @c man end | |
80 | ||
81 | @c man begin SEEALSO | |
82 | qemu-img(1) | |
83 | @c man end | |
84 | ||
85 | @end ignore |