Add scaffolding to allow logging via syslog or a file.

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

diff --git a/doc/htsnrc.example b/doc/htsnrc.example
index 18a5a3be3b60a81c811b3410c4a4663a0ca248b4..0c265575f215adcacb351c3502aaf8be2fb53dd3 100644 (file)
--- a/doc/htsnrc.example
+++ b/doc/htsnrc.example
@@ -1,5 +1,7 @@
 # Example configuration file for htsn. For this to take effect, you
-# would need to place it in $HOME/.htsnrc
+# 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.
 #
@@ -7,12 +9,14 @@
 #
 # username = "whoever"
 
+
 # The password used to connect to the feed.
 #
 # Default: none (required)
 #
 # password = "whatever"
 
+
 # By default, htsn will output the XML files to the current working
 # directory. Often this is not desirable, and you would rather save
 # them to a specific location. Specify it here.
@@ -21,6 +25,7 @@
 #
 # output-directory = "/var/lib/htsn"
 
+
 # A list of hostnames that supply the feed.
 #
 # Default: ["feed1.sportsnetwork.com",
@@ -28,3 +33,31 @@
 #           "feed3.sportsnetwork.com"]
 #
 # feed-hosts = [ "hostname1", "hostname2", ... ]
+
+
+# Do you want to log to syslog? If so, the log_file option below will
+# be ignored. This will log to the event log on Windows.
+#
+# Default: True
+#
+# syslog = False
+
+
+# If syslog = False, which file should we use for a log? Can be either
+# a relative or absolute path. It will not be auto-rotated; use
+# something log logrotate for that.
+#
+# Default: htsn.log
+#
+# 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"