micropeak: Add micropeak man page
[fw/altos] / micropeak / micropeak.1
diff --git a/micropeak/micropeak.1 b/micropeak/micropeak.1
new file mode 100644 (file)
index 0000000..ed2c77e
--- /dev/null
@@ -0,0 +1,43 @@
+.\"
+.\" Copyright © 2013 Keith Packard <keithp@keithp.com>
+.\"
+.\" This program is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+.\" General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License along
+.\" with this program; if not, write to the Free Software Foundation, Inc.,
+.\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+.\"
+.\"
+.TH MICROPEAK 1 "micropeak" ""
+.SH NAME
+micropeak \- MicroPeak logging altimeter download and analysis
+.SH SYNOPSIS
+.B "micropeak"
+.SH DESCRIPTION
+.I micropeak
+connects to a MicroPeak USB adapter for MicroPeak data download.
+It provides a menu-oriented
+user interface to download and analyze data logged on a MicroPeak
+altimeter.
+.SH USAGE
+When connected to a MicroPeak USB adapter,
+.I micropeak 
+can download data from a MicroPeak device, save it to a file and graph
+data from saved files.
+.P
+A number of other menu options exist, including the ability to export flight
+data in different formats.
+.SH FILES
+All data log files are recorded into a user-specified directory
+(default ~/AltusMetrum). Files are named using the current date and a
+unique flight number with a '.mpd' extension.
+.SH AUTHOR
+Keith Packard