Disable syslog by default.

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

diff --git a/doc/htsnrc.example b/doc/htsnrc.example
index 0c265575f215adcacb351c3502aaf8be2fb53dd3..8af53988d41121605b85da17f77ecad966e571f5 100644 (file)
--- a/doc/htsnrc.example
+++ b/doc/htsnrc.example
@@ -10,23 +10,24 @@
 # username = "whoever"
 
 
-# The password used to connect to the feed.
+# The password associated with your TSN username.
 #
 # Default: none (required)
 #
 # password = "whatever"
 
 
-# By default, htsn will output the XML files to the current working
+# 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: "." (here)
+# Default: "."
 #
 # output-directory = "/var/lib/htsn"
 
 
-# A list of hostnames that supply the feed.
+# A list of hostnames that supply the feed. You probably don't need to
+# change this, but you can.
 #
 # Default: ["feed1.sportsnetwork.com",
 #           "feed2.sportsnetwork.com",
@@ -35,19 +36,21 @@
 # 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.
+# 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: True
+# Default: False
 #
-# syslog = False
+# syslog = True
 
 
-# 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.
+# 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: htsn.log
+# Default: empty
 #
 # log_file = /var/log/htsn/htsn.log