From 81e4fa6c81739f668f9bea63a29f19433e4b90a4 Mon Sep 17 00:00:00 2001
From: "Kay Marquardt (Gnadelwartz)" <kay@rrr.de>
Date: Fri, 1 Jan 2021 22:48:13 +0100
Subject: [PATCH] examples: improvements and printf conversion

---
 examples/README.html      | 153 +++++++++++++++++++++++++++++++++++---
 examples/README.md        |   2 +-
 examples/bash2env.sh      |   2 +-
 examples/bashbot-multi.sh |   2 +-
 examples/bashbot.cron     |   2 +-
 examples/calc.sh          |  40 +++++-----
 examples/notify.sh        |  33 +++++---
 examples/question.sh      |  36 ++++++---
 8 files changed, 215 insertions(+), 55 deletions(-)

diff --git a/examples/README.html b/examples/README.html
index c9b370a..5f0e1a2 100644
--- a/examples/README.html
+++ b/examples/README.html
@@ -6,10 +6,143 @@
   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
   <title>Bashobot Documentation - examples/README.html</title>
   <style>
-      code{white-space: pre-wrap;}
-      span.smallcaps{font-variant: small-caps;}
-      span.underline{text-decoration: underline;}
-      div.column{display: inline-block; vertical-align: top; width: 50%;}
+    html {
+      line-height: 1.5;
+      font-family: Georgia, serif;
+      font-size: 20px;
+      color: #1a1a1a;
+      background-color: #fdfdfd;
+    }
+    body {
+      margin: 0 auto;
+      max-width: 36em;
+      padding-left: 50px;
+      padding-right: 50px;
+      padding-top: 50px;
+      padding-bottom: 50px;
+      hyphens: auto;
+      word-wrap: break-word;
+      text-rendering: optimizeLegibility;
+      font-kerning: normal;
+    }
+    @media (max-width: 600px) {
+      body {
+        font-size: 0.9em;
+        padding: 1em;
+      }
+    }
+    @media print {
+      body {
+        background-color: transparent;
+        color: black;
+        font-size: 12pt;
+      }
+      p, h2, h3 {
+        orphans: 3;
+        widows: 3;
+      }
+      h2, h3, h4 {
+        page-break-after: avoid;
+      }
+    }
+    p {
+      margin: 1em 0;
+    }
+    a {
+      color: #1a1a1a;
+    }
+    a:visited {
+      color: #1a1a1a;
+    }
+    img {
+      max-width: 100%;
+    }
+    h1, h2, h3, h4, h5, h6 {
+      margin-top: 1.4em;
+    }
+    h5, h6 {
+      font-size: 1em;
+      font-style: italic;
+    }
+    h6 {
+      font-weight: normal;
+    }
+    ol, ul {
+      padding-left: 1.7em;
+      margin-top: 1em;
+    }
+    li > ol, li > ul {
+      margin-top: 0;
+    }
+    blockquote {
+      margin: 1em 0 1em 1.7em;
+      padding-left: 1em;
+      border-left: 2px solid #e6e6e6;
+      color: #606060;
+    }
+    code {
+      font-family: Menlo, Monaco, 'Lucida Console', Consolas, monospace;
+      font-size: 85%;
+      margin: 0;
+    }
+    pre {
+      margin: 1em 0;
+      overflow: auto;
+    }
+    pre code {
+      padding: 0;
+      overflow: visible;
+    }
+    .sourceCode {
+     background-color: transparent;
+     overflow: visible;
+    }
+    hr {
+      background-color: #1a1a1a;
+      border: none;
+      height: 1px;
+      margin: 1em 0;
+    }
+    table {
+      margin: 1em 0;
+      border-collapse: collapse;
+      width: 100%;
+      overflow-x: auto;
+      display: block;
+      font-variant-numeric: lining-nums tabular-nums;
+    }
+    table caption {
+      margin-bottom: 0.75em;
+    }
+    tbody {
+      margin-top: 0.5em;
+      border-top: 1px solid #1a1a1a;
+      border-bottom: 1px solid #1a1a1a;
+    }
+    th {
+      border-top: 1px solid #1a1a1a;
+      padding: 0.25em 0.5em 0.25em 0.5em;
+    }
+    td {
+      padding: 0.125em 0.5em 0.25em 0.5em;
+    }
+    header {
+      margin-bottom: 4em;
+      text-align: center;
+    }
+    #TOC li {
+      list-style: none;
+    }
+    #TOC a:not(:hover) {
+      text-decoration: none;
+    }
+    code{white-space: pre-wrap;}
+    span.smallcaps{font-variant: small-caps;}
+    span.underline{text-decoration: underline;}
+    div.column{display: inline-block; vertical-align: top; width: 50%;}
+    div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
+    ul.task-list{list-style: none;}
+    .display.math{display: block; text-align: center; margin: 0.5rem auto;}
   </style>
   <!--[if lt IE 9]>
     <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
