git.gag.com Git - fw/stlink/blob - debian/patches/0001-Add-man-pages.patch

   1 From: Keith Packard <keithp@keithp.com>
   2 Date: Sat, 14 Dec 2013 12:49:35 -0800
   3 Subject: Add man pages
   4
   5 ---
   6  Makefile.am |  2 ++
   7  st-flash.1  | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
   8  st-info.1   | 41 +++++++++++++++++++++++++++++++++++++++++
   9  st-term.1   | 40 ++++++++++++++++++++++++++++++++++++++++
  10  st-util.1   | 38 ++++++++++++++++++++++++++++++++++++++
  11  5 files changed, 171 insertions(+)
  12  create mode 100644 st-flash.1
  13  create mode 100644 st-info.1
  14  create mode 100644 st-term.1
  15  create mode 100644 st-util.1
  16
  17 diff --git a/Makefile.am b/Makefile.am
  18 index 2ddbf47..2733fa9 100644
  19 --- a/Makefile.am
  20 +++ b/Makefile.am
  21 @@ -6,8 +6,10 @@ AUTOMAKE_OPTIONS = subdir-objects
  22
  23  if MINGW
  24  bin_PROGRAMS = st-flash st-util st-info
  25 +man_MANS = st-flash.1 st-util.1 st-info.1
  26  else
  27  bin_PROGRAMS = st-flash st-util st-term st-info
  28 +man_MANS = st-flash.1 st-util.1 st-term.1 st-info.1
  29  endif
  30
  31  noinst_LIBRARIES      = libstlink.a
  32 diff --git a/st-flash.1 b/st-flash.1
  33 new file mode 100644
  34 index 0000000..ee1130e
  35 --- /dev/null
  36 +++ b/st-flash.1
  37 @@ -0,0 +1,50 @@
  38 +.\" (C) Copyright 2013 Keith Packard <keithp@keithp.com>,
  39 +.\"
  40 +.\"Redistribution and use in source and binary forms, with or without
  41 +.\"modification, are permitted provided that the following conditions are
  42 +.\"met:
  43 +.\"
  44 +.\"   * Redistributions of source code must retain the above copyright
  45 +.\"notice, this list of conditions and the following disclaimer.
  46 +.\"   * Redistributions in binary form must reproduce the above
  47 +.\"copyright notice, this list of conditions and the following disclaimer
  48 +.\"in the documentation and/or other materials provided with the
  49 +.\"distribution.
  50 +.\"   * Neither the name of Martin Capitanio nor the names of its
  51 +.\"contributors may be used to endorse or promote products derived from
  52 +.\"this software without specific prior written permission.
  53 +.\"
  54 +.\"THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  55 +.\""AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  56 +.\"LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  57 +.\"A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  58 +.\"OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  59 +.\"SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  60 +.\"LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  61 +.\"DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  62 +.\"THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  63 +.\"(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  64 +.\"OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  65 +.\"
  66 +.TH ST-FLASH 1 "st-flash" ""
  67 +.SH NAME
  68 +st-flash \- flash STM devices via STlink
  69 +.SH SYNOPSIS
  70 +.B st-flash
  71 +.RI (v1 devices) [--reset] {read|write} " /dev/sgX path addr <size>"
  72 +.br
  73 +.B st-flash
  74 +.RI (v1 devices) " /dev/sgX erase"
  75 +.br
  76 +.B st-flash
  77 +.RI (v2 devices) [--reset] {read|write} " path addr <size>"
  78 +.br
  79 +.B st-flash
  80 +.RI (v2 devices) [--reset] {read|write} " erase"
  81 +.SH DESCRIPTION
  82 +This manual page documents briefly the
  83 +st-flash command
  84 +.SH SEE ALSO
  85 +.BR st-util (1),
  86 +.BR st-term (1),
  87 +.BR st-info (1).
  88 diff --git a/st-info.1 b/st-info.1
  89 new file mode 100644
  90 index 0000000..4fe2182
  91 --- /dev/null
  92 +++ b/st-info.1
  93 @@ -0,0 +1,41 @@
  94 +.\" (C) Copyright 2013 Keith Packard <keithp@keithp.com>,
  95 +.\"
  96 +.\"Redistribution and use in source and binary forms, with or without
  97 +.\"modification, are permitted provided that the following conditions are
  98 +.\"met:
  99 +.\"
 100 +.\"   * Redistributions of source code must retain the above copyright
 101 +.\"notice, this list of conditions and the following disclaimer.
 102 +.\"   * Redistributions in binary form must reproduce the above
 103 +.\"copyright notice, this list of conditions and the following disclaimer
 104 +.\"in the documentation and/or other materials provided with the
 105 +.\"distribution.
 106 +.\"   * Neither the name of Martin Capitanio nor the names of its
 107 +.\"contributors may be used to endorse or promote products derived from
 108 +.\"this software without specific prior written permission.
 109 +.\"
 110 +.\"THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 111 +.\""AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 112 +.\"LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 113 +.\"A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 114 +.\"OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 115 +.\"SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 116 +.\"LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 117 +.\"DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 118 +.\"THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 119 +.\"(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 120 +.\"OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 121 +.\"
 122 +.TH ST-INFO 1 "st-info" ""
 123 +.SH NAME
 124 +st-info \- get information about STM cpu via STlink device
 125 +.SH SYNOPSIS
 126 +.B st-info
 127 +.RI [--flash] [--sram] [--descr] [--pagesize] [--chipid]
 128 +.SH DESCRIPTION
 129 +This manual page documents briefly the
 130 +st-info command
 131 +.SH SEE ALSO
 132 +.BR st-flash (1),
 133 +.BR st-util (1),
 134 +.BR st-term (1).
 135 diff --git a/st-term.1 b/st-term.1
 136 new file mode 100644
 137 index 0000000..1b1f1d7
 138 --- /dev/null
 139 +++ b/st-term.1
 140 @@ -0,0 +1,40 @@
 141 +.\" (C) Copyright 2013 Keith Packard <keithp@keithp.com>,
 142 +.\"
 143 +.\"Redistribution and use in source and binary forms, with or without
 144 +.\"modification, are permitted provided that the following conditions are
 145 +.\"met:
 146 +.\"
 147 +.\"   * Redistributions of source code must retain the above copyright
 148 +.\"notice, this list of conditions and the following disclaimer.
 149 +.\"   * Redistributions in binary form must reproduce the above
 150 +.\"copyright notice, this list of conditions and the following disclaimer
 151 +.\"in the documentation and/or other materials provided with the
 152 +.\"distribution.
 153 +.\"   * Neither the name of Martin Capitanio nor the names of its
 154 +.\"contributors may be used to endorse or promote products derived from
 155 +.\"this software without specific prior written permission.
 156 +.\"
 157 +.\"THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 158 +.\""AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 159 +.\"LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 160 +.\"A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 161 +.\"OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 162 +.\"SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 163 +.\"LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 164 +.\"DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 165 +.\"THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 166 +.\"(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 167 +.\"OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 168 +.\"
 169 +.TH ST-TERM 1 "st-term" ""
 170 +.SH NAME
 171 +st-term \- ST-link terminal
 172 +.SH SYNOPSIS
 173 +.B st-term
 174 +.SH DESCRIPTION
 175 +This manual page documents briefly the
 176 +st-term command
 177 +.SH SEE ALSO
 178 +.BR st-flash (1),
 179 +.BR st-util (1),
 180 +.BR st-info (1).
 181 diff --git a/st-util.1 b/st-util.1
 182 new file mode 100644
 183 index 0000000..b661aa1
 184 --- /dev/null
 185 +++ b/st-util.1
 186 @@ -0,0 +1,38 @@
 187 +.\" (C) Copyright 2013 Keith Packard <keithp@keithp.com>
 188 +.\"
 189 +.\"Redistribution and use in source and binary forms, with or without
 190 +.\"modification, are permitted provided that the following conditions are
 191 +.\"met:
 192 +.\"
 193 +.\"   * Redistributions of source code must retain the above copyright
 194 +.\"notice, this list of conditions and the following disclaimer.
 195 +.\"   * Redistributions in binary form must reproduce the above
 196 +.\"copyright notice, this list of conditions and the following disclaimer
 197 +.\"in the documentation and/or other materials provided with the
 198 +.\"distribution.
 199 +.\"   * Neither the name of Martin Capitanio nor the names of its
 200 +.\"contributors may be used to endorse or promote products derived from
 201 +.\"this software without specific prior written permission.
 202 +.\"
 203 +.\"THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 204 +.\""AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 205 +.\"LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 206 +.\"A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 207 +.\"OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 208 +.\"SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 209 +.\"LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 210 +.\"DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 211 +.\"THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 212 +.\"(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 213 +.\"OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 214 +.\"
 215 +.TH ST-UTIL 1 "st-util" ""
 216 +.SH NAME
 217 +st-util \- GDB server for STM devices via STlink
 218 +.SH DESCRIPTION
 219 +This manual page documents briefly the
 220 +st-util command
 221 +.SH SEE ALSO
 222 +.BR st-flash (1),
 223 +.BR st-term (1),
 224 +.BR st-info (1).