From 7bc5f73e27233a8f32294ba96d523efc643a57b7 Mon Sep 17 00:00:00 2001
From: Asif Bacchus <asif@bacchus.cloud>
Date: Sat, 8 May 2021 03:43:47 -0600
Subject: [PATCH] docs: add in-script example commands

---
 cfddns.posix.sh | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/cfddns.posix.sh b/cfddns.posix.sh
index ab0d8e1..9153f89 100644
--- a/cfddns.posix.sh
+++ b/cfddns.posix.sh
@@ -108,6 +108,9 @@ scriptHelp() {
     textblockSwitches "-h | --help | -?"
     textblock "Display this help screen."
     newline
+    textblockSwitches "--examples"
+    textblock "Show some usage examples."
+    newline
     textblock "${magenta}--- DNS related parameters ---${norm}"
     newline
     textblockSwitches "-r | --record | --records"
@@ -129,6 +132,32 @@ scriptHelp() {
     exit 0
 }
 
+scriptExamples() {
+    newline
+    printf "Update CloudFlare DNS host A/AAAA records with current IP address.\n"
+    printf "%sUsage: %s --records host.domain.tld[,host2.domain.tld,...] [parameters]%s\n\n" "$bold" "$scriptName" "$norm"
+    textblock "${magenta}--- usage examples ---${norm}"
+    newline
+    textblockSwitches "${scriptName} -r myserver.mydomain.net"
+    textblock "Update CloudFlare DNS records for myserver.mydomain.net with the auto-detected public IP4 address. Credentials will be expected in the default location and the log will be written in the default location also."
+    newline
+    textblockSwitches "${scriptName} -r myserver.mydomain.net -6"
+    textblock "Same as above, but update AAAA host records with the auto-detected public IP6 address."
+    newline
+    textblockSwitches "${scriptName} -r myserver.mydomain.net,otherserver.mydomain.net -l /var/log/cfddns.log --nc"
+    textblock "Update DNS entries for both listed hosts using auto-detected IP4 address. Write a non-coloured log to '/var/log/cfddns.log'."
+    newline
+    textblockSwitches "${scriptName} -r myserver.mydomain.net,otherserver.mydomain.net -l /var/log/cfddns.log --ip6 --ip fd21:7a62:2737:9c3a::a151"
+    textblock "Update DNS AAAA entries for listed hosts using the *specified* IP address. Write a colourful log to the location specified."
+    newline
+    textblockSwitches "${scriptName} -r myserver.mydomain.net -c /root/cloudflare.creds -l /var/log/cfddns.log --ip 1.2.3.4"
+    textblock "Update DNS A entry for listed hostname with the provided IP address. Read cloudflare credentials file from specified location, save log in specified location."
+    newline
+    textblockSwitches "${scriptName} -r myserver.mydomain.net -c /root/cloudflare.creds -l /var/log/cfddns.log -6 -i fd21:7a62:2737:9c3a::a151"
+    textblock "Exact same as above, but change the AAAA record. This is how you run the script once for IP4 and again for IP6."
+    exit 0
+}
+
 textblock() {
     printf "%s\n" "$1" | fold -w "$width" -s
 }
@@ -171,6 +200,10 @@ while [ $# -gt 0 ]; do
         # display help
         scriptHelp
         ;;
+    --examples)
+        # display sample commands
+        scriptExamples
+        ;;
     -l | --log)
         # set log file location
         if [ -n "$2" ]; then