summaryrefslogtreecommitdiffstats
path: root/doc/common-options.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/common-options.rst')
-rw-r--r--doc/common-options.rst51
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/common-options.rst b/doc/common-options.rst
new file mode 100644
index 0000000..d56df99
--- /dev/null
+++ b/doc/common-options.rst
@@ -0,0 +1,51 @@
+.. 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.
+
+.. option:: -v, --verbose
+
+ Provide more verbose output.
+
+.. option:: --suricata-conf <path>
+
+ Path to the suricata config file.
+
+ Default: */etc/suricata/suricata.yaml*
+
+.. option:: --suricata <path>
+
+ The path to the Suricata program. If not provided
+ ``suricata-update`` will attempt to find Suricata on your path.
+
+ The Suricata program is used to determine the version of Suricata
+ as well as providing information about the Suricata configuration.
+
+.. option:: --suricata-version <version>
+
+ Set the Suricata version to a specific version instead of checking
+ the version of Suricata on the path.
+
+.. option:: --user-agent <string>
+
+ Set a custom user agent string for HTTP requests.
+
+.. option:: -s, --show-advanced
+
+ Show advanced options.
+ \ No newline at end of file