ao-tools: Add ao-dumpflash program
[fw/altos] / ao-tools / ao-dumpflash / ao-dumpflash.1
1 .\"
2 .\" Copyright © 2013 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-DUMPFLASH 1 "ao-dumpflash" ""
20 .SH NAME
21 ao-dumpflash \- Fetch flash memory contents from AltOS device
22 .SH SYNOPSIS
23 .B "ao-dumpflash"
24 [\--tty \fItty-device\fP]
25 [\--device \fIaltos-device\fP]
26 [\--output \fIoutput-file\fP]
27 [\--remote\fP]
28 [\--frequency \fIfrequency\fP]
29 [\--call \fIcallsign\fP]
30 .SH OPTIONS
31 .TP
32 \-T tty-device | --tty tty-device
33 This selects which tty device ao-dumpflash uses to communicate with
34 the target device.
35 .TP
36 \-D AltOS-device | --device AltOS-device
37 Search for a connected device. This requires an argument of one of the
38 following forms:
39 .IP
40 TeleMetrum:2
41 .br
42 TeleMetrum
43 .br
44 2
45 .IP
46 Leaving out the product name will cause the tool to select a suitable
47 product, leaving out the serial number will cause the tool to match
48 one of the available devices.
49 .TP
50 \-o output-file | --output output-file
51 Write flash contents to the specified file rather than stdout.
52 .TP
53 \-R | --remote
54 This uses the command radio link to download the flash from TeleMetrum
55 through a TeleDongle.
56 .TP
57 \-F frequency | --frequency frequency
58 Specifies the radio frequency to use for remote communications in
59 kHz. Default is 434550.
60 .TP
61 \-C callsign | --call callsign
62 Specifies the callsign to use for remote communications. Default is N0CALL.
63 .SH DESCRIPTION
64 .I ao-dumpflash
65 downloads the entire flash memory contents from a connected AltOS device and writes
66 it to either stdout or the specified output file.
67 .SH USAGE
68 .I ao-dumpflash
69 connects to the specified target device and dumps the flash.
70 .SH AUTHOR
71 Keith Packard