From 20796586f12c8341fde710f493ebe203daf29f7e Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Mon, 30 May 2016 12:44:33 -0700 Subject: [PATCH] initial man pages --- st-flash.1 | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ st-info.1 | 41 +++++++++++++++++++++++++++++++++++++++++ st-term.1 | 40 ++++++++++++++++++++++++++++++++++++++++ st-util.1 | 38 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 169 insertions(+) create mode 100644 st-flash.1 create mode 100644 st-info.1 create mode 100644 st-term.1 create mode 100644 st-util.1 diff --git a/st-flash.1 b/st-flash.1 new file mode 100644 index 0000000..ee1130e --- /dev/null +++ b/st-flash.1 @@ -0,0 +1,50 @@ +.\" (C) Copyright 2013 Keith Packard , +.\" +.\"Redistribution and use in source and binary forms, with or without +.\"modification, are permitted provided that the following conditions are +.\"met: +.\" +.\" * Redistributions of source code must retain the above copyright +.\"notice, this list of conditions and the following disclaimer. +.\" * Redistributions in binary form must reproduce the above +.\"copyright notice, this list of conditions and the following disclaimer +.\"in the documentation and/or other materials provided with the +.\"distribution. +.\" * Neither the name of Martin Capitanio nor the names of its +.\"contributors may be used to endorse or promote products derived from +.\"this software without specific prior written permission. +.\" +.\"THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +.\""AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +.\"LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +.\"A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +.\"OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +.\"SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +.\"LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\"DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\"THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\"(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +.\"OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.TH ST-FLASH 1 "st-flash" "" +.SH NAME +st-flash \- flash STM devices via STlink +.SH SYNOPSIS +.B st-flash +.RI (v1 devices) [--reset] {read|write} " /dev/sgX path addr " +.br +.B st-flash +.RI (v1 devices) " /dev/sgX erase" +.br +.B st-flash +.RI (v2 devices) [--reset] {read|write} " path addr " +.br +.B st-flash +.RI (v2 devices) [--reset] {read|write} " erase" +.SH DESCRIPTION +This manual page documents briefly the +st-flash command +.SH SEE ALSO +.BR st-util (1), +.BR st-term (1), +.BR st-info (1). diff --git a/st-info.1 b/st-info.1 new file mode 100644 index 0000000..4fe2182 --- /dev/null +++ b/st-info.1 @@ -0,0 +1,41 @@ +.\" (C) Copyright 2013 Keith Packard , +.\" +.\"Redistribution and use in source and binary forms, with or without +.\"modification, are permitted provided that the following conditions are +.\"met: +.\" +.\" * Redistributions of source code must retain the above copyright +.\"notice, this list of conditions and the following disclaimer. +.\" * Redistributions in binary form must reproduce the above +.\"copyright notice, this list of conditions and the following disclaimer +.\"in the documentation and/or other materials provided with the +.\"distribution. +.\" * Neither the name of Martin Capitanio nor the names of its +.\"contributors may be used to endorse or promote products derived from +.\"this software without specific prior written permission. +.\" +.\"THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +.\""AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +.\"LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +.\"A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +.\"OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +.\"SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +.\"LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\"DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\"THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\"(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +.\"OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.TH ST-INFO 1 "st-info" "" +.SH NAME +st-info \- get information about STM cpu via STlink device +.SH SYNOPSIS +.B st-info +.RI [--flash] [--sram] [--descr] [--pagesize] [--chipid] +.SH DESCRIPTION +This manual page documents briefly the +st-info command +.SH SEE ALSO +.BR st-flash (1), +.BR st-util (1), +.BR st-term (1). diff --git a/st-term.1 b/st-term.1 new file mode 100644 index 0000000..1b1f1d7 --- /dev/null +++ b/st-term.1 @@ -0,0 +1,40 @@ +.\" (C) Copyright 2013 Keith Packard , +.\" +.\"Redistribution and use in source and binary forms, with or without +.\"modification, are permitted provided that the following conditions are +.\"met: +.\" +.\" * Redistributions of source code must retain the above copyright +.\"notice, this list of conditions and the following disclaimer. +.\" * Redistributions in binary form must reproduce the above +.\"copyright notice, this list of conditions and the following disclaimer +.\"in the documentation and/or other materials provided with the +.\"distribution. +.\" * Neither the name of Martin Capitanio nor the names of its +.\"contributors may be used to endorse or promote products derived from +.\"this software without specific prior written permission. +.\" +.\"THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +.\""AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +.\"LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +.\"A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +.\"OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +.\"SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +.\"LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\"DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\"THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\"(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +.\"OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.TH ST-TERM 1 "st-term" "" +.SH NAME +st-term \- ST-link terminal +.SH SYNOPSIS +.B st-term +.SH DESCRIPTION +This manual page documents briefly the +st-term command +.SH SEE ALSO +.BR st-flash (1), +.BR st-util (1), +.BR st-info (1). diff --git a/st-util.1 b/st-util.1 new file mode 100644 index 0000000..b661aa1 --- /dev/null +++ b/st-util.1 @@ -0,0 +1,38 @@ +.\" (C) Copyright 2013 Keith Packard +.\" +.\"Redistribution and use in source and binary forms, with or without +.\"modification, are permitted provided that the following conditions are +.\"met: +.\" +.\" * Redistributions of source code must retain the above copyright +.\"notice, this list of conditions and the following disclaimer. +.\" * Redistributions in binary form must reproduce the above +.\"copyright notice, this list of conditions and the following disclaimer +.\"in the documentation and/or other materials provided with the +.\"distribution. +.\" * Neither the name of Martin Capitanio nor the names of its +.\"contributors may be used to endorse or promote products derived from +.\"this software without specific prior written permission. +.\" +.\"THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +.\""AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +.\"LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +.\"A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +.\"OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +.\"SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +.\"LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\"DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\"THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\"(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +.\"OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.TH ST-UTIL 1 "st-util" "" +.SH NAME +st-util \- GDB server for STM devices via STlink +.SH DESCRIPTION +This manual page documents briefly the +st-util command +.SH SEE ALSO +.BR st-flash (1), +.BR st-term (1), +.BR st-info (1). -- 2.30.2