utilities/ovs-ofctl: Fix meter requests.

[cascardo/ovs.git] / utilities / bugtool / ovs-bugtool.8.in

diff --git a/utilities/bugtool/ovs-bugtool.8.in b/utilities/bugtool/ovs-bugtool.8.in
index 6f4e0b5..8729214 100644 (file)
--- a/utilities/bugtool/ovs-bugtool.8.in
+++ b/utilities/bugtool/ovs-bugtool.8.in
@@ -15,44 +15,66 @@ ovs\-bugtool \- Open vSwitch bug reporting utility
 .B ovs\-bugtool
 .
 .SH DESCRIPTION
-Generate a debug bundle with useful information about Open vSwitch on this
+Generates a debug bundle with useful information about Open vSwitch on this
 system and places it in \fB/var/log/ovs-bugtool\fR.
 .
-.SH OPTIONS
-.
-.IP "\fB\-\-all\fR"
-Use all available capabilities.
-.
-.IP "\fB\-\-capabilities\fR"
-List \fBovs\-bugtool\fR capabilities.
-.
-.IP "\fB\-\-debug\fR"
-Print verbose debugging output.
+.SH "COLLECTION OPTIONS"
+.PP
+These options influence what categories of data \fBovs\-bugtool\fR
+collects.
 .
 .IP "\fB\-\-entries=\fIlist\fR"
-Use the capabilities specified in a comma-separated list.
-.
+Collect the capabilities specified in the comma-separated \fIlist\fR.
+.IP "\fB\-\-all\fR"
+Collect all available capabilities.
+.IP "\fB\-\-ovs\fR"
+In addition to Open vSwitch configuration and status,
+\fBovs\-bugtool\fR can collect a variety of relevant system
+information.  This option limits collection to Open vSwitch-specific
+categories.
 .IP "\fB\-\-log\-days=\fIdays\fR"
 Include the logs with last modification time in the previous \fIdays\fR days
 in the debug bundle. The number of log files included has a big impact on the
 eventual bundle size. The default value is 20 days.
+.IP "\fB\-y\fR"
+.IQ "\fB\-\-yestoall\fR"
+Answer yes to all prompts.
+.IP "\fB\-\-capabilities\fR"
+Writes the categories that \fBovs\-bugtool\fR can collect on stdout in
+XML, then exits.
+.
+.SH "OUTPUT OPTIONS"
+.PP
+These options influence the format and destination of
+\fBovs\-bugtool\fR output.
 .
 .IP "\fB\-\-output=\fIfiletype\fR"
-Generate a debug bundle with the specified file type.  Options include
+Generates a debug bundle with the specified file type.  Options include
 \fBtar\fR, \fBtar.gz\fR, \fBtar.bz2\fR, and \fBzip\fR.
-.
-.IP "\fB\-\-ovs\fR"
-Use only Open vSwitch relevant capabilities.
-.
-.IP "\fB\-\-silent\fR"
-Suppress output.
-.
+.IP "\fB\-\-outfile=\fIfile\fR"
+Write output to \fIfile\fR.  Mutually exclusive with \fB\-\-outfd\fR.
+.IP "\fB\-\-outfd=\fIfd\fR"
+Write output to file descriptor \fIfd\fR.  This option must be used
+with \fB\-\-output=tar\fR.
 .IP "\fB\-\-unlimited\fR"
 Do not exclude files which are too large. Also skip checking free disk space.
 By default up to 90 percent of the free disk space can be used.
+.IP "\fB\-\-debug\fR"
+Print verbose debugging output.
 .
-.IP "\fB\-\-yestoall\fR"
-Answer yes to all prompts.
+.SH "OTHER OPTIONS"
+.
+.IP "\fB\-s\fR"
+.IQ "\fB\-\-silent\fR"
+Suppress most output to stdout.
+.IP "\fB\-\-help\fR"
+Print a summary of \fBovs\-bugtool\fR usage to stdout, then exit.
+.
+.SH EXAMPLES
+.PP
+Here's a collection of some commonly useful options:
+.PP
+\fBovs\-bugtool \-y \-s \-\-output=tar.gz \-\-outfile=/var/log/bugtool-report.tgz\fR
 .
 .SH BUGS
 \fBovs\-bugtool\fR makes many assumptions about file locations and the