Document changes in qemu-img interface
[qemu/hppa.git] / qemu-img.texi
blobdae7b826ede399a54e7450a7fa7629b2c0581c70
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 [-F @var{base_fmt}] [-b @var{base_image}] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
12 @item commit [-f @var{fmt}] @var{filename}
13 @item convert [-c] [-f @var{fmt}] [-O @var{output_fmt}] [-o @var{options}] [-B @var{output_base_image}] @var{filename} [@var{filename2} [...]] @var{output_filename}
14 @item info [-f @var{fmt}] @var{filename}
15 @item snapshot [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename}
16 @end table
18 Command parameters:
19 @table @var
20 @item filename
21  is a disk image filename
22 @item base_image
23 is the read-only disk image which is used as base for a copy on
24     write image; the copy on write image only stores the modified data
25 @item output_base_image
26 forces the output image to be created as a copy on write
27 image of the specified base image; @code{output_base_image} should have the same
28 content as the input's base image, however the path, image format, etc may
29 differ
30 @item base_fmt
31 is the disk image format of @var{base_image}. for more information look at @var{fmt}
32 @item fmt
33 is the disk image format. It is guessed automatically in most cases. The following formats are supported:
35 @table @code
36 @item raw
38 Raw disk image format (default). This format has the advantage of
39 being simple and easily exportable to all other emulators. If your
40 file system supports @emph{holes} (for example in ext2 or ext3 on
41 Linux or NTFS on Windows), then only the written sectors will reserve
42 space. Use @code{qemu-img info} to know the real size used by the
43 image or @code{ls -ls} on Unix/Linux.
45 @item qcow2
46 QEMU image format, the most versatile format. Use it to have smaller
47 images (useful if your filesystem does not supports holes, for example
48 on Windows), optional AES encryption, zlib based compression and
49 support of multiple VM snapshots.
50 @item qcow
51 Old QEMU image format. Left for compatibility.
52 @item cow
53 User Mode Linux Copy On Write image format. Used to be the only growable
54 image format in QEMU. It is supported only for compatibility with
55 previous versions. It does not work on win32.
56 @item vmdk
57 VMware 3 and 4 compatible image format.
58 @item cloop
59 Linux Compressed Loop image, useful only to reuse directly compressed
60 CD-ROM images present for example in the Knoppix CD-ROMs.
61 @end table
63 @item size
64 is the disk image size in bytes. Optional suffixes @code{k} or @code{K}
65 (kilobyte, 1024) @code{M} (megabyte, 1024k) and @code{G} (gigabyte, 1024M)
66 and T (terabyte, 1024G) are supported.  @code{b} is ignored.
68 @item output_filename
69 is the destination disk image filename
71 @item output_fmt
72  is the destination format
73 @item options
74 is a comma separated list of format specific options in a
75 name=value format. Use @code{-o ?} for an overview of the options supported
76 by the used format
79 @item -c
80 indicates that target image must be compressed (qcow format only)
81 @item -h
82 with or without a command shows help and lists the supported formats
83 @end table
85 Parameters to snapshot subcommand:
87 @table @option
89 @item snapshot
90 is the name of the snapshot to create, apply or delete
91 @item -a
92 applies a snapshot (revert disk to saved state)
93 @item -c
94 creates a snapshot
95 @item -d
96 deletes a snapshot
97 @item -l
98 lists all snapshots in the given image
99 @end table
101 Command description:
103 @table @option
104 @item create [-F @var{base_fmt}] [-b @var{base_image}] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
106 Create the new disk image @var{filename} of size @var{size} and format
107 @var{fmt}.
109 If @var{base_image} is specified, then the image will record only the
110 differences from @var{base_image}. No size needs to be specified in
111 this case. @var{base_image} will never be modified unless you use the
112 @code{commit} monitor command.
114 The size can also be specified using the @var{size} option with @code{-o},
115 it doesn't need to be specified separately in this case.
117 @item commit [-f @var{fmt}] @var{filename}
119 Commit the changes recorded in @var{filename} in its base image.
121 @item convert [-c] [-f @var{fmt}] [-O @var{output_fmt}] [-o @var{options}] [-B @var{output_base_image}] @var{filename} [@var{filename2} [...]] @var{output_filename}
123 Convert the disk image @var{filename} to disk image @var{output_filename}
124 using format @var{output_fmt}. It can be optionally compressed (@code{-c}
125 option) or use any format specific options like encryption (@code{-o} option).
127 Only the formats @code{qcow} and @code{qcow2} support encryption or compression. The
128 compression is read-only. It means that if a compressed sector is
129 rewritten, then it is rewritten as uncompressed data.
131 Encryption uses the AES format which is very secure (128 bit keys). Use
132 a long password (16 characters) to get maximum protection.
134 Image conversion is also useful to get smaller image when using a
135 growable format such as @code{qcow} or @code{cow}: the empty sectors
136 are detected and suppressed from the destination image.
138 @item info [-f @var{fmt}] @var{filename}
140 Give information about the disk image @var{filename}. Use it in
141 particular to know the size reserved on disk which can be different
142 from the displayed size. If VM snapshots are stored in the disk image,
143 they are displayed too.
145 @item snapshot [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot} ] @var{filename}
147 List, apply, create or delete snapshots in image @var{filename}.
148 @end table
150 @c man end
152 @ignore
154 @setfilename qemu-img
155 @settitle QEMU disk image utility
157 @c man begin SEEALSO
158 The HTML documentation of QEMU for more precise information and Linux
159 user mode emulator invocation.
160 @c man end
162 @c man begin AUTHOR
163 Fabrice Bellard
164 @c man end
166 @end ignore