Finish updating the manpage; make the example config file match.

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

diff --git a/doc/htsnrc.example b/doc/htsnrc.example
index 2158504374e5ea5885106009311b1b18db94316c..6ddcebeeafda540e27589a12deb9f1fc1cc539cc 100644 (file)
--- a/doc/htsnrc.example
+++ b/doc/htsnrc.example
@@ -3,27 +3,11 @@
 # needs to go in %APPDATA%, or C:\Users\<username>\Application Data.
 
 
-# The username used to connect to the feed.
-#
-# Default: none (required)
-#
-# username = "whoever"
-
-
-# The password associated with your TSN username.
-#
-# Default: none (required)
+# Run in the background as a daemon?
 #
-# password = "whatever"
-
-
-# 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: "."
+# Default: false
 #
-# output-directory = "/var/lib/htsn"
+# daemonize = True
 
 
 # A list of hostnames that supply the feed. You probably don't need to
@@ -36,15 +20,6 @@
 # feed-hosts = [ "hostname1", "hostname2", ... ]
 
 
-# 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
-
-
 # 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
@@ -64,3 +39,62 @@
 # 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: "."
+#
+# output-directory = "/var/lib/htsn"
+
+
+# The password associated with your TSN username.
+#
+# Default: none (required)
+#
+# password = "whatever"
+
+
+# (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.
+#
+# Default: /run/htsn.pid
+#
+# pidfile = /var/run/htsn.pid
+
+
+# (Daemon mode only) Run htsn as the specified system grup. The PID
+# file is written before privileges are dropped, so the only
+# privileges needed by htsn are those necessary to write the XML files
+# and (optionally) the log file.
+#
+# Default: the current group
+#
+# run-as-group = htsn
+
+
+# (Daemon mode only) Run htsn as the specified system user. The PID
+# file is written before privileges are dropped, so the only
+# privileges needed by htsn are those necessary to write the XML files
+# and (optionally) the log file.
+#
+# Default: the current user
+#
+# 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: False
+#
+# syslog = True
+
+
+# The username used to connect to the feed.
+#
+# Default: none (required)
+#
+# username = "whoever"