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  debian/stlink.udev |  2 ++
   8  st-flash.1         | 22 ++++++++++++++++++++++
   9  st-info.1          | 13 +++++++++++++
  10  st-term.1          | 12 ++++++++++++
  11  st-util.1          | 10 ++++++++++
  12  6 files changed, 61 insertions(+)
  13  create mode 100644 debian/stlink.udev
  14  create mode 100644 st-flash.1
  15  create mode 100644 st-info.1
  16  create mode 100644 st-term.1
  17  create mode 100644 st-util.1
  18
  19 diff --git a/Makefile.am b/Makefile.am
  20 index 2ddbf47..2733fa9 100644
  21 --- a/Makefile.am
  22 +++ b/Makefile.am
  23 @@ -6,8 +6,10 @@ AUTOMAKE_OPTIONS = subdir-objects
  24
  25  if MINGW
  26  bin_PROGRAMS = st-flash st-util st-info
  27 +man_MANS = st-flash.1 st-util.1 st-info.1
  28  else
  29  bin_PROGRAMS = st-flash st-util st-term st-info
  30 +man_MANS = st-flash.1 st-util.1 st-term.1 st-info.1
  31  endif
  32
  33  noinst_LIBRARIES      = libstlink.a
  34 diff --git a/debian/stlink.udev b/debian/stlink.udev
  35 new file mode 100644
  36 index 0000000..521ef8e
  37 --- /dev/null
  38 +++ b/debian/stlink.udev
  39 @@ -0,0 +1,2 @@
  40 +49-stlinkv1.rules
  41 +49-stlinkv2.rules
  42 diff --git a/st-flash.1 b/st-flash.1
  43 new file mode 100644
  44 index 0000000..0ff7ae6
  45 --- /dev/null
  46 +++ b/st-flash.1
  47 @@ -0,0 +1,22 @@
  48 +.\" (C) Copyright 2013 Keith Packard <keithp@keithp.com>,
  49 +.SH NAME
  50 +st-flash \- flash STM devices via STlink
  51 +.SH SYNOPSIS
  52 +.B st-flash
  53 +.RI (v1 devices) [--reset] {read|write} " /dev/sgX path addr <size>"
  54 +.br
  55 +.B st-flash
  56 +.RI (v1 devices) " /dev/sgX erase"
  57 +.br
  58 +.B st-flash
  59 +.RI (v2 devices) [--reset] {read|write} " path addr <size>"
  60 +.br
  61 +.B st-flash
  62 +.RI (v2 devices) [--reset] {read|write} " erase"
  63 +.SH DESCRIPTION
  64 +This manual page documents briefly the
  65 +st-flash command
  66 +.SH SEE ALSO
  67 +.BR st-util (1),
  68 +.BR st-term (1),
  69 +.BR st-info (1).
  70 diff --git a/st-info.1 b/st-info.1
  71 new file mode 100644
  72 index 0000000..80fa82e
  73 --- /dev/null
  74 +++ b/st-info.1
  75 @@ -0,0 +1,13 @@
  76 +.\" (C) Copyright 2013 Keith Packard <keithp@keithp.com>,
  77 +.SH NAME
  78 +st-info \- get information about STM cpu via STlink device
  79 +.SH SYNOPSIS
  80 +.B st-info
  81 +.RI [--flash] [--sram] [--descr] [--pagesize] [--chipid]
  82 +.SH DESCRIPTION
  83 +This manual page documents briefly the
  84 +st-info command
  85 +.SH SEE ALSO
  86 +.BR st-flash (1),
  87 +.BR st-util (1),
  88 +.BR st-term (1).
  89 diff --git a/st-term.1 b/st-term.1
  90 new file mode 100644
  91 index 0000000..3703077
  92 --- /dev/null
  93 +++ b/st-term.1
  94 @@ -0,0 +1,12 @@
  95 +.\" (C) Copyright 2013 Keith Packard <keithp@keithp.com>,
  96 +.SH NAME
  97 +st-term \- ST-link terminal
  98 +.SH SYNOPSIS
  99 +.B st-term
 100 +.SH DESCRIPTION
 101 +This manual page documents briefly the
 102 +st-term command
 103 +.SH SEE ALSO
 104 +.BR st-flash (1),
 105 +.BR st-util (1),
 106 +.BR st-info (1).
 107 diff --git a/st-util.1 b/st-util.1
 108 new file mode 100644
 109 index 0000000..6331321
 110 --- /dev/null
 111 +++ b/st-util.1
 112 @@ -0,0 +1,10 @@
 113 +.\" (C) Copyright 2013 Keith Packard <keithp@keithp.com>,
 114 +.SH NAME
 115 +st-util \- GDB server for STM devices via STlink
 116 +.SH DESCRIPTION
 117 +This manual page documents briefly the
 118 +st-util command
 119 +.SH SEE ALSO
 120 +.BR st-flash (1),
 121 +.BR st-term (1),
 122 +.BR st-info (1).