virt-resize: Arrange options in man page in alphabetical order.
authorRichard W.M. Jones <rjones@redhat.com>
Wed, 13 Jul 2011 08:44:13 +0000 (09:44 +0100)
committerRichard W.M. Jones <rjones@redhat.com>
Wed, 13 Jul 2011 08:44:13 +0000 (09:44 +0100)
resize/virt-resize.pod

index 69c93e3..473c582 100644 (file)
@@ -222,58 +222,25 @@ C<dd if=/dev/zero of=outdisk bs=1M count=..>)
 
 Display help.
 
 
 Display help.
 
-=item B<-V>
-
-=item B<--version>
-
-Display version number and exit.
-
-=item B<--resize part=size>
-
-Resize the named partition (expanding or shrinking it) so that it has
-the given size.
-
-C<size> can be expressed as an absolute number followed by
-b/K/M/G to mean bytes, Kilobytes, Megabytes, or Gigabytes;
-or as a percentage of the current size;
-or as a relative number or percentage.
-For example:
-
- --resize /dev/sda2=10G
-
- --resize /dev/sda4=90%
-
- --resize /dev/sda2=+1G
-
- --resize /dev/sda2=-200M
+=item B<-d>
 
 
- --resize /dev/sda1=+128K
+=item B<--debug>
 
 
- --resize /dev/sda1=+10%
+Enable debugging messages.
 
 
- --resize /dev/sda1=-10%
+=item B<--delete part>
 
 
-You can increase the size of any partition.  Virt-resize will expand
-the direct content of the partition if it knows how (see I<--expand>
-below).
+Delete the named partition.  It would be more accurate to describe
+this as "don't copy it over", since virt-resize doesn't do in-place
+changes and the original disk image is left intact.
 
 
-You can only I<decrease> the size of partitions that contain
-filesystems or PVs which have already been shrunk.  Virt-resize will
-check this has been done before proceeding, or else will print an
-error (see also I<--resize-force>).
+Note that when you delete a partition, then anything contained in the
+partition is also deleted.  Furthermore, this causes any partitions
+that come after to be I<renumbered>, which can easily make your guest
+unbootable.
 
 You can give this option multiple times.
 
 
 You can give this option multiple times.
 
