weatherrc.5

   1 .TH WEATHERRC 5 "July 13, 2008" "" \" -*- nroff -*-
   2 \" Copyright (c) 2006-2008 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 city
  23 the city name (ex: Raleigh Durham)
  24 .TP
  25 .B conditions
  26 output current conditions (possible values are False and True or 0 and 1)
  27 .TP
  28 .B flines
  29 maximum number of forecast lines to show (integer value, 0 means unlimited)
  30 .TP
  31 .B forecast
  32 include a local forecast (possible values are False and True or 0 and 1)
  33 .TP
  34 .B furl
  35 forecast URL (ex: http://forecast.org/%st%/%city%.txt)
  36 .TP
  37 .B headers
  38 the conditions headers to display (ex: temperature,wind)
  39 .TP
  40 .B id
  41 the METAR station ID (ex: KRDU)
  42 .TP
  43 .B murl
  44 METAR URL (ex: http://metar.org/%id%.txt)
  45 .TP
  46 .B quiet
  47 skip preambles and don't indent (possible values are False and True or 0 and 1)
  48 .TP
  49 .B st
  50 the state abbreviation (ex: NC)
  51 .TP
  52 .B verbose
  53 show full decoded feeds (possible values are False and True or 0 and 1)
  54 .SH URL FORMAT
  55 The placeholders %city% and %st% in the furl URL and %id% in the murl URL
  56 will be replaced with the city, st and id definitions respectively. If the
  57 placeholder has all letters lowercased, the replacement will be forced to
  58 all lowercase. If the placeholder has all letters uppercased, the
  59 replacement will be forced to all uppercase. If the placeholder has its
  60 first letter uppercased and the remainder lowercased, then all words in the
  61 replacement will start with an uppercase letter and the rest will be
  62 lowercase. If the placeholder has its last letter uppercased and the
  63 remainder lowercased, then case will be preserved in the replacement. Also,
  64 after replacement, any spaces in the resulting URL will be converted to
  65 underscore characters prior to use.
  66 .SH EXAMPLES
  67 Following is an example
  68 .B ~/.weatherrc
  69 defining the default settings to be used when running the utility with no
  70 aliases specified, and a couple definitions for aliases named home and
  71 work...
  72 .P
  73 .RS
  74 [default]
  75 .br
  76 City = Asheville
  77 .br
  78 Forecast = True
  79 .br
  80 ID = KAVL
  81 .br
  82 St = NC
  83 .P
  84 [home]
  85 .br
  86 City = Raleigh Durham
  87 .br
  88 ID = KRDU
  89 .br
  90 St = NC
  91 .P
  92 [work]
  93 .br
  94 City = Greensboro
  95 .br
  96 ID = KGSO
  97 .br
  98 St = NC
  99 .RE
 100 .SH SEE ALSO
 101 .BR weather (1)
 102 .SH AUTHOR
 103 Specification and manual written by Jeremy Stanley <fungi@yuggoth.org>.