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 [OPTIONS] [HOSTNAMES]
   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. The goal of \fBhtsn\fR
  15 is to watch the XML feed and parse the individual XML documents into
  16 files.
  17
  18 .SH INPUT
  19
  20 .P
  21 The program takes no input; a username and password must be supplied
  22 on the command-line or in a configuration file.
  23
  24 .SH OUTPUT
  25
  26 .P
  27 Standard out and standard error are fairly noisy. All traffic between
  28 htsn and the feed server is displayed on stdout. Status messages are
  29 interspersed when they are generated.
  30 .IP \[bu] 2
  31 The only data we send to the feed are the username and password. These
  32 will be highlighted in green on stdout.
  33 .IP \[bu]
  34 All data received from the feed will be echoed in the default color to
  35 stdout.
  36 .IP \[bu]
  37 Informational messages will be highlighted in cyan and sent to stdout.
  38 .IP \[bu]
  39 Warnings will be highlighted in yellow and sent to stderr.
  40 .IP \[bu]
  41 Errors will be highlighted in red and sent to stderr.
  42
  43 .SH LOGGING
  44
  45 Logging is done either to syslog or a file. The destination and
  46 verbosity are controlled by the \fIlog_file\fR, \fIlog_level\fR, and
  47 \fIsyslog\fR parameters which may be specified either on the
  48 command line or in the configuration file.
  49
  50 .SH OPTIONS
  51
  52 .IP \fB\-\-log-file\fR
  53 If you specify a file here, logs will be written to it (possibly in
  54 addition to syslog). Can be either a relative or absolute path. It
  55 will not be auto-rotated; use something log logrotate for that.
  56
  57 Default: none
  58
  59 .IP \fB\-\-log-level\fR
  60 How verbose should the logs be? We log notifications at three levels:
  61 INFO, WARN, and ERROR. Specify the \(dqmost boring\(dq level of
  62 notifications you would like to receive (in all-caps); more
  63 interesting notifications will be logged as well.
  64
  65 Default: INFO
  66
  67 .IP \fB\-\-password\fR,\ \fB\-p\fR
  68 The password associated with your TSN username. A password is
  69 required, so you must supply one either on the command line or in a
  70 configuration file.
  71
  72 Default: none
  73
  74 .IP \fB\-\-output_directory\fR,\ \fB\-o\fR
  75 To which directory should we write the XML files?
  76
  77 Default: .
  78
  79 .IP \fB\-\-syslog\fR,\ \fB\-s\fR
  80 Enable logging to syslog. On Windows this will attempt to communicate
  81 (over UDP) with a syslog daemon on localhost, which will most likely
  82 not work.
  83
  84 .IP \fB\-\-username\fR,\ \fB\-u\fR
  85 Your TSN username. A username is required, so you must supply one
  86 either on the command line or in a configuration file.
  87
  88 Default: none
  89
  90 .SH FEED HOSTS
  91
  92 It is possible to pass a list of feed hostnames on the command-line
  93 (see [HOSTNAMES] in the synopsis). By default \fBhtsn\fR will attempt
  94 to connect to every known TSN XML feed host in a round-robin fashion,
  95 so there is rarely a need to do this.
  96
  97 .SH BUGS
  98
  99 .P
 100 Send bugs to michael@orlitzky.com.