From: Michael Orlitzky <michael@orlitzky.com>
Date: Mon, 20 Jan 2014 16:32:13 +0000 (-0500)
Subject: Add the example config file.
X-Git-Tag: 0.0.1~30
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=a619c61f4892039b2fd1095cc1c3be0035ba6e16;p=dead%2Fhtsn-import.git

Add the example config file.
---

diff --git a/doc/htsn-importrc.example b/doc/htsn-importrc.example
new file mode 100644
index 0000000..b9a6ffb
--- /dev/null
+++ b/doc/htsn-importrc.example
@@ -0,0 +1,68 @@
+# Example configuration file for htsn-import. For this to take effect, you
+# would need to place it in either the user or global configuration
+# directories.
+#
+# For a user, that's either $HOME/.htsn-importrc on Unix or
+# %APPDATA%\.htsn-importrc (e.g. C:\Users\<username>\Application
+# Data\.htsn-importrc) on Windows.
+#
+# 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/htsn-importrc.
+
+
+# The RDBMS backend to use. Valid choices are "Sqlite" and
+# "Postgres". Capitalization is important, sorry.
+#
+# Default: "Sqlite"
+#
+# backend = "Postgres"
+
+
+# The connection string used for connecting to the database backend
+# given by the "backend" option. The default is appropriate for
+# the "Sqlite" backend.
+#
+# Default: ":memory:"
+#
+# connection_string = "dbname=htsn, user=postgres"
+
+
+# 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"
+
+
+# Remove successfully processed files. If you enable this, you can see
+# at a glance which XML files are not being processed, because they're
+# all that should be left.
+#
+# Default: false
+#
+# remove = true
+
+
+# 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