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 Generates 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 "COLLECTION OPTIONS"
  22 .PP
  23 These options influence what categories of data \fBovs\-bugtool\fR
  24 collects.
  25 .
  26 .IP "\fB\-\-entries=\fIlist\fR"
  27 Collect the capabilities specified in the comma-separated \fIlist\fR.
  28 .IP "\fB\-\-all\fR"
  29 Collect all available capabilities.
  30 .IP "\fB\-\-ovs\fR"
  31 In addition to Open vSwitch configuration and status,
  32 \fBovs\-bugtool\fR can collect a variety of relevant system
  33 information.  This option limits collection to Open vSwitch-specific
  34 categories.
  35 .IP "\fB\-\-log\-days=\fIdays\fR"
  36 Include the logs with last modification time in the previous \fIdays\fR days
  37 in the debug bundle. The number of log files included has a big impact on the
  38 eventual bundle size. The default value is 20 days.
  39 .IP "\fB\-y\fR"
  40 .IQ "\fB\-\-yestoall\fR"
  41 Answer yes to all prompts.
  42 .IP "\fB\-\-capabilities\fR"
  43 Writes the categories that \fBovs\-bugtool\fR can collect on stdout in
  44 XML, then exits.
  45 .
  46 .SH "OUTPUT OPTIONS"
  47 .PP
  48 These options influence the format and destination of
  49 \fBovs\-bugtool\fR output.
  50 .
  51 .IP "\fB\-\-output=\fIfiletype\fR"
  52 Generates a debug bundle with the specified file type.  Options include
  53 \fBtar\fR, \fBtar.gz\fR, \fBtar.bz2\fR, and \fBzip\fR.
  54 .IP "\fB\-\-outfile=\fIfile\fR"
  55 Write output to \fIfile\fR.  Mutually exclusive with \fB\-\-outfd\fR.
  56 .IP "\fB\-\-outfd=\fIfd\fR"
  57 Write output to file descriptor \fIfd\fR.  This option must be used
  58 with \fB\-\-output=tar\fR.
  59 .IP "\fB\-\-unlimited\fR"
  60 Do not exclude files which are too large. Also skip checking free disk space.
  61 By default up to 90 percent of the free disk space can be used.
  62 .IP "\fB\-\-debug\fR"
  63 Print verbose debugging output.
  64 .
  65 .SH "OTHER OPTIONS"
  66 .
  67 .IP "\fB\-s\fR"
  68 .IQ "\fB\-\-silent\fR"
  69 Suppress most output to stdout.
  70 .IP "\fB\-\-help\fR"
  71 Print a summary of \fBovs\-bugtool\fR usage to stdout, then exit.
  72 .
  73 .SH EXAMPLES
  74 .PP
  75 Here's a collection of some commonly useful options:
  76 .PP
  77 \fBovs\-bugtool \-y \-s \-\-output=tar.gz \-\-outfile=/var/log/bugtool-report.tgz\fR
  78 .
  79 .SH BUGS
  80 \fBovs\-bugtool\fR makes many assumptions about file locations and the
  81 availability of system utilities.  It has been tested on Debian and
  82 Red Hat and derived distributions.  On other distributions it is
  83 likely to be less useful.