summaryrefslogtreecommitdiff
path: root/weather-2.3/README
blob: 375fb08a3e5bad200b2899b36091977f5296c3d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
===============================================
 General Information About the Weather Utility
===============================================

:Copyright: (c) 2006-2012 Jeremy Stanley <fungi@yuggoth.org>. Permission
            to use, copy, modify, and distribute this software is
            granted under terms provided in the LICENSE file distributed
            with this software.

.. contents::

What?
-----
This command-line utility is intended to provide quick access to current
weather conditions and forecasts. Presently, it is capable of returning
data for localities throughout the USA and some select locations
globally by retrieving and formatting decoded METARs (Meteorological
Aerodrome Reports) from NOAA (the USA National Oceanic and Atmospheric
Administration) and forecasts/alerts from NWS (the USA National Weather
Service). The tool is written to function in the same spirit as other
command-line informational utilities like cal(1), calendar(1) and
dict(1). It retrieves arbitrary weather data via precompiled
correlations or custom-tailored aliases (system-wide or on a per-user
basis). It can be freely used and redistributed under the terms of a
BSD-like License.

Why?
----
My girlfriend had a long commute to/from work and school, and often
wanted to check the weather both for home and her office. Unfortunately,
starting a Web browser, pulling up a weather site, entering multiple ZIP
codes and waiting for them to load is time-consuming for the
marginally-impatient. Since she tended to stay logged into a shell
server most of the time, I figured I'd install a quick command-line tool
to retrieve weather info for her commute. To my surprise, a quick search
turned up little that met my basic requirements:

 * retrieve current data on-demand
 * provide both current conditions and short-term forecasts
 * simple, human-readable output
 * easy to configure and use
 * flexible command-line switches and options

Where?
------
A tarball for the most recent version of the weather utility can be had
here:

 * http://fungi.yuggoth.org/weather/src/

Alternatively, Debian and Ubuntu users can install the weather-util
package from any mirror.