Documentation: Don't mention old qemu-img options

The old options are still supported for compatibility, but they are
inconsistent (for example create -b vs. convert -B for backing files) and
incomplete (-F only exists for create) which tends to confuse people. Remove
all references to the old options from the documentation to guide users to the
more consistent -o options.

Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
This commit is contained in:
Kevin Wolf 2009-10-28 12:49:16 +01:00 committed by Anthony Liguori
parent f932c04039
commit 8063d0fe3b
3 changed files with 21 additions and 31 deletions

View File

@ -16,9 +16,9 @@ STEXI
ETEXI ETEXI
DEF("create", img_create, DEF("create", img_create,
"create [-F fmt] [-b base_image] [-f fmt] [-o options] filename [size]") "create [-f fmt] [-o options] filename [size]")
STEXI STEXI
@item create [-F @var{base_fmt}] [-b @var{base_image}] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}] @item create [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
ETEXI ETEXI
DEF("commit", img_commit, DEF("commit", img_commit,
@ -28,9 +28,9 @@ STEXI
ETEXI ETEXI
DEF("convert", img_convert, DEF("convert", img_convert,
"convert [-c] [-f fmt] [-O output_fmt] [-o options] [-B output_base_image] filename [filename2 [...]] output_filename") "convert [-c] [-f fmt] [-O output_fmt] [-o options] filename [filename2 [...]] output_filename")
STEXI STEXI
@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} @item convert [-c] [-f @var{fmt}] [-O @var{output_fmt}] [-o @var{options}] @var{filename} [@var{filename2} [...]] @var{output_filename}
ETEXI ETEXI
DEF("info", img_info, DEF("info", img_info,

View File

@ -71,12 +71,6 @@ static void help(void)
"\n" "\n"
"Command parameters:\n" "Command parameters:\n"
" 'filename' is a disk image filename\n" " 'filename' is a disk image filename\n"
" 'base_image' is the read-only disk image which is used as base for a copy on\n"
" write image; the copy on write image only stores the modified data\n"
" 'output_base_image' forces the output image to be created as a copy on write\n"
" image of the specified base image; 'output_base_image' should have the same\n"
" content as the input's base image, however the path, image format, etc may\n"
" differ\n"
" 'fmt' is the disk image format. It is guessed automatically in most cases\n" " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
" 'size' is the disk image size in kilobytes. Optional suffixes\n" " 'size' is the disk image size in kilobytes. Optional suffixes\n"
" 'M' (megabyte, 1024 * 1024) and 'G' (gigabyte, 1024 * 1024 * 1024) are\n" " 'M' (megabyte, 1024 * 1024) and 'G' (gigabyte, 1024 * 1024 * 1024) are\n"

View File

@ -14,16 +14,6 @@ Command parameters:
@table @var @table @var
@item filename @item filename
is a disk image filename is a disk image filename
@item base_image
is the read-only disk image which is used as base for a copy on
write image; the copy on write image only stores the modified data
@item output_base_image
forces the output image to be created as a copy on write
image of the specified base image; @code{output_base_image} should have the same
content as the input's base image, however the path, image format, etc may
differ
@item base_fmt
is the disk image format of @var{base_image}. for more information look at @var{fmt}
@item fmt @item fmt
is the disk image format. It is guessed automatically in most cases. See below is the disk image format. It is guessed automatically in most cases. See below
for a description of the supported disk formats. for a description of the supported disk formats.
@ -69,15 +59,16 @@ lists all snapshots in the given image
Command description: Command description:
@table @option @table @option
@item create [-F @var{base_fmt}] [-b @var{base_image}] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}] @item create [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
Create the new disk image @var{filename} of size @var{size} and format Create the new disk image @var{filename} of size @var{size} and format
@var{fmt}. @var{fmt}. Depending on the file format, you can add one or more @var{options}
that enable additional features of this format.
If @var{base_image} is specified, then the image will record only the If the option @var{backing_file} is specified, then the image will record
differences from @var{base_image}. No size needs to be specified in only the differences from @var{backing_file}. No size needs to be specified in
this case. @var{base_image} will never be modified unless you use the this case. @var{backing_file} will never be modified unless you use the
@code{commit} monitor command. @code{commit} monitor command (or qemu-img commit).
The size can also be specified using the @var{size} option with @code{-o}, The size can also be specified using the @var{size} option with @code{-o},
it doesn't need to be specified separately in this case. it doesn't need to be specified separately in this case.
@ -86,23 +77,25 @@ it doesn't need to be specified separately in this case.
Commit the changes recorded in @var{filename} in its base image. Commit the changes recorded in @var{filename} in its base image.
@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} @item convert [-c] [-f @var{fmt}] [-O @var{output_fmt}] [-o @var{options}] @var{filename} [@var{filename2} [...]] @var{output_filename}
Convert the disk image @var{filename} to disk image @var{output_filename} Convert the disk image @var{filename} to disk image @var{output_filename}
using format @var{output_fmt}. It can be optionally compressed (@code{-c} using format @var{output_fmt}. It can be optionally compressed (@code{-c}
option) or use any format specific options like encryption (@code{-o} option). option) or use any format specific options like encryption (@code{-o} option).
Only the formats @code{qcow} and @code{qcow2} support encryption or compression. The Only the formats @code{qcow} and @code{qcow2} support compression. The
compression is read-only. It means that if a compressed sector is compression is read-only. It means that if a compressed sector is
rewritten, then it is rewritten as uncompressed data. rewritten, then it is rewritten as uncompressed data.
Encryption uses the AES format which is very secure (128 bit keys). Use
a long password (16 characters) to get maximum protection.
Image conversion is also useful to get smaller image when using a Image conversion is also useful to get smaller image when using a
growable format such as @code{qcow} or @code{cow}: the empty sectors growable format such as @code{qcow} or @code{cow}: the empty sectors
are detected and suppressed from the destination image. are detected and suppressed from the destination image.
You can use the @var{backing_file} option to force the output image to be
created as a copy on write image of the specified base image; the
@var{backing_file} should have the same content as the input's base image,
however the path, image format, etc may differ.
@item info [-f @var{fmt}] @var{filename} @item info [-f @var{fmt}] @var{filename}
Give information about the disk image @var{filename}. Use it in Give information about the disk image @var{filename}. Use it in
@ -138,6 +131,9 @@ QEMU image format, the most versatile format. Use it to have smaller
images (useful if your filesystem does not supports holes, for example images (useful if your filesystem does not supports holes, for example
on Windows), optional AES encryption, zlib based compression and on Windows), optional AES encryption, zlib based compression and
support of multiple VM snapshots. support of multiple VM snapshots.
Encryption uses the AES format which is very secure (128 bit keys). Use
a long password (16 characters) to get maximum protection.
@item qcow @item qcow
Old QEMU image format. Left for compatibility. Old QEMU image format. Left for compatibility.
@item cow @item cow