v1.7.10

Author: RaspberryFpc

CHANGELOG.md

@@ -1,11 +1,20 @@
 # Changelog
 All notable changes to this project are documented in this file.
 
-## [1.7.7] – 2026-04-08
+## [1.7.10] – 2026-04-10
+
+### ✨ Improvements
+
+* Added a tips/help file with compression recommendations and exclude file syntax documentation.
+* Added installation of README, CHANGELOG, LICENSE and tips documentation to `/usr/share/doc/pibackup/`.
+* Critical buttons and UI elements are now disabled while backup or restore processes are running to prevent invalid operations and accidental user interaction.
+
+
+## [1.7.9] – 2026-04-08
 
 ### ✨ Improvements
 
-*Removed checkbox to optionally ignore the MBR signature, no need anymore
+* Removed checkbox to optionally ignore the MBR signature, no need anymore
 
 
 ## [1.7.7] – 2026-04-08

bin/pibackup.deb

@@ -2,7 +2,7 @@
 set -euo pipefail
 
 PKG="pibackup_pkg"
-version="1.7.9"
+version="1.7.10"
 OUTDIR="/home/pi/git/pibackup/bin"
 
 SRC_BIN="/home/pi/git/pibackup/source/pibackup"
@@ -24,6 +24,7 @@ mkdir -p "$PKG/DEBIAN"
 mkdir -p "$PKG/usr/lib/pibackup"
 mkdir -p "$PKG/usr/share/applications"
 mkdir -p "$PKG/usr/share/icons/hicolor/256x256/apps"
+mkdir -p "$PKG/usr/share/doc/pibackup"
 
 # Binary
 install -Dm755 "$SRC_BIN" \
@@ -44,6 +45,20 @@ install -Dm644 /home/pi/git/pibackup/source/raspberry.exclude \
 install -Dm644 /home/pi/git/pibackup/source/ssh-cleanup.exclude \
     "$PKG/etc/pibackup/ssh-cleanup.exclude"
 
+install -Dm644 /home/pi/git/pibackup/docs/tips.md \
+    "$PKG/usr/share/doc/pibackup/tips.txt"
+
+install -Dm644 /home/pi/git/pibackup/README.md \
+    "$PKG/usr/share/doc/pibackup/README.md"
+
+install -Dm644 /home/pi/git/pibackup/CHANGELOG.md \
+    "$PKG/usr/share/doc/pibackup/CHANGELOG.md"
+
+install -Dm644 /home/pi/git/pibackup/LICENSE \
+    "$PKG/usr/share/doc/pibackup/LICENSE"
+
+
+
 
 cat > "$PKG/etc/pibackup/pibackup.ini" <<EOF
 [Drive]

build_deb.sh

@@ -0,0 +1,197 @@
+# pibackup Exclude File Syntax
+
+Exclude files can be used to remove unnecessary files and directories from the backup image before compression.
+
+Default example file:
+
+```text
+/etc/pibackup/raspberry.exclude
+```
+
+## Syntax
+
+Each line uses the following format:
+
+```text
+command = /path
+```
+
+Lines starting with `#` are comments.
+
+The placeholder:
+
+```text
+§user
+```
+
+is automatically replaced with the current username.
+
+---
+
+## Available Commands
+
+### RF = Remove File
+
+Removes a single file.
+
+Example:
+
+```text
+rf = /home/§user/.bash_history
+```
+
+---
+
+### RD = Remove Directory
+
+Removes an empty directory.
+
+Example:
+
+```text
+rd = /home/§user/emptyfolder
+```
+
+---
+
+### RT = Remove Tree
+
+Removes a directory and everything inside it.
+
+Example:
+
+```text
+rt = /var/lib/snapd
+```
+
+---
+
+### RFID = Remove Files In Directory
+
+Removes all files in a directory but keeps subdirectories.
+
+Example:
+
+```text
+rfid = /var/backups/*
+```
+
+---
+
+### RAID = Remove All In Directory
+
+Removes everything inside a directory, but keeps the directory itself.
+
+Example:
+
+```text
+raid = /home/§user/Downloads
+```
+
+---
+
+### RAIT = Remove All In Tree
+
+Removes all files and directories inside a directory, including subdirectories, but keeps the top-level directory.
+
+Example:
+
+```text
+rait = /tmp
+```
+
+---
+
+## Example Exclude Entries
+
+```text
+# Temporary directories
+rait = /tmp
+rait = /var/tmp
+rait = /var/cache/apt/archives
+
+# Logs
+rait = /var/log
+
+# Browser cache
+rait = /home/§user/.cache/mozilla
+rait = /home/§user/.cache/chromium
+
+# Downloads folder contents
+raid = /home/§user/Downloads
+
+# Snap
+rt = /var/lib/snapd
+rt = /home/§user/snap
+```
+
+---
+
+## Notes
+
+* Commands are case-insensitive.
+* Spaces around `=` are optional.
+* Invalid or missing paths are ignored.
+* Be careful when using `rt`, because it removes complete directory trees.
+* `raid` and `rait` are safer if you want to keep the main directory structure.
+* Comment out optional entries with `#` if you do not want them to be used.
+* The exclude file is processed before shrinking and compression start.
+
+---
+
+# Compression Guide
+
+pibackup uses Zstandard (zstd) with long mode always enabled.
+
+## Compression Levels
+
+### Level 1–3
+
+* Very fast
+* Larger backup files
+* Good for frequent backups
+
+### Level 4–6
+
+* Best balance between speed and compression
+* Recommended for most users
+* Suggested default range
+
+### Level 7–10
+
+* Better compression ratio
+* Noticeably slower
+* Useful if storage space is important
+
+### Level 11–19
+
+* Maximum compression ratio
+* Very slow
+* Usually only useful for archive backups
+
+## Long Mode (--long)
+
+Long mode is always enabled.
+
+It improves compression by searching further back in the data stream.
+This is especially useful for Raspberry Pi images because they often contain many repeated patterns.
+
+Important:
+
+* Lower compression levels with long mode can sometimes achieve similar results faster than higher levels without it.
+* Very high compression levels often provide only small additional savings.
+* Level 4–6 is usually the best compromise.
+
+## Recommended Levels by Device
+
+### Raspberry Pi 3
+
+* Level 3–5
+
+### Raspberry Pi 4
+
+* Level 4–7
+
+### Raspberry Pi 5
+
+* Level 5–10