From: Ethan Jackson <ethan@nicira.com>
Date: Thu, 23 Sep 2010 06:45:58 +0000 (-0700)
Subject: debian: Added a manpage for ovs-bugtool
X-Git-Tag: v1.1.0~1069
X-Git-Url: http://git.onelab.eu/?a=commitdiff_plain;ds=sidebyside;h=85d32f1feed0befba10dd9727a99d16b22b3e0b1;p=sliver-openvswitch.git

debian: Added a manpage for ovs-bugtool

Added a manpage for the ovs-bugtool script.
---

diff --git a/debian/automake.mk b/debian/automake.mk
index 20432062a..7c73831a2 100644
--- a/debian/automake.mk
+++ b/debian/automake.mk
@@ -42,6 +42,7 @@ EXTRA_DIST += \
 	debian/openvswitch-switch.postrm \
 	debian/openvswitch-switch.template \
 	debian/ovs-bugtool \
+	debian/ovs-bugtool.8 \
 	debian/ovs-monitor-ipsec \
 	debian/python-openvswitch.dirs \
 	debian/python-openvswitch.install \
diff --git a/debian/openvswitch-common.install b/debian/openvswitch-common.install
index 298f1ad0f..1733612ae 100644
--- a/debian/openvswitch-common.install
+++ b/debian/openvswitch-common.install
@@ -5,4 +5,5 @@ _debian/utilities/ovs-ofctl usr/sbin
 _debian/utilities/ovs-parse-leaks usr/bin
 _debian/utilities/ovs-pki usr/sbin
 debian/ovs-bugtool usr/sbin
+debian/ovs-bugtool.8 usr/share/man/man8
 vswitchd/vswitch.ovsschema usr/share/openvswitch
diff --git a/debian/ovs-bugtool.8 b/debian/ovs-bugtool.8
new file mode 100644
index 000000000..28147e460
--- /dev/null
+++ b/debian/ovs-bugtool.8
@@ -0,0 +1,46 @@
+.\" -*- nroff -*-
+.de IQ
+.  br
+.  ns
+.  IP "\\$1"
+..
+.TH ovs\-bugtool 8 "September 2010" "Open vSwitch" "Open vSwitch Manual"
+.\" This program's name:
+.ds PN ovs\-bugtool
+.
+.SH NAME
+ovs\-bugtool \- Open vSwitch
+.
+.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.
+.
+.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.
+.
+.IP "\fB\-\-entries=\fIlist\fR\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\-\-silent\fR"
+suppress output.
+.
+.IP "\fB\-\-unlimited\fR"
+do not exclude files which are too large.
+.
+.IP "\fB\-\-yestoall\fR"
+answer yes to all prompts.