From: Jason Ish <ish@unx.ca>
Date: Fri, 8 Dec 2017 12:33:27 +0000 (-0600)
Subject: doc: include common options with all commands
X-Git-Tag: 1.0.0b1~23
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d4491885e4a63ffd2b5031ea86c6a2fb1d439629;p=thirdparty%2Fsuricata-update.git

doc: include common options with all commands
---

diff --git a/doc/common-options.rst b/doc/common-options.rst
index 113acb9..4e63b23 100644
--- a/doc/common-options.rst
+++ b/doc/common-options.rst
@@ -1,3 +1,19 @@
+.. option:: -h, --help
+
+   Show help.
+
+.. option:: -D <directory>, --data-dir <directory>
+
+   Set an alternate data directory.
+
+   Default: */var/lib/suricata*
+
+.. option:: -c <filename>, --config <filename>
+
+   Path to the suricata-update config file.
+
+   Default: */etc/suricata/update.yaml*
+
 .. option:: -q, --quiet
 
    Run quietly. Only warning and error messages will be displayed.
diff --git a/doc/disable-source.rst b/doc/disable-source.rst
index 9463de5..b2c9ef0 100644
--- a/doc/disable-source.rst
+++ b/doc/disable-source.rst
@@ -15,3 +15,8 @@ Description
 The ``disable-source`` command disables a currently enabled
 source. The configuration for the source is not removed, allowing it
 to be re-enabled without having to re-enter any required parameters.
+
+Options
+=======
+
+.. include:: ./common-options.rst
diff --git a/doc/enable-source.rst b/doc/enable-source.rst
index 0559573..c90ad39 100644
--- a/doc/enable-source.rst
+++ b/doc/enable-source.rst
@@ -24,3 +24,8 @@ For example::
 
 This will prevent the prompt for the et/pro secret code using the
 value provided on the command line instead.
+
+Options
+=======
+
+.. include:: ./common-options.rst
diff --git a/doc/remove-source.rst b/doc/remove-source.rst
index f54023c..f8e3135 100644
--- a/doc/remove-source.rst
+++ b/doc/remove-source.rst
@@ -14,3 +14,8 @@ Description
 
 Remove a source configuration. This removes the source file from
 ``/var/lib/suricata/update/sources``, even if its disabled.
+
+Options
+=======
+
+.. include:: ./common-options.rst
diff --git a/doc/update.rst b/doc/update.rst
index edd8acd..56905cd 100644
--- a/doc/update.rst
+++ b/doc/update.rst
@@ -16,15 +16,7 @@ management tool for Suricata.
 Options
 =======
 
-.. option:: -h, --help
-
-   Show help.
-
-.. option:: -c <filename>, --config <filename>
-   
-   Path to the suricata-update config file.
-
-   Default: */etc/suricata/update.yaml*
+.. include:: ./common-options.rst
 
 .. option:: -o, --output
 
@@ -191,8 +183,6 @@ Options
 
    Display the version of **suricata-update**.
 
-.. include:: ./common-options.rst
-
 Rule Matching
 =============