aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorJake Hunsaker <jhunsake@redhat.com>2021-02-05 13:16:54 -0500
committerJake Hunsaker <jhunsake@redhat.com>2021-02-22 10:31:23 -0500
commit2d697caef5fa7dc43dea4464ac9d2a49abca4969 (patch)
treec84f8274af0af2819c20639130c13f47c2496ce5 /man
parentd810d4d7aa5dc49044a5fbc665983071f6a03cb5 (diff)
downloadsos-2d697caef5fa7dc43dea4464ac9d2a49abca4969.tar.gz
[clean] Allow specifying keywords in a text file
This commit adds the ability for users to provide a text file with a list of newline-delimited keywords that should be obfuscated, rather than requiring all keywords be specified either by the `--keywords` option or configuration file settings. Files may be provided via the new `--keyword-file` option which is available to `clean`, `collect`, and `report`. Closes: #2401 Resolves: #2408 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'man')
-rw-r--r--man/en/sos-clean.16
1 files changed, 6 insertions, 0 deletions
diff --git a/man/en/sos-clean.1 b/man/en/sos-clean.1
index 28ac67f7..0c62ed07 100644
--- a/man/en/sos-clean.1
+++ b/man/en/sos-clean.1
@@ -4,6 +4,8 @@ sos clean - Obfuscate sensitive data from one or more sosreports
.SH SYNOPSIS
.B sos clean TARGET [options]
[\-\-domains]
+ [\-\-keywords]
+ [\-\-keyword-file]
[\-\-map-file]
[\-\-jobs]
[\-\-no-update]
@@ -54,6 +56,10 @@ 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 \-\-keyword-file FILE
+Provide a file that contains a list of keywords that should be obfuscated. Each word must
+be specified on a newline within the file.
+.TP
.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