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  | 22 ++++++++++++++++++++++
   8  st-info.1   | 13 +++++++++++++
   9  st-term.1   | 12 ++++++++++++
  10  st-util.1   | 10 ++++++++++
  11  5 files changed, 59 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..0ff7ae6
  35 --- /dev/null
  36 +++ b/st-flash.1
  37 @@ -0,0 +1,22 @@
  38 +.\" (C) Copyright 2013 Keith Packard <keithp@keithp.com>,
  39 +.SH NAME
  40 +st-flash \- flash STM devices via STlink
  41 +.SH SYNOPSIS
  42 +.B st-flash
  43 +.RI (v1 devices) [--reset] {read|write} " /dev/sgX path addr <size>"
  44 +.br
  45 +.B st-flash
  46 +.RI (v1 devices) " /dev/sgX erase"
  47 +.br
  48 +.B st-flash
  49 +.RI (v2 devices) [--reset] {read|write} " path addr <size>"
  50 +.br
  51 +.B st-flash
  52 +.RI (v2 devices) [--reset] {read|write} " erase"
  53 +.SH DESCRIPTION
  54 +This manual page documents briefly the
  55 +st-flash command
  56 +.SH SEE ALSO
  57 +.BR st-util (1),
  58 +.BR st-term (1),
  59 +.BR st-info (1).
  60 diff --git a/st-info.1 b/st-info.1
  61 new file mode 100644
  62 index 0000000..80fa82e
  63 --- /dev/null
  64 +++ b/st-info.1
  65 @@ -0,0 +1,13 @@
  66 +.\" (C) Copyright 2013 Keith Packard <keithp@keithp.com>,
  67 +.SH NAME
  68 +st-info \- get information about STM cpu via STlink device
  69 +.SH SYNOPSIS
  70 +.B st-info
  71 +.RI [--flash] [--sram] [--descr] [--pagesize] [--chipid]
  72 +.SH DESCRIPTION
  73 +This manual page documents briefly the
  74 +st-info command
  75 +.SH SEE ALSO
  76 +.BR st-flash (1),
  77 +.BR st-util (1),
  78 +.BR st-term (1).
  79 diff --git a/st-term.1 b/st-term.1
  80 new file mode 100644
  81 index 0000000..3703077
  82 --- /dev/null
  83 +++ b/st-term.1
  84 @@ -0,0 +1,12 @@
  85 +.\" (C) Copyright 2013 Keith Packard <keithp@keithp.com>,
  86 +.SH NAME
  87 +st-term \- ST-link terminal
  88 +.SH SYNOPSIS
  89 +.B st-term
  90 +.SH DESCRIPTION
  91 +This manual page documents briefly the
  92 +st-term command
  93 +.SH SEE ALSO
  94 +.BR st-flash (1),
  95 +.BR st-util (1),
  96 +.BR st-info (1).
  97 diff --git a/st-util.1 b/st-util.1
  98 new file mode 100644
  99 index 0000000..6331321
 100 --- /dev/null
 101 +++ b/st-util.1
 102 @@ -0,0 +1,10 @@
 103 +.\" (C) Copyright 2013 Keith Packard <keithp@keithp.com>,
 104 +.SH NAME
 105 +st-util \- GDB server for STM devices via STlink
 106 +.SH DESCRIPTION
 107 +This manual page documents briefly the
 108 +st-util command
 109 +.SH SEE ALSO
 110 +.BR st-flash (1),
 111 +.BR st-term (1),
 112 +.BR st-info (1).