]> Pileus Git - aweather/blob - docs/aweather.ad
ae5f1817aff874c4a0447c9a9a4ac706dd7fdb76
[aweather] / docs / aweather.ad
1 aweather(1)
2 ===========
3 Andy Spencer <andy753421@gmail.com>
4
5 NAME
6 ----
7 aweather - Advanced weather reporting program
8
9 SYNOPSIS
10 --------
11 *aweather* [*-aho*] [-d 'level'] [-s 'site']
12
13 DESCRIPTION
14 -----------
15 AWeather is a advanced weather reporting program which is designed to be used
16 by weather enthusiasts. AWeather is not another weather dockapp that simply
17 displays a pre-computed forecast. It is designed to be an easy to use program
18 that integrates a variety of weather data in simple unified interface; see
19 features for more details.
20
21 OPTIONS
22 -------
23 *-a*, *--auto*::
24         Auto update radar (todo)
25
26 *-h*, *--help*::
27         Show usage.
28
29 *-d*, *--debug*='level'::
30         Change default log level*, a debug level ranges from 0 to 7. A debug
31         level of 7 is recommended only for debugging purposes.
32
33 *-s*, *--site*='site'::
34         Set initial site. The site should be given as a WSR88D site code such
35         as KLSX. 
36
37 *-o*, *--offline*::
38         Run in offline mode, AWeather will not attempt to connect to the
39         internet to download radar files but will show the closest matching
40         cached file.
41
42 KEY BINDINGS
43 ------------
44 *h*, *j*, *k*, *l*::
45 *Left*, *Down*, *Up*, *Right*::
46         Pan the surface of the earth left, down, up, or right.
47
48 *i*, *o*::
49 *+*, *-*::
50 *Scroll up*, *Scroll down*::
51         Zoom towards or away from the surface of the earth.
52
53 *J*, *K*::
54         Zoom
55         Rotate the camera back or forward. If looking across the surface of the
56         earth, J will point the camera towards ground while K will point the
57         camera towards the sky.
58
59 *H*, *L*::
60         Rotate the counter clockwise or clockwise around the vertical axes. If
61         looking across the surface of the earth, H will pan to the left while L
62         will pan to the right.
63
64 *w*::
65         Draw a wire frame of the earth for debugging purposes.
66
67 *q*::
68         Exit AWeather.
69
70 *Tab*::
71         Cycle through available plugins.
72
73 *CTRL-R*::
74         Refresh all map data.
75
76 MOUSE MOTION
77 ------------
78 *Left-click and drag*::
79         Pan the surface of the earth.
80
81 *Middle-click and drag*::
82         Zoom towards (up) or away (down) from the surface of the earth.
83
84 *Right-click and drag*::
85         Rotate the camera around the vertical and horizontal axes.
86
87 EXAMPLES
88 --------
89 Start AWeather in offline mode and center the map on the St. Louis radar.::
90 `$ aweather -s KLSX -o`
91
92 SEE ALSO
93 --------
94 grits-demo(1)
95
96 BUGS
97 ----
98 Many