From bc9ac70e0ccac038ccc44af8b27b58f68685778e Mon Sep 17 00:00:00 2001
From: speedie <speedie@duck.com>
Date: Sun, 11 Dec 2022 16:57:10 +0100
Subject: [PATCH] some improvements to speedwm-help and bug fix

---
 scripts/speedwm-help | 71 ++++++++++++++++++++++----------------------
 1 file changed, 35 insertions(+), 36 deletions(-)

diff --git a/scripts/speedwm-help b/scripts/speedwm-help
index 73d054f..10aa052 100755
--- a/scripts/speedwm-help
+++ b/scripts/speedwm-help
@@ -6,10 +6,10 @@
 [ -z "${DOCDIR}" ] && DOCDIR=/usr/share/speedwm
 [ -z "$PREFIX" ] && PREFIX=""
 [ -z "$2" ] && VIEWER=less || VIEWER="$2"
-[ -z "$VERSION" ] && VERSION="$(grep "VERSION" ../options.mk | head -n 1 | awk '{ print $3 }')"
+[ -e "../options.mk" ] && [ -z "$VERSION" ] && VERSION="$(grep "VERSION" ../options.mk | head -n 1 | awk '{ print $3 }')"
 [ "$VIEWER" = "-o" ] && VIEWER="cat"
 
-[ -e "${DOCDIR}/${PREFIX}example.Xresources" ] && sed 's|\(!*\)!.*|\1|' ${DOCDIR}/${PREFIX}example.Xresources | grep -v "!" | grep speedwm > /tmp/example.Xresources && \
+[ -e "${DOCDIR}/${PREFIX}example.Xresources" ] && sed 's|\(!*\)!.*|\1|' ${DOCDIR}/${PREFIX}example.Xresources | grep -v "!" | grep "speedwm" > "/tmp/example.Xresources" && \
         sed "s/speedwm[.]/- speedwm./g" /tmp/example.Xresources > /tmp/example.Xresources.tmp && \
         mv /tmp/example.Xresources.tmp /tmp/example.Xresources
 
