weather.1

   1 .TH WEATHER 1 "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 weather \- command\-line tool to obtain weather conditions and forecasts
   6 .SH SYNOPSIS
   7 .B weather [ options ] [ alias [ alias [...] ] ]
   8 .SH DESCRIPTION
   9 This utility is intended to provide quick access to current weather
  10 conditions and forecasts. Presently, it is capable of providing data for
  11 localities throughout the United States of America by retrieving and
  12 processing METAR data from the National Oceanic and Atmospheric
  13 Administration and forecasts from the National Weather Service. Behavior
  14 can be determined by command\-line options and specification of zero or
  15 more aliases. Aliases are defined in weatherrc files, as a convenient
  16 means of grouping option combinations together using a short name.
  17 Specifying multiple aliases on the command line causes the utility to
  18 output data for each, as if it had been invoked multiple times. If no
  19 alias is specified, then an alias of "default" is used (assuming it has
  20 been defined) or the built\-in default values are chosen (if it has not).
  21 .SH OPTIONS
  22 A summary of options is included below.
  23 .TP
  24 .B \-\-version
  25 show program's version number and exit
  26 .TP
  27 .B \-h, \-\-help
  28 show a help message and exit
  29 .TP
  30 .B \-cCITY, \-\-city=CITY
  31 the city name (ex: "Raleigh Durham")
  32 .TP
  33 .B \-f, \-\-forecast
  34 include a local forecast
  35 .TP
  36 .B \-iID, \-\-id=ID
  37 the METAR station ID (ex: KRDU)
  38 .TP
  39 .B \-l, \-\-list
  40 print a list of configured aliases
  41 .TP
  42 .B \-n, \-\-no\-conditions
  43 disable output of current conditions (forces \-f)
  44 .TP
  45 .B \-o, \-\-omit\-forecast
  46 omit the local forecast (cancels \-f)
  47 .TP
  48 .B \-sST, \-\-st=ST
  49 the state abbreviation (ex: NC)
  50 .TP
  51 .B \-v, \-\-verbose
  52 show full decoded feeds
  53 .SH FILES
  54 .B weather
  55 may additionally obtain configuration data from a system\-wide
  56 configuration file, a per\-user configuration file, and a local
  57 directory configuration file. The file format and configuration options
  58 are described in
  59 .BR weatherrc (5) .
  60 They are aggregated in the following order:
  61 .TP
  62 .B /etc/weatherrc
  63 the system\-wide configuration
  64 .TP
  65 .B ~/.weatherrc
  66 the per\-user configuration (can be used to override the above)
  67 .TP
  68 .B ./weatherrc
  69 the local directory configuration (can be used to override the above)
  70 .SH EXAMPLES
  71 .TP
  72 .B weather
  73 View output for the defined default alias, or the built-in default values
  74 if there is no default alias defined in the configuration files.
  75 .TP
  76 .B weather -i kavl
  77 Display current conditions at the KAVL METAR station.
  78 .TP
  79 .B weather -n -c asheville -s nc
  80 See a forecast for the Asheville, NC area.
  81 .TP
  82 .B weather -fv gso
  83 Get the full decoded METAR for the station associated with the gso alias,
  84 and the forecast data for the city/state associated with the gso alias,
  85 without filtering or fancy formatting.
  86 .TP
  87 .B weather home work
  88 Show current conditions for both the home and work aliases in that order.
  89 .SH SEE ALSO
  90 .BR weatherrc (5)
  91 .SH AUTHOR
  92 Utility and manual written by Jeremy Stanley <fungi@yuggoth.org>.