Fix parsing error with ~ versus -

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

diff --git a/virt-df/virt-df.txt b/virt-df/virt-df.txt
index aa02a8f..a8ab3dc 100644 (file)
--- a/virt-df/virt-df.txt
+++ b/virt-df/virt-df.txt
@@ -11,10 +11,6 @@ DESCRIPTION
     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.
-
 OPTIONS
     -a, --all
         Show all domains. The default is show only running (active) domains.
@@ -23,16 +19,24 @@ OPTIONS
         Connect to libvirt URI. The default is to connect to the default
         libvirt URI, normally Xen.
 
+    --csv
+        Print the results in CSV format, suitable for importing into a
+        spreadsheet or database.
+
+        This option is only supported if virt-df was built with CSV support.
+
     --debug
         Emit debugging information on stderr. Please supply this if you
         report a bug.
 
     -h, --human-readable
-        Display human-readable sizes (eg. 10GiB).
+        Display human-readable sizes (eg. "10GiB" instead of large numbers).
 
     -i, --inodes
         Display inode information.
 
+        This option only works for Unix-like filesystems.
+
     --help
         Display usage summary.
 
@@ -44,16 +48,19 @@ OPTIONS
     --version
         Display version and exit.
 
+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
+
 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 that
+    (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 can read the
@@ -64,10 +71,10 @@ SHORTCOMINGS
     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 example,
+    (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 fact the guest kernel