doc: add doc for update-sources

Also introduce a common-options file for options that are
common to all commands.

diff --git a/doc/add-source.rst b/doc/add-source.rst
index 383dc886b9c8efc4df9c9a48037344cbf9f63467..77677da1452ccea32fa766ec9e825d707bb0def7 100644 (file)
--- a/doc/add-source.rst
+++ b/doc/add-source.rst
@@ -28,3 +28,4 @@ Options
    The URL of the source. If not provided on the command line the user
    will be prompted.
 
+.. include:: ./common-options.rst

diff --git a/doc/common-options.rst b/doc/common-options.rst
new file mode 100644 (file)
index 0000000..113acb9
--- /dev/null
+++ b/doc/common-options.rst
@@ -0,0 +1,7 @@
+.. option:: -q, --quiet
+
+   Run quietly. Only warning and error messages will be displayed.
+
+.. option:: -v, --verbose
+
+   Provide more verbose output.

diff --git a/doc/index.rst b/doc/index.rst
index 7ffbf743149329931bcb9a85e0b2b903c39d1d58..c5adb8aadf12dff2445148c8f99dc4793e8921cf 100644 (file)
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -8,3 +8,4 @@ suricata-update - A Suricata Rule Update Tool
    quickstart
    update
    add-source
+   update-sources

diff --git a/doc/update-sources.rst b/doc/update-sources.rst
new file mode 100644 (file)
index 0000000..0264c5c
--- /dev/null
+++ b/doc/update-sources.rst
@@ -0,0 +1,40 @@
+########################################
+update-sources - Update the source index
+########################################
+
+Synopsis
+========
+
+::
+
+   suricata-update update-sources
+
+Description
+===========
+
+The ``update-sources`` command downloads the latest index of available
+sources.
+
+Options
+=======
+
+.. include:: common-options.rst
+
+Files and Directories
+=====================
+
+``/var/lib/suricata/rules/.cache/index.yaml``
+  Where the downloaded source index is cached.
+  
+Environment Variables
+=====================
+
+**SOURCE_INDEX_URL**
+  This environment variable allows the specification of an alternate
+  URL to download the index from.
+
+URLs
+====
+
+``https://raw.githubusercontent.com/jasonish/suricata-intel-index/master/index.yaml``
+  The default URL used to download the index from.

diff --git a/doc/update.rst b/doc/update.rst
index 59ba099dbd0750575a9a905437339d744201800c..edd8acdacbb7b968d9ef16ce5fe4ec1c2956d524 100644 (file)
--- a/doc/update.rst
+++ b/doc/update.rst
@@ -20,10 +20,6 @@ Options
 
    Show help.
 
-.. option:: -v, --verbose
-
-   Be more verbose.
-
 .. option:: -c <filename>, --config <filename>
    
    Path to the suricata-update config file.
@@ -155,10 +151,6 @@ Options
    URLs provided on the command line or sources provided in the
    configuration.
 
-.. option:: -q, --quiet
-
-   Run quietly. Only warning and error message will be displayed.
-
 .. option:: --dump-sample-configs
 
    Output sample configuration files for the ``--disable``,
@@ -199,6 +191,8 @@ Options
 
    Display the version of **suricata-update**.
 
+.. include:: ./common-options.rst
+
 Rule Matching
 =============