weather.1

   1 .TH WEATHER 1 "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 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 \-a, \-\-alert
  33 include local alert notices
  34 .TP
  35 .B \-\-atypes=ATYPES
  36 alert notification types to display
  37 .TP
  38 .B \-\-aurl=AURL
  39 alert URL (including %atype% and %zone%)
  40 .TP
  41 .B \-c CITY, \-\-city=CITY
  42 the city name (ex: "Raleigh Durham")
  43 .TP
  44 .B \-\-flines=FLINES
  45 maximum number of forecast lines to show
  46 .TP
  47 .B \-f, \-\-forecast
  48 include a local forecast
  49 .TP
  50 .B \-\-furl=FURL
  51 forecast URL (including %city% and %st%)
  52 .TP
  53 .B \-\-headers=HEADERS
  54 the conditions headers to display
  55 .TP
  56 .B \-i ID, \-\-id=ID
  57 the METAR station ID (ex: KRDU)
  58 .TP
  59 .B \-\-imperial
  60 filter/convert for US/UK units
  61 .TP
  62 .B \-l, \-\-list
  63 print a list of configured aliases
  64 .TP
  65 .B \-m, \-\-metric
  66 filter/convert for metric units
  67 .TP
  68 .B \-\-murl=MURL
  69 METAR URL (including %id%)
  70 .TP
  71 .B \-n, \-\-no\-conditions
  72 disable output of current conditions (forces \-f)
  73 .TP
  74 .B \-o, \-\-omit\-forecast
  75 omit the local forecast (cancels \-f)
  76 .TP
  77 .B \-\-quiet
  78 skip preambles and don't indent
  79 .TP
  80 .B \-s ST, \-\-st=ST
  81 the state abbreviation (ex: NC)
  82 .TP
  83 .B \-v, \-\-verbose
  84 show full decoded feeds (cancels \-q)
  85 .TP
  86 .B \-z ZONES, \-\-zones=ZONES
  87 alert zones (ex: nc/ncc183,nc/ncz041)
  88 .SH FILES
  89 .B weather
  90 may additionally obtain configuration data from a system\-wide
  91 configuration file, a per\-user configuration file, and a local
  92 directory configuration file. The file format and configuration options
  93 are described in
  94 .BR weatherrc (5) .
  95 They are aggregated in the following order:
  96 .TP
  97 .B /etc/weatherrc
  98 the system\-wide configuration
  99 .TP
 100 .B ~/.weatherrc
 101 the per\-user configuration (can be used to override the above)
 102 .TP
 103 .B ./weatherrc
 104 the local directory configuration (can be used to override the above)
 105 .SH EXAMPLES
 106 .TP
 107 .B weather
 108 View output for the defined default alias, or the built-in default values
 109 if there is no default alias defined in the configuration files.
 110 .TP
 111 .B weather -i kavl
 112 Display current conditions at the KAVL METAR station.
 113 .TP
 114 .B weather -n -c asheville -s nc
 115 See a forecast for the Asheville, NC area.
 116 .TP
 117 .B weather -fv gso
 118 Get the full decoded METAR for the station associated with the gso alias,
 119 and the forecast data for the city/state associated with the gso alias,
 120 without filtering or fancy formatting.
 121 .TP
 122 .B weather home work
 123 Show current conditions for both the home and work aliases in that order.
 124 .SH SEE ALSO
 125 .BR weatherrc (5)
 126 .SH AUTHOR
 127 Utility and manual written by Jeremy Stanley <fungi@yuggoth.org>.