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