X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=doc%2Fhtsnrc.example;h=3a2347c9e82a7d22b8d230c293d1cc9028213b25;hb=7300f85caa0e6158eaf9ad972b488e2f58089a89;hp=f82e19586853272c02e3dfc91288a48a96d8a889;hpb=f6cb0ba712e06e52d080b86e9eba6c3585a7514b;p=dead%2Fhtsn.git

diff --git a/doc/htsnrc.example b/doc/htsnrc.example
index f82e195..3a2347c 100644
--- a/doc/htsnrc.example
+++ b/doc/htsnrc.example
@@ -1,13 +1,21 @@
 # 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 the user or global configuration
+# directories.
+#
+# For a user, that's either $HOME/.htsnrc on Unix or
+# %APPDATA%\.htsnrc (e.g. C:\Users\<username>\Application
+# Data\.htsnrc) on Windows.
+#
+# The global configuration directory is determined by Cabal. The
+# "sysconfdir" parameter during the "configure" step will be used. On
+# Unix, it's probably /etc, and this file will need to  go in
+# /etc/htsnrc.
 
 # 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 +25,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 +35,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 +55,7 @@
 #
 # Default: "."
 #
-# output-directory = "/var/lib/htsn"
+# output_directory = "/var/lib/htsn"
 
 
 # The password associated with your TSN username.
@@ -57,33 +65,45 @@
 # 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
+# If necessary, its parent directory will be created with owner/group
+# set to the appropriate user/group, but at most one directory will be
+# created (that is, we won't create an entire directory tree).
 #
-# pidfile = /var/run/htsn.pid
+# Default: /run/htsn/htsn.pid
+#
+# pidfile = /var/run/htsn/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
 # most likely not work.
 #
-# Default: False
+# Default: false
 #
-# syslog = True
+# syslog = true
 
 
 # The username used to connect to the feed.