From: Jason Ish <ish@unx.ca>
Date: Mon, 4 Dec 2017 19:28:31 +0000 (-0600)
Subject: doc: add page for enable-source
X-Git-Tag: 1.0.0a1~11
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=25f58249fcc07b340073c8a0fe828e367d7762a3;p=thirdparty%2Fsuricata-update.git

doc: add page for enable-source
---

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