From: Jason Ish <jason.ish@oisf.net>
Date: Wed, 2 Oct 2019 22:49:50 +0000 (-0600)
Subject: doc: -v verbose option documentation update
X-Git-Tag: suricata-5.0.0~32
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c97195bf0bc562a94b27af4ccc183e8161d2fd5a;p=thirdparty%2Fsuricata.git

doc: -v verbose option documentation update

Update -v documentation to reflect the new behaviour discussed
in bug #1851 where -v changes the log level to fixed levels
instead of an offset of the default log level configured
in suricata.yaml.
---

diff --git a/doc/userguide/partials/options.rst b/doc/userguide/partials/options.rst
index 9a0863ab97..fec2a2380e 100644
--- a/doc/userguide/partials/options.rst
+++ b/doc/userguide/partials/options.rst
@@ -18,8 +18,18 @@
 
 .. option:: -v
 
-   The -v option enables more verbosity of Suricata's output. Supply
-   multiple times for more verbosity.
+   Increase the verbosity of the Suricata application logging by
+   increasing the log level from the default. This option can be
+   passed multiple times to further increase the verbosity.
+
+   - -v: INFO
+   - -vv: PERF
+   - -vvv: CONFIG
+   - -vvvv: DEBUG
+
+   This option will not decrease the log level set in the
+   configuration file if it is already more verbose than the level
+   requested with this option.
 
 .. Basic input options.