Finish updating the manpage; make the example config file match.

[dead/htsn.git] / doc / htsnrc.example

diff --git a/doc/htsnrc.example b/doc/htsnrc.example
index f82e19586853272c02e3dfc91288a48a96d8a889..6ddcebeeafda540e27589a12deb9f1fc1cc539cc 100644 (file)
--- a/doc/htsnrc.example
+++ b/doc/htsnrc.example
@@ -57,21 +57,28 @@
 # password = "whatever"
 
 
-# (Daemon mode only) Create a PID file in the given location.
+# (Daemon mode only) Create a PID file in the given location. This is
+# used by the init system on Unix to keep track of the running daemon.
 #
 # Default: /run/htsn.pid
 #
 # pidfile = /var/run/htsn.pid
 
 
-# (Daemon mode only) Run htsn as the specified system grup.
+# (Daemon mode only) Run htsn as the specified system grup. The PID
+# file is written before privileges are dropped, so the only
+# privileges needed by htsn are those necessary to write the XML files
+# and (optionally) the log file.
 #
 # Default: the current group
 #
 # run-as-group = htsn
 
 
-# (Daemon mode only) Run htsn as the specified system user.
+# (Daemon mode only) Run htsn as the specified system user. The PID
+# file is written before privileges are dropped, so the only
+# privileges needed by htsn are those necessary to write the XML files
+# and (optionally) the log file.
 #
 # Default: the current user
 #