stlink/doc/man/st-util.1

76 wiersze
1.7 KiB
Groff

.\" Automatically generated by Pandoc 2.4
.\"
.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
.SH SYNOPSIS
.PP
\f[I]st\-util\f[R] [<ARGS>\&...]
.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]\[en]listen_port\f[R]
option, the default \f[B]4242\f[R] port will be used.
.PP
Stlink version 2 is used by default unless the option
\f[B]\[en]stlinkv1\f[R] 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
Print this message.
.TP
.B \-\-version
Print version information
.TP
.B \-v \f[I]XX\f[R], \-\-verbose=XX
Specify a specific verbosity level (0..99)
.TP
.B \-v, \-\-verbose
Specify generally verbose logging
.TP
.B \-s \f[I]X\f[R], \-\-stlink_version=X
Choose what version of stlink to use, (defaults to 2)
.TP
.B \-1, \-\-stlinkv1
Force stlink version 1
.TP
.B \-p \f[I]4242\f[R], \-\-listen_port=1234
Set the gdb server listen port.
(default port: 4242)
.TP
.B \-m, \-\-multi
Set gdb server to extended mode.
st\-util will continue listening for connections after disconnect.
.TP
.B \-n, \-\-no\-reset
Do not reset board on connection.
.TP
.B \-\-semihosting
Enable ARM Semihosting output on stdout
.SH EXAMPLES
.PP
Run GDB server on port 4500 and connect to it
.IP
.nf
\f[C]
$ st\-util \-p 4500
$ gdb
(gdb) target extended\-remote localhost:4500
\f[R]
.fi
.SH SEE ALSO
.PP
st\-flash(1), st\-info(1)
.SH COPYRIGHT
.PP
This work is copyrighted.
Stlink contributors.
See \f[I]LICENSE\f[R] file in the stlink source distribution.