Minor documentation fixes; create all (even internal) docs with `make doc`.

[dead/htsn.git] / doc / man1 / htsn.1

diff --git a/doc/man1/htsn.1 b/doc/man1/htsn.1
index d105d13a97c1523ffe2a39dcf248e2e1eb312c9d..78bb8d492e2f95818793d175f28765f3168198c1 100644 (file)
--- a/doc/man1/htsn.1
+++ b/doc/man1/htsn.1
@@ -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.


@@ -100,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.
 
 (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
 
 .IP \fB\-\-run\-as\-group\fR
 (Daemon mode only) Run as the given system group. The PID file is


@@ -141,15 +145,20 @@ 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. 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
 .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