ao-tools/ao-telem: Fix man page and usage to match code
authorKeith Packard <keithp@keithp.com>
Mon, 15 Jul 2019 20:28:11 +0000 (13:28 -0700)
committerKeith Packard <keithp@keithp.com>
Mon, 15 Jul 2019 20:28:11 +0000 (13:28 -0700)
ao-telem just parses .telem files.

Signed-off-by: Keith Packard <keithp@keithp.com>
ao-tools/ao-telem/ao-telem.1
ao-tools/ao-telem/ao-telem.c

index 8e6699d..83a27c2 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
index ea0aa8d..ee60712 100644 (file)
@@ -31,8 +31,7 @@ static const struct option options[] = {
 
 static void usage(char *program)
 {
-       fprintf(stderr, "usage: %s\n"
-               "\t{flight-log} ...\n", program);
+       fprintf(stderr, "usage: %s [--crc] {flight.telem} ...\n",program);
        exit(1);
 }