@@ -35,8 +168,7 @@
     run_diskusage.sh - shows disk usage every 100 seconds
     run_filename.sh - shown the name of new files in a named dir
     run_filecontent.sh  - shown the content of new files in a named dir
-    run_notify.sh - same as notify.sh
-</code></pre>
+    run_notify.sh - same as notify.sh</code></pre>
 <p><strong>Note:</strong> Output of system commands often contains newlines, each newline results in a telegram message, the function 'send_telegram' in mycommands.sh avoids this by converting each newline to ' mynewlinestartshere ' before output the string.</p>
 <h3>System Status</h3>
 <p><strong>send-system-status</strong> contains an example for commands showing status of different subsystems. This example is adapted from https://github.com/RG72/telegram-bot-bash to current bashbot commands, but not fully tested. This will show how easy you can convert existing bots.</p>
@@ -52,10 +184,9 @@
     /lvsd *Datailed lvm status*
     /df *disk space*
     /ifconfig *ifconfig output*
-    /smart *sda* _smart status for sda drive_
-</code></pre>
-<h3>External scripts</h3>
-<p><strong>external-use</strong> will contain some examples on how to send messages from external scripts to Telegram chats or users.</p>
-<h4>$$VERSION$$ v0.98-pre2-0-ga597303</h4>
+    /smart *sda* _smart status for sda drive_</code></pre>
+<h3>jsonDB and Keyboards</h3>
+<p><strong>jsonDB-keybords</strong> contains a stripped down real world example from my bot showing the usage of jsonDB to store and retrieve values plus use of keyboards in private chats. It's an extended version of mycommands.sh.dist. Messages and help are in german.</p>
+<h4>$$VERSION$$ v1.20-0-g2ab00a2</h4>
 </body>
 </html>
diff --git a/examples/README.md b/examples/README.md
index 4c03ef3..b642c54 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -56,6 +56,6 @@ convert existing bots.
 **jsonDB-keybords** contains a stripped down real world example from my bot showing the usage of jsonDB to store and retrieve values
 plus use of keyboards in private chats. It's an extended version of mycommands.sh.dist. Messages and help are in german.
 
-#### $$VERSION$$ v1.20-0-g2ab00a2
+#### $$VERSION$$ v1.21-pre-14-ga93dc56
 
 
diff --git a/examples/bash2env.sh b/examples/bash2env.sh
index 18c647e..8aa4064 100755
--- a/examples/bash2env.sh
+++ b/examples/bash2env.sh
@@ -6,7 +6,7 @@
 # This file is public domain in the USA and all free countries.
 # Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
 # shellcheck disable=SC1117
-#### $$VERSION$$ v1.20-0-g2ab00a2
+#### $$VERSION$$ v1.21-pre-14-ga93dc56
 
 # adjust your language setting here
 # https://github.com/topkecleon/telegram-bot-bash#setting-up-your-environment
diff --git a/examples/bashbot-multi.sh b/examples/bashbot-multi.sh
index d48da65..25e4d98 100755
--- a/examples/bashbot-multi.sh
+++ b/examples/bashbot-multi.sh
@@ -2,7 +2,7 @@
 # file. multibot.sh
 # description:  run multiple telegram bots from one installation
 #
