sparsify: Add -o option for passing qemu-img output format options.

[libguestfs.git] / sparsify / virt-sparsify.pod

diff --git a/sparsify/virt-sparsify.pod b/sparsify/virt-sparsify.pod
index 3d88a5f..6653787 100644 (file)
--- a/sparsify/virt-sparsify.pod
+++ b/sparsify/virt-sparsify.pod
@@ -22,8 +22,8 @@ Virt-sparsify can also convert between some disk formats, for example
 converting a raw disk image to a thin-provisioned qcow2 image.
 
 Virt-sparsify can operate on any disk image, not just ones from
-virtual machines.  If a virtual machine has multiple disk images, then
-you must sparsify each one separately.
+virtual machines.  If a virtual machine has more than one attached
+disk, you must sparsify each one separately.
 
 =head2 IMPORTANT LIMITATIONS
 
@@ -104,6 +104,11 @@ image.
 
 Display help.
 
+=item B<--compress>
+
+Compress the output file.  This I<only> works if the output format is
+C<qcow2>.
+
 =item B<--convert> raw
 
 =item B<--convert> qcow2
@@ -113,15 +118,16 @@ Display help.
 Use C<output-format> as the format for the destination image.  If this
 is not specified, then the input format is used.
 
-Supported and known-working output formats are: C<raw>, C<qcow2>.
+Supported and known-working output formats are: C<raw>, C<qcow2>, C<vdi>.
 
 You can also use any format supported by the L<qemu-img(1)> program,
-eg. C<vdi> or C<vmdk>, but support for other formats is reliant on
-qemu.
+eg. C<vmdk>, but support for other formats is reliant on qemu.
 
 Specifying the I<--convert> option is usually a good idea, because
 then virt-sparsify doesn't need to try to guess the input format.
 
+For fine-tuning the output format, see: I<--compress>, I<-o>.
+
 =item B<--format> raw
 
 =item B<--format> qcow2
@@ -150,6 +156,18 @@ This option is used to make the output more machine friendly
 when being parsed by other programs.  See
 L</MACHINE READABLE OUTPUT> below.
 
+=item B<-o> option[,option,...]
+
+Pass I<-o> option(s) to the L<qemu-img(1)> command to fine-tune the
+output format.  Options available depend on the output format (see
+I<--convert>) and the installed version of the qemu-img program.
+
+You should use I<-o> at most once.  To pass multiple options, separate
+them with commas, eg:
+
+ virt-sparsify --convert qcow2 \
+   -o cluster_size=512,preallocation=metadata ...
+
 =item B<-q>
 
 =item B<--quiet>
@@ -281,4 +299,4 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
-Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.