doc: add pid-file section to suricata.yaml doc

Redmine issue:
https://redmine.openinfosecfoundation.org/issues/2104

diff --git a/doc/userguide/configuration/suricata-yaml.rst b/doc/userguide/configuration/suricata-yaml.rst
index 1b5e9cce5862e88a8dfba23567d034df9f5d3b00..265952e62df5a0c8429b933b9f160b4d90fb8fde 100644 (file)
--- a/doc/userguide/configuration/suricata-yaml.rst
+++ b/doc/userguide/configuration/suricata-yaml.rst
@@ -66,6 +66,24 @@ It is possible to set the user and group to run Suricata as:
     group: suri
 
 
+PID File
+--------
+
+This option sets the name of the PID file when Suricata is run in
+daemon mode. This file records the Suricata process ID.
+
+::
+
+   pid-file: /var/run/suricata.pid
+
+.. note:: This configuration file option only sets the PID file when
+          running in daemon mode. To force creation of a PID file when
+          not running in daemon mode, use the :option:`--pidfile`
+          command line option.
+
+         Also, if running more than one Suricata process, each
+         process will need to specify a different pid-file location.
+
 .. _suricata-yaml-action-order:
 
 Action-order