Pull request #3419: doc: User documentation update for obfuscate_pii and --help-module

Merge in SNORT/snort3 from ~PRBG/snort3:doc_update_help_and_usage to master

Squashed commit of the following:

commit f6293a0d79293afa35d44555c1abb2175b3b120f
Author: Priyanka Gurudev <prbg@cisco.com>
Date:   Thu May 12 12:15:35 2022 -0400

    doc: update clone link in README. Thanks to billchenchina.

commit 1838326a7c37672ff85cc97f5cb4e13dfd6a3781
Author: Priyanka Gurudev <prbg@cisco.com>
Date:   Tue May 10 14:20:44 2022 -0400

    doc: user documentation update for obfuscate_pii and --help-module

diff --git a/README.md b/README.md
index c7b3280f70ae616d450aede7b5103a0e2002235c..3197109b0c303c912b8b1bbfc1482cb114646a9c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -75,7 +75,7 @@ There is a source tarball available in the Downloads section on snort.org:
 
 You can also get the code with:
 
-    git clone git://github.com/snort3/snort3.git
+    git clone https://github.com/snort3/snort3.git
 
 There are separate extras packages for cmake that provide additional
 features and demonstrate how to build plugins. The source for extras

diff --git a/doc/user/concepts.txt b/doc/user/concepts.txt
index 33f32e862f20331f693db41419dd7a9c975cf11e..df3db3dc2a13524c909191f3cb347f0d9b3cd0f9 100644 (file)
--- a/doc/user/concepts.txt
+++ b/doc/user/concepts.txt
@@ -13,7 +13,7 @@ and consistently.  You can learn quite a lot about any given module from
 the command line.  For example, to see what stream_tcp is all about, do
 this:
 
-    $ snort --help-config stream_tcp
+    $ snort --help-module stream_tcp
 
 Modules are configured using Lua tables with the same name.  So the
 stream_tcp module is configured with defaults like this:

diff --git a/doc/user/sensitive_data.txt b/doc/user/sensitive_data.txt
index fa07f27e9b5fe28c39565841da4046d123daaf14..ce7a599c986eb717fbc689c40c97ef4d59cd9ac7 100644 (file)
--- a/doc/user/sensitive_data.txt
+++ b/doc/user/sensitive_data.txt
@@ -74,11 +74,11 @@ in a packet, you will not see an event.
 ===== Obfuscating Credit Cards and Social Security Numbers
 
 Snort provides discreet logging for the built in patterns "credit_card",
-"us_social" and "us_social_nodashes". Enabling `output.obfuscate_pii` makes
+"us_social" and "us_social_nodashes". Enabling `ips.obfuscate_pii` makes
 Snort obfuscate the suspect packet payload which was matched by the
 patterns. This configuration is disabled by default.
 
-    output =
+    ips =
     { 
         obfuscate_pii = true
     }