|
 |
e75bc7 |
From 0be76caf77b53ce2726cb419262ceb8f52081c9e Mon Sep 17 00:00:00 2001
|
|
|
e75bc7 |
From: "Bryn M. Reeves" <bmr@redhat.com>
|
|
|
e75bc7 |
Date: Wed, 17 Dec 2014 13:01:03 +0000
|
|
|
e75bc7 |
Subject: [PATCH] [docs] update man page for new options
|
|
|
e75bc7 |
|
|
|
e75bc7 |
The man page was missing:
|
|
|
e75bc7 |
|
|
|
e75bc7 |
--verify
|
|
|
e75bc7 |
--all-logs
|
|
|
e75bc7 |
--log-size
|
|
|
e75bc7 |
--plugin-option
|
|
|
e75bc7 |
|
|
|
e75bc7 |
And listed the old '--ticket' (now --ticket-number).
|
|
|
e75bc7 |
|
|
|
e75bc7 |
Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
|
|
|
e75bc7 |
---
|
|
|
e75bc7 |
man/en/sosreport.1 | 29 +++++++++++++++++++++++++----
|
|
|
e75bc7 |
1 file changed, 25 insertions(+), 4 deletions(-)
|
|
|
e75bc7 |
|
|
|
e75bc7 |
diff --git a/man/en/sosreport.1 b/man/en/sosreport.1
|
|
|
e75bc7 |
index 88589cf..1066b1d 100644
|
|
|
e75bc7 |
--- a/man/en/sosreport.1
|
|
|
e75bc7 |
+++ b/man/en/sosreport.1
|
|
|
e75bc7 |
@@ -8,14 +8,19 @@ sosreport \- Collect and package diagnostic and support data
|
|
|
e75bc7 |
[-e|--enable-plugins plugin-names]\fR
|
|
|
e75bc7 |
[-o|--only-plugins plugin-names]\fR
|
|
|
e75bc7 |
[-a|--alloptions] [-v|--verbose]\fR
|
|
|
e75bc7 |
+ [-k plug.opt|--plugin-option plug.opt]\fR
|
|
|
e75bc7 |
[--no-report] [--config-file conf]\fR
|
|
|
e75bc7 |
[--batch] [--build] [--debug]\fR
|
|
|
e75bc7 |
[--name name] [--case-id id] [--ticket-number nr]
|
|
|
e75bc7 |
[--tmp-dir directory]\fR
|
|
|
e75bc7 |
[-p|--profile profile-name]\fR
|
|
|
e75bc7 |
[--list-profiles]\fR
|
|
|
e75bc7 |
+ [--verify]\fR
|
|
|
e75bc7 |
+ [--log-size]\fR
|
|
|
e75bc7 |
+ [--all-logs]\fR
|
|
|
e75bc7 |
[-z|--compression-type method]\fR
|
|
|
e75bc7 |
- [--help]\fR
|
|
|
e75bc7 |
+ [-h|--help]\fR
|
|
|
e75bc7 |
+
|
|
|
e75bc7 |
.SH DESCRIPTION
|
|
|
e75bc7 |
\fBsosreport\fR generates an archive of configuration and diagnostic
|
|
|
e75bc7 |
information from the running system. The archive may be stored locally
|
|
|
e75bc7 |
@@ -46,7 +51,7 @@ Enable the specified plugin(s) only (all other plugins should be
|
|
|
e75bc7 |
disabled). Multiple plugins may be specified by repeating the option
|
|
|
e75bc7 |
or as a comma-separated list.
|
|
|
e75bc7 |
.TP
|
|
|
e75bc7 |
-.B \-k PLUGNAME.PLUGOPT[=VALUE]
|
|
|
e75bc7 |
+.B \-k PLUGNAME.PLUGOPT[=VALUE], \--plugin-option=PLUGNAME.PLUGOPT[=VALUE]
|
|
|
e75bc7 |
Specify plug-in options. The option PLUGOPT is enabled, or set to the
|
|
|
e75bc7 |
specified value in the plug-in PLUGNAME.
|
|
|
e75bc7 |
.TP
|
|
|
e75bc7 |
@@ -81,6 +86,22 @@ profiles include: boot, cluster, desktop, debug, hardware, identity,
|
|
|
e75bc7 |
network, openstack, packagemanager, security, services, storage,
|
|
|
e75bc7 |
sysmgmt, system, performance, virt, and webserver.
|
|
|
e75bc7 |
.TP
|
|
|
e75bc7 |
+.B \--verify
|
|
|
e75bc7 |
+Instructs plugins to perform plugin-specific verification during data
|
|
|
e75bc7 |
+collection. This may include package manager verification, log integrity
|
|
|
e75bc7 |
+testing or other plugin defined behaviour. Use of \--verify may cause
|
|
|
e75bc7 |
+the time taken to generate a report to be considerably longer.
|
|
|
e75bc7 |
+.TP
|
|
|
e75bc7 |
+.B \--log-size
|
|
|
e75bc7 |
+Places a global limit on the size of any collected set of logs. The
|
|
|
e75bc7 |
+limit is applied separately for each set of logs collected by any
|
|
|
e75bc7 |
+plugin.
|
|
|
e75bc7 |
+.TP
|
|
|
e75bc7 |
+.B \--all-logs
|
|
|
e75bc7 |
+Tell plugins to collect all possible log data ignoring any size limits
|
|
|
e75bc7 |
+and including logs in non-default locations. This option may significantly
|
|
|
e75bc7 |
+increase the size of reports.
|
|
|
e75bc7 |
+.TP
|
|
|
e75bc7 |
.B \-z, \--compression-type METHOD
|
|
|
e75bc7 |
Override the default compression type specified by the active policy.
|
|
|
e75bc7 |
.TP
|
|
|
e75bc7 |
@@ -94,9 +115,9 @@ Specify a name to be used for the archive.
|
|
|
e75bc7 |
.B \--case-id NUMBER
|
|
|
e75bc7 |
Specify a case identifier to associate with the archive.
|
|
|
e75bc7 |
Identifiers may include alphanumeric characters, commas and periods ('.').
|
|
|
e75bc7 |
-Synonymous with \--ticket, \--ticket-number.
|
|
|
e75bc7 |
+Synonymous with \--ticket-number.
|
|
|
e75bc7 |
.TP
|
|
|
e75bc7 |
-.B \--ticket, \--ticket-number NUMBER
|
|
|
e75bc7 |
+.B \--ticket-number NUMBER
|
|
|
e75bc7 |
Specify a ticket number or other identifier to associate with the archive.
|
|
|
e75bc7 |
Identifiers may include alphanumeric characters, commas and periods ('.').
|
|
|
e75bc7 |
Synonymous with \--case-id.
|
|
|
e75bc7 |
--
|
|
|
e75bc7 |
1.9.3
|
|
|
e75bc7 |
|