-#### $$VERSION$$ v1.20-0-g2ab00a2
+#### $$VERSION$$ v1.21-pre-14-ga93dc56
 
 if [ "${2}" = "" ] || [ "${2}" = "-h" ]; then
 	echo "Usage: $0 botname command"
diff --git a/examples/bashbot.cron b/examples/bashbot.cron
index b5c31e9..917c32f 100644
--- a/examples/bashbot.cron
+++ b/examples/bashbot.cron
@@ -7,7 +7,7 @@
 # This file is public domain in the USA and all free countries.
 # Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
 #
-#### $$VERSION$$ v1.20-0-g2ab00a2
+#### $$VERSION$$ v1.21-pre-14-ga93dc56
 
 
 SHELL=/bin/sh
diff --git a/examples/calc.sh b/examples/calc.sh
index de2f662..7b0dab1 100755
--- a/examples/calc.sh
+++ b/examples/calc.sh
@@ -1,11 +1,18 @@
 #!/bin/bash
-# file: calc.sh
-# example for an interactive chat, run with startproc calc.sh
+########################################################################
+#
+# File: calc.sh
+#
+# Description: example for an background job, see mycommands.sh.dist
+#
+# Usage: runback calc  example/calc.sh  - or run in terminal
+#        killback calc - to stop background job
 #
 # This file is public domain in the USA and all free countries.
 # Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
 #
-#### $$VERSION$$ v1.20-0-g2ab00a2
+#### $$VERSION$$ v1.21-pre-14-ga93dc56
+########################################################################
 
 ######
 # parameters
@@ -23,22 +30,21 @@ export 'LANGUAGE=C.UTF-8'
 unset IFS
 # set -f # if you are paranoid use set -f to disable globbing
 
-echo 'Starting Calculator ...'
-echo 'Enter first number.'
+printf 'Starting Calculator ...\n'
+printf 'Enter first number.\n'
 read -r A <"${INPUT}"
-echo 'Enter second number.'
+printf 'Enter second number.\n'
 read -r B <"${INPUT}"
-echo 'Select Operation: mykeyboardstartshere [ "Addition" , "Subtraction" , "Multiplication" , "Division" ,  "Cancel" ]'
+printf 'Select Operation: mykeyboardstartshere [ "Addition" , "Subtraction" , "Multiplication" , "Division" ,  "Cancel" ]\n'
 read -r opt <"${INPUT}"
-echo -n 'Result: '
-case $opt in
-	'add'* | 'Add'* ) res="$(( A + B ))" ;;
-	'sub'* | 'Sub'* ) res="$(( A - B ))" ;;
-	'mul'* | 'Mul'* ) res="$(( A * B ))" ;;
-	'div'* | 'Div'* ) res="$(( A / B ))" ;;
-	'can'* | 'Can'* ) res="abort!" ;;
-		* ) echo "unknown operator!";;
+printf 'Result: '
+case ${opt,,} in
+	'a'*) res="$(( A + B ))" ;;
+	's'*) res="$(( A - B ))" ;;
+	'm'*) res="$(( A * B ))" ;;
+	'd'*) res="$(( A / B ))" ;;
+	'c'*) res="abort!" ;;
+	* ) printf "unknown operator!\n";;
 esac
-echo "$res"
-echo "Bye .."
+printf "%s\nBye ...\n" "${res}"
 
diff --git a/examples/notify.sh b/examples/notify.sh
index 3c8988b..53e483d 100755
--- a/examples/notify.sh
+++ b/examples/notify.sh
@@ -1,17 +1,26 @@
 #!/bin/bash
-# file: notify.sh
-# example for an background job, run with startback notify.sh
+########################################################################
+#
+# File: notify.sh
+#
+# Description: example for an background job, see mycommands.sh.dist
+#
+# Usage: runback notify  example/notify.sh [seconds] - or run in terminal
+#        killback notify - to stop background job
+#
+# Options: seconds - time to sleep between output, default 10
 #
 # This file is public domain in the USA and all free countries.
 # Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
