← Back to branch summary

~ubuntu-branches/ubuntu/wily/openvswitch/wily

« back to all changes in this revision

Viewing changes to utilities/bugtool/ovs-bugtool.8.in

  • Committer: Package Import Robot
  • Author(s): James Page
  • Date: 2015-08-10 11:35:15 UTC
  • mfrom: (1.1.30)
  • Revision ID: package-import@ubuntu.com-20150810113515-575vj06oq29emxsn
Tags: 2.4.0~git20150810.97bab95-0ubuntu1
* New upstream snapshot from 2.4 branch:
  - d/*: Align any relevant packaging changes with upstream.
* d/*: wrap-and-sort.
* d/openvswitch-{common,vswitch}.install: Correct install location for
  bash completion files.
* d/tests/openflow.py: Explicitly use ovs-testcontroller as provided
  by 2.4.0 release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
utilities/bugtool/ovs-bugtool.8.in
15
15
.B ovs\-bugtool
16
16
.
17
17
.SH DESCRIPTION
18
 
Generate a debug bundle with useful information about Open vSwitch on this
 
18
Generates a debug bundle with useful information about Open vSwitch on this
19
19
system and places it in \fB/var/log/ovs-bugtool\fR.
20
20
.
21
 
.SH OPTIONS
 
21
.SH "COLLECTION OPTIONS"
 
22
.PP
 
23
These options influence what categories of data \fBovs\-bugtool\fR
 
24
collects.
22
25
.
 
26
.IP "\fB\-\-entries=\fIlist\fR"
 
27
Collect the capabilities specified in the comma-separated \fIlist\fR.
23
28
.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
 
.
 
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
35
.IP "\fB\-\-log\-days=\fIdays\fR"
36
36
Include the logs with last modification time in the previous \fIdays\fR days
37
37
in the debug bundle. The number of log files included has a big impact on the
38
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.
39
50
.
40
51
.IP "\fB\-\-output=\fIfiletype\fR"
41
 
Generate a debug bundle with the specified file type.  Options include
 
52
Generates a debug bundle with the specified file type.  Options include
42
53
\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
 
.
 
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.
50
59
.IP "\fB\-\-unlimited\fR"
51
60
Do not exclude files which are too large. Also skip checking free disk space.
52
61
By default up to 90 percent of the free disk space can be used.
53
 
.
54
 
.IP "\fB\-\-yestoall\fR"
55
 
Answer yes to all prompts.
 
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
56
78
.
57
79
.SH BUGS
58
80
\fBovs\-bugtool\fR makes many assumptions about file locations and the