Add user documentations

[aweather] / docs / aweather.ad

diff --git a/docs/aweather.ad b/docs/aweather.ad
new file mode 100644 (file)
index 0000000..c21c097
--- /dev/null
+++ b/docs/aweather.ad
@@ -0,0 +1,98 @@
+aweather(1)
+===========
+Andy Spencer <andy753421@gmail.com>
+
+NAME
+----
+aweather - Advanced weather reporting program
+
+SYNOPSIS
+--------
+*aweather* [*-aho*] [-d 'level'] [-s 'site']
+
+DESCRIPTION
+-----------
+AWeather is a advanced weather reporting program which is designed to be used
+by weather enthusiasts. AWeather is not another weather dockapp that simply
+displays a pre-computed forecast. It is designed to be an easy to use program
+that integrates a variety of weather data in simple unified interface; see
+features for more details.
+
+OPTIONS
+-------
+*-a*, *--auto*::
+       Auto update radar (todo)
+
+*-h*, *--help*::
+       Show usage.
+
+*-d*, *--debug*='level'::
+       Change default log level*, a debug level ranges from 0 to 7. A debug
+       level of 7 is recommended only for debugging purposes.
+
+*-s*, *--site*='site'::
+       Set initial site. The site should be given as a WSR88D site code such
+       as KLSX. 
+
+*-o*, *--offline*::
+       Run in offline mode, AWeather will not attempt to connect to the
+       internet to download radar files but will show the closest matching
+       cached file.
+
+KEY BINDINGS
+------------
+*h*, *j*, *k*, *l*::
+*Left*, *Down*, *Up*, *Right*::
+       Pan the surface of the earth left, down, up, or right.
+
+*i*, *o*::
+*+*, *-*::
+*Scroll up*, *Scroll down*::
+       Zoom towards or away from the surface of the earth.
+
+*J*, *K*::
+       Zoom
+       Rotate the camera back or forward. If looking across the surface of the
+       earth, J will point the camera towards ground while K will point the
+       camera towards the sky.
+
+*H*, *L*::
+       Rotate the counter clockwise or clockwise around the vertical axes. If
+       looking across the surface of the earth, H will pan to the left while L
+       will pan to the right.
+
+*w*::
+       Draw a wire frame of the earth for debugging purposes.
+
+*q*::
+       Exit AWeather.
+
+*Tab*::
+       Cycle through available plugins.
+
+*CTRL-R*::
+       Refresh all map data.
+
+MOUSE MOTION
+------------
+*Left-click and drag*::
+       Pan the surface of the earth.
+
+*Middle-click and drag*::
+       Zoom towards (up) or away (down) from the surface of the earth.
+
+*Right-click and drag*::
+       Rotate the camera around the vertical and horizontal axes.
+
+EXAMPLES
+--------
+Start AWeather in offline mode and center the map on the St. Louis radar.::
+`$ aweather -s KLSX -o`
+
+SEE ALSO
+--------
+gis-demo(1)
+
+BUGS
+----
+Many