Fix variables and examples in htsnrc.example.

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

diff --git a/doc/htsnrc.example b/doc/htsnrc.example
index 2158504374e5ea5885106009311b1b18db94316c..ca527fcd4236896820d968fdc3261c1ba09f766a 100644 (file)
--- a/doc/htsnrc.example
+++ b/doc/htsnrc.example
@@ -1,20 +1,45 @@
 # 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.
 
 
-# The username used to connect to the feed.
+# Run in the background as a daemon?
 #
-# Default: none (required)
+# Default: false
 #
-# username = "whoever"
+# daemonize = true
 
 
-# The password associated with your TSN username.
+# A list of hostnames that supply the feed. You probably don't need to
+# change this, but you can.
 #
-# Default: none (required)
+# Default: ["feed1.sportsnetwork.com",
+#           "feed2.sportsnetwork.com",
+#           "feed3.sportsnetwork.com"]
 #
-# password = "whatever"
+# feed_hosts = [ "hostname1", "hostname2", ... ]
+
+
+# If you specify a file path here, logs will be written to it
+# (possibly in addition to syslog). Can be either a relative or
+# absolute path. It will not be auto-rotated; use something like
+# logrotate for that.
+#
+# Default: none
+#
+# log_file = "/var/log/htsn/htsn.log"
+
+
+# How verbose should the logs be? Valid levels are,
+#
+#   "INFO", "WARNING", "ERROR"
+#
+# (there are others, but we don't emit them.)
+#
+# Default: "INFO"
+#
+# log_level = "WARNING"
 
 
 # By default, XML files will be written to the current working
@@ -23,44 +48,56 @@
 #
 # Default: "."
 #
-# output-directory = "/var/lib/htsn"
+# output_directory = "/var/lib/htsn"
 
 
-# A list of hostnames that supply the feed. You probably don't need to
-# change this, but you can.
+# The password associated with your TSN username.
 #
-# Default: ["feed1.sportsnetwork.com",
-#           "feed2.sportsnetwork.com",
-#           "feed3.sportsnetwork.com"]
+# Default: none (required)
 #
-# feed-hosts = [ "hostname1", "hostname2", ... ]
+# password = "whatever"
 
 
-# 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.
+# (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. Its parent directory must be writable by the user/group that
+# we will run as!
 #
-# Default: False
+# Default: /run/htsn/htsn.pid
 #
-# syslog = True
+# pidfile = /var/run/htsn/htsn.pid
 
 
-# If you specify a file path here, logs will be written to it
-# (possibly in addition to syslog). Can be either a relative or
-# absolute path. It will not be auto-rotated; use something like
-# logrotate for that.
+# (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: none
+# Default: the current group
 #
-# log_file = /var/log/htsn/htsn.log
+# run_as_group = "htsn"
 
 
-# How verbose should the logs be? Valid levels are,
+# (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.
 #
-#   "INFO", "WARNING", "ERROR"
+# Default: the current user
 #
-# (there are others, but we don't emit them.)
+# 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: "INFO"
+# Default: false
 #
-# log_level = "WARNING"
+# syslog = true
+
+
+# The username used to connect to the feed.
+#
+# Default: none (required)
+#
+# username = "whoever"