From edef3c330339a48eb8c575ed0efc79e2eeb38dba Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Stephan=20D=C3=BCsterhaupt?= <me@stephanduesterhaupt.de>
Date: Sun, 28 Jun 2026 10:08:08 +0200
Subject: [PATCH] style: refine dyndns.sh and vars.example comments and
 formatting

---
 dyndns.sh    | 44 ++++++++++++++++++++++----------------------
 vars.example |  4 ++--
 2 files changed, 24 insertions(+), 24 deletions(-)

diff --git a/dyndns.sh b/dyndns.sh
index 350cda7..749a27a 100644
--- a/dyndns.sh
+++ b/dyndns.sh
@@ -17,7 +17,7 @@
 # - Validate database connectivity before command execution
 # - POSIX-compatible operation for cron and service integration
 
-# Authors: Stephan Düsterhaupt
+# Authors: Stephan Düsterhaupt, Ivo Noack aka Insonic
 # Copyright (c) 2018-2026 CB-601 - the open tec Elevator
 # License: MIT
 
@@ -233,10 +233,10 @@ _vars_source_check() {
     [ -n "$DYNDNS_SQL_USER" ]     || _die "DYNDNS_SQL_USER env-var undefined" 5
     [ -n "$DYNDNS_SQL_PASS" ]     || _die "DYNDNS_SQL_PASS env-var undefined" 5
 
-    [ -n "$DYNDNS_BIND_ZONE" ]          || _die "DYNDNS_BIND_ZONE env-var undefined" 5
-    [ -n "$DYNDNS_BIND_ZONE_KEY" ]      || _die "DYNDNS_BIND_ZONE_KEY env-var undefined" 5
-    [ -n "$DYNDNS_BIND_ZONE_DIR" ]      || _die "DYNDNS_BIND_ZONE_DIR env-var undefined" 5
-    [ -n "$DYNDNS_BIND_ZONE_FILE" ]     || _die "DYNDNS_BIND_ZONE_FILE env-var undefined" 5
+    [ -n "$DYNDNS_BIND_ZONE" ]      || _die "DYNDNS_BIND_ZONE env-var undefined" 5
+    [ -n "$DYNDNS_BIND_ZONE_KEY" ]  || _die "DYNDNS_BIND_ZONE_KEY env-var undefined" 5
+    [ -n "$DYNDNS_BIND_ZONE_DIR" ]  || _die "DYNDNS_BIND_ZONE_DIR env-var undefined" 5
+    [ -n "$DYNDNS_BIND_ZONE_FILE" ] || _die "DYNDNS_BIND_ZONE_FILE env-var undefined" 5
 
     _log "Leave the function '_vars_source_check()'..." 1
 
@@ -253,8 +253,8 @@ _verify_runtime_init() {
 
     _vars_source_check
 
-    [ -d "$DYNDNS_LOG_DIR" ]           || _die "DYNDNS_LOG_DIR missing. $help_note" 5
-    [ -d "$DYNDNS_BIND_ZONE_DIR" ]     || _die "DYNDNS_BIND_ZONE_DIR missing. $help_note" 5
+    [ -d "$DYNDNS_LOG_DIR" ]       || _die "DYNDNS_LOG_DIR missing. $help_note" 5
+    [ -d "$DYNDNS_BIND_ZONE_DIR" ] || _die "DYNDNS_BIND_ZONE_DIR missing. $help_note" 5
 
     #[ -f "$DYNDNS_BIND_ZONE_FILE" ]     || _die "DYNDNS_BIND_ZONE_FILE missing. $help_note" 5
 
@@ -398,17 +398,17 @@ set_var() {
 
 
 # SDuesterhaupt: 2026-06-18 - Write a message to the dynDNS log file.
-
-# Severity levels:
-# 0 -> OFF
-# 1 -> DEBUG
-# 2 -> INFO
-# 3 -> WARNING
-# 4 -> ERROR
-# 5 -> CRITICAL
-
-# @param1: Log message.
-# @param2: Severity level.
+#
+#                Severity levels:
+#                  0 -> OFF
+#                  1 -> DEBUG
+#                  2 -> INFO
+#                  3 -> WARNING
+#                  4 -> ERROR
+#                  5 -> CRITICAL
+#
+#                @param1: Log message.
+#                @param2: Severity level.
 _log() {
     msg=$1
     level=${2:-0}
@@ -444,10 +444,10 @@ _log() {
 
 
 # SDuesterhaupt: 2026-06-18 - Check whether DYNDNS_MEMBER_HOSTNAME is a valid hostname
-
-# Returns:
-# 0 if valid
-# 1 if invalid
+#
+#                Returns:
+#                  0 if valid
+#                  1 if invalid
 _hostname_is_valid() {
     _log "Enter the function '_hostname_is_valid()'..." 1
 
diff --git a/vars.example b/vars.example
index b4579b3..44e1a1e 100644
--- a/vars.example
+++ b/vars.example
@@ -69,7 +69,7 @@
 # Database login credentials.
 # These are mainly used when DYNDNS_SQL_GROUP is unset/empty.
 #set_var DYNDNS_SQL_USER  "dyndns_user"
-#set_var DYNDNS_SQL_PASS  "strong_passphrase"
+#set_var DYNDNS_SQL_PASS  "<REPLACE_WITH_STRONG_PASSWORD>"
 
 # Additional database client options, if needed.
 # Example:
@@ -119,7 +119,7 @@
 #set_var DYNDNS_MEMBER_EMAIL  "admin@example24.com"
 
 # Password or shared secret used during member creation/authentication
-#set_var DYNDNS_MEMBER_PASS  "strong_passphrase"
+#set_var DYNDNS_MEMBER_PASS  "<REPLACE_WITH_STRONG_PASSWORD>"
 
 # ------------------------------------------------------------------
 # OPTIONAL COMMAND HOOKS