Quote example user/group names.

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

diff --git a/doc/htsnrc.example b/doc/htsnrc.example
index f82e19586853272c02e3dfc91288a48a96d8a889..dfe38cb77eaaa1b9052b81daa6513376c25a9e0c 100644 (file)
--- a/doc/htsnrc.example
+++ b/doc/htsnrc.example
@@ -1,6 +1,7 @@
 # Example configuration file for htsn. For this to take effect, you
-# would need to place it in $HOME/.htsnrc. On Windows, it probably
-# needs to go in %APPDATA%, or C:\Users\<username>\Application Data.
+# would need to place it in either /etc/htsnrc or $HOME/.htsnrc. On
+# Windows, it probably needs to go in %APPDATA%, or
+# C:\Users\<username>\Application Data.
 
 
 # Run in the background as a daemon?
@@ -57,25 +58,32 @@
 # 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
+# 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
 #
-# run-as-user = htsn
+# run-as-user = "htsn"
 
 # Do you want to log to syslog? On Windows this will attempt to
 # communicate (over UDP) with a syslog daemon on localhost, which will