Simplified Windows man page processing. Added Cygwin support to update_windows_man_page.sh.

update_windows_man_page.sh

@@ -1,7 +1,32 @@
 #!/bin/bash
 
+#
+#   The MIT License (MIT)
+#
+#   Copyright (C) 2021 Joe Testa (jtesta@positronsecurity.com)
+#   Copyright (C) 2021 Adam Russell (<adam[at]thecliguy[dot]co[dot]uk>)
+#
+#   Permission is hereby granted, free of charge, to any person obtaining a copy
+#   of this software and associated documentation files (the "Software"), to deal
+#   in the Software without restriction, including without limitation the rights
+#   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#   copies of the Software, and to permit persons to whom the Software is
+#   furnished to do so, subject to the following conditions:
+#
+#   The above copyright notice and this permission notice shall be included in
+#   all copies or substantial portions of the Software.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#   THE SOFTWARE.
+#
+
 ################################################################################
-# update_windows_man_page
+# update_windows_man_page.sh
 #
 # PURPOSE
 #   Since Windows lacks a manual reader it's necessary to provide an alternative
@@ -13,12 +38,29 @@
 #   'WINDOWS_MAN_PAGE' by invoking ssh-audit with the manual parameters 
 #   (--manual / -m).
 #
+#   Cygwin is required.
+#
 # USAGE
-#   update_windows_man_page.sh -m <path-to-man-page> -g <path-to-globals.py>
+#   update_windows_man_page.sh [-m <path-to-man-page>] [-g <path-to-globals.py>]
 #
 ################################################################################
 
-while getopts "m: g:" OPTION
+function usage {
+    echo >&2 "Usage: $0 [-m <path-to-man-page>] [-g <path-to-globals.py>] [-h]"
+    echo >&2 "  -m    Specify an alternate man page path (default: ./ssh-audit.1)"
+    echo >&2 "  -g    Specify an alternate globals.py path (default: ./src/ssh_audit/globals.py)"
+    echo >&2 "  -h    This help message"
+}
+
+if [[ $(uname -s) != CYGWIN* ]]; then
+    echo >&2 "This script is designed to be run under Cygwin only.  It can potentially be extended to run under Linux, but this is not supported at this time."
+    exit -1
+fi
+
+MAN_PAGE=ssh-audit.1
+GLOBALS_PY=src/ssh_audit/globals.py
+
+while getopts "m: g: h" OPTION
 do
     case "$OPTION" in
         m)
@@ -27,24 +69,24 @@ do
         g)
             GLOBALS_PY="$OPTARG"
             ;;
+        h)
+            usage
+            exit 0
+            ;;
         *)
             echo >&2 "Invalid parameter(s) provided"
+            usage
             exit 1
             ;;
     esac
 done
 
-if [[ -z "$MAN_PAGE" || -z "$GLOBALS_PY" ]]; then
-    echo >&2 "Missing parameter(s)."
-    exit 1
-fi
-
 # Check that the specified files exist.
 [ -f "$MAN_PAGE" ] || { echo >&2 "man page file not found: $MAN_PAGE"; exit 1; }
 [ -f "$GLOBALS_PY" ] || { echo >&2 "globals.py file not found: $GLOBALS_PY"; exit 1; }
 
-# Check that the 'ul' (do underlining) binary exists.
-command -v ul >/dev/null 2>&1 || { echo >&2 "ul not found."; exit 1; }
+# Check that the 'ul' (do underlining) binary exists.  (Commented out since Cygwin's man outputs ANSI escape codes automatically; re-enable if running under Linux.)
+# command -v ul >/dev/null 2>&1 || { echo >&2 "ul not found."; exit 1; }
 
 # Check that the 'sed' (stream editor) binary exists.
 command -v sed >/dev/null 2>&1 || { echo >&2 "sed not found."; exit 1; }
@@ -52,6 +94,8 @@ command -v sed >/dev/null 2>&1 || { echo >&2 "sed not found."; exit 1; }
 # Remove the Windows man page placeholder from 'globals.py'.
 sed -i '/^WINDOWS_MAN_PAGE/d' "$GLOBALS_PY"
 
+echo "Processing man page at ${MAN_PAGE} and placing output into ${GLOBALS_PY}..."
+
 # Append the man page content to 'globals.py'.
 #   * man outputs a backspace-overwrite sequence rather than an ANSI escape 
 #     sequence.
@@ -60,5 +104,10 @@ sed -i '/^WINDOWS_MAN_PAGE/d' "$GLOBALS_PY"
 #   * The 'ul' command converts the backspace-overwrite sequence to an ANSI escape 
 #     sequence.
 echo WINDOWS_MAN_PAGE = '"""' >> "$GLOBALS_PY"
-MANWIDTH=80 MAN_KEEP_FORMATTING=1 man "$MAN_PAGE" | ul >> "$GLOBALS_PY"
-echo '"""' >> "$GLOBALS_PY"
+# The 'ul' tool would be necessary if running under Linux to convert the overstrike characters into ANSI escape sequences.
+# MANWIDTH=80 MAN_KEEP_FORMATTING=1 man "$MAN_PAGE" | ul >> "$GLOBALS_PY"
+MANWIDTH=80 MAN_KEEP_FORMATTING=1 man "./$MAN_PAGE" >> "$GLOBALS_PY"
+echo '"""' >> "$GLOBALS_PY"
+
+echo "Done."
+exit 0