[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-commits] [COMMIT eff4426] Document changes in qemu-img interface
From: |
Anthony Liguori |
Subject: |
[Qemu-commits] [COMMIT eff4426] Document changes in qemu-img interface |
Date: |
Mon, 08 Jun 2009 13:03:19 -0000 |
From: Kevin Wolf <address@hidden>
Update the documentation to reflect the introduction of format specific options
with -o. Don't advertise -e or -6 any more, they exist only for compatibility
reasons and can be replaced by the corresponding -o options.
Signed-off-by: Kevin Wolf <address@hidden>
diff --git a/qemu-img.c b/qemu-img.c
index 947e71b..aff3980 100644
--- a/qemu-img.c
+++ b/qemu-img.c
@@ -59,9 +59,9 @@ static void help(void)
"\n"
"Command syntax:\n"
" check [-f fmt] filename\n"
- " create [-e] [-6] [-F fmt] [-b base_image] [-f fmt] filename
[size]\n"
+ " create [-F fmt] [-b base_image] [-f fmt] [-o options] filename
[size]\n"
" commit [-f fmt] filename\n"
- " convert [-c] [-e] [-6] [-f fmt] [-O output_fmt] [-B
output_base_image] filename [filename2 [...]] output_filename\n"
+ " convert [-c] [-f fmt] [-O output_fmt] [-o options] [-B
output_base_image] filename [filename2 [...]] output_filename\n"
" info [-f fmt] filename\n"
" snapshot [-l | -a snapshot | -c snapshot | -d snapshot]
filename\n"
"\n"
@@ -79,9 +79,10 @@ static void help(void)
" supported any 'k' or 'K' is ignored\n"
" 'output_filename' is the destination disk image filename\n"
" 'output_fmt' is the destination format\n"
+ " 'options' is a comma separated list of format specific options
in a\n"
+ " name=value format. Use -o ? for an overview of the options
supported by the\n"
+ " used format\n"
" '-c' indicates that target image must be compressed (qcow format
only)\n"
- " '-e' indicates that the target image must be encrypted (qcow
format only)\n"
- " '-6' indicates that the target image must use compatibility
level 6 (vmdk format only)\n"
" '-h' with or without a command shows this help and lists the
supported formats\n"
"\n"
"Parameters to snapshot subcommand:\n"
diff --git a/qemu-img.texi b/qemu-img.texi
index deef2ab..dae7b82 100644
--- a/qemu-img.texi
+++ b/qemu-img.texi
@@ -8,9 +8,9 @@ usage: qemu-img command [command options]
The following commands are supported:
@table @option
address@hidden create [-e] [-6] [-F @var{base_fmt}] [-b @var{base_image}] [-f
@var{fmt}] @var{filename} address@hidden
address@hidden create [-F @var{base_fmt}] [-b @var{base_image}] [-f @var{fmt}]
[-o @var{options}] @var{filename} address@hidden
@item commit [-f @var{fmt}] @var{filename}
address@hidden convert [-c] [-e] [-6] [-f @var{fmt}] [-O @var{output_fmt}] [-B
@var{output_base_image}] @var{filename} address@hidden [...]]
@var{output_filename}
address@hidden convert [-c] [-f @var{fmt}] [-O @var{output_fmt}] [-o
@var{options}] [-B @var{output_base_image}] @var{filename} address@hidden
[...]] @var{output_filename}
@item info [-f @var{fmt}] @var{filename}
@item snapshot [-l | -a @var{snapshot} | -c @var{snapshot} | -d
@var{snapshot}] @var{filename}
@end table
@@ -61,22 +61,23 @@ CD-ROM images present for example in the Knoppix CD-ROMs.
@end table
@item size
-is the disk image size in kilobytes. Optional suffixes @code{M}
-(megabyte, 1024 * 1024) and @code{G} (gigabyte, 1024 * 1024 * 1024)
-are supported and any @code{k} or @code{K} is ignored.
+is the disk image size in bytes. Optional suffixes @code{k} or @code{K}
+(kilobyte, 1024) @code{M} (megabyte, 1024k) and @code{G} (gigabyte, 1024M)
+and T (terabyte, 1024G) are supported. @code{b} is ignored.
@item output_filename
is the destination disk image filename
@item output_fmt
is the destination format
address@hidden options
+is a comma separated list of format specific options in a
+name=value format. Use @code{-o ?} for an overview of the options supported
+by the used format
+
@item -c
indicates that target image must be compressed (qcow format only)
address@hidden -e
-indicates that the target image must be encrypted (qcow format only)
address@hidden -6
-indicates that the target image must use compatibility level 6 (vmdk format
only)
@item -h
with or without a command shows help and lists the supported formats
@end table
@@ -100,7 +101,7 @@ lists all snapshots in the given image
Command description:
@table @option
address@hidden create [-6] [-e] [-b @var{base_image}] [-f @var{fmt}]
@var{filename} address@hidden
address@hidden create [-F @var{base_fmt}] [-b @var{base_image}] [-f @var{fmt}]
[-o @var{options}] @var{filename} address@hidden
Create the new disk image @var{filename} of size @var{size} and format
@var{fmt}.
@@ -110,17 +111,20 @@ differences from @var{base_image}. No size needs to be
specified in
this case. @var{base_image} will never be modified unless you use the
@code{commit} monitor command.
+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.
+
@item commit [-f @var{fmt}] @var{filename}
Commit the changes recorded in @var{filename} in its base image.
address@hidden convert [-c] [-e] [-f @var{fmt}] @var{filename} [-O
@var{output_fmt}] @var{output_filename}
address@hidden convert [-c] [-f @var{fmt}] [-O @var{output_fmt}] [-o
@var{options}] [-B @var{output_base_image}] @var{filename} address@hidden
[...]] @var{output_filename}
Convert the disk image @var{filename} to disk image @var{output_filename}
-using format @var{output_fmt}. It can be optionally encrypted
-(@code{-e} option) or compressed (@code{-c} option).
+using format @var{output_fmt}. It can be optionally compressed (@code{-c}
+option) or use any format specific options like encryption (@code{-o} option).
-Only the format @code{qcow} supports encryption or compression. The
+Only the formats @code{qcow} and @code{qcow2} support encryption or
compression. The
compression is read-only. It means that if a compressed sector is
rewritten, then it is rewritten as uncompressed data.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Qemu-commits] [COMMIT eff4426] Document changes in qemu-img interface,
Anthony Liguori <=