Update manpage.

3 files changed, 39 insertions, 22 deletions

diff --git a/virt-df/virt-df.1 b/virt-df/virt-df.1
index ff7e92d..93c4ad7 100644
--- 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-03-04" "ocaml-libvirt-0.4.0.3" "Virtualization Support"
+.TH VIRT-DF 1 "2008-04-16" "ocaml-libvirt-0.4.1.1" "Virtualization Support"
 .SH "NAME"
 virt\-df \- 'df'\-like utility for virtualization stats
 .SH "SUMMARY"
@@ -156,6 +156,10 @@ 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\-\-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).
@@ -165,6 +169,11 @@ Display inode information.
 .IP "\fB\-\-help\fR" 4
 .IX Item "--help"
 Display usage summary.
+.IP "\fB\-t diskimage\fR" 4
+.IX Item "-t diskimage"
+Test mode.  Instead of checking libvirt for domain information, this
+runs virt-df directly on the disk image (or device) supplied.  You may
+specify the \fB\-t\fR option multiple times.
 .IP "\fB\-\-version\fR" 4
 .IX Item "--version"
 Display version and exit.
@@ -202,12 +211,8 @@ superblock, for example \fIfsync\fR\|(2) [that is my reading of the ext2/3
 source code at least].
 .SH "SECURITY"
 .IX Header "SECURITY"
-The current code is probably not secure against malicious guests.  In
-particular a malicious guest can set up a disk in such a way that disk
-structures with loops can cause virt-df to spin forever.  We are
-preparing a parsing library which can fix these sorts of problems.
-.PP
-In the meantime, do not run virt-df on untrusted guests.
+The current code tries hard to be secure against malicious guests, for
+example guests which set up malicious disk partitions.
 .SH "SEE ALSO"
 .IX Header "SEE ALSO"
 \&\fIdf\fR\|(1),
@@ -254,7 +259,7 @@ have fixed it.
 Run
 .Sp
 .Vb 1
-\& virt-df > virt-df.log 2>&1
+\& virt-df --debug > virt-df.log 2>&1
 .Ve
 .Sp
 and keep \fIvirt\-df.log\fR.  It contains error messages which you should
diff --git a/virt-df/virt-df.pod b/virt-df/virt-df.pod
index 84b1d97..ffde02b 100644
--- a/virt-df/virt-df.pod
+++ b/virt-df/virt-df.pod
@@ -32,6 +32,11 @@ Show all domains.  The default is show only running (active) domains.
 Connect to libvirt URI.  The default is to connect to the default
 libvirt URI, normally Xen.
 
+=item  B<--debug>
+
+Emit debugging information on stderr.  Please supply this if you
+report a bug.
+
 =item B<-h>, B<--human-readable>
 
 Display human-readable sizes (eg. 10GiB).
@@ -44,6 +49,12 @@ Display inode information.
 
 Display usage summary.
 
+=item B<-t diskimage>
+
+Test mode.  Instead of checking libvirt for domain information, this
+runs virt-df directly on the disk image (or device) supplied.  You may
+specify the B<-t> option multiple times.
+
 =item B<--version>
 
 Display version and exit.
@@ -85,12 +96,8 @@ source code at least].
 
 =head1 SECURITY
 
-The current code is probably not secure against malicious guests.  In
-particular a malicious guest can set up a disk in such a way that disk
-structures with loops can cause virt-df to spin forever.  We are
-preparing a parsing library which can fix these sorts of problems.
-
-In the meantime, do not run virt-df on untrusted guests.
+The current code tries hard to be secure against malicious guests, for
+example guests which set up malicious disk partitions.
 
 =head1 SEE ALSO
 
@@ -144,7 +151,7 @@ have fixed it.
 
 Run
 
- virt-df > virt-df.log 2>&1
+ virt-df --debug > virt-df.log 2>&1
 
 and keep I<virt-df.log>.  It contains error messages which you should
 submit with your bug report.
diff --git a/virt-df/virt-df.txt b/virt-df/virt-df.txt
index fcddafb..aa02a8f 100644
--- a/virt-df/virt-df.txt
+++ b/virt-df/virt-df.txt
@@ -23,6 +23,10 @@ OPTIONS
         Connect to libvirt URI. The default is to connect to the default
         libvirt URI, normally Xen.
 
+    --debug
+        Emit debugging information on stderr. Please supply this if you
+        report a bug.
+
     -h, --human-readable
         Display human-readable sizes (eg. 10GiB).
 
@@ -32,6 +36,11 @@ OPTIONS
     --help
         Display usage summary.
 
+    -t diskimage
+        Test mode. Instead of checking libvirt for domain information, this
+        runs virt-df directly on the disk image (or device) supplied. You
+        may specify the -t option multiple times.
+
     --version
         Display version and exit.
 
@@ -68,12 +77,8 @@ SHORTCOMINGS
     least].
 
 SECURITY
-    The current code is probably not secure against malicious guests. In
-    particular a malicious guest can set up a disk in such a way that disk
-    structures with loops can cause virt-df to spin forever. We are
-    preparing a parsing library which can fix these sorts of problems.
-
-    In the meantime, do not run virt-df on untrusted guests.
+    The current code tries hard to be secure against malicious guests, for
+    example guests which set up malicious disk partitions.
 
 SEE ALSO
     df(1), virsh(1), xm(1), <http://www.libvirt.org/ocaml/>,
@@ -115,7 +120,7 @@ REPORTING BUGS
     2. Capture debug and error messages
         Run
 
-         virt-df > virt-df.log 2>&1
+         virt-df --debug > virt-df.log 2>&1
 
         and keep *virt-df.log*. It contains error messages which you should
         submit with your bug report.