diff options
| author | Jake Hunsaker <jhunsake@redhat.com> | 2021-05-13 13:41:36 -0400 |
|---|---|---|
| committer | Jake Hunsaker <jhunsake@redhat.com> | 2021-05-14 10:32:54 -0400 |
| commit | 8b297c0bc5d52f34955c9b5d5cee4dd1e75d5dc8 (patch) | |
| tree | d3e549f21cc1cb9a72df82e2069f1fa6efdd27e8 /man | |
| parent | ea6ebc2f202c810836a6f1b145a16a94abac303f (diff) | |
| download | sos-8b297c0bc5d52f34955c9b5d5cee4dd1e75d5dc8.tar.gz | |
[docs] Clarify profile in manpage and how to enable further plugins
Updates the language in the manpage to clarify that in order to enable
additional plugins outside of a profile when a profile is specified,
that users must use `-o` instead of `-e`.
Remove the 'current profiles' list from the manpage as it is outdated
and it is better to refer users to the list reported by the local
installation.
Closes: #504
Resolves: #2543
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'man')
| -rw-r--r-- | man/en/sos-report.1 | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/man/en/sos-report.1 b/man/en/sos-report.1 index 7a6813c2..c38753d4 100644 --- a/man/en/sos-report.1 +++ b/man/en/sos-report.1 @@ -62,8 +62,13 @@ Disable the specified plugin(s). Multiple plug-ins may be specified by repeating the option or as a comma-separated list. .TP .B \-e, --enable-plugins PLUGNAME[,PLUGNAME] -Enable the specified plugin(s). Multiple plug-ins may be specified -by repeating the option or as a comma-separated list. +Enable the specified plugin(s) that would otherwise be disabled. Multiple plugins +may be specified by repeating the option or as a comma-separated list. + +Note that if using \fB-p, --profile\fR this option will \fBnot\fR enable further +plugins. Use \fB-o, --only-plugins\fR to extend the list of plugins enabled by +profiles. + .TP .B \-o, --only-plugins PLUGNAME[,PLUGNAME] Enable the specified plugin(s) only (all other plugins should be @@ -157,10 +162,13 @@ Display a list of available profiles and the plugins that they enable. .B \-p, \--profile, \--profiles NAME Only run plugins that correspond to the given profile. Multiple profiles may be specified as a comma-separated list; the set of plugins executed -is the union of each of the profile's plugin sets. Currently defined -profiles include: boot, cluster, desktop, debug, hardware, identity, -network, openstack, packagemanager, security, services, storage, -sysmgmt, system, performance, virt, and webserver. +is the union of each of the profile's plugin sets. + +Note that if there are specific plugins outside of the profile(s) passed to this +option that you would also want to enable, use \fB-o, --only-plugins\fR to add those +plugins to the list. + +See \fBsos report --list-profiles\fR for a list of currently supported profiles. .TP .B \--verify Instructs plugins to perform plugin-specific verification during data |