diff --git a/CMakeLists.txt b/CMakeLists.txt index 6b6c7b306..bfa752d6b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -150,6 +150,11 @@ set(STLINK_SOURCE src/flash_loader.c ) +set(STLINK_MANPAGES + doc/man/stlink.1 +) + + if (WIN32 OR MSYS OR MINGW) set (STLINK_SOURCE "${STLINK_SOURCE};src/mmap.c;src/mingw/mingw.c") # TODO endif () @@ -224,6 +229,9 @@ install(FILES ${CMAKE_SOURCE_DIR}/include/stlink.h install(FILES ${STLINK_HEADERS} DESTINATION include/${CMAKE_LIBRARY_PATH}/stlink-${STLINK_PACKAGE_VERSION}/stlink) +install(FILES ${STLINK_MANPAGES} + DESTINATION share/man/man1) + if (NOT APPLE AND NOT WIN32) set(PKG_CONFIG_LIBDIR "\${prefix}/lib/\${deb_host_multiarch}" diff --git a/doc/man/.gitignore b/doc/man/.gitignore new file mode 100644 index 000000000..f7e585b87 --- /dev/null +++ b/doc/man/.gitignore @@ -0,0 +1 @@ +*.1 diff --git a/doc/man/Makefile b/doc/man/Makefile new file mode 100644 index 000000000..8871c6331 --- /dev/null +++ b/doc/man/Makefile @@ -0,0 +1,11 @@ +MAN1 = +MAN1 += st-util.md + +all: $(patsubst %.md, %.1, $(MAN1)) + +%.1: %.md + pandoc -s -t man $< -o $@ + tail --line=+3 $@ > tmp && mv tmp $@ + +clean: + rm *.1 diff --git a/doc/man/st-util.md b/doc/man/st-util.md new file mode 100644 index 000000000..8f015c806 --- /dev/null +++ b/doc/man/st-util.md @@ -0,0 +1,68 @@ +% ST-UTIL(1) Open Source STMicroelectronics Stlink Tools | STLINK +% +% Sep 2016 + + +# NAME +st-util - Run GDB server to interact with STM32 device + + +# SYNOPSIS +*st-util* \[\...] + + +# DESCRIPTION +Start a GDB server to interact with a STM32 device +Run the main binary of the local package (src/main.rs). + +If a port number is not specified using the **--listen_port** option, the +default **4242** port will be used. + +Stlink version 2 is used by default unless the option **--stlinkv1** is given. + +The STLINKv2 device to use can be specified in the environment +variable STLINK_DEVICE on the format :. + + +# OPTIONS + +-h, --help +: Print this message. + +-v *XX*, --verbose=XX +: Specify a specific verbosity level (0..99) + +-v, --verbose +: Specify generally verbose logging + +-s *X*, --stlink_version=X +: Choose what version of stlink to use, (defaults to 2) + +-1, --stlinkv1 +: Force stlink version 1 + +-p *4242*, --listen_port=1234 +: Set the gdb server listen port. (default port: 4242) + +-m, --multi +: Set gdb server to extended mode. st-util will continue listening for connections after disconnect. + +-n, --no-reset +: Do not reset board on connection. + + +# EXAMPLES +Run GDB server on port 4500 and connect to it + + $ st-util -p 4500 + $ gdb + (gdb) target extended-remote localhost:4500 + + +# SEE ALSO +st-flash(1), st-info(1), st-term(1) + + +# COPYRIGHT +This work is copyrighted. Stlink contributors. +See *LICENSE* file in the stlink source distribution.