Add a bunch of new options allowing htsn to daemonize.

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

diff --git a/doc/htsnrc.example b/doc/htsnrc.example
index 0c265575f215adcacb351c3502aaf8be2fb53dd3..f82e19586853272c02e3dfc91288a48a96d8a889 100644 (file)
--- a/doc/htsnrc.example
+++ b/doc/htsnrc.example
@@ -3,61 +3,91 @@
 # 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 used to connect to the feed.
+# 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", ... ]
 
 
-# By default, htsn will output the XML files to the current working
+# 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
 # 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.
+# 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? If so, the log_file option below will
-# be ignored. This will log to the event log on Windows.
+# (Daemon mode only) Create a PID file in the given location.
 #
-# Default: True
+# Default: /run/htsn.pid
 #
-# syslog = False
+# pidfile = /var/run/htsn.pid
 
 
-# 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.
+# (Daemon mode only) Run htsn as the specified system grup.
 #
-# Default: htsn.log
+# 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.
 #
-#   "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"