From 023fc2cb6b96eabb45a5d35c527516c5e5ae319a Mon Sep 17 00:00:00 2001
From: Bryan Black <reelsense@users.noreply.github.com>
Date: Thu, 19 Jul 2018 15:05:24 -0700
Subject: [PATCH] added code comments

---
 yubikey_gpg-agent-forward.sh | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/yubikey_gpg-agent-forward.sh b/yubikey_gpg-agent-forward.sh
index b956b18..6848336 100644
--- a/yubikey_gpg-agent-forward.sh
+++ b/yubikey_gpg-agent-forward.sh
@@ -1,9 +1,16 @@
 #!/bin/bash
 
 function gpg-agent-forward() {
+# BEGIN variables
+# Input variables
 ruser=$1
-hostshortcut=$(cat /dev/urandom | env LC_CTYPE=C tr -dc "a-z0-9" | fold -w 3 | head -n 1)
 hostname=$2
+# Generates random 3 character host shortcut. LC_CTYPE is needed for OS X and FreeBSD.
+# https://gist.github.com/earthgecko/3089509
+hostshortcut=$(cat /dev/urandom | env LC_CTYPE=C tr -dc "a-z0-9" | fold -w 3 | head -n 1)
+# END VARIABLES
+
+# BEGIN script
 touch ~/.ssh/config
 echo "CREATING GPG-AGENT FORWARDING CONFIG"
 echo "YOUR HOST SHORTCUT IS \"$hostshortcut\""
@@ -15,7 +22,11 @@ echo "  RemoteForward /home/$ruser/.gnupg/S.gpg-agent.ssh $HOME/.gnupg/S.gpg-age
 echo "  ServerAliveInterval 10" >> ~/.ssh/config
 echo "Use this shortcut to forward your Yubikey to $host:"
 echo "  ssh $hostshortcut" 
+echo "Inspect or edit the config:"
+echo "  vi ~/.ssh/config"
+echo "DONE"
 return 0
+# END script
 }
 
 gpg-agent-forward $1 $2