weather.1

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