Change altos build process to support per-product compile-time changes
[fw/altos] / ao-tools / ao-dumplog / ao-dumplog.1
1 .\"
2 .\" Copyright © 2009 Keith Packard <keithp@keithp.com>
3 .\"
4 .\" This program is free software; you can redistribute it and/or modify
5 .\" it under the terms of the GNU General Public License as published by
6 .\" the Free Software Foundation; either version 2 of the License, or
7 .\" (at your option) any later version.
8 .\"
9 .\" This program is distributed in the hope that it will be useful, but
10 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 .\" General Public License for more details.
13 .\"
14 .\" You should have received a copy of the GNU General Public License along
15 .\" with this program; if not, write to the Free Software Foundation, Inc.,
16 .\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
17 .\"
18 .\"
19 .TH AO-DUMPLOG 1 "ao-dumplog" ""
20 .SH NAME
21 ao-dumplog \- Store flight log from TeleMetrum device
22 .SH SYNOPSIS
23 .B "ao-dumplog"
24 [\-T \fItty-device\fP]
25 [\--tty \fItty-device\fP]
26 [\-D \fIaltos-device\fP]
27 [\--device \fIaltos-device\fP]
28 .SH OPTIONS
29 .TP
30 \-T tty-device | --tty tty-device
31 This selects which tty device ao-dumplog uses to communicate with
32 the target device.
33 .TP
34 \-D AltOS-device | --device AltOS-device
35 Search for a connected device. This requires an argument of one of the
36 following forms:
37 .IP
38 TeleMetrum:2
39 .br
40 TeleMetrum
41 .br
42 2
43 .IP
44 Leaving out the product name will cause the tool to select a suitable
45 product, leaving out the serial number will cause the tool to match
46 one of the available devices.
47 .SH DESCRIPTION
48 .I ao-dumplog
49 downloads the flight log from a connected TeleMetrum device and stores
50 it to the configured flight log directory using a name of the form
51 .IP
52 \fIyyyy\fP-\fImm\fP-\fIdd\fP-serialP-\fIsss\fP-flight-\fIfff\fP.eeprom
53 .PP
54 \fIyyyy\fP is the current year
55 .br
56 \fImm\fP is the current month
57 .br
58 \fIdd\fP is the current day
59 .br
60 \fIsss\fP is the device serial number
61 .br
62 \fIfff\fP is a flight sequence number (to make filenames unique)
63 .SH USAGE
64 .I ao-dumplog
65 connects to the specified target device and dumps the stored flight
66 log.
67 .SH AUTHOR
68 Keith Packard