ao-tools/ao-telem: Fix man page and usage to match code
[fw/altos] / ao-tools / ao-telem / ao-telem.1
index 8e6699d5ad3c87090906be32d6eedae7c58535a6..83a27c242819fdd866b01c90c3d581f9d087f299 100644 (file)
 .\"
 .TH AO-TELEM 1 "ao-telem" ""
 .SH NAME
-ao-telem \- Analyse a flight log (either telemetry or eeprom)
+ao-telem \- Analyze a telemetry log
 .SH SYNOPSIS
 .B "ao-telem"
-[\-s <summary-file>]
-[\--summary=<summary-file>]
-[\-d <detail-file>]
-[\--detail=<detail-file>]
-[\-r <raw-file>]
-[\--raw=<raw-file>]
-[\-p <plot-file>]
-[\--plot=<plot-file>]
-[\-g <gps-file]
-[\--gps=<gps-file]
-[\-k <kml-file]
-[\--kml=<kml-file]
-{flight.eeprom|flight.telem}
+[\--crc]
+{flight.telem} ...
+.SH OPTIONS
+.TP
+\-c | --crc
+This option makes ao-telem analyze records with CRC errors. By
+default, these records are skipped.
 .SH DESCRIPTION
 .I ao-telem
-reads the specified flight log and produces several different kinds of
-output.
-.IP Summary
-By default, summary information is shown on stdout. With the --summary
-option, it can be redirected to a file.
-.IP Detail
-When requested with the --detail option, a filtered version of the
-flight position, speed and acceleration are written to the specified
-file.
-.IP Raw
-The --raw option writes the unfiltered, but converted acceleration
-and height data to the specified file.
-.IP Plot
-The --plot option writes plots of height, speed and acceleration to
-the specified file in .svg format
-.IP GPS
-The --gps option writes the recorded GPS data to the specified file in
-three columns.
-.IP KML
-The --kml option writes the recorded GPS data to the specified file in
-Keyhole Markup Language format, which can be displayed in Googleearth.
+reads the specified telemetry log and display the contents of each
+record.
 .SH AUTHOR
 Keith Packard