X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=doc%2Fman1%2Fhtsn.1;h=43858c6b53a8edd5f0eac629e22e07ccb6da7da2;hb=b13f4b597ff3055026722adc5661566b1aa8b3ed;hp=db20cac4b14769a1709c853b5e5056414f40d9fe;hpb=431c2a85ca0fc6be25d6ef35447c6f4ccf54b34c;p=dead%2Fhtsn.git

diff --git a/doc/man1/htsn.1 b/doc/man1/htsn.1
index db20cac..43858c6 100644
--- a/doc/man1/htsn.1
+++ b/doc/man1/htsn.1
@@ -8,9 +8,8 @@ htsn \- Parse XML files from The Sports Network feed.
 \fBhtsn\fR [OPTIONS] [HOSTNAMES]
 
 .SH DESCRIPTION
-
 .P
-The Sports Network <http://www.sportsnetwork.com> offers an XML feed
+The Sports Network <http://www.sportsnetwork.com/> offers an XML feed
 containing various sports news and statistics. The goal of \fBhtsn\fR
 is to watch the XML feed and parse the individual XML documents into
 files.
@@ -26,17 +25,15 @@ If we encounter an error (say, the connection is dropped), then we
 will attempt to connect to the next host in the list after waiting
 five seconds. This process continues indefinitely.
 .P
-The program can run either interactively (i.e. outputting to the
+The program can run either interactively (that is, outputting to the
 console), or as a daemon with the \fI\-\-daemonize\fR flag.
 
 .SH INPUT
-
 .P
 The program takes no input; a username and password must be supplied
 on the command-line or in a configuration file.
 
 .SH OUTPUT
-
 .P
 Output is not generated when running as a daemon; otherwise, standard
 out and standard error are fairly noisy. All traffic between htsn and
@@ -57,15 +54,15 @@ Warnings will be highlighted in yellow and sent to stderr.
 Errors will be highlighted in red and sent to stderr.
 
 .SH LOGGING
-
+.P
 Logging is done either to syslog or a file. The destination and
-verbosity are controlled by the \fI\-\-log_file\fR,
-\fI\-\-log_level\fR, and \fI\-\-syslog\fR parameters which may be
+verbosity are controlled by the \fI\-\-log\-file\fR,
+\fI\-\-log\-level\fR, and \fI\-\-syslog\fR parameters which may be
 specified either on the command line or in the configuration file.
 
 .SH OPTIONS
 
-.IP \fB\-\-daemonize\fR
+.IP \fB\-\-daemonize\fR,\ \fB\-d\fR
 Run as a daemon, in the background. When running as a daemon the
 \fI\-\-pidfile\fR, \fI\-\-run\-as\-group\fR, and
 \fI\-\-run\-as\-user\fR flags become relevant.
@@ -75,7 +72,7 @@ Default: disabled
 .IP \fB\-\-log-file\fR
 If you specify a file 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 log logrotate for that.
+will not be auto-rotated; use something like logrotate for that.
 
 Default: none
 
@@ -103,7 +100,11 @@ Default: none
 (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
+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
 
 .IP \fB\-\-run\-as\-group\fR
 (Daemon mode only) Run as the given system group. The PID file is
@@ -135,12 +136,31 @@ either on the command line or in a configuration file.
 Default: none
 
 .SH FEED HOSTS
-
+.P
 It is possible to pass a list of feed hostnames on the command-line
 (see [HOSTNAMES] in the synopsis). By default \fBhtsn\fR will attempt
 to connect to every known TSN XML feed host in a round-robin fashion,
 so there is rarely a need to do this.
 
+.SH CONFIGURATION FILE
+.P
+Any of the command-line options mentioned above can be specified in a
+configuration file instead. We first look for \(dqhtsnrc\(dq in the
+system configuration directory. We then look for a file named
+\(dq.htsnrc\(dq in the user's home directory. The latter will override
+the former.
+.P
+The user's home directory is simply $HOME on Unix; on Windows it's
+wherever %APPDATA% points. The system configuration directory is
+determined by Cabal; the \(dqsysconfdir\(dq parameter during the
+\(dqconfigure\(dq step is used.
+.P
+The file's syntax is given by examples in the htsnrc.example file
+(included with \fBhtsn\fR).
+.P
+Options specified on the command-line override those in either
+configuration file.
+
 .SH BUGS
 
 .P