summaryrefslogtreecommitdiffstats
path: root/doc/enable-source.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 17:43:34 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 17:43:34 +0000
commit0fcce96a175531ec6042cde1b11a0052aa261dd5 (patch)
tree898a1e161c4984b41e6a732866bd73b24f0f7b7a /doc/enable-source.rst
parentInitial commit. (diff)
downloadsuricata-update-0fcce96a175531ec6042cde1b11a0052aa261dd5.tar.xz
suricata-update-0fcce96a175531ec6042cde1b11a0052aa261dd5.zip
Adding upstream version 1.3.2.upstream/1.3.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/enable-source.rst')
-rw-r--r--doc/enable-source.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/enable-source.rst b/doc/enable-source.rst
new file mode 100644
index 0000000..476b87f
--- /dev/null
+++ b/doc/enable-source.rst
@@ -0,0 +1,35 @@
+###############################
+enable-source - Enable a source
+###############################
+
+Synopsis
+========
+
+::
+
+ suricata-update enable-source <source-name> [param=val ...]
+
+Description
+===========
+
+Enable a source that is listed in the index.
+
+If the index requires user provided parameters the user will be
+prompted for them. Alternatively they can be provided on command line
+to avoid the prompt.
+
+For example::
+
+ suricata-update enable-source et/pro secret-code=xxxxxxxxxxxxxxxx
+
+This will prevent the prompt for the et/pro secret code using the
+value provided on the command line instead.
+
+To update parameters for enabled sources, just re-run the ``enable-source``
+command above again with changed parameters. Changed parameters will be
+updated in the stored configuration.
+
+Options
+=======
+
+.. include:: ./common-options.rst