aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorJake Hunsaker <jhunsake@redhat.com>2020-06-09 12:40:17 -0400
committerJake Hunsaker <jhunsake@redhat.com>2020-06-17 12:11:29 -0400
commit2d73f01ec7d96eb242517e008793c7f3a20e753f (patch)
tree060188bdf85ff39d39b7be1b48b65927e5cf8c29 /man
parente7b91722b20a51555cf86dbaa36ba840fe6d6350 (diff)
downloadsos-2d73f01ec7d96eb242517e008793c7f3a20e753f.tar.gz
[cleaner] Add user-provided keyword obfuscation
Adds a new parser and map to allow user defined keyword obfuscation. Users may now use the `--keywords` option to have `SoSCleaner` scan lines for matching keywords, and replace them in place like we do for other parsers. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'man')
-rw-r--r--man/en/sos-clean.17
1 files changed, 7 insertions, 0 deletions
diff --git a/man/en/sos-clean.1 b/man/en/sos-clean.1
index 85bd6dfc..fab677fc 100644
--- a/man/en/sos-clean.1
+++ b/man/en/sos-clean.1
@@ -47,6 +47,13 @@ match a domain given via this option will also be obfuscated.
For example, if \fB\-\-domains redhat.com\fR is specified, then 'redhat.com' will
be obfuscated, as will 'www.redhat.com' and subdomains such as 'foo.redhat.com'.
.TP
+.B \-\-keywords KEYWORDS
+Provide a comma-delimited list of keywords to scrub in addition to the default parsers.
+
+Keywords provided by this option will be obfuscated as "obfuscatedwordX" where X is an
+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
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