Fix parsing error with ~ versus -

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

diff --git a/virt-df/virt-df.1 b/virt-df/virt-df.1
index 93c4ad7..35ab421 100644 (file)
--- a/virt-df/virt-df.1
+++ b/virt-df/virt-df.1
@@ -129,7 +129,7 @@
 .\" ========================================================================
 .\"
 .IX Title "VIRT-DF 1"
-.TH VIRT-DF 1 "2008-04-16" "ocaml-libvirt-0.4.1.1" "Virtualization Support"
+.TH VIRT-DF 1 "2008-06-10" "virt-df-2.1.1" "Virtualization Support"
 .SH "NAME"
 virt\-df \- 'df'\-like utility for virtualization stats
 .SH "SUMMARY"
@@ -143,10 +143,6 @@ of guests.  Many command line options are the same as for ordinary
 .PP
 It uses libvirt so it is capable of showing stats across a variety of
 different virtualization systems.
-.PP
-There are some shortcomings to the whole approach of reading disk
-state from outside the guest.  Please read \s-1SHORTCOMINGS\s0 section below
-for more details.
 .SH "OPTIONS"
 .IX Header "OPTIONS"
 .IP "\fB\-a\fR, \fB\-\-all\fR" 4
@@ -156,16 +152,24 @@ Show all domains.  The default is show only running (active) domains.
 .IX Item "-c uri, --connect uri"
 Connect to libvirt \s-1URI\s0.  The default is to connect to the default
 libvirt \s-1URI\s0, normally Xen.
+.IP "\fB\-\-csv\fR" 4
+.IX Item "--csv"
+Print the results in \s-1CSV\s0 format, suitable for importing into a
+spreadsheet or database.
+.Sp
+This option is only supported if virt-df was built with \s-1CSV\s0 support.
 .IP "\fB\-\-debug\fR" 4
 .IX Item "--debug"
 Emit debugging information on stderr.  Please supply this if you
 report a bug.
 .IP "\fB\-h\fR, \fB\-\-human\-readable\fR" 4
 .IX Item "-h, --human-readable"
-Display human-readable sizes (eg. 10GiB).
+Display human-readable sizes (eg. \*(L"10GiB\*(R" instead of large numbers).
 .IP "\fB\-i\fR, \fB\-\-inodes\fR" 4
 .IX Item "-i, --inodes"
 Display inode information.
+.Sp
+This option only works for Unix-like filesystems.
 .IP "\fB\-\-help\fR" 4
 .IX Item "--help"
 Display usage summary.
@@ -177,17 +181,22 @@ specify the \fB\-t\fR option multiple times.
 .IP "\fB\-\-version\fR" 4
 .IX Item "--version"
 Display version and exit.
+.SH "EXAMPLE"
+.IX Header "EXAMPLE"
+.Vb 5
+\& # 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
+.Ve
 .SH "SHORTCOMINGS"
 .IX Header "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.
 .PP
-(1) It does not work over remote connections.  The storage \s-1API\s0 does
-not support peeking into remote disks, and libvirt has rejected a
-request to add this support.
-.PP
-(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
@@ -198,10 +207,10 @@ libparted which doesn't support \s-1LVM\s0 yet).  The Linux kernel does
 support that, but there's not really any good way to access that work.
 .PP
 The current implementation uses a hand-coded parser which understands
-some simple formats (\s-1MBR\s0, \s-1LVM2\s0, ext2/3).  In future we should use
-something like libparted.
+some formats (\s-1MBR\s0, \s-1LVM2\s0, ext2/3, \s-1DOS\s0 \s-1FAT\s0, Windows \s-1NTFS\s0, Linux swap and
+Linux suspend partitions).
 .PP
-(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