Bump to v0.1.1 and allow >= network-2.6.

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

diff --git a/doc/htsnrc.example b/doc/htsnrc.example
index ca527fcd4236896820d968fdc3261c1ba09f766a..bb2de46199e2b1b98582612bdbf6f57d670e0f5f 100644 (file)
--- a/doc/htsnrc.example
+++ b/doc/htsnrc.example
@@ -1,8 +1,15 @@
 # Example configuration file for htsn. For this to take effect, you
-# would need to place it in either /etc/htsnrc or $HOME/.htsnrc. On
-# Windows, it probably needs to go in %APPDATA%, or
-# C:\Users\<username>\Application Data.
-
+# would need to place it in either the user or global configuration
+# directories.
+#
+# For a user, that's either $HOME/.htsnrc on Unix or
+# %APPDATA%\.htsnrc (e.g. C:\Users\<username>\Application
+# Data\.htsnrc) 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/htsnrc.
 
 # Run in the background as a daemon?
 #
@@ -33,9 +40,10 @@
 
 # How verbose should the logs be? Valid levels are,
 #
-#   "INFO", "WARNING", "ERROR"
+#   "DEBUG", "INFO", "WARNING", "ERROR"
 #
-# (there are others, but we don't emit them.)
+# (there are others, but we don't emit them.) The debug output is
+# extremely verbose and will not be written to syslog even if you try.
 #
 # Default: "INFO"
 #
@@ -60,8 +68,11 @@
 
 # (Daemon mode only) Create a PID file in the given location. This is
 # used by the init system on Unix to keep track of the running
-# daemon. Its parent directory must be writable by the user/group that
-# we will run as!
+# daemon.
+#
+# If necessary, its parent directory will be created with owner/group
+# set to the appropriate user/group, but at most one directory will be
+# created (that is, we won't create an entire directory tree).
 #
 # Default: /run/htsn/htsn.pid
 #