Fix variables and examples in htsnrc.example.

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

diff --git a/doc/htsnrc.example b/doc/htsnrc.example
index 6ddcebeeafda540e27589a12deb9f1fc1cc539cc..ca527fcd4236896820d968fdc3261c1ba09f766a 100644 (file)
--- a/doc/htsnrc.example
+++ b/doc/htsnrc.example
@@ -1,13 +1,14 @@
 # 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?
 #
 # Default: false
 #
-# daemonize = True
+# daemonize = true
 
 
 # A list of hostnames that supply the feed. You probably don't need to
@@ -17,7 +18,7 @@
 #           "feed2.sportsnetwork.com",
 #           "feed3.sportsnetwork.com"]
 #
-# feed-hosts = [ "hostname1", "hostname2", ... ]
+# feed_hosts = [ "hostname1", "hostname2", ... ]
 
 
 # If you specify a file path here, logs will be written to it
@@ -27,7 +28,7 @@
 #
 # Default: none
 #
-# log_file = /var/log/htsn/htsn.log
+# log_file = "/var/log/htsn/htsn.log"
 
 
 # How verbose should the logs be? Valid levels are,
@@ -47,7 +48,7 @@
 #
 # Default: "."
 #
-# output-directory = "/var/lib/htsn"
+# output_directory = "/var/lib/htsn"
 
 
 # The password associated with your TSN username.
@@ -58,11 +59,13 @@
 
 
 # (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.
+# used by the init system on Unix to keep track of the running
+# daemon. Its parent directory must be writable by the user/group that
+# we will run as!
 #
-# Default: /run/htsn.pid
+# Default: /run/htsn/htsn.pid
 #
-# pidfile = /var/run/htsn.pid
+# pidfile = /var/run/htsn/htsn.pid
 
 
 # (Daemon mode only) Run htsn as the specified system grup. The PID
@@ -72,7 +75,7 @@
 #
 # Default: the current group
 #
-# run-as-group = htsn
+# run_as_group = "htsn"
 
 
 # (Daemon mode only) Run htsn as the specified system user. The PID
@@ -82,15 +85,15 @@
 #
 # 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
 # most likely not work.
 #
-# Default: False
+# Default: false
 #
-# syslog = True
+# syslog = true
 
 
 # The username used to connect to the feed.