doc/man1/htsn.1

   1 .TH htsn 1
   2
   3 .SH NAME
   4 htsn \- Parse XML files from The Sports Network feed.
   5
   6 .SH SYNOPSIS
   7
   8 \fBhtsn\fR [\fB-h\fR] [\fB-u\fR USERNAME] [\fB-p\fR PASSWORD] [\fB-f\fR FEED_HOSTS]
   9
  10 .SH DESCRIPTION
  11
  12 .P
  13 The Sports Network <http://www.sportsnetwork.com> offers an XML feed
  14 containing various sports news and statistics.
  15
  16 .SH INPUT
  17
  18 .P
  19 The program takes no input; a username and password must be supplied
  20 on the command-line or in a configuration file.
  21
  22 .SH OUTPUT
  23
  24 .P
  25 There are three \(dqoutput streams\(dq:
  26
  27 .nr step 1 1
  28 .IP \n[step] 2
  29 \fIStandard output/error\fR. The entire conversation with the feed
  30 will be output to standard out in the default color.
  31
  32 The username and password prompt from TSN will be highlighted in
  33 green. Errors will be highlighted in red. Informational messages will
  34 NOT be output to standard out, as they would interfere with the
  35 display of the XML on the wire.
  36
  37 Warnings and errors will be written, in red, to standard error.
  38 .IP \n+[step]
  39 \fIXML files\fR. Each XML received from the feed will be inspected for
  40 an XML_File_ID element, and then written to a file named
  41 accordingly. The name fill be of the form <XML_File_ID>.xml, and it
  42 will be written to the \fBoutput_directory\fR described below.
  43 .IP \n+[step]
  44 \fILogs\fR. Informational messages, warnings, and errors will all be
  45 logged. This should eventually be configurable.
  46