utilities/bugtool/ovs-bugtool.8.in

   1 .\" -*- nroff -*-
   2 .de IQ
   3 .  br
   4 .  ns
   5 .  IP "\\$1"
   6 ..
   7 .TH ovs\-bugtool 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
   8 .\" This program's name:
   9 .ds PN ovs\-bugtool
  10 .
  11 .SH NAME
  12 ovs\-bugtool \- Open vSwitch bug reporting utility
  13 .
  14 .SH SYNOPSIS
  15 .B ovs\-bugtool
  16 .
  17 .SH DESCRIPTION
  18 Generate a debug bundle with useful information about Open vSwitch on this
  19 system and places it in \fB/var/log/ovs-bugtool\fR.
  20 .
  21 .SH OPTIONS
  22 .
  23 .IP "\fB\-\-all\fR"
  24 Use all available capabilities.
  25 .
  26 .IP "\fB\-\-capabilities\fR"
  27 List \fBovs\-bugtool\fR capabilities.
  28 .
  29 .IP "\fB\-\-debug\fR"
  30 Print verbose debugging output.
  31 .
  32 .IP "\fB\-\-entries=\fIlist\fR"
  33 Use the capabilities specified in a comma-separated list.
  34 .
  35 .IP "\fB\-\-log\-days=\fIdays\fR"
  36 Include the logs rotated in the previous \fIdays\fR days in the debug bundle.
  37 The number of log files included has a big impact on the eventual bundle size.
  38 The default value is 20 days.
  39 .
  40 .IP "\fB\-\-output=\fIfiletype\fR"
  41 Generate a debug bundle with the specified file type.  Options include
  42 \fBtar\fR, \fBtar.gz\fR, \fBtar.bz2\fR, and \fBzip\fR.
  43 .
  44 .IP "\fB\-\-ovs\fR"
  45 Use only Open vSwitch relevant capabilities.
  46 .
  47 .IP "\fB\-\-silent\fR"
  48 Suppress output.
  49 .
  50 .IP "\fB\-\-unlimited\fR"
  51 Do not exclude files which are too large.
  52 .
  53 .IP "\fB\-\-yestoall\fR"
  54 Answer yes to all prompts.
  55 .
  56 .SH BUGS
  57 \fBovs\-bugtool\fR makes many assumptions about file locations and the
  58 availability of system utilities.  It has been tested on Debian and
  59 Red Hat and derived distributions.  On other distributions it is
  60 likely to be less useful.