From: Jason Ish <jason.ish@oisf.net>
Date: Mon, 17 Oct 2022 21:40:43 +0000 (-0600)
Subject: doc/userguide: document --include command line option
X-Git-Tag: suricata-7.0.0-rc1~55
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1b844cd7f7317b237449c8838bdbdeaad282c432;p=thirdparty%2Fsuricata.git

doc/userguide: document --include command line option
---

diff --git a/doc/userguide/partials/options.rst b/doc/userguide/partials/options.rst
index f6487f10c2..85a77b74c3 100644
--- a/doc/userguide/partials/options.rst
+++ b/doc/userguide/partials/options.rst
@@ -12,6 +12,22 @@
 
    Path to configuration file.
 
+.. option:: --include <path>
+
+   Additional configuration files to include. Multiple additonal
+   configuration files can be provided and will be included in the
+   order specified on the command line.  These additonal configuration
+   files are loaded as if they existed at the end of the main
+   configuration file.
+
+   Example including one additional file::
+
+     --include /etc/suricata/other.yaml
+
+   Example including more than one additional file::
+
+     --include /etc/suricata/other.yaml --include /etc/suricata/extra.yaml
+
 .. option:: -T
 
    Test configuration.