doc(unitproc):checkAgePubkey: Added comment about stderr output

[BK-2020-03.git] / unitproc / bktemp-checkAgePubkey

diff --git a/unitproc/bktemp-checkAgePubkey b/unitproc/bktemp-checkAgePubkey
index 8089111fa6bf993d12fdff4a5cfeeab53f563ba8..12f20445c69918737aa2f1bdca002e15fc7bbb9d 100644 (file)
--- a/unitproc/bktemp-checkAgePubkey
+++ b/unitproc/bktemp-checkAgePubkey
@@ -3,10 +3,11 @@
 checkAgePubkey() {
     # Desc: Checks if string is an age-compatible pubkey
     # Usage: checkAgePubkey [str pubkey]
-    # Version: 0.1.0
+    # Version: 0.1.2
     # Input: arg1: string
     # Output: return code 0: string is age-compatible pubkey
     #         return code 1: string is NOT an age-compatible pubkey
+    #         age stderr (ex: there is stderr if invalid string provided)
     # Depends: age (v0.1.0-beta2; https://github.com/FiloSottile/age/releases/tag/v1.0.0-beta2 )
     
     argPubkey="$1";
@@ -17,3 +18,13 @@ checkAgePubkey() {
        return 1;
     fi;
 } # Check age pubkey
+
+#==BEGIN sample code==
+myKey="age18nnr0nm9fg44elkhrrcn3uhalvug04swas6su464k2kx92l05v6s4exfcz";
+if checkAgePubkey "$myKey"; then echo "Is an age-compatible public key:$myKey"; else echo "Is NOT an age-compatible public key:$myKey"; fi
+myKey2="blahblahblah";
+if checkAgePubkey "$myKey2"; then echo "Is an age-compatible public key:$myKey2"; else echo "Is NOT an age-compatible public key:$myKey2"; fi
+#==END sample code==
+
+# Author: Steven Baltakatei Sandoval
+# License: GPLv3+