From c8dbc0adb3a5788c498ab45cd04bee40ed3fd060 Mon Sep 17 00:00:00 2001 From: Jerry Jacobs Date: Thu, 1 Mar 2018 11:40:10 +0100 Subject: [PATCH] doc/man: Fix reference to non-exisiting st-term tool. Fixes #676. --- doc/man/st-flash.1 | 44 ++++++++++++++++++++++++++------------------ doc/man/st-flash.md | 4 ++-- doc/man/st-info.1 | 32 ++++++++++++++++++-------------- doc/man/st-info.md | 5 ++--- doc/man/st-util.1 | 39 +++++++++++++++++++++------------------ doc/man/st-util.md | 4 ++-- 6 files changed, 71 insertions(+), 57 deletions(-) diff --git a/doc/man/st-flash.1 b/doc/man/st-flash.1 index 77a8bb550..5a36354e9 100644 --- a/doc/man/st-flash.1 +++ b/doc/man/st-flash.1 @@ -1,18 +1,21 @@ -.TH ST-FLASH 1 "Sep 2016" "Open Source STMicroelectronics Stlink Tools" "STLINK" +.\" Automatically generated by Pandoc 2.1.1 +.\" +.TH "st\-flash" "1" "Feb 2018" "Open Source STMicroelectronics Stlink Tools" "stlink" +.hy .SH NAME .PP -st-flash - Flash binary files to STM32 device +st\-flash \- Flash binary files to STM32 device .SH SYNOPSIS .PP -\f[I]st-flash\f[] [\f[I]OPTIONS\f[]] {read|write|erase} [\f[I]FILE\f[]] +\f[I]st\-flash\f[] [\f[I]OPTIONS\f[]] {read|write|erase} [\f[I]FILE\f[]] .SH DESCRIPTION .PP Flash binary files to arbitrary sections of memory, or read arbitrary addresses of memory out to a binary file. .PP -You can use this instead of st-util(1) if you prefer, but remember to -use the \f[B]\&.bin\f[] image, rather than the \f[B]\&.elf\f[] file. +You can use this instead of st\-util(1) if you prefer, but remember to +use the \f[B].bin\f[] image, rather than the \f[B].elf\f[] file. .PP Use hexadecimal format for the \f[I]ADDR\f[] and \f[I]SIZE\f[]. .SH COMMANDS @@ -32,33 +35,38 @@ Read firmware from device starting from \f[I]ADDR\f[] up to Perform a mass erasing of the device firmware .RS .RE +.TP +.B reset +Reset the target +.RS +.RE .SH OPTIONS .TP -.B --version +.B \[en]version Print version information .RS .RE .TP -.B --debug +.B \[en]debug TODO .RS .RE .TP -.B --reset +.B \[en]reset TODO .RS .RE .TP -.B --serial \f[I]iSerial\f[] +.B \[en]serial \f[I]iSerial\f[] TODO .RS .RE .TP -.B --flash=\f[I]size\f[] -Override the device's normal flash size, where size is the flash size in bytes. -It can be specified in decimal, octal or hexadecimal. -The size argument can optionally be followed by 'k' for KB or 'm' for MB. -Examples --flash=128k or --flash=0x080k. +.B \[en]flash=fsize +Where fsize is the size in decimal, octal, or hex followed by an +optional multiplier `k' for KB, or `m' for MB. +Use a leading \[lq]0x\[rq] to specify hexadecimal, or a leading zero for +octal. .RS .RE .SH EXAMPLES @@ -67,7 +75,7 @@ Flash \f[C]firmware.bin\f[] to device .IP .nf \f[C] -$\ st-flash\ write\ firmware.bin\ 0x8000000 +$\ st\-flash\ write\ firmware.bin\ 0x8000000 \f[] .fi .PP @@ -75,7 +83,7 @@ Read firmware from device (4096 bytes) .IP .nf \f[C] -$\ st-flash\ read\ firmware.bin\ 0x8000000\ 4096 +$\ st\-flash\ read\ firmware.bin\ 0x8000000\ 4096 \f[] .fi .PP @@ -83,12 +91,12 @@ Erase firmware from device .IP .nf \f[C] -$\ st-flash\ erase +$\ st\-flash\ erase \f[] .fi .SH SEE ALSO .PP -st-util(1), st-info(1), st-term(1) +st\-util(1), st\-info(1) .SH COPYRIGHT .PP This work is copyrighted. diff --git a/doc/man/st-flash.md b/doc/man/st-flash.md index d1844976c..0ac9b111f 100644 --- a/doc/man/st-flash.md +++ b/doc/man/st-flash.md @@ -1,6 +1,6 @@ -% ST-FLASH(1) Open Source STMicroelectronics Stlink Tools | STLINK +% st-flash(1) Open Source STMicroelectronics Stlink Tools | stlink % -% Sep 2016 +% Feb 2018 # NAME diff --git a/doc/man/st-info.1 b/doc/man/st-info.1 index 8576d39e4..a774d3ade 100644 --- a/doc/man/st-info.1 +++ b/doc/man/st-info.1 @@ -1,10 +1,14 @@ -.TH ST-INFO 1 "Sep 2016" "Open Source STMicroelectronics Stlink Tools" "STLINK" +.\" Automatically generated by Pandoc 2.1.1 +.\" +.TH "st\-flash" "1" "Feb 2018" "Open Source STMicroelectronics Stlink Tools" "stlink" +.hy .SH NAME .PP -st-info - Provides information about connected STLink and STM32 devices +st\-info \- Provides information about connected STLink and STM32 +devices .SH SYNOPSIS .PP -\f[I]st-info\f[] [\f[I]OPTIONS\f[]] +\f[I]st\-info\f[] [\f[I]OPTIONS\f[]] .SH DESCRIPTION .PP Provides information about connected STLink programmers and STM32 @@ -12,47 +16,47 @@ devices: Serial code, openocd, flash, sram, page size, chipid, description. .SH OPTIONS .TP -.B --version +.B \[en]version Print version information .RS .RE .TP -.B --flash +.B \[en]flash Display amount of flash memory available in the device .RS .RE .TP -.B --sram +.B \[en]sram Display amount of sram memory available in device .RS .RE .TP -.B --descr +.B \[en]descr Display textual description of the device .RS .RE .TP -.B --pagesize +.B \[en]pagesize Display the page size of the device .RS .RE .TP -.B --chipid +.B \[en]chipid Display the chip ID of the device .RS .RE .TP -.B --serial +.B \[en]serial Display the serial code of the device .RS .RE .TP -.B --hla-serial +.B \[en]hla\-serial Display the hex escaped serial code of the device .RS .RE .TP -.B --probe +.B \[en]probe Display the summarized information of the connected programmers and devices .RS @@ -63,12 +67,12 @@ Display information about connected programmers and devices .IP .nf \f[C] -$\ st-info\ --probe +$\ st\-info\ \-\-probe \f[] .fi .SH SEE ALSO .PP -st-util(1), st-flash(1), st-term(1) +st\-util(1), st\-flash(1) .SH COPYRIGHT .PP This work is copyrighted. diff --git a/doc/man/st-info.md b/doc/man/st-info.md index 62d7c5ce1..1a0773e74 100644 --- a/doc/man/st-info.md +++ b/doc/man/st-info.md @@ -1,7 +1,6 @@ -% ST-INFO(1) Open Source STMicroelectronics Stlink Tools | STLINK +% st-flash(1) Open Source STMicroelectronics Stlink Tools | stlink % -% Sep 2016 - +% Feb 2018 # NAME st-info - Provides information about connected STLink and STM32 devices diff --git a/doc/man/st-util.1 b/doc/man/st-util.1 index 8fb791221..6796bda23 100644 --- a/doc/man/st-util.1 +++ b/doc/man/st-util.1 @@ -1,68 +1,71 @@ -.TH ST-UTIL 1 "Sep 2016" "Open Source STMicroelectronics Stlink Tools" "STLINK" +.\" Automatically generated by Pandoc 2.1.1 +.\" +.TH "st\-util" "1" "Feb 2018" "Open Source STMicroelectronics Stlink Tools" "stlink" +.hy .SH NAME .PP -st-util - Run GDB server to interact with STM32 device +st\-util \- Run GDB server to interact with STM32 device .SH SYNOPSIS .PP -\f[I]st-util\f[] [...] +\f[I]st\-util\f[] [\&...] .SH DESCRIPTION .PP Start a GDB server to interact with a STM32 device Run the main binary of the local package (src/main.rs). .PP -If a port number is not specified using the \f[B]--listen_port\f[] +If a port number is not specified using the \f[B]\[en]listen_port\f[] option, the default \f[B]4242\f[] port will be used. .PP Stlink version 2 is used by default unless the option -\f[B]--stlinkv1\f[] is given. +\f[B]\[en]stlinkv1\f[] is given. .PP The STLinkV2 device to use can be specified in the environment variable STLINK_DEVICE on the format :. .SH OPTIONS .TP -.B -h, --help +.B \-h, \[en]help Print this message. .RS .RE .TP -.B --version +.B \[en]version Print version information .RS .RE .TP -.B -v \f[I]XX\f[], --verbose=XX +.B \-v \f[I]XX\f[], \[en]verbose=XX Specify a specific verbosity level (0..99) .RS .RE .TP -.B -v, --verbose +.B \-v, \[en]verbose Specify generally verbose logging .RS .RE .TP -.B -s \f[I]X\f[], --stlink_version=X +.B \-s \f[I]X\f[], \[en]stlink_version=X Choose what version of stlink to use, (defaults to 2) .RS .RE .TP -.B -1, --stlinkv1 +.B \-1, \[en]stlinkv1 Force stlink version 1 .RS .RE .TP -.B -p \f[I]4242\f[], --listen_port=1234 +.B \-p \f[I]4242\f[], \[en]listen_port=1234 Set the gdb server listen port. (default port: 4242) .RS .RE .TP -.B -m, --multi +.B \-m, \[en]multi Set gdb server to extended mode. -st-util will continue listening for connections after disconnect. +st\-util will continue listening for connections after disconnect. .RS .RE .TP -.B -n, --no-reset +.B \-n, \[en]no\-reset Do not reset board on connection. .RS .RE @@ -72,14 +75,14 @@ Run GDB server on port 4500 and connect to it .IP .nf \f[C] -$\ st-util\ -p\ 4500 +$\ st\-util\ \-p\ 4500 $\ gdb -(gdb)\ target\ extended-remote\ localhost:4500 +(gdb)\ target\ extended\-remote\ localhost:4500 \f[] .fi .SH SEE ALSO .PP -st-flash(1), st-info(1), st-term(1) +st\-flash(1), st\-info(1) .SH COPYRIGHT .PP This work is copyrighted. diff --git a/doc/man/st-util.md b/doc/man/st-util.md index fd744d825..325f84206 100644 --- a/doc/man/st-util.md +++ b/doc/man/st-util.md @@ -1,6 +1,6 @@ -% ST-UTIL(1) Open Source STMicroelectronics Stlink Tools | STLINK +% st-util(1) Open Source STMicroelectronics Stlink Tools | stlink % -% Sep 2016 +% Feb 2018 # NAME