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