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