ovs-bugtool: Restore RHEL support.
[sliver-openvswitch.git] / debian / ovs-bugtool.8
index 28147e4..6755d6a 100644 (file)
@@ -4,43 +4,49 @@
 .  ns
 .  IP "\\$1"
 ..
-.TH ovs\-bugtool 8 "September 2010" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-bugtool 8 "June 2011" "Open vSwitch" "Open vSwitch Manual"
 .\" This program's name:
 .ds PN ovs\-bugtool
 .
 .SH NAME
-ovs\-bugtool \- Open vSwitch
+ovs\-bugtool \- Open vSwitch bug reporting utility
 .
 .SH SYNOPSIS
 .B ovs\-bugtool
 .
 .SH DESCRIPTION
 Generate a debug bundle with useful information about Open vSwitch on this
-system. The bundle is placed in /var/log/openvswitch.
+system and places it in \fB/var/log/ovs-bugtool\fR.
 .
 .SH OPTIONS
 .
 .IP "\fB\-\-all\fR"
-use all available capabilities.
+Use all available capabilities.
 .
 .IP "\fB\-\-capabilities\fR"
-list \fBovs\-bugtool\fR capabilities.
+List \fBovs\-bugtool\fR capabilities.
 .
 .IP "\fB\-\-debug\fR"
-print verbose debugging output.
+Print verbose debugging output.
 .
-.IP "\fB\-\-entries=\fIlist\fR\fR"
-use the capabilities specified in a comma separated list.
+.IP "\fB\-\-entries=\fIlist\fR"
+Use the capabilities specified in a comma-separated list.
 .
-.IP "\fB\-\-output=\fIfiletype\fR\fR"
-generate a debug bundle with the specified file type.  Options include \fBtar\fR,
-\fBtar.bz2\fR, and \fBzip\fR.
+.IP "\fB\-\-output=\fIfiletype\fR"
+Generate a debug bundle with the specified file type.  Options include
+\fBtar\fR, \fBtar.gz\fR, \fBtar.bz2\fR, and \fBzip\fR.
 .
 .IP "\fB\-\-silent\fR"
-suppress output.
+Suppress output.
 .
 .IP "\fB\-\-unlimited\fR"
-do not exclude files which are too large.
+Do not exclude files which are too large.
 .
 .IP "\fB\-\-yestoall\fR"
-answer yes to all prompts.
+Answer yes to all prompts.
+.
+.SH BUGS
+\fBovs\-bugtool\fR makes many assumptions about file locations and the
+availability of system utilities.  It has been tested on Debian and
+Red Hat and derived distributions.  On other distributions it is
+likely to be less useful.