Rewrite manual page.

[virt-df.git] / virt-df / virt-df.pod

diff --git a/virt-df/virt-df.pod b/virt-df/virt-df.pod
index 50ed7fe..f5dc3c3 100644 (file)
--- a/virt-df/virt-df.pod
+++ b/virt-df/virt-df.pod
@@ -15,10 +15,6 @@ I<df>.
 It uses libvirt so it is capable of showing stats across a variety of
 different virtualization systems.
 
-There are some shortcomings to the whole approach of reading disk
-state from outside the guest.  Please read SHORTCOMINGS section below
-for more details.
-
 =head1 OPTIONS
 
 =over 4
@@ -46,12 +42,14 @@ report a bug.
 
 =item B<-h>, B<--human-readable>
 
-Display human-readable sizes (eg. 10GiB).
+Display human-readable sizes (eg. "10GiB" instead of large numbers).
 
 =item B<-i>, B<--inodes>
 
 Display inode information.
 
+This option only works for Unix-like filesystems.
+
 =item B<--help>
 
 Display usage summary.
@@ -68,17 +66,21 @@ Display version and exit.
 
 =back
 
+=head1 EXAMPLE
+
+ # virt-df 
+ Filesystem                1K-blocks    Used Available Type
+ f9x32kvm:hda1                190740   24817    165923 Linux ext2/3
+ f9x32kvm:VolGroup/LogVol00  6568348 3401656   3166692 Linux ext2/3
+ f9x32kvm:VolGroup/LogVol01  1015808                   Linux swap
+
 =head1 SHORTCOMINGS
 
 virt-df spies on the guest's disk image to try to work out how much
 disk space it is actually using.  There are some shortcomings to this,
 described here.
 
-(1) It does not work over remote connections.  The storage API does
-not support peeking into remote disks, and libvirt has rejected a
-request to add this support.
-
-(2) It only understands a limited set of partition types.  Assuming
+(1) It only understands a limited set of partition types.  Assuming
 that the files and partitions that we get back from libvirt / Xen
 correspond to block devices in the guests, we can go some way towards
 manually parsing those partitions to find out what they contain.  We
@@ -89,10 +91,10 @@ libparted which doesn't support LVM yet).  The Linux kernel does
 support that, but there's not really any good way to access that work.
 
 The current implementation uses a hand-coded parser which understands
-some simple formats (MBR, LVM2, ext2/3).  In future we should use
-something like libparted.
+some formats (MBR, LVM2, ext2/3, DOS FAT, Windows NTFS, Linux swap and
+Linux suspend partitions).
 
-(3) The statistics you get are delayed.  The real state of, for
+(2) The statistics you get are delayed.  The real state of, for
 example, an ext2 filesystem is only stored in the memory of the
 guest's kernel.  The ext2 superblock contains some meta-information
 about blocks used and free, but this superblock is not up to date.  In