doc/yaml: SIGSEGV option description

OISF · Jul 1, 2021 · 5844248 · 5844248
1 parent 8be58a9
commit 5844248
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/doc/userguide/configuration/suricata-yaml.rst b/doc/userguide/configuration/suricata-yaml.rst
@@ -2229,6 +2229,19 @@ inspected for possible presence of Teredo.
 Advanced Options
 ----------------
 
+sigsegv
+~~~~~~~
+Diagnostic stacktraces when a SIGSEGV occurs are available when Suricata is configured with
+``--enable-libunwind`` and the ``libunwind`` library is available. The default value
+is to display the diagnostic message if a ``SIGSEGV`` occurs.
+
+::
+
+    logging:
+        # Requires --enable-libunwind. Display a brief diagnostic message with the
+        # offending stacktrace when enabled _and_ configured.
+        # sigsegv-stacktrace: on
+
 luajit
 ~~~~~~