docs: fix a few typos
[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* [*-hoaf*] [-d 'level'] [-s 'site'] [-t 'time']
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 a simple unified interface; see
19 features for more details.
20
21 OPTIONS
22 -------
23 *-h*, *--help*::
24         Show usage.
25
26 *-d*, *--debug*='level'::
27         Change default log level*, a debug level ranges from 0 to 5. A debug
28         level of 5 is recommended only for debugging purposes.
29
30 *-s*, *--site*='site'::
31         Set initial site. The site should be given as a WSR88D site code such
32         as KLSX. 
33
34 *-t*, *--time*='time'::
35         Set initial time. The time format should be provided in the
36         *YYYY-MM-DD HH:MM* format.
37
38 *-o*, *--offline*::
39         Run in offline mode, AWeather will not attempt to connect to the
40         internet to download radar files but will show the closest matching
41         cached file.
42
43 *-a*, *--autoupdate*::
44         Run in autoupdate mode, AWeather will periodically poll data servers
45         for updated information.
46
47 *-f*, *--fullscreen*::
48         Run in fullscreen mode, AWeather start up using the entire screen as he
49         main display area. Toolbars and side panels are hidden by default and
50         can be accessed by moving the mouse to the edge of the screen.
51
52 KEY BINDINGS
53 ------------
54 *h*, *j*, *k*, *l*::
55 *Left*, *Down*, *Up*, *Right*::
56         Pan the surface of the earth left, down, up, or right.
57
58 *i*, *o*::
59 *+*, *-*::
60 *Scroll up*, *Scroll down*::
61         Zoom towards or away from the surface of the earth.
62
63 *J*, *K*::
64         Rotate the camera back or forward. If looking across the surface of the
65         earth, J will point the camera towards ground while K will point the
66         camera towards the sky.
67
68 *H*, *L*::
69         Rotate the counter clockwise or clockwise around the vertical axes. If
70         looking across the surface of the earth, H will pan to the left while L
71         will pan to the right.
72
73 *w*::
74         Draw a wire frame of the earth for debugging purposes.
75
76 *q*::
77         Exit AWeather.
78
79 *Tab*::
80         Cycle through available plugins.
81
82 *CTRL-R*::
83         Refresh all map data.
84
85 *F11*::
86         Toggle full screen mode
87
88 MOUSE MOTION
89 ------------
90 *Left-click and drag*::
91         Pan the surface of the earth.
92
93 *Middle-click and drag*::
94         Zoom towards (up) or away (down) from the surface of the earth.
95
96 *Right-click and drag*::
97         Rotate the camera around the vertical and horizontal axes.
98
99 EXAMPLES
100 --------
101 Start AWeather in offline mode and center the map on the St. Louis radar.::
102 `$ aweather -s KLSX -o`
103
104 SEE ALSO
105 --------
106 grits-demo(1)
107
108 BUGS
109 ----
110 Many