-#### $$VERSION$$ v1.20-0-g2ab00a2
+#
+#### $$VERSION$$ v1.21-pre-14-ga93dc56
+########################################################################
 
 ######
 # parameters
 # $1 $2 args as given to starct_proc chat script arg1 arg2
 # $3 path to named pipe/log
 
-
 # adjust your language setting here
 # https://github.com/topkecleon/telegram-bot-bash#setting-up-your-environment
 export 'LC_ALL=C.UTF-8'
@@ -24,18 +33,20 @@ unset IFS
 # discard STDIN for background jobs!
 cat >/dev/null & 
 
-# check if $1 is a number
-re='^[0-9]+$'
-if [[ $1 =~ $re ]] ; then
+# $1 = time between time notifications
+# check if $1 is a valid number
+if [[ "$1" =~ ^[0-9]+$ ]] ; then
 	SLEEP="$1"
 else
-	SLEEP=10 # time between time notifications
+	SLEEP=10
 fi
 
 # output current time every $1 seconds
-date "+* It's %k:%M:%S o' clock ..."
-while sleep $SLEEP
+printf "Output time every %s seconds ...\n" "${SLEEP}"
+
+while true 
 do
-	date "+* It's %k:%M:%S o' clock ..."
+	date "+* It's %k:%M:%S o'clock ..."
+	sleep $SLEEP
 done
 
diff --git a/examples/question.sh b/examples/question.sh
index 59a55cd..71ff11f 100755
--- a/examples/question.sh
+++ b/examples/question.sh
@@ -1,11 +1,17 @@
 #!/bin/bash
-# file: question.sh
-# example for an interactive chat, run with startproc question.sh
+########################################################################
+#
+# File: question.sh
+#
+# Usage: runproc example/question.sh - or run in terminal
+#
+# Description: example for an interactive chat, see mycommands.sh.dist
 #
 # This file is public domain in the USA and all free countries.
 # Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
 #
-#### $$VERSION$$ v1.20-0-g2ab00a2
+#### $$VERSION$$ v1.21-pre-14-ga93dc56
+########################################################################
 
 ######
 # parameters
@@ -14,7 +20,6 @@
 
 INPUT="${3:-/dev/stdin}"
 
-
 # adjust your language setting here
 # https://github.com/topkecleon/telegram-bot-bash#setting-up-your-environment
 export 'LC_ALL=C.UTF-8'
@@ -24,18 +29,25 @@ export 'LANGUAGE=C.UTF-8'
 unset IFS
 # set -f # if you are paranoid use set -f to disable globbing
 
-echo "Hi, hello there.
-Would you like some tea (y/n)?"
+# simple yes/no question, defaults to no
+printf "Hi, hello there\nWould you like some tea (y/n)?\n"
 read -r answer <"${INPUT}"
-[[ $answer =~ ^([yY][eE][sS]|[yY])$ ]] && echo "OK then, here you go: http://www.rivertea.com/blog/wp-content/uploads/2013/12/Green-Tea.jpg" || echo "OK then."
+if [[ ${answer,,} == "y"* ]]; then
+	printf "OK then, here you go: http://www.rivertea.com/blog/wp-content/uploads/2013/12/Green-Tea.jpg\n"
+else
+	printf "OK then, no tea ...\n"
+fi
+
+# question with Keyboard, repeating until correct answer given
 until [ "$SUCCESS" = "y" ] ;do
-	echo 'Do you like Music? mykeyboardstartshere "Yass!" , "No"'
+	printf 'Do you like Music? mykeyboardstartshere "Yass!" , "No"\n'
 	read -r answer <"${INPUT}"
-	case $answer in
-		'Yass!') echo "Goody! mykeyboardendshere";SUCCESS=y;;
-		'No') echo "Well that's weird. mykeyboardendshere";SUCCESS=y;;
-		'') echo "empty answer! Try again";; 
+	case ${answer,,} in
+		'') printf "empty answer! Try again\n";; 
+		'yass'*) printf "Goody! mykeyboardendshere\n";SUCCESS=y;;
+		'no'*) printf "Well that's weird. mykeyboardendshere\n";SUCCESS=y;;
 		*) SUCCESS=n;;
 	esac
 done
+printf "OK, Done!\n"