simplify docs
authorIan Kelling <iank@fsf.org>
Fri, 12 Apr 2019 23:27:20 +0000 (19:27 -0400)
committerIan Kelling <iank@fsf.org>
Fri, 12 Apr 2019 23:27:20 +0000 (19:27 -0400)
libremanage

index 6cf1898fbd1219e38cbc65bef87489b0aba608cd..48e870c6728fe78b50b1e2510ef706dfb7accf74 100755 (executable)
@@ -12,13 +12,28 @@ v() {
 
 usage() {
   cat <<EOF
-Usage: libremanage poweroff|poweron|reboot HOSTNAME|CHANNEL [BOARD_ID]
+Basic Usage: libremanage poweroff|poweron|reboot HOSTNAME
 
-HOSTNAME is based on configuration in /etc/libremanage.conf.
+Available HOSTNAMEs defined in /etc/libremanage.conf on this machine:
+
+EOF
+
+  if [[ -e /etc/libremanage.conf ]]; then
+    sed -r '/\s*#/d;/^\s*$/d;s/_.*//' /etc/libremanage.conf
+  else
+    echo "/etc/libremanage.conf does not exist."
+  fi
+
+  cat <<EOF
+
+Thats all you need to know unless you are defining configuration or
+setting up a device.
+
+Advanced Usage: libremanage poweroff|poweron|reboot HOSTNAME|CHANNEL [BOARD_ID]
 
 Note, the relay's channels default state when plugged in are off.
 
-Example config:
+Example /etc/libremanage.conf:
 
 # This config is sourced from bash, so make sure its valid bash.
 cephserver3_channel=1
@@ -27,7 +42,6 @@ cephserver2_channel=2
 cephserver2_board_id=HURTM
 # end of config
 
-Example usage given the above config:
 
 libremanage reboot cephserver3
 
@@ -48,7 +62,7 @@ script is running, it will continue to run and complete.
 
 EOF
   if [[ -e /etc/libremanage.conf ]]; then
-    echo "Current config:"
+    echo "Current /etc/libremanage.conf:"
     cat /etc/libremanage.conf
   else
     echo "Note: /etc/libremanage.conf does not exist on the current machine"