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