doc/htsnrc.example

   1 # Example configuration file for htsn. For this to take effect, you
   2 # would need to place it in either the user or global configuration
   3 # directories.
   4 #
   5 # For a user, that's either $HOME/.htsnrc on Unix or
   6 # %APPDATA%\.htsnrc (e.g. C:\Users\<username>\Application
   7 # Data\.htsnrc) on Windows.
   8 #
   9 # The global configuration directory is determined by Cabal. The
  10 # "sysconfdir" parameter during the "configure" step will be used. On
  11 # Unix, it's probably /etc, and this file will need to  go in
  12 # /etc/htsnrc.
  13
  14 # Run in the background as a daemon?
  15 #
  16 # Default: false
  17 #
  18 # daemonize = true
  19
  20
  21 # A list of hostnames that supply the feed. You probably don't need to
  22 # change this, but you can.
  23 #
  24 # Default: ["feed1.sportsnetwork.com",
  25 #           "feed2.sportsnetwork.com",
  26 #           "feed3.sportsnetwork.com"]
  27 #
  28 # feed_hosts = [ "hostname1", "hostname2", ... ]
  29
  30
  31 # If you specify a file path here, logs will be written to it
  32 # (possibly in addition to syslog). Can be either a relative or
  33 # absolute path. It will not be auto-rotated; use something like
  34 # logrotate for that.
  35 #
  36 # Default: none
  37 #
  38 # log_file = "/var/log/htsn/htsn.log"
  39
  40
  41 # How verbose should the logs be? Valid levels are,
  42 #
  43 #   "DEBUG", "INFO", "WARNING", "ERROR"
  44 #
  45 # (there are others, but we don't emit them.) The debug output is
  46 # extremely verbose and will not be written to syslog even if you try.
  47 #
  48 # Default: "INFO"
  49 #
  50 # log_level = "WARNING"
  51
  52
  53 # By default, XML files will be written to the current working
  54 # directory. Often this is not desirable, and you would rather save
  55 # them to a specific location. Specify it here.
  56 #
  57 # Default: "."
  58 #
  59 # output_directory = "/var/lib/htsn"
  60
  61
  62 # The password associated with your TSN username.
  63 #
  64 # Default: none (required)
  65 #
  66 # password = "whatever"
  67
  68
  69 # (Daemon mode only) Create a PID file in the given location. This is
  70 # used by the init system on Unix to keep track of the running
  71 # daemon.
  72 #
  73 # If necessary, its parent directory will be created with owner/group
  74 # set to the appropriate user/group, but at most one directory will be
  75 # created (that is, we won't create an entire directory tree).
  76 #
  77 # Default: /run/htsn/htsn.pid
  78 #
  79 # pidfile = /var/run/htsn/htsn.pid
  80
  81
  82 # (Daemon mode only) Run htsn as the specified system grup. The PID
  83 # file is written before privileges are dropped, so the only
  84 # privileges needed by htsn are those necessary to write the XML files
  85 # and (optionally) the log file.
  86 #
  87 # Default: the current group
  88 #
  89 # run_as_group = "htsn"
  90
  91
  92 # (Daemon mode only) Run htsn as the specified system user. The PID
  93 # file is written before privileges are dropped, so the only
  94 # privileges needed by htsn are those necessary to write the XML files
  95 # and (optionally) the log file.
  96 #
  97 # Default: the current user
  98 #
  99 # run_as_user = "htsn"
 100
 101 # Do you want to log to syslog? On Windows this will attempt to
 102 # communicate (over UDP) with a syslog daemon on localhost, which will
 103 # most likely not work.
 104 #
 105 # Default: false
 106 #
 107 # syslog = true
 108
 109
 110 # The username used to connect to the feed.
 111 #
 112 # Default: none (required)
 113 #
 114 # username = "whoever"