Remove trailing whitespace.
[dockapps.git] / wmWeather / Src / wmWeather.1
blob56ed778a16ff94536b4e4ed56c03d72b2cc74798
1 .TH WMWEATHER 1.1 "19 January 1999"
2 .SH NAME
3 WMWEATHER \- Dockable  Weather Monitor
4 .SH SYNOPSIS
5 .B wmWeather -station <4-char station ID> [-h] [-display <Display>] [-metric] [-kPa] [-hPa] [-mmHg] [-beaufort] [-mps] [-delay <Time in Minutes>] [-bc <color>] [-tc <color>] [-lc <color>] [-dc <color>] [-wgc <color>]
6 .SH DESCRIPTION
7 .PP
8 wmWeather monitors local weather conditions (temperature, Dew Point, Pressure,
9 Humidity and Wind direction and speed).  The user needs to specify a
10 4-character `METAR station identifier code'. (The standardized METAR station
11 designations and current weather reports are designed for use by the aviation
12 community. Since most major cities have at least one airport, there is usually
13 one or more METAR stations in a given city.) You (obviously) need to be
14 connected to the internet and you also need to have wget installed (most linux
15 systems should have it already).  wmWeather will then attempt to download the
16 latest METAR report for the station of your choice (from the National Weather
17 Sevice run by NOAA).
18 .PP
19 You can toggles back and forth between imperial and metric units. I.e. between
20 (degrees Fareheight, inches of Mercury, and miles per hour) and (degrees
21 Celsius, millimeters of Mercury, and kilometers per hour). Any key press will
22 do this.
23 .PP
24 Also, a left double click will bring up the fully decoded METAR report up in
25 xmessage. And a right double click will force an immediate update (i.e.
26 wmWeather will attempt to grab the weather information).
27 .PP
28 When the wind speed turns red, this means that the wind is gusty and the listed
29 value is an average only. Similarly, a red direction indicates a variable wind
30 direction and the value given is the average direction.
31 .PP
32 To find out more about the METAR/TAF system and to find the METAR code for your
33 location, look at http://www.nws.noaa.gov/oso/oso1/oso12/metar.htm for NOAA's
34 "National Weather Service METAR/TAF Information" page. To determine what your
35 station ID is use the lookup utility at:
36 http://www.nws.noaa.gov/oso/siteloc.shtml.
37 .SH OPTIONS
38 .TP
39 .B \-h
40 Display list of command-line options.
41 .TP
42 .B \-display <display>
43 Use an alternate X Display.
44 .TP
45 .B \-station <4-char station ID> (or \-s <4-char station ID>)
46 This option tells wmWeather which METAR station to show data for.
47 .TP
48 .B \-metric (or \-m)
49 Display temperatures in degrees Celsius.
50 .TP
51 .B \-kPa
52 When toggled to Celsius, display  pressure in units of kPa.
53 .TP
54 .B \-hPa
55 When toggled to Celsius, display  pressure in units of hPa (i.e. milliBars).
56 .TP
57 .B \-mmHg
58 When toggled to Celsius, display  pressure in units of millimeters of Mercury. (This is
59 the default for Celsius when no other units are specified).
60 .TP
61 .B \-beaufort
62 When toggled to Celsius, display wind speeds on the "beaufort scale".
63 .TP
64 .B \-mps
65 When toggled to metric display, show windspeed in units of meters/second.
66 .TP
67 .B \-delay <Time in Minutes>
68 Override time (in minutes) between updates (default is 15 minutes). (Times are approximate.)
69 .TP
70 .B \-lc <color>
71 Set the color of the labels. (E.g. -lc red or -lc salmon or -lc #4523ff).
72 .TP
73 .B \-bc <color>
74 Set the background color. (#8e8e69 is LCD-ish).
75 .TP
76 .B \-dc <color>
77 Set the color of the data entries.
78 .TP
79 .B \-tc <color>
80 Set the color of the station ID/update time header.
81 .TP
82 .B \-wgc <color>
83 Set the gusty-wind/variable-direction color. The wind speed indicator will turn
84 this color when the wind speed is gusty. (The value shown in this case is the
85 average speed).  Similarly, the wind direction indicator with change to this
86 color when the wind direction is variable. (The value shown in this case is the
87 average direction).
88 .SH BUGS
89 Let me know if/when you find any.
90 .SH NOTES
91 Requires that a (fairly recent) version of wget be installed on your machine.
92 You can download wget from "http://sunsite.auc.dk/wget/".
93 .SH AUTHOR
94 Michael G. Henderson <mghenderson@lanl.gov>