-=item B<--resize-force part=size>
-
-This is the same as I<--resize> except that it will let you decrease
-the size of any partition.  Generally this means you will lose any
-data which was at the end of the partition you shrink, but you may not
-care about that (eg. if shrinking an unused partition, or if you can
-easily recreate it such as a swap partition).
-
-See also the I<--ignore> option.
-
 =item B<--expand part>
 
 Expand the named partition so it uses up all extra space (space left
 =item B<--expand part>
 
 Expand the named partition so it uses up all extra space (space left
@@ -313,23 +280,16 @@ could also resize LVs as desired after boot.
 
 Note that you cannot use I<--expand> and I<--shrink> together.
 
 
 Note that you cannot use I<--expand> and I<--shrink> together.
 
-=item B<--shrink part>
+=item B<--format> raw
 
 
-Shrink the named partition until the overall disk image fits in the
-destination.  The named partition B<must> contain a filesystem or PV
-which has already been shrunk using another tool (eg. L<guestfish(1)>
-or other online tools).  Virt-resize will check this and give an error
-if it has not been done.
+Specify the format of the input disk image.  If this flag is not
+given then it is auto-detected from the image itself.
 
 
-The amount by which the overall disk must be shrunk (after carrying
-out all other operations requested by the user) is called the
-"deficit".  For example, a straight copy (assume no other operations)
-from a 5GB disk image to a 4GB disk image results in a 1GB deficit.
-In this case, virt-resize would give an error unless the user
-specified a partition to shrink and that partition had more than a
-gigabyte of free space.
+If working with untrusted raw-format guest disk images, you should
+ensure the format is always specified.
 
 
-Note that you cannot use I<--expand> and I<--shrink> together.
+Note that this option I<does not> affect the output format.
+See L</QCOW2 AND NON-SPARSE RAW FORMATS>.
 
 =item B<--ignore part>
 
 
 =item B<--ignore part>
 
@@ -340,19 +300,6 @@ blank (all zero bytes).
 
 You can give this option multiple times.
 
 
 You can give this option multiple times.
 
-=item B<--delete part>
-
-Delete the named partition.  It would be more accurate to describe
-this as "don't copy it over", since virt-resize doesn't do in-place
-changes and the original disk image is left intact.
-
-Note that when you delete a partition, then anything contained in the
-partition is also deleted.  Furthermore, this causes any partitions
-that come after to be I<renumbered>, which can easily make your guest
-unbootable.
-
-You can give this option multiple times.
-
 =item B<--LV-expand logvol>
 
 This takes the logical volume and, as a final step, expands it to fill
 =item B<--LV-expand logvol>
 
 This takes the logical volume and, as a final step, expands it to fill
@@ -376,6 +323,12 @@ You can give this option multiple times, I<but> it doesn't
 make sense to do this unless the logical volumes you specify
 are all in different volume groups.
 
 make sense to do this unless the logical volumes you specify
 are all in different volume groups.
 
+=item B<-n>
+
+=item B<--dryrun>
+
+Print a summary of what would be done, but don't do anything.
+
 =item B<--no-copy-boot-loader>
 
 By default, virt-resize copies over some sectors at the start of the
 =item B<--no-copy-boot-loader>
 
 By default, virt-resize copies over some sectors at the start of the
@@ -413,17 +366,18 @@ You have to use this option if you want to resize a Windows
 guest multiple times without booting into Windows between each
 resize.
 
 guest multiple times without booting into Windows between each
 resize.
 
-=item B<-d>
-
-=item B<--debug>
-
-Enable debugging messages.
+=item B<--output-format> raw
 
 
-=item B<-n>
+Specify the format of the output disk image.  If this flag is not
+given then it is auto-detected from the image itself.
 
 
-=item B<--dryrun>
+If working with untrusted raw-format guest disk images, you should
+ensure the format is always specified.
 
 
-Print a summary of what would be done, but don't do anything.
+Note that this option I<does not create> the output format.  This
+option just tells libguestfs what it is so it doesn't try to guess it.
+You still need to create the output disk with the right format.  See
+L</QCOW2 AND NON-SPARSE RAW FORMATS>.
 
 =item B<-q>
 
 
 =item B<-q>
 
@@ -431,29 +385,75 @@ Print a summary of what would be done, but don't do anything.
 
 Don't print the summary.
 
 
 Don't print the summary.
 
-=item B<--format> raw
+=item B<--resize part=size>
 
 
-Specify the format of the input disk image.  If this flag is not
-given then it is auto-detected from the image itself.
+Resize the named partition (expanding or shrinking it) so that it has
+the given size.
 
 
-If working with untrusted raw-format guest disk images, you should
-ensure the format is always specified.
+C<size> can be expressed as an absolute number followed by
+b/K/M/G to mean bytes, Kilobytes, Megabytes, or Gigabytes;
+or as a percentage of the current size;
+or as a relative number or percentage.
+For example:
 
 
-Note that this option I<does not> affect the output format.
-See L</QCOW2 AND NON-SPARSE RAW FORMATS>.
+ --resize /dev/sda2=10G
 
 
-=item B<--output-format> raw
+ --resize /dev/sda4=90%
 
 
-Specify the format of the output disk image.  If this flag is not
-given then it is auto-detected from the image itself.
+ --resize /dev/sda2=+1G
 
 
-If working with untrusted raw-format guest disk images, you should
-ensure the format is always specified.
+ --resize /dev/sda2=-200M
 
 
-Note that this option I<does not create> the output format.  This
-option just tells libguestfs what it is so it doesn't try to guess it.
-You still need to create the output disk with the right format.  See
-L</QCOW2 AND NON-SPARSE RAW FORMATS>.
+ --resize /dev/sda1=+128K
+
+ --resize /dev/sda1=+10%
+
+ --resize /dev/sda1=-10%
+
+You can increase the size of any partition.  Virt-resize will expand
+the direct content of the partition if it knows how (see I<--expand>
+below).
+
+You can only I<decrease> the size of partitions that contain
+filesystems or PVs which have already been shrunk.  Virt-resize will
+check this has been done before proceeding, or else will print an
+error (see also I<--resize-force>).
+
+You can give this option multiple times.
+
+=item B<--resize-force part=size>
+
+This is the same as I<--resize> except that it will let you decrease
+the size of any partition.  Generally this means you will lose any
+data which was at the end of the partition you shrink, but you may not
+care about that (eg. if shrinking an unused partition, or if you can
+easily recreate it such as a swap partition).
+
+See also the I<--ignore> option.
+
+=item B<--shrink part>
+
+Shrink the named partition until the overall disk image fits in the
+destination.  The named partition B<must> contain a filesystem or PV
+which has already been shrunk using another tool (eg. L<guestfish(1)>
+or other online tools).  Virt-resize will check this and give an error
+if it has not been done.
+
+The amount by which the overall disk must be shrunk (after carrying
+out all other operations requested by the user) is called the
+"deficit".  For example, a straight copy (assume no other operations)
+from a 5GB disk image to a 4GB disk image results in a 1GB deficit.
+In this case, virt-resize would give an error unless the user
+specified a partition to shrink and that partition had more than a
+gigabyte of free space.
+
+Note that you cannot use I<--expand> and I<--shrink> together.
+
+=item B<-V>
+
+=item B<--version>
+
+Display version number and exit.
 
 =back
 
 
 =back