Add docstrings

bin/eeiam.in

@@ -37,12 +37,18 @@ usage() {
 #
 
 familiars_at() {
+    #
+    # daemons specific to $1 location plus the rest
+    #
     test -n "$1" || usagef "location"
     iniread -p iam.needing.at.$1 iam.ini
     iniread -p iam.needing.at.ANY iam.ini
 }
 
 where_i_am() {
+    #
+    # what is my physical location?
+    #
     if=$(iniread -p iam.using.if iam.ini)
     gwmac=$(arp | grep "^gateway\\>.*\\<$if\$" | tr ' ' '\n' | grep :)
     iniread -p iam.seeing.gw.$gwmac iam.ini | grep . || echo OUT
@@ -54,6 +60,9 @@ where_i_am() {
 #
 
 i_am_afk() {
+    #
+    # away from keyboard; blocks until i'm back again
+    #
     mocp --pause
     slock
 }
@@ -63,6 +72,9 @@ i_am_at() {
 }
 
 i_am_back() {
+    #
+    # returning to work (should be called by other subcommands)
+    #
     local f fbin
     for f in $(familiars_at $(where_i_am));
     do
@@ -73,6 +85,9 @@ i_am_back() {
 }
 
 i_am_gone() {
+    #
+    # gone fishin'
+    #
     kdestroy
     killall $(familiars_at $(where_i_am))
     i_am_afk
@@ -80,14 +95,23 @@ i_am_gone() {
 }
 
 i_am_moving() {
+    #
+    # to other train or dreamland, but localhost must sleep now
+    #
     die "not implemented"   # hint: use zleep
 }
 
 i_am_ooo() {
+    #
+    # too dangerous to implement
+    #
     die "not implemented"
 }
 
 i_am_wfh() {
+    #
+    # too dangerous to implement
+    #
     die "not implemented"
 }