aboutsummaryrefslogtreecommitdiffstats
path: root/src/sosreport.1
blob: 3ae187a8e33258af840f9cde19a2bfea37ddd6a5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
.TH SOSREPORT 1 "Tue Feb 20 2007"
.SH NAME
sosreport \- Generate debugging information for this system
.SH SYNOPSIS
.B sosreport
          [-l|--list-plugins]\fR
          [-n|--skip-plugins plugin-names]\fR
          [-e|--enable-plugins plugin-names]\fR
          [-o|--only-plugins plugin-names]\fR
          [-a|--alloptions] [-v|--verbose]
          [--no-multithread] [--no-progressbar]
.SH DESCRIPTION
\fBsosreport\fR generates a compressed tarball of debugging information 
for the system it is run on that can be sent to technical support
reps that will give them a more complete view of the overall system
status.
.SH OPTIONS
.TP
.B \-l, \--list-plugins
This will list all available plugins showing which ones will be enabled by the current configuration. It will also show all plugin options which can be 
modified using the -k option (see below).
.TP
.B \-n, --skip-plugins PLUGNAME[,PLUGNAME]
Do not load specified plugin(s). To specify multiple plugins, separate them with a comma.
.TP
.B \-e, --enable-plugins PLUGNAME[,PLUGNAME]
Enable the specified plugin(s). To specify multiple plugins, separate them with a comma.
.TP
.B \-o, --only-plugins PLUGNAME[,PLUGNAME]
Enable the specified plugin(s) only (all other plugins should be disabled). To specify multiple plugins, separate them with a comma.
.TP
.B \-k PLUGNAME.PLUGOPT[=VALUE]
This is used to specify options for plugins. A list of available plugin options can be obtained from the output of --list-plugins.
If no value is specified and the option is a boolean (on/off), it will be set to "on".
.TP
.B \-a, \--alloptions
Enable all (boolean) options for all loaded plugins.
.TP
.B \-v, \--verbose
Increase the verbosity of the output as sosreport is running. Multiple -v mean more verbosity.
.TP
.B \--no-progressbar
Do not display a progress bar (ETA will not be available).
.TP
.B \--no-multithread
Disable multithreaded collection and analysis of the sosreport data.
.SH MAINTAINER
.nf
Navid Sheikhol-Eslami <navid@redhat.com>
.fi
.SH AUTHORS
.nf
Steve Conklin <sconklin@redhat.com>
John Berninger <jwb@redhat.com>
Pierre Amadio <pamadio@redhat.com>
Adam Stokes <astokes@redhat.com>
.fi
.SH THANKS TO
.nf
Eva Schaller <eschaller@redhat.com> for providing an Italian translation
Marco Ceci <mceci@redhat.com> for helping me out with the cluster plugin
Leonardo Macchia <lmacchia@redhat.com> for being my personal regexp generator
Imed Chihi <ichihi@redhat.com> for providing Arabic and French translations
.fi