From: Keith Packard Date: Thu, 19 Dec 2013 05:02:15 +0000 (-0800) Subject: ao-tools: Add man pages for ao-flash utilities X-Git-Tag: 1.3~9 X-Git-Url: https://git.gag.com/?p=fw%2Faltos;a=commitdiff_plain;h=2b2ba87d5f68b9e052dddd49d69341f36d777122 ao-tools: Add man pages for ao-flash utilities These aren't very wordy, but these tools are pretty simple scripts. Signed-off-by: Keith Packard --- diff --git a/ao-tools/ao-flash/Makefile.am b/ao-tools/ao-flash/Makefile.am index 97dc91cd..6b7ea6bb 100644 --- a/ao-tools/ao-flash/Makefile.am +++ b/ao-tools/ao-flash/Makefile.am @@ -1 +1,3 @@ -bin_SCRIPTS=ao-flash-stm ao-flash-lpc \ No newline at end of file +bin_SCRIPTS=ao-flash-stm ao-flash-lpc + +man_MANS = ao-flash-stm.1 ao-flash-lpc.1 \ No newline at end of file diff --git a/ao-tools/ao-flash/ao-flash-lpc.1 b/ao-tools/ao-flash/ao-flash-lpc.1 new file mode 100644 index 00000000..46312030 --- /dev/null +++ b/ao-tools/ao-flash/ao-flash-lpc.1 @@ -0,0 +1,36 @@ +.\" +.\" Copyright © 2013 Keith Packard +.\" +.\" 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 AO-FLASH-LPC 1 "ao-flash-lpc" "" +.SH NAME +ao-flash-lpc \- flash a program to an LPC11U14-based AltOS device using openocd +.SH SYNOPSIS +.B "ao-flash-lpc" +\fIfile.elf\fP +.SH DESCRIPTION +.I ao-flash-lpc +loads the specified .elf file into the target device flash memory. +.SH USAGE +.I ao-flash-lpc +is a simple script that passes the correct arguments to openocd to +load a file into the target device via a connected STlink +debugging dongle. +.SH "SEE ALSO" +openocd(1) +.SH AUTHOR +Keith Packard diff --git a/ao-tools/ao-flash/ao-flash-stm.1 b/ao-tools/ao-flash/ao-flash-stm.1 new file mode 100644 index 00000000..81aa5927 --- /dev/null +++ b/ao-tools/ao-flash/ao-flash-stm.1 @@ -0,0 +1,38 @@ +.\" +.\" Copyright © 2013 Keith Packard +.\" +.\" 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 AO-FLASH-STM 1 "ao-flash-stm" "" +.SH NAME +ao-flash-stm \- flash a program to an STM32-based AltOS device using st-flash +.SH SYNOPSIS +.B "ao-flash-stm" +\fIfile.elf\fP +.SH DESCRIPTION +.I ao-flash-stm +loads the specified .elf file into the target device flash memory. +.SH USAGE +.I ao-flash-stm +converts the specified .elf file into a raw binary file and then uses +st-flash to load it into the target device via a connected STlink +debugging dongle. If st-flash is not available, +.I ao-flash-stm +will emit an error message and terminate. +.SH "SEE ALSO" +st-flash(1) +.SH AUTHOR +Keith Packard