weatherrc.5

   1 .TH WEATHERRC 5 "March 26, 2006" "" \" -*- nroff -*-
   2 \" Copyright (c) 2006 Jeremy Stanley <fungi@yuggoth.org>, all rights reserved.
   3 \" Licensed per terms in the LICENSE file distributed with this software.
   4 .SH NAME
   5 weatherrc \- configuration file format for the
   6 .BR weather (1)
   7 utility
   8 .SH DESCRIPTION
   9 The weatherrc file format is intended to specify a set of macros
  10 by which to group a METAR station ID for current conditions data with a
  11 city/state combination for a forecast, but many of the other
  12 command\-line options and flags for the weather utility can be specified
  13 as well. The file is organized as an INI-format config, with the alias
  14 name in [] brackets and the associated parameter/value pairs on following
  15 lines. Parameters and their values as separated by = or : characters.
  16 Multi-word values do not need quoting.
  17 .SH PARAMETERS
  18 These parameters are supported...
  19 .TP
  20 .B city
  21 the city name (ex: Raleigh Durham)
  22 .TP
  23 .B forecast
  24 include a local forecast (possible values are False and True or 0 and 1)
  25 .TP
  26 .B id
  27 the METAR station ID (ex: KRDU)
  28 .TP
  29 .B conditions
  30 output current conditions (possible values are False and True or 0 and 1)
  31 .TP
  32 .B st
  33 the state abbreviation (ex: NC)
  34 .TP
  35 .B verbose
  36 show full decoded feeds (possible values are False and True or 0 and 1)
  37 .SH EXAMPLES
  38 Following is an example
  39 .B ~/.weatherrc
  40 defining the default settings to be used when running the utility with no
  41 aliases specified, and a couple definitions for aliases named home and
  42 work...
  43 .P
  44 .RS
  45 [default]
  46 .br
  47 City = Asheville
  48 .br
  49 Forecast = True
  50 .br
  51 ID = KAVL
  52 .br
  53 St = NC
  54 .P
  55 [home]
  56 .br
  57 City = Raleigh Durham
  58 .br
  59 ID = KRDU
  60 .br
  61 St = NC
  62 .P
  63 [work]
  64 .br
  65 City = Greensboro
  66 .br
  67 ID = KGSO
  68 .br
  69 St = NC
  70 .RE
  71 .SH SEE ALSO
  72 .BR weather (1)
  73 .SH AUTHOR
  74 Specification and manual written by Jeremy Stanley <fungi@yuggoth.org>.