]> gitweb.michael.orlitzky.com - dead/htsn.git/blobdiff - doc/man1/htsn.1
Update the man page to reflect the global configuration file change.
[dead/htsn.git] / doc / man1 / htsn.1
index d105d13a97c1523ffe2a39dcf248e2e1eb312c9d..ee2361d41c877bfd6d29c3ab86f3b4580b07ac5e 100644 (file)
@@ -9,7 +9,7 @@ htsn \- Parse XML files from The Sports Network feed.
 
 .SH DESCRIPTION
 .P
 
 .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.
 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.
@@ -99,8 +99,10 @@ Default: none
 .IP \fB\-\-pidfile\fR
 (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.
 .IP \fB\-\-pidfile\fR
 (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!
 
 
-Default: /run/htsn.pid
+Default: /run/htsn/htsn.pid
 
 .IP \fB\-\-run\-as\-group\fR
 (Daemon mode only) Run as the given system group. The PID file is
 
 .IP \fB\-\-run\-as\-group\fR
 (Daemon mode only) Run as the given system group. The PID file is
@@ -141,15 +143,15 @@ 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
 .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).
+configuration file instead. We first look for \(dqhtsnrc\(dq in the
+system configuration directory (/etc on Unix). We then look for a file
+named \(dq.htsnrc\(dq in the user's home directory. The latter will
+override the former.
 .P
 .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).
+The file's syntax is given by examples in the htsnrc.example file
+(included with \fBhtsn\fR).
 .P
 .P
-Options specified on the command-line override those in the
+Options specified on the command-line override those in either
 configuration file.
 
 .SH BUGS
 configuration file.
 
 .SH BUGS