From 759f423987b89610546f55bb053db4c30c600543 Mon Sep 17 00:00:00 2001 From: "Daniel Campoverde [alx741]" Date: Thu, 15 Sep 2016 18:18:45 -0500 Subject: [PATCH] Add st-info man page --- doc/man/CMakeLists.txt | 1 + doc/man/st-info.md | 58 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 doc/man/st-info.md diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt index baf482e..795b6fa 100644 --- a/doc/man/CMakeLists.txt +++ b/doc/man/CMakeLists.txt @@ -1,6 +1,7 @@ set(MANPAGES st-util st-flash + st-info ) # Only generate manpages with pandoc in Debug builds diff --git a/doc/man/st-info.md b/doc/man/st-info.md new file mode 100644 index 0000000..9cc48e9 --- /dev/null +++ b/doc/man/st-info.md @@ -0,0 +1,58 @@ +% ST-INFO(1) Open Source STMicroelectronics Stlink Tools | STLINK +% +% Sep 2016 + + +# NAME +st-info - Provides information about connected STLINK and STM32 devices + + +# SYNOPSIS +*st-info* \[*OPTIONS*\] + + +# DESCRIPTION +Provides information about connected STLINK programmers and STM32 devices: +Serial code, openocd, flash, sram, page size, chipid, description. + + +# OPTIONS + +--flash +: Display amount of flash memory available in the device + +--sram +: Display amount of sram memory available in device + +--descr +: Display textual description of the device + +--pagesize +: Display the page size of the device + +--chipid +: Display the chip ID of the device + +--serial +: Display the serial code of the device + +--hla-serial +: Display the hex escaped serial code of the device + +--probe +: Display the summarized information of the connected programmers and devices + + +# EXAMPLES +Display information about connected programmers and devices + + $ st-info --probe + + +# SEE ALSO +st-util(1), st-flash(1), st-term(1) + + +# COPYRIGHT +This work is copyrighted. Stlink contributors. +See *LICENSE* file in the stlink source distribution.