From df1cf36437dae8c8d51161ad827e890c60e596d5 Mon Sep 17 00:00:00 2001
From: Joachim Wiberg <troglobit@gmail.com>
Date: Wed, 25 Jan 2023 20:35:09 +0100
Subject: [PATCH] Change help viewer to 'most', more helpful to newbies

 - Default to start pager (most), fall back to less/more/cat
 - Drop : from sub-headings
 - Repeat 'See Also' section
 - Relocate network section's Interesting Files to end
 - Add dhcpcd.conf to list of interesting files

Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
---
 board/common/rootfs/bin/help                  | 63 +++++++++++++------
 .../rootfs/etc/profile.d/convenience.sh       |  2 +-
 configs/aarch64_defconfig                     |  2 +
 configs/amd64_defconfig                       |  2 +
 4 files changed, 50 insertions(+), 19 deletions(-)

diff --git a/board/common/rootfs/bin/help b/board/common/rootfs/bin/help
index 8158ad5b..cfffa421 100755
--- a/board/common/rootfs/bin/help
+++ b/board/common/rootfs/bin/help
@@ -10,15 +10,21 @@ H0=$(printf '\033[0m')
 overview()
 {
 	cat <<EOF
-${H2}Syntax:${H0}
+${H1}Help System            Press 'Q' to quit | Arrow keys and PgUp/PgDn to scroll   ${H0}
+
+${H2}See Also${H0}
+  help edit            Tutorial on VI and Mg editors
+  help net             Network set up introduction
+
+${H2}General Syntax${H0}
   cmd [optional arg]   E.g., use 'date -h' to get help for date command
 
-${H2}File system:${H0}
+${H2}File system${H0}
   pwd | ls | cd        Show directory, contents, or change directory
   cat file             Show file contents
   vi  | mg [file]      Edit file with the VI or Micro Emacs editor
 
-${H2}Services:${H0}
+${H2}Services${H0}
   initctl list         Lists all configurable services (svc's)
   initctl enable svc   Enable a service 'svc'
   initctl reload       Reload init process' state, start/stop svc's
@@ -27,7 +33,7 @@ ${H2}Services:${H0}
   initctl restart svc  Restart a running 'svc'
   initctl status [svc] Display running status of all services, or one 'svc'
 
-${H2}Tools:${H0}
+${H2}Tools${H0}
   date    [-h]         Display current time, or sets the system date
   factory              Factory reset the device (on the next boot)
   hwclock [-h]         Query or set the hardware clock (RTC)
@@ -41,7 +47,7 @@ ${H2}Tools:${H0}
   reboot               Restart the device
   reset                Reset the shell prompt if it gets garbled
 
-${H2}Network Tools:${H0}
+${H2}Network Tools${H0}
   ethtool    [-h]      Ethernet stats, and low-level MAC/PHY settings
   traceroute [-h]      Trace the route ip packets follow going to a host
   tcpdump    [-h]      Display network packet headers in real-time
@@ -86,7 +92,6 @@ ${H2}Example Commands${H0}
 ${H2}See Also${H0}
   help edit            Tutorial on VI and Mg editors
   help net             Network set up introduction
-  help net | less      Read with less pager, use 'h' for help, 'q' to quit
 
 EOF
 }
@@ -475,14 +480,6 @@ The resulting stack of interfaces look like this:
               eth0 eth1  :  eth2 eth3      Layer-1 :: Link layer
                          :
 
-${H2}Interesting Files:${H0}
-
- - /etc/network/interfaces      The original, useful for small setups
- - /etc/network/interfaces.d/*  Snippets, useful for non-trivial setups
- - /etc/mactab                  Rename interfaces: 'NAME16CHARS WHITESPACE MAC'
- - /etc/sysctl.conf             Interface and TCP/IP settings, e.g., routing
- - /etc/sysctl.d/*              Snippets, useful for per-subsystem settings
-
 
 ${H2}Persistent Configuration${H0}
 
@@ -566,6 +563,16 @@ Another way is to add something like this to /etc/rc.local:
     done
 
 
+${H2}Interesting Files${H0}
+
+ - /etc/dhcpcd.conf             General DHCP and ZeroConf (LL) settings
+ - /etc/network/interfaces      The original, useful for small setups
+ - /etc/network/interfaces.d/*  Snippets, useful for non-trivial setups
+ - /etc/mactab                  Rename interfaces: 'NAME16CHARS WHITESPACE MAC'
+ - /etc/sysctl.conf             Interface and TCP/IP settings, e.g., routing
+ - /etc/sysctl.d/*              Snippets, useful for per-subsystem settings
+
+
 ${H1}Summary                                                                        ${H0}
 
 All persistent networking is set up in /etc/network/interfaces using the
@@ -590,10 +597,12 @@ on vlan2.
 EOF
 }
 
-topic=$1
-[ -n "$topic" ] && shift
+topic()
+{
+	topic=$1
+	[ -n "$1" ] && shift
 
-case $topic in
+	case $topic in
 	ed*)
 		editor $*
 		;;
@@ -603,4 +612,22 @@ case $topic in
 	*)
 		overview
 		;;
-esac
+	esac
+}
+
+if [ -t 1 ] ; then
+	fn=$(mktemp /tmp/system-help.XXXXXX)
+	topic $* >"$fn"
+	if command -v most; then
+		most "$fn"
+	elif command -v less; then
+		less -R "$fn"
+	elif command -v more; then
+		more "$fn"
+	else
+		cat "$fn"
+	fi
+	rm "$fn"
+else
+	topic $*
+fi
diff --git a/board/common/rootfs/etc/profile.d/convenience.sh b/board/common/rootfs/etc/profile.d/convenience.sh
index 92154db0..f8939a1d 100644
--- a/board/common/rootfs/etc/profile.d/convenience.sh
+++ b/board/common/rootfs/etc/profile.d/convenience.sh
@@ -3,6 +3,7 @@ alias la='ls -A'
 alias ll='ls -alF'
 alias ls='ls --color=auto'
 
+alias less=most
 alias vim='vi'
 alias view='vi -R'
 alias emacs='mg'
@@ -17,4 +18,3 @@ alias ipb='ip -br'
 alias ipaddr='ip addr'
 alias iplink='ip link'
 alias bridge='bridge --color=auto'
-
diff --git a/configs/aarch64_defconfig b/configs/aarch64_defconfig
index adc93ad0..33dee033 100644
--- a/configs/aarch64_defconfig
+++ b/configs/aarch64_defconfig
@@ -81,6 +81,8 @@ BR2_PACKAGE_SYSKLOGD=y
 BR2_PACKAGE_SYSKLOGD_LOGGER=y
 BR2_PACKAGE_WATCHDOGD=y
 BR2_PACKAGE_MG=y
+BR2_PACKAGE_MOST=y
+BR2_PACKAGE_NANO=y
 BR2_TARGET_ROOTFS_EXT2=y
 BR2_TARGET_ROOTFS_EXT2_4=y
 BR2_TARGET_ROOTFS_EXT2_SIZE="384M"
diff --git a/configs/amd64_defconfig b/configs/amd64_defconfig
index 0c9b236a..90eccc5e 100644
--- a/configs/amd64_defconfig
+++ b/configs/amd64_defconfig
@@ -77,6 +77,8 @@ BR2_PACKAGE_SYSKLOGD=y
 BR2_PACKAGE_SYSKLOGD_LOGGER=y
 BR2_PACKAGE_WATCHDOGD=y
 BR2_PACKAGE_MG=y
+BR2_PACKAGE_MOST=y
+BR2_PACKAGE_NANO=y
 BR2_TARGET_ROOTFS_EXT2=y
 BR2_TARGET_ROOTFS_EXT2_SIZE="128M"
 BR2_TARGET_ROOTFS_ISO9660=y