From: Michael Orlitzky <michael@orlitzky.com>
Date: Fri, 20 Dec 2013 06:21:35 +0000 (-0500)
Subject: Add a man page, work in progress.
X-Git-Tag: 0.0.2~38
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=d47e5ec7e78b7766220763e9e14b3fd633afbed0;p=dead%2Fhtsn.git

Add a man page, work in progress.
---

diff --git a/doc/man1/htsn.1 b/doc/man1/htsn.1
new file mode 100644
index 0000000..d23642c
--- /dev/null
+++ b/doc/man1/htsn.1
@@ -0,0 +1,46 @@
+.TH htsn 1
+
+.SH NAME
+htsn \- Parse XML files from The Sports Network feed.
+
+.SH SYNOPSIS
+
+\fBhtsn\fR [\fB-h\fR] [\fB-u\fR USERNAME] [\fB-p\fR PASSWORD] [\fB-f\fR FEED_HOSTS]
+
+.SH DESCRIPTION
+
+.P
+The Sports Network <http://www.sportsnetwork.com> offers an XML feed
+containing various sports news and statistics.
+
+.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
+There are three \(dqoutput streams\(dq:
+
+.nr step 1 1
+.IP \n[step] 2
+\fIStandard output/error\fR. The entire conversation with the feed
+will be output to standard out in the default color.
+
+The username and password prompt from TSN will be highlighted in
+green. Errors will be highlighted in red. Informational messages will
+NOT be output to standard out, as they would interfere with the
+display of the XML on the wire.
+
+Warnings and errors will be written, in red, to standard error.
+.IP \n+[step]
+\fIXML files\fR. Each XML received from the feed will be inspected for
+an XML_File_ID element, and then written to a file named
+accordingly. The name fill be of the form <XML_File_ID>.xml, and it
+will be written to the \fBoutput_directory\fR described below.
+.IP \n+[step]
+\fILogs\fR. Informational messages, warnings, and errors will all be
+logged. This should eventually be configurable.
+