Bump version to 0.0.2 and make some small documentation updates.

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

diff --git a/doc/htsnrc.example b/doc/htsnrc.example
index 2158504374e5ea5885106009311b1b18db94316c..90212cdfa4d39ef6090a4d0bc09f69c5eef24b22 100644 (file)
--- a/doc/htsnrc.example
+++ b/doc/htsnrc.example
@@ -1,29 +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.
-
-
-# The username used to connect to the feed.
-#
-# Default: none (required)
-#
-# username = "whoever"
-
-
-# The password associated with your TSN username.
+# would need to place it in either the user or global configuration
+# directories.
 #
-# Default: none (required)
+# For a user, that's either $HOME/.htsnrc on Unix or
+# %APPDATA%\.htsnrc (e.g. C:\Users\<username>\Application
+# Data\.htsnrc) on Windows.
 #
-# password = "whatever"
+# 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.
 
-
-# By default, XML files will be written to the current working
-# directory. Often this is not desirable, and you would rather save
-# them to a specific location. Specify it here.
+# Run in the background as a daemon?
 #
-# Default: "."
+# Default: false
 #
-# output-directory = "/var/lib/htsn"
+# daemonize = true
 
 
 # A list of hostnames that supply the feed. You probably don't need to
@@ -33,16 +25,7 @@
 #           "feed2.sportsnetwork.com",
 #           "feed3.sportsnetwork.com"]
 #
-# feed-hosts = [ "hostname1", "hostname2", ... ]
-
-
-# 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
-#
-# syslog = True
+# feed_hosts = [ "hostname1", "hostname2", ... ]
 
 
 # If you specify a file path here, logs will be written to it
@@ -52,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,
@@ -64,3 +47,64 @@
 # Default: "INFO"
 #
 # log_level = "WARNING"
+
+
+# By default, XML files will be written to the current working
+# directory. Often this is not desirable, and you would rather save
+# them to a specific location. Specify it here.
+#
+# Default: "."
+#
+# output_directory = "/var/lib/htsn"
+
+
+# The password associated with your TSN username.
+#
+# Default: none (required)
+#
+# password = "whatever"
+
+
+# (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: /run/htsn/htsn.pid
+#
+# pidfile = /var/run/htsn/htsn.pid
+
+
+# (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"
+
+
+# (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"
+
+# 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
+#
+# syslog = true
+
+
+# The username used to connect to the feed.
+#
+# Default: none (required)
+#
+# username = "whoever"