From: Michael Orlitzky <michael@orlitzky.com>
Date: Mon, 23 Dec 2013 15:48:43 +0000 (-0500)
Subject: Add a "CONFIGURATION FILE" section to the man page.
X-Git-Tag: 0.0.2~16
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=204f007f0cf40420fc7fe7738b66d96c0547f0fe;p=dead%2Fhtsn.git

Add a "CONFIGURATION FILE" section to the man page.
---

diff --git a/doc/man1/htsn.1 b/doc/man1/htsn.1
index db20cac..d105d13 100644
--- a/doc/man1/htsn.1
+++ b/doc/man1/htsn.1
@@ -8,7 +8,6 @@ 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
 containing various sports news and statistics. The goal of \fBhtsn\fR
@@ -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.
@@ -135,12 +132,26 @@ 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 look for a file named \(dq.htsnrc\(dq
+in the user's home directory; its syntax is given by examples in the
+htsnrc.example file (included with \fBhtsn\fR).
+.P
+If you are using the \fI\-\-run\-as\-user\fR option, that means that
+the configuration file will need to go in that user's home directory
+(and not, for example, root's).
+.P
+Options specified on the command-line override those in the
+configuration file.
+
 .SH BUGS
 
 .P