.\" -*- nroff -*- .\" -*- nroff -*- .\" ovs.tmac .\" .\" Open vSwitch troff macro library . . .\" Continuation line for .IP. .de IQ . br . ns . IP "\\$1" .. . .\" Introduces a sub-subsection .de ST . PP . RS -0.15in . I "\\$1" . RE .. . .\" The content between the lines below is from an-ext.tmac in groff .\" 1.21, with some modifications. .\" ---------------------------------------------------------------------- .\" an-ext.tmac .\" .\" Written by Eric S. Raymond .\" Werner Lemberg .\" .\" Version 2007-Feb-02 .\" .\" Copyright (C) 2007, 2009, 2011 Free Software Foundation, Inc. .\" You may freely use, modify and/or distribute this file. .\" .\" .\" The code below provides extension macros for the `man' macro package. .\" Care has been taken to make the code portable; groff extensions are .\" properly hidden so that all troff implementations can use it without .\" changes. .\" .\" With groff, this file is sourced by the `man' macro package itself. .\" Man page authors who are concerned about portability might add the .\" used macros directly to the prologue of the man page(s). . . .\" Convention: Auxiliary macros and registers start with `m' followed .\" by an uppercase letter or digit. . . .\" Declare start of command synopsis. Sets up hanging indentation. .de SY . ie !\\n(mS \{\ . nh . nr mS 1 . nr mA \\n(.j . ad l . nr mI \\n(.i . \} . el \{\ . br . ns . \} . . HP \w'\fB\\$1\fP\ 'u . B "\\$1" .. . . .\" End of command synopsis. Restores adjustment. .de YS . in \\n(mIu . ad \\n(mA . hy \\n(HY . nr mS 0 .. . . .\" Declare optional option. .de OP . ie \\n(.$-1 \ . RI "[\fB\\$1\fP" "\ \\$2" "]" . el \ . RB "[" "\\$1" "]" .. . . .\" Start URL. .de UR . ds m1 \\$1\" . nh . if \\n(mH \{\ . \" Start diversion in a new environment. . do ev URL-div . do di URL-div . \} .. . . .\" End URL. .de UE . ie \\n(mH \{\ . br . di . ev . . \" Has there been one or more input lines for the link text? . ie \\n(dn \{\ . do HTML-NS "" . \" Yes, strip off final newline of diversion and emit it. . do chop URL-div . do URL-div \c . do HTML-NS . \} . el \ . do HTML-NS "\\*(m1" \&\\$*\" . \} . el \ \\*(la\\*(m1\\*(ra\\$*\" . . hy \\n(HY .. . . .\" Start email address. .de MT . ds m1 \\$1\" . nh . if \\n(mH \{\ . \" Start diversion in a new environment. . do ev URL-div . do di URL-div . \} .. . . .\" End email address. .de ME . ie \\n(mH \{\ . br . di . ev . . \" Has there been one or more input lines for the link text? . ie \\n(dn \{\ . do HTML-NS "" . \" Yes, strip off final newline of diversion and emit it. . do chop URL-div . do URL-div \c . do HTML-NS . \} . el \ . do HTML-NS "\\*(m1" \&\\$*\" . \} . el \ \\*(la\\*(m1\\*(ra\\$*\" . . hy \\n(HY .. . . .\" Continuation line for .TP header. .de TQ . br . ns . TP \\$1\" no doublequotes around argument! .. . . .\" Start example. .de EX . nr mE \\n(.f . nf . nh . ft CW .. . . .\" End example. .de EE . ft \\n(mE . fi . hy \\n(HY .. . .\" EOF .\" ---------------------------------------------------------------------- .TH ovs\-bugtool 8 "3.1.0" "Open vSwitch" "Open vSwitch Manual" .\" This program's name: .ds PN ovs\-bugtool . .SH NAME ovs\-bugtool \- Open vSwitch bug reporting utility . .SH SYNOPSIS .B ovs\-bugtool . .SH DESCRIPTION Generates a debug bundle with useful information about Open vSwitch on this system and places it in \fB/var/log/ovs-bugtool\fR. . .SH "COLLECTION OPTIONS" .PP These options influence what categories of data \fBovs\-bugtool\fR collects. . .IP "\fB\-\-entries=\fIlist\fR" 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" Generates a debug bundle with the specified file type. Options include \fBtar\fR, \fBtar.gz\fR, \fBtar.bz2\fR, and \fBzip\fR. .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. . .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 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.