htsn.cabal

   1 name:           htsn
   2 version:        0.0.1
   3 cabal-version:  >= 1.8
   4 author:         Michael Orlitzky
   5 maintainer:     Michael Orlitzky <michael@orlitzky.com>
   6 category:       Utils
   7 license:        GPL-3
   8 license-file:   doc/LICENSE
   9 build-type:     Simple
  10 extra-source-files:
  11   doc/htsnrc.example
  12   doc/man1/htsn.1
  13   doc/init.openrc
  14   test/xml/*.xml
  15 synopsis:
  16   Parse XML files from The Sports Network feed.
  17 description:
  18   /Usage/:
  19   .
  20   @
  21   htsn [OPTIONS] [HOSTNAMES]
  22   @
  23   .
  24   The Sports Network <http://www.sportsnetwork.com/> offers an XML feed
  25   containing various sports news and statistics. The goal of /htsn/
  26   is to watch the XML feed and parse the individual XML documents into
  27   files.
  28   .
  29   Once started, we will choose an XML feed host to connect to. The
  30   choice is made from a list in a round-robin fashion, and by default,
  31   the list contains all known TSN feed hosts. Once we have a connection,
  32   your username and password are sent. If they are accepted, we begin to
  33   parse the feed saving all XML files to the configured output directory
  34   (see @--output-directory@).
  35   .
  36   If we encounter an error (say, the connection is dropped), then we
  37   will attempt to connect to the next host in the list after waiting
  38   five seconds. This process continues indefinitely.
  39   .
  40   The program can run either interactively (that is, outputting to the
  41   console), or as a daemon with the @--daemonize@ flag.
  42   .
  43   /Input/:
  44   .
  45   The program takes no input; a username and password must be supplied
  46   on the command-line or in a configuration file.
  47   .
  48   /Output/:
  49   .
  50   Output is not generated when running as a daemon; otherwise, standard
  51   out and standard error are fairly noisy. All traffic between /htsn/ and
  52   the feed server is displayed on stdout. Status messages are
  53   interspersed when they are generated with warnings and errors going to
  54   stderr. The following can be expected:
  55   .
  56     * The only data we send to the feed are the username and password.
  57       These will be highlighted in green on stdout.
  58   .
  59     * All data received from the feed will be echoed in the default color
  60       to stdout.
  61   .
  62     * Informational messages will be highlighted in cyan and sent to stdout.
  63   .
  64     * Warnings will be highlighted in yellow and sent to stderr.
  65   .
  66     * Errors will be highlighted in red and sent to stderr.
  67   .
  68   /Logging/:
  69   .
  70   Logging is done either to syslog or a file. The destination and
  71   verbosity are controlled by the @--log-file@, @--log-level@,
  72   and @--syslog@ parameters which may be specified either on the command
  73   line or in the configuration file.
  74   .
  75   /Options/:
  76   .
  77   @
  78   \--daemonize, -d
  79   @
  80   .
  81   Run as a daemon, in the background. When running as a daemon the
  82   \--pidfile, --run-as-group, and --run-as-user flags become relevant.
  83   .
  84   Default: disabled
  85   .
  86   @
  87   \--log-file
  88   @
  89   .
  90   If you specify a file here, logs will be written to it (possibly in
  91   addition to syslog). Can be either a relative or absolute path. It
  92   will not be auto-rotated; use something log logrotate for that.
  93   .
  94   Default: none
  95   .
  96   @
  97   \--log-level
  98   @
  99   .
 100   How verbose should the logs be? We log notifications at three levels:
 101   INFO, WARN, and ERROR. Specify the \"most boring\" level of
 102   notifications you would like to receive (in all-caps); more
 103   interesting notifications will be logged as well.
 104   .
 105   Default: INFO
 106   .
 107   @
 108   \--output-directory, -o
 109   @
 110   .
 111   To which directory should we write the XML files?
 112   .
 113   Default: .
 114   .
 115   @
 116   \--password
 117   @
 118   .
 119   The password associated with your TSN username. A password is
 120   required, so you must supply one either on the command line or in a
 121   configuration file.
 122   .
 123   Default: none
 124   .
 125   @
 126   \--pidfile
 127   @
 128   .
 129   (Daemon mode only) Create a PID file in the given location. This is
 130   used by the init system on Unix to keep track of the running daemon.
 131   Its parent directory must be writable by the user/group that we will
 132   run as!
 133   .
 134   Default: \/run\/htsn\/htsn.pid
 135   .
 136   @
 137   \--run-as-group
 138   @
 139   .
 140   (Daemon mode only) Run as the given system group. The PID file is
 141   written before privileges are dropped, so the only privileges needed
 142   by /htsn/ are those necessary to write the XML files and (optionally)
 143   the log file.
 144   .
 145   Default: the current group
 146   .
 147   @
 148   \--run-as-user
 149   @
 150   .
 151   (Daemon mode only) Run as the given system user. The PID file is
 152   written before privileges are dropped, so the only privileges needed
 153   by /htsn/ are those necessary to write the XML files and (optionally)
 154   the log file.
 155   .
 156   Default: the current user
 157   .
 158   @
 159   \--syslog, -s
 160   @
 161   .
 162   Enable logging to syslog. On Windows this will attempt to communicate
 163   (over UDP) with a syslog daemon on localhost, which will most likely
 164   not work.
 165   .
 166   Default: disabled
 167   .
 168   @
 169   \--username, -u
 170   @
 171   .
 172   Your TSN username. A username is required, so you must supply one
 173   either on the command line or in a configuration file.
 174   .
 175   Default: none
 176   .
 177   /Feed Hosts/:
 178   .
 179   It is possible to pass a list of feed hostnames on the command-line
 180   (see [HOSTNAMES] in the synopsis). By default /htsn/ will attempt
 181   to connect to every known TSN XML feed host in a round-robin fashion,
 182   so there is rarely a need to do this.
 183   .
 184   /Configuration File/:
 185   .
 186   Any of the command-line options mentioned above can be specified in a
 187   configuration file instead. We first look for \"htsnrc\" in the
 188   system configuration directory (/etc on Unix). We then look for a file
 189   named \".htsnrc\" in the user's home directory. The latter will override
 190   the former.
 191   .
 192   The file's syntax is given by examples in the htsnrc.example file
 193   (included with /htsn/).
 194   .
 195   Options specified on the command-line override those in either
 196   configuration file.
 197
 198
 199 executable htsn
 200   build-depends:
 201     ansi-terminal               == 0.6.*,
 202     base                        == 4.*,
 203     cmdargs                     >= 0.10.6,
 204     configurator                == 0.2.*,
 205     directory                   == 1.2.*,
 206     filepath                    == 1.3.*,
 207     hdaemonize                  == 0.4.*,
 208     hslogger                    == 1.2.*,
 209     hxt                         == 9.3.*,
 210     MissingH                    == 1.2.*,
 211     network                     == 2.4.*,
 212     tasty                       == 0.5.*,
 213     tasty-hunit                 == 0.4.*,
 214     transformers                == 0.3.*,
 215     unix                        == 2.6.*
 216
 217   main-is:
 218     Main.hs
 219
 220   hs-source-dirs:
 221     src/
 222
 223   other-modules:
 224     CommandLine
 225     Configuration
 226     ExitCodes
 227     Logging
 228     OptionalConfiguration
 229     Terminal
 230     TSN.FeedHosts
 231     TSN.Xml
 232     Unix
 233
 234   ghc-options:
 235     -Wall
 236     -fwarn-hi-shadowing
 237     -fwarn-missing-signatures
 238     -fwarn-name-shadowing
 239     -fwarn-orphans
 240     -fwarn-type-defaults
 241     -fwarn-tabs
 242     -fwarn-incomplete-record-updates
 243     -fwarn-monomorphism-restriction
 244     -fwarn-unused-do-bind
 245     -rtsopts
 246     -threaded
 247     -optc-O3
 248     -optc-march=native
 249     -O2
 250
 251   ghc-prof-options:
 252     -prof
 253     -auto-all
 254     -caf-all
 255
 256
 257
 258 test-suite testsuite
 259   type: exitcode-stdio-1.0
 260   hs-source-dirs: src test
 261   main-is: TestSuite.hs
 262   build-depends:
 263     ansi-terminal               == 0.6.*,
 264     base                        == 4.*,
 265     cmdargs                     >= 0.10.6,
 266     configurator                == 0.2.*,
 267     directory                   == 1.2.*,
 268     filepath                    == 1.3.*,
 269     hdaemonize                  == 0.4.*,
 270     hslogger                    == 1.2.*,
 271     hxt                         == 9.3.*,
 272     MissingH                    == 1.2.*,
 273     network                     == 2.4.*,
 274     tasty                       == 0.5.*,
 275     tasty-hunit                 == 0.4.*,
 276     transformers                == 0.3.*,
 277     unix                        == 2.6.*
 278
 279   -- It's not entirely clear to me why I have to reproduce all of this.
 280   ghc-options:
 281     -Wall
 282     -fwarn-hi-shadowing
 283     -fwarn-missing-signatures
 284     -fwarn-name-shadowing
 285     -fwarn-orphans
 286     -fwarn-type-defaults
 287     -fwarn-tabs
 288     -fwarn-incomplete-record-updates
 289     -fwarn-monomorphism-restriction
 290     -fwarn-unused-do-bind
 291     -rtsopts
 292     -threaded
 293     -optc-O3
 294     -optc-march=native
 295     -O2
 296
 297
 298 source-repository head
 299   type: git
 300   location: http://michael.orlitzky.com/git/htsn.git
 301   branch: master