root / qemu-img.texi @ 1eec614b
History | View | Annotate | Download (5.2 kB)
1 | acd935ef | bellard | @example |
---|---|---|---|
2 | acd935ef | bellard | @c man begin SYNOPSIS |
3 | acd935ef | bellard | usage: qemu-img command [command options] |
4 | acd935ef | bellard | @c man end |
5 | acd935ef | bellard | @end example |
6 | acd935ef | bellard | |
7 | acd935ef | bellard | @c man begin OPTIONS |
8 | acd935ef | bellard | |
9 | acd935ef | bellard | The following commands are supported: |
10 | acd935ef | bellard | @table @option |
11 | ec36ba14 | ths | @item create [-e] [-6] [-b @var{base_image}] [-f @var{fmt}] @var{filename} [@var{size}] |
12 | acd935ef | bellard | @item commit [-f @var{fmt}] @var{filename} |
13 | f58c7b35 | ths | @item convert [-c] [-e] [-6] [-f @var{fmt}] [-O @var{output_fmt}] [-B @var{output_base_image}] @var{filename} [@var{filename2} [...]] @var{output_filename} |
14 | acd935ef | bellard | @item info [-f @var{fmt}] @var{filename} |
15 | d2c639d6 | blueswir1 | @item snapshot [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename} |
16 | acd935ef | bellard | @end table |
17 | acd935ef | bellard | |
18 | acd935ef | bellard | Command parameters: |
19 | acd935ef | bellard | @table @var |
20 | acd935ef | bellard | @item filename |
21 | acd935ef | bellard | is a disk image filename |
22 | 5fafdf24 | ths | @item base_image |
23 | acd935ef | bellard | is the read-only disk image which is used as base for a copy on |
24 | acd935ef | bellard | write image; the copy on write image only stores the modified data |
25 | f58c7b35 | ths | @item output_base_image |
26 | f58c7b35 | ths | forces the output image to be created as a copy on write |
27 | f58c7b35 | ths | image of the specified base image; @code{output_base_image} should have the same |
28 | f58c7b35 | ths | content as the input's base image, however the path, image format, etc may |
29 | f58c7b35 | ths | differ |
30 | 5fafdf24 | ths | @item fmt |
31 | acd935ef | bellard | is the disk image format. It is guessed automatically in most cases. The following formats are supported: |
32 | acd935ef | bellard | |
33 | acd935ef | bellard | @table @code |
34 | acd935ef | bellard | @item raw |
35 | acd935ef | bellard | |
36 | acd935ef | bellard | Raw disk image format (default). This format has the advantage of |
37 | 19d36792 | bellard | being simple and easily exportable to all other emulators. If your |
38 | 19d36792 | bellard | file system supports @emph{holes} (for example in ext2 or ext3 on |
39 | 19d36792 | bellard | Linux or NTFS on Windows), then only the written sectors will reserve |
40 | 19d36792 | bellard | space. Use @code{qemu-img info} to know the real size used by the |
41 | 19d36792 | bellard | image or @code{ls -ls} on Unix/Linux. |
42 | acd935ef | bellard | |
43 | 19d36792 | bellard | @item qcow2 |
44 | acd935ef | bellard | QEMU image format, the most versatile format. Use it to have smaller |
45 | acd935ef | bellard | images (useful if your filesystem does not supports holes, for example |
46 | 19d36792 | bellard | on Windows), optional AES encryption, zlib based compression and |
47 | 19d36792 | bellard | support of multiple VM snapshots. |
48 | 19d36792 | bellard | @item qcow |
49 | 19d36792 | bellard | Old QEMU image format. Left for compatibility. |
50 | acd935ef | bellard | @item cow |
51 | acd935ef | bellard | User Mode Linux Copy On Write image format. Used to be the only growable |
52 | acd935ef | bellard | image format in QEMU. It is supported only for compatibility with |
53 | acd935ef | bellard | previous versions. It does not work on win32. |
54 | acd935ef | bellard | @item vmdk |
55 | e5d80f94 | bellard | VMware 3 and 4 compatible image format. |
56 | acd935ef | bellard | @item cloop |
57 | acd935ef | bellard | Linux Compressed Loop image, useful only to reuse directly compressed |
58 | acd935ef | bellard | CD-ROM images present for example in the Knoppix CD-ROMs. |
59 | acd935ef | bellard | @end table |
60 | acd935ef | bellard | |
61 | 5fafdf24 | ths | @item size |
62 | acd935ef | bellard | is the disk image size in kilobytes. Optional suffixes @code{M} |
63 | d2c639d6 | blueswir1 | (megabyte, 1024 * 1024) and @code{G} (gigabyte, 1024 * 1024 * 1024) |
64 | d2c639d6 | blueswir1 | are supported and any @code{k} or @code{K} is ignored. |
65 | acd935ef | bellard | |
66 | acd935ef | bellard | @item output_filename |
67 | 5fafdf24 | ths | is the destination disk image filename |
68 | acd935ef | bellard | |
69 | acd935ef | bellard | @item output_fmt |
70 | acd935ef | bellard | is the destination format |
71 | acd935ef | bellard | |
72 | acd935ef | bellard | @item -c |
73 | acd935ef | bellard | indicates that target image must be compressed (qcow format only) |
74 | 5fafdf24 | ths | @item -e |
75 | acd935ef | bellard | indicates that the target image must be encrypted (qcow format only) |
76 | ec36ba14 | ths | @item -6 |
77 | ec36ba14 | ths | indicates that the target image must use compatibility level 6 (vmdk format only) |
78 | d2c639d6 | blueswir1 | @item -h |
79 | d2c639d6 | blueswir1 | with or without a command shows help and lists the supported formats |
80 | d2c639d6 | blueswir1 | @end table |
81 | d2c639d6 | blueswir1 | |
82 | d2c639d6 | blueswir1 | Parameters to snapshot subcommand: |
83 | d2c639d6 | blueswir1 | |
84 | d2c639d6 | blueswir1 | @table @option |
85 | d2c639d6 | blueswir1 | |
86 | d2c639d6 | blueswir1 | @item snapshot |
87 | d2c639d6 | blueswir1 | is the name of the snapshot to create, apply or delete |
88 | d2c639d6 | blueswir1 | @item -a |
89 | d2c639d6 | blueswir1 | applies a snapshot (revert disk to saved state) |
90 | d2c639d6 | blueswir1 | @item -c |
91 | d2c639d6 | blueswir1 | creates a snapshot |
92 | d2c639d6 | blueswir1 | @item -d |
93 | d2c639d6 | blueswir1 | deletes a snapshot |
94 | d2c639d6 | blueswir1 | @item -l |
95 | d2c639d6 | blueswir1 | lists all snapshots in the given image |
96 | acd935ef | bellard | @end table |
97 | acd935ef | bellard | |
98 | acd935ef | bellard | Command description: |
99 | acd935ef | bellard | |
100 | acd935ef | bellard | @table @option |
101 | ec36ba14 | ths | @item create [-6] [-e] [-b @var{base_image}] [-f @var{fmt}] @var{filename} [@var{size}] |
102 | acd935ef | bellard | |
103 | acd935ef | bellard | Create the new disk image @var{filename} of size @var{size} and format |
104 | 5fafdf24 | ths | @var{fmt}. |
105 | acd935ef | bellard | |
106 | acd935ef | bellard | If @var{base_image} is specified, then the image will record only the |
107 | acd935ef | bellard | differences from @var{base_image}. No size needs to be specified in |
108 | acd935ef | bellard | this case. @var{base_image} will never be modified unless you use the |
109 | acd935ef | bellard | @code{commit} monitor command. |
110 | acd935ef | bellard | |
111 | acd935ef | bellard | @item commit [-f @var{fmt}] @var{filename} |
112 | acd935ef | bellard | |
113 | acd935ef | bellard | Commit the changes recorded in @var{filename} in its base image. |
114 | acd935ef | bellard | |
115 | acd935ef | bellard | @item convert [-c] [-e] [-f @var{fmt}] @var{filename} [-O @var{output_fmt}] @var{output_filename} |
116 | acd935ef | bellard | |
117 | acd935ef | bellard | Convert the disk image @var{filename} to disk image @var{output_filename} |
118 | 4be456f1 | ths | using format @var{output_fmt}. It can be optionally encrypted |
119 | acd935ef | bellard | (@code{-e} option) or compressed (@code{-c} option). |
120 | acd935ef | bellard | |
121 | acd935ef | bellard | Only the format @code{qcow} supports encryption or compression. The |
122 | acd935ef | bellard | compression is read-only. It means that if a compressed sector is |
123 | acd935ef | bellard | rewritten, then it is rewritten as uncompressed data. |
124 | acd935ef | bellard | |
125 | acd935ef | bellard | Encryption uses the AES format which is very secure (128 bit keys). Use |
126 | acd935ef | bellard | a long password (16 characters) to get maximum protection. |
127 | acd935ef | bellard | |
128 | acd935ef | bellard | Image conversion is also useful to get smaller image when using a |
129 | acd935ef | bellard | growable format such as @code{qcow} or @code{cow}: the empty sectors |
130 | acd935ef | bellard | are detected and suppressed from the destination image. |
131 | acd935ef | bellard | |
132 | acd935ef | bellard | @item info [-f @var{fmt}] @var{filename} |
133 | acd935ef | bellard | |
134 | acd935ef | bellard | Give information about the disk image @var{filename}. Use it in |
135 | acd935ef | bellard | particular to know the size reserved on disk which can be different |
136 | 19d36792 | bellard | from the displayed size. If VM snapshots are stored in the disk image, |
137 | 19d36792 | bellard | they are displayed too. |
138 | d2c639d6 | blueswir1 | |
139 | d2c639d6 | blueswir1 | @item snapshot [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot} ] @var{filename} |
140 | d2c639d6 | blueswir1 | |
141 | d2c639d6 | blueswir1 | List, apply, create or delete snapshots in image @var{filename}. |
142 | acd935ef | bellard | @end table |
143 | acd935ef | bellard | |
144 | acd935ef | bellard | @c man end |
145 | acd935ef | bellard | |
146 | acd935ef | bellard | @ignore |
147 | acd935ef | bellard | |
148 | acd935ef | bellard | @setfilename qemu-img |
149 | acd935ef | bellard | @settitle QEMU disk image utility |
150 | acd935ef | bellard | |
151 | acd935ef | bellard | @c man begin SEEALSO |
152 | acd935ef | bellard | The HTML documentation of QEMU for more precise information and Linux |
153 | acd935ef | bellard | user mode emulator invocation. |
154 | acd935ef | bellard | @c man end |
155 | acd935ef | bellard | |
156 | acd935ef | bellard | @c man begin AUTHOR |
157 | acd935ef | bellard | Fabrice Bellard |
158 | acd935ef | bellard | @c man end |
159 | acd935ef | bellard | |
160 | acd935ef | bellard | @end ignore |