From 8b044cea5c90dac7f0b8af50335405e895cf343d Mon Sep 17 00:00:00 2001
From: Julian <julian.cenkier@wp.eu>
Date: Thu, 29 May 2025 11:11:56 +0200
Subject: [PATCH] v0.7.1: Added detailed help and none encryption

.config 100% compatible with previews version
shellcheck 100% valid
*
Added detailed help to show:
- defined backup dirs
- if is more prunes
- encryption kind
- shorten executable name
*
If Passphrase is empty then apply NONE for encryption. No longer error display.
---
 borg-backup.sh | 57 +++++++++++++++++++++++++++++++-------------------
 1 file changed, 35 insertions(+), 22 deletions(-)

diff --git a/borg-backup.sh b/borg-backup.sh
index b20c847..47bccea 100755
--- a/borg-backup.sh
+++ b/borg-backup.sh
@@ -43,7 +43,8 @@
 
 set -eu
 
-BORG_BACKUP_SH_VERSION="0.7.0"
+BORG_BACKUP_SH_VERSION="0.7.1"
+SH="${0##*/}"
 
 : "${BORG:=/usr/local/bin/borg}"
 : "${CONFIG:=/etc/borg-backup.conf}"
@@ -57,33 +58,43 @@ err() {
 }
 
 usage() {
-	echo "borg-backup.sh $BORG_BACKUP_SH_VERSION"
+	echo
+	echo "* ${SH%%.*} * $BORG_BACKUP_SH_VERSION *"
 	echo
 	echo "Configuration:"
 	echo "  Borg:        $BORG"
 	echo "  Config:      $CONFIG"
 	echo "  Backups:     $BACKUPS"
+		for B in $BACKUPS; do
+			eval "DIRS=\${BACKUP_${B}-}"
+			[ -n "$DIRS" ] && echo "  | ${B}: ${DIRS}"
+		done
 	echo "  Location:    $TARGET"
+	echo "  Encryption:  $REPOKEY"
 	echo "  Compression: $COMPRESSION"
 	echo "  Pruning:     $PRUNE"
+		for B in $BACKUPS; do
+			eval "THIS_PRUNE=\${PRUNE_${B}-}"
+			[ -n "$THIS_PRUNE" ] && echo "  | ${B}: ${THIS_PRUNE}"
+		done     
 	echo
 	echo "Usage:"
-	echo " $0 help"
-	echo " $0 init [BACKUP]"
-	echo " $0 create [BACKUP]"
-	echo " $0 list [BACKUP]"
-	echo " $0 check [BACKUP]"
-	echo " $0 quickcheck [BACKUP]"
-	echo " $0 repocheck [BACKUP]"
-	echo " $0 prune [BACKUP]"
-	echo " $0 compact [BACKUP]"
-	echo " $0 break-lock [BACKUP]"
-	echo " $0 extract BACKUP [borg extract command]"
-	echo " $0 info BACKUP ARCHIVE"
-	echo " $0 delete BACKUP ARCHIVE"
-	echo " $0 borg BACKUP [arbitrary borg command-line]"
+	echo " $SH help"
+	echo " $SH init [BACKUP]"
+	echo " $SH create [BACKUP]"
+	echo " $SH list [BACKUP]"
+	echo " $SH check [BACKUP]"
+	echo " $SH quickcheck [BACKUP]"
+	echo " $SH repocheck [BACKUP]"
+	echo " $SH prune [BACKUP]"
+	echo " $SH compact [BACKUP]"
+	echo " $SH break-lock [BACKUP]"
+	echo " $SH extract BACKUP [borg extract command]"
+	echo " $SH info BACKUP ARCHIVE"
+	echo " $SH delete BACKUP ARCHIVE"
+	echo " $SH borg BACKUP [arbitrary borg command-line]"
 	echo
-	echo " e.g: $0 borg etc extract ::etc-2017-02-21T20:00Z etc/rc.conf --stdout"
+	echo " e.g: $SH borg etc extract ::etc-2017-02-21T20:00Z etc/rc.conf --stdout"
 	echo
 	echo "Use a BACKUP name of '--' to apply a 'borg' command to all backups"
 	exit "$1"
@@ -98,7 +109,12 @@ usage() {
 
 [ -e "$BORG" ]          || err "$BORG not executable (see https://borgbackup.readthedocs.io/en/stable/installation.html)"
 [ -z "$PRUNE" ]         && err "PRUNE not set (e.g. '-H 24 -d 14 -w 8 -m 6')"
-[ -z "${PASSPHRASE-}" ] && err "PASSPHRASE not set (e.g. 'incorrect zebra generator clip')"
+if [ -z "${PASSPHRASE-}" ];then
+	REPOKEY="none"
+else
+	REPOKEY="repokey"
+	export BORG_PASSPHRASE="$PASSPHRASE"
+fi
 [ -z "${TARGET-}" ]     && err "TARGET not set (e.g. 'backup@host:/backup/path')"
 [ -z "${BACKUPS-}" ]    && err "BACKUPS not set (e.g. 'homes etc')"
 
@@ -107,8 +123,6 @@ for B in $BACKUPS; do
 	[ -z "${DIRS}" ] && err "BACKUP_${B} not set (e.g. '/home/bla -e /home/bla/.foo')"
 done
 
-export BORG_PASSPHRASE="$PASSPHRASE"
-
 TIMESTAMP=$(date -u +"%Y-%m-%dT%H:%MZ")
 
 nargs=$#
@@ -125,7 +139,7 @@ for B in $BACKUPS; do
 		case $cmd in
 			init)
 				[ "$nargs" -gt 2 ] && usage 64
-				$BORG init --encryption=repokey || rc=$?
+				$BORG init --encryption=$REPOKEY || rc=$?
 			;;
 			create)
 				[ "$nargs" -gt 2 ] && usage 64
@@ -189,4 +203,3 @@ for B in $BACKUPS; do
 done
 
 exit $rc
-