]> git.ipfire.org Git - thirdparty/suricata-update.git/commitdiff
doc: add page for enable-source
authorJason Ish <ish@unx.ca>
Mon, 4 Dec 2017 19:28:31 +0000 (13:28 -0600)
committerJason Ish <ish@unx.ca>
Mon, 4 Dec 2017 19:28:31 +0000 (13:28 -0600)
doc/enable-source.rst [new file with mode: 0644]
doc/index.rst

diff --git a/doc/enable-source.rst b/doc/enable-source.rst
new file mode 100644 (file)
index 0000000..0559573
--- /dev/null
@@ -0,0 +1,26 @@
+###############################
+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.
index c5adb8aadf12dff2445148c8f99dc4793e8921cf..32a6096ab372fe9bbbc11905bebe4bf8c30b99d6 100644 (file)
@@ -9,3 +9,4 @@ suricata-update - A Suricata Rule Update Tool
    update
    add-source
    update-sources
+   enable-source