From: Michael Orlitzky <michael@orlitzky.com>
Date: Tue, 24 Dec 2013 00:39:37 +0000 (-0500)
Subject: Fix variables and examples in htsnrc.example.
X-Git-Tag: 0.0.2~8
X-Git-Url: http://gitweb.michael.orlitzky.com/?p=dead%2Fhtsn.git;a=commitdiff_plain;h=2533174daff9d6588729f3359eed3a0c68c6778f

Fix variables and examples in htsnrc.example.
---

diff --git a/doc/htsnrc.example b/doc/htsnrc.example
index dfe38cb..ca527fc 100644
--- a/doc/htsnrc.example
+++ b/doc/htsnrc.example
@@ -8,7 +8,7 @@
 #
 # Default: false
 #
-# daemonize = True
+# daemonize = true
 
 
 # A list of hostnames that supply the feed. You probably don't need to
@@ -18,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
@@ -28,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,
@@ -48,7 +48,7 @@
 #
 # Default: "."
 #
-# output-directory = "/var/lib/htsn"
+# output_directory = "/var/lib/htsn"
 
 
 # The password associated with your TSN username.
@@ -59,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
@@ -73,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
@@ -83,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.