# 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
# "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
#
# 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,
#
-# "INFO", "WARNING", "ERROR"
+# "DEBUG", "INFO", "WARNING", "ERROR"
#
-# (there are others, but we don't emit them.)
+# (there are others, but we don't emit them.) The debug output is
+# extremely verbose and will not be written to syslog even if you try.
#
# Default: "INFO"
#
#
# Default: "."
#
-# output-directory = "/var/lib/htsn"
+# output_directory = "/var/lib/htsn"
# The password associated with your TSN username.
# 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.