@@ -17,8 +17,7 @@
 HELP() {
     printf "speedwm help\n"
     printf "This small shell script works with pandoc to write and display documentation for speedwm.\n"
-    printf "All displayed documentation is Markdown, and can be parsed however you want. This allows it to be really portable.\n"
-    printf "\n\n"
+    printf "All displayed documentation is Markdown, and can be parsed however you want. This allows it to be really portable.\n\n\n"
     printf "%s-h                          View this list of arguments.\n"
     printf "%s-a                          View everything.\n"
     printf "%s-1                          What is speedwm?\n"
@@ -48,7 +47,7 @@ FORMATMANPAGE() {
 
     mv ../README.md ../README.md.orig
     printf "%% speedwm(1) $VERSION | speedie's window manager.\n" > ../README.md
-    cat ../README.md.orig | grep -v "docs/preview" >> ../README.md
+    grep -v "docs/preview" ../README.md.orig >> ../README.md
     
     pandoc --standalone --to man ../README.md -o ../speedwm.1
 
@@ -65,7 +64,7 @@ FORMATHTMLPAGE() {
     test ../README.md || exit 1
 
     mv ../README.md ../README.md.orig
-    cat ../README.md.orig | grep -v "docs/preview" > ../README.md
+    grep -v "docs/preview" ../README.md.orig > ../README.md
 
     rm -f ../README.md.orig
 
@@ -76,32 +75,32 @@ FORMATHTMLPAGE() {
 
 # format page properly
 FORMATPAGE() {
-    test ../readme.html && cat ../docs/speedwm.html.template.1 ../readme.html ../docs/speedwm.html.template.2 >> ../readme.temp.html && exit 0 || printf "You need to $0 --generate-html first."
+    test ../readme.html && cat ../docs/speedwm.html.template.1 ../readme.html ../docs/speedwm.html.template.2 >> ../readme.temp.html && exit 0 || printf "You need to %s --generate-html first." "$0"
     exit 1
 }
 
 # format markdown properly
 FORMATMD() {
-    mv /tmp/${PREFIX}doc ../README.md && exit 0
+    mv "/tmp/${PREFIX}doc" ../README.md && exit 0
     exit 1
 }
 
 # write docs
-cat ${DOCDIR}/${PREFIX}doc-01 \
-${DOCDIR}/${PREFIX}doc-02 \
-${DOCDIR}/${PREFIX}doc-03 \
-${DOCDIR}/${PREFIX}doc-04 \
-${DOCDIR}/${PREFIX}keybinds \
-${DOCDIR}/${PREFIX}dependencies \
-${DOCDIR}/${PREFIX}doc-05 \
-${DOCDIR}/${PREFIX}doc-06 \
-/tmp/example.Xresources \
-${DOCDIR}/${PREFIX}doc-07 \
-${DOCDIR}/${PREFIX}example.signal \
-${DOCDIR}/${PREFIX}doc-08 \
-${DOCDIR}/${PREFIX}doc-09 \
-${DOCDIR}/${PREFIX}doc-10 | \
-    grep -v "!!" > /tmp/${PREFIX}doc
+cat "${DOCDIR}/${PREFIX}doc-01" \
+"${DOCDIR}/${PREFIX}doc-02" \
+"${DOCDIR}/${PREFIX}doc-03" \
+"${DOCDIR}/${PREFIX}doc-04" \
+"${DOCDIR}/${PREFIX}keybinds" \
+"${DOCDIR}/${PREFIX}dependencies" \
+"${DOCDIR}/${PREFIX}doc-05" \
+"${DOCDIR}/${PREFIX}doc-06" \
+"/tmp/example.Xresources" \
+"${DOCDIR}/${PREFIX}doc-07" \
+"${DOCDIR}/${PREFIX}example.signal" \
+"${DOCDIR}/${PREFIX}doc-08" \
+"${DOCDIR}/${PREFIX}doc-09" \
+"${DOCDIR}/${PREFIX}doc-10" | \
+    grep -v "!!" > "/tmp/${PREFIX}doc"
 
 # check arguments and perform actions based on it
 case "$1" in
@@ -112,19 +111,19 @@ case "$1" in
 "") $0 -h && exit 0 ;;
 "-h") HELP && exit 0 ;;
 "--help") HELP && exit 0 ;;
-"-1") tail -n +4 ${DOCDIR}/${PREFIX}doc-01 > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
-"-2") cat ${DOCDIR}/${PREFIX}doc-04 ${DOCDIR}/${PREFIX}keybinds > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
-"-3") cat ${DOCDIR}/${PREFIX}dependencies > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
-"-4") cat ${DOCDIR}/${PREFIX}doc-06 /tmp/example.Xresources > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
-"-5") cat ${DOCDIR}/${PREFIX}doc-07 ${DOCDIR}/${PREFIX}example.signal > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
-"-6") cat ${DOCDIR}/${PREFIX}doc-08 > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
-"-7") cat ${DOCDIR}/${PREFIX}doc-02 > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
-"-8") cat ${DOCDIR}/${PREFIX}doc-03 > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
-"-9") cat ${DOCDIR}/${PREFIX}doc-05 > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
-"-10") cat ${DOCDIR}/${PREFIX}doc-09 > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
-"-11") cat ${DOCDIR}/${PREFIX}doc-10 > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
-"-a") cat /tmp/${PREFIX}doc > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
+"-1") tail -n +4 "${DOCDIR}/${PREFIX}doc-01" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
+"-2") cat "${DOCDIR}/${PREFIX}doc-04" "${DOCDIR}/${PREFIX}keybinds" > "/tmp/stdout" ; $VIEWER "/tmp/stdout" ; exit 0 ;;
+"-3") cat "${DOCDIR}/${PREFIX}dependencies" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
+"-4") cat "${DOCDIR}/${PREFIX}doc-06" "/tmp/example.Xresources" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
+"-5") cat "${DOCDIR}/${PREFIX}doc-07" "${DOCDIR}/${PREFIX}example.signal" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
+"-6") cat "${DOCDIR}/${PREFIX}doc-08" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
+"-7") cat "${DOCDIR}/${PREFIX}doc-02" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
+"-8") cat "${DOCDIR}/${PREFIX}doc-03" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
+"-9") cat "${DOCDIR}/${PREFIX}doc-05" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
+"-10") cat "${DOCDIR}/${PREFIX}doc-09" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
+"-11") cat "${DOCDIR}/${PREFIX}doc-10" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
+"-a") cat "/tmp/${PREFIX}doc" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
 esac
 
-printf "Unknown argument: '$1'.\n"
+printf "Unknown argument: '%s'.\n" "$1"
 exit 1