aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorJake Hunsaker <jhunsake@redhat.com>2021-02-02 13:53:18 -0500
committerJake Hunsaker <jhunsake@redhat.com>2021-02-03 12:25:38 -0500
commit9bc386c9191d6b094684982cbc35efe79eecff81 (patch)
tree1ac5c416824ae53f317967d917d8a9e59eca2cec /man
parentc753bc0841ea5a21304369ed07884e93d3332c01 (diff)
downloadsos-9bc386c9191d6b094684982cbc35efe79eecff81.tar.gz
[sos] Align plugin options with destination names
This commit alters several option long-form names or destination names to align those values in a sensible way. This serves to not only remove some abiguity in option naming in code, but also to make it so that the "effective options" line logged in every sos execution can be direction copy-pasted as a working command. Closes: #2288 Resolves: #2398 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'man')
-rw-r--r--man/en/sos-clean.14
-rw-r--r--man/en/sos-report.12
2 files changed, 3 insertions, 3 deletions
diff --git a/man/en/sos-clean.1 b/man/en/sos-clean.1
index 3bc99810..28ac67f7 100644
--- a/man/en/sos-clean.1
+++ b/man/en/sos-clean.1
@@ -4,7 +4,7 @@ sos clean - Obfuscate sensitive data from one or more sosreports
.SH SYNOPSIS
.B sos clean TARGET [options]
[\-\-domains]
- [\-\-map]
+ [\-\-map-file]
[\-\-jobs]
[\-\-no-update]
@@ -54,7 +54,7 @@ Keywords provided by this option will be obfuscated as "obfuscatedwordX" where X
integer based on the keyword's index in the parser. Note that keywords will be replaced as
both standalone words and in substring matches.
.TP
-.B \-\-map FILE
+.B \-\-map-file FILE
Provide a location to a valid mapping file to use as a reference for existing obfuscation pairs.
If one is found, the contents are loaded before parsing is started. This allows consistency between
runs of this command for obfuscated pairs. By default, sos will write the generated private map file
diff --git a/man/en/sos-report.1 b/man/en/sos-report.1
index 179e553a..fcf3d020 100644
--- a/man/en/sos-report.1
+++ b/man/en/sos-report.1
@@ -151,7 +151,7 @@ compressed report.
.B \--list-profiles
Display a list of available profiles and the plugins that they enable.
.TP
-.B \-p, \--profile NAME
+.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