From: Michael Orlitzky <michael@orlitzky.com>
Date: Wed, 18 Dec 2013 07:48:27 +0000 (-0500)
Subject: Add an example configuration file.
X-Git-Tag: 0.0.2~43
X-Git-Url: http://gitweb.michael.orlitzky.com/?p=dead%2Fhtsn.git;a=commitdiff_plain;h=eab42a8effc71f75a585a540d92c9dd295c7c9c9

Add an example configuration file.
---

diff --git a/doc/htsnrc.example b/doc/htsnrc.example
new file mode 100644
index 0000000..18a5a3b
--- /dev/null
+++ b/doc/htsnrc.example
@@ -0,0 +1,30 @@
+# Example configuration file for htsn. For this to take effect, you
+# would need to place it in $HOME/.htsnrc
+
+# The username used to connect to the feed.
+#
+# Default: none (required)
+#
+# 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.
+#
+# Default: "." (here)
+#
+# output-directory = "/var/lib/htsn"
+
+# A list of hostnames that supply the feed.
+#
+# Default: ["feed1.sportsnetwork.com",
+#           "feed2.sportsnetwork.com",
+#           "feed3.sportsnetwork.com"]
+#
+# feed-hosts = [ "hostname1", "hostname2", ... ]