]> git.ipfire.org Git - thirdparty/suricata-update.git/commitdiff
doc: include common options with all commands
authorJason Ish <ish@unx.ca>
Fri, 8 Dec 2017 12:33:27 +0000 (06:33 -0600)
committerJason Ish <ish@unx.ca>
Fri, 8 Dec 2017 12:33:27 +0000 (06:33 -0600)
doc/common-options.rst
doc/disable-source.rst
doc/enable-source.rst
doc/remove-source.rst
doc/update.rst

index 113acb968bc3ba1817532bf53dd10369c9b4a99b..4e63b234e9d6d9b9e5fdb58d2c066a3e711cc618 100644 (file)
@@ -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.
index 9463de5f3c0aa3aef4ced9c0eb196f9925aa4d1c..b2c9ef0c9c6491f1c5457ab9aca813f720c3ff83 100644 (file)
@@ -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
index 0559573ee500220ac188c4bcf1de9a9d75902812..c90ad39477c4d0ea487ee714b316aee35ff59f4b 100644 (file)
@@ -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
index f54023c60c4c405dd898d6b8ef9d9b1d1ca1c21f..f8e31358e384b1c23b09a6a69b36961c1cb80aee 100644 (file)
@@ -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
index edd8acdacbb7b968d9ef16ce5fe4ec1c2956d524..56905cdba66bf3522844836fc735b3a481c0ea5b 100644 (file)
@@ -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
 =============