weatherrc.5

   1 .TH WEATHERRC 5 "March 15, 2010" "" \" -*- nroff -*-
   2 \" Copyright (c) 2006-2010 Jeremy Stanley <fungi@yuggoth.org>.
   3 \" Permission to use, copy, modify, and distribute this software is
   4 \" granted under terms provided in the LICENSE file distributed with
   5 \" this software.
   6 .SH NAME
   7 weatherrc \- configuration file format for the
   8 .BR weather (1)
   9 utility
  10 .SH DESCRIPTION
  11 The weatherrc file format is intended to specify a set of macros
  12 by which to group a METAR station ID for current conditions data with a
  13 city/state combination for a forecast, but many of the other
  14 command\-line options and flags for the weather utility can be specified
  15 as well. The file is organized as an INI-format config, with the alias
  16 name in [] brackets and the associated parameter/value pairs on following
  17 lines. Parameters and their values as separated by = or : characters.
  18 Multi-word values do not need quoting.
  19 .SH PARAMETERS
  20 These parameters are supported...
  21 .TP
  22 .B alert
  23 include local alert notices
  24 .TP
  25 .B atypes
  26 alert notification types to display
  27 .TP
  28 .B aurl
  29 alert URL (including %atype% and %zone%)
  30 .TP
  31 .B city
  32 the city name (ex: Raleigh Durham)
  33 .TP
  34 .B conditions
  35 output current conditions (possible values are False and True or 0 and 1)
  36 .TP
  37 .B flines
  38 maximum number of forecast lines to show (integer value, 0 means unlimited)
  39 .TP
  40 .B forecast
  41 include a local forecast (possible values are False and True or 0 and 1)
  42 .TP
  43 .B furl
  44 forecast URL (ex: http://forecast.org/%st%/%city%.txt)
  45 .TP
  46 .B headers
  47 the conditions headers to display (ex: temperature,wind)
  48 .TP
  49 .B id
  50 the METAR station ID (ex: KRDU)
  51 .TP
  52 .B imperial
  53 filter/convert for US/UK units
  54 .TP
  55 .B metric
  56 filter/convert for metric units
  57 .TP
  58 .B murl
  59 METAR URL (ex: http://metar.org/%id%.txt)
  60 .TP
  61 .B quiet
  62 skip preambles and don't indent (possible values are False and True or 0 and 1)
  63 .TP
  64 .B st
  65 the state abbreviation (ex: NC)
  66 .TP
  67 .B verbose
  68 show full decoded feeds (possible values are False and True or 0 and 1)
  69 .TP
  70 .B zones
  71 alert zones (ex: nc/ncc183,nc/ncz041)
  72 .SH URL FORMAT
  73 The placeholders %city% and %st% in the furl URL and %id% in the murl URL
  74 will be replaced with the city, st and id definitions respectively. If the
  75 placeholder has all letters lowercased, the replacement will be forced to
  76 all lowercase. If the placeholder has all letters uppercased, the
  77 replacement will be forced to all uppercase. If the placeholder has its
  78 first letter uppercased and the remainder lowercased, then all words in the
  79 replacement will start with an uppercase letter and the rest will be
  80 lowercase. If the placeholder has its last letter uppercased and the
  81 remainder lowercased, then case will be preserved in the replacement. Also,
  82 after replacement, any spaces in the resulting URL will be converted to
  83 underscore characters prior to use.
  84 .SH EXAMPLES
  85 Following is an example
  86 .B ~/.weatherrc
  87 defining the default settings to be used when running the utility with no
  88 aliases specified, and a couple definitions for aliases named home and
  89 work...
  90 .P
  91 .RS
  92 [default]
  93 .br
  94 City = Asheville
  95 .br
  96 Forecast = True
  97 .br
  98 ID = KAVL
  99 .br
 100 St = NC
 101 .P
 102 [home]
 103 .br
 104 City = Raleigh Durham
 105 .br
 106 ID = KRDU
 107 .br
 108 St = NC
 109 .P
 110 [work]
 111 .br
 112 City = Greensboro
 113 .br
 114 ID = KGSO
 115 .br
 116 St = NC
 117 .RE
 118 .SH SEE ALSO
 119 .BR weather (1)
 120 .SH AUTHOR
 121 Specification and manual written by Jeremy Stanley <fungi@yuggoth.org>.