Ignore Podman container images (#380)

Same basic pattern as with Docker, but Podman uses a slightly different
path for this

.codespellrc

@@ -0,0 +1,6 @@
+[codespell]
+skip = .git,*.pdf,*.svg,go.sum,.codespellrc
+check-hidden = true
+# ignore-regex = 
+# ist -- unfortunate variable
+ignore-words-list = ist

.github/workflows/codespell.yml

@@ -0,0 +1,22 @@
+---
+name: Codespell
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

41_snapshots-btrfs

@@ -20,14 +20,16 @@
 # - Automatically generate grub.cfg if you use the provided systemd service.
 #
 # Installation:
-# - Refer to https://github.com/Antynea/grub-btrfs#installation-
+# - Refer to https://github.com/Antynea/grub-btrfs#%EF%B8%8F-installation
 #
 # Customization:
 #  You have the possibility to modify many parameters in /etc/default/grub-btrfs/config.
+#  Read more here https://github.com/Antynea/grub-btrfs#installation- an in the manpage
+#  'man grub-btrfs'
 #
 # Automatically update Grub
 #  If you would like grub-btrfs menu to automatically update when a snapshot is created or deleted:
-#  - Refer to https://github.com/Antynea/grub-btrfs#automatically-update-grub.
+#  - Refer to https://github.com/Antynea/grub-btrfs#-automatically-update-grub-upon-snapshot.
 #
 # Special thanks for assistance and contributions:
 # - My friends
@@ -39,30 +41,49 @@ set -e
 sysconfdir="/etc"
 grub_btrfs_config="${sysconfdir}/default/grub-btrfs/config"
 
-[[ -f "$grub_btrfs_config" ]] && . "$grub_btrfs_config"
-[[ -f "${sysconfdir}/default/grub" ]] && . "${sysconfdir}/default/grub"
-
-## Exit the script, if:
-[[ "${GRUB_BTRFS_DISABLE,,}" == "true" ]] && exit 0 # Disable Grub-btrfs is set to true (default=false)
-if ! type btrfs >/dev/null 2>&1; then exit 0; fi # btrfs-progs isn't installed
-[[ -f "${GRUB_BTRFS_MKCONFIG_LIB:-/usr/share/grub/grub-mkconfig_lib}" ]] && . "${GRUB_BTRFS_MKCONFIG_LIB:-/usr/share/grub/grub-mkconfig_lib}" || exit 0 # grub-mkconfig_lib couldn't be found
-# Root filesystem isn't btrfs
-root_fs=$(${grub_probe} --target="fs" / 2>/dev/null)
-[[ "$root_fs" != "btrfs" ]] && exit 0
+[ -f "$grub_btrfs_config" ] && . "$grub_btrfs_config"
+[ -f "${sysconfdir}/default/grub" ] && . "${sysconfdir}/default/grub"
 
 ## Error Handling
 print_error()
 {
     local err_msg="$*"
-    local bug_report="If you think an error has occurred , please file a bug report at \" https://github.com/Antynea/grub-btrfs \""
+    local bug_report="If you think an error has occurred, please file a bug report at \"https://github.com/Antynea/grub-btrfs\""
     printf "%s\n" "${err_msg}" "${bug_report}" >&2 ;
     exit 0
 }
 
+# parse arguments
+while getopts :V-: opt; do
+    case "$opt" in
+        -)
+            case "${OPTARG}" in
+                version)
+                    printf "Version %s\n" "${GRUB_BTRFS_VERSION}" >&2 ;
+                    exit 0
+                    ;;
+            esac;;
+        V)
+            printf "Version %s\n" "${GRUB_BTRFS_VERSION}" >&2 ;
+            exit 0
+            ;;
+        *)
+            printf "Unknown flag, exiting...\n"
+            exit 0
+            ;;
+    esac
+done
+
+## Exit the script, if:
+[ "$(echo "$GRUB_BTRFS_DISABLE" | tr '[:upper:]' '[:lower:]')" = 'true' ] && print_error "GRUB_BTRFS_DISABLE is set to true (default=false)"
+if ! type btrfs >/dev/null 2>&1; then print_error "btrfs-progs isn't installed"; fi
+[ -f "${GRUB_BTRFS_MKCONFIG_LIB:-/usr/share/grub/grub-mkconfig_lib}" ] && . "${GRUB_BTRFS_MKCONFIG_LIB:-/usr/share/grub/grub-mkconfig_lib}" || print_error "grub-mkconfig_lib couldn't be found"
+[[ "$(btrfs filesystem df / 2>&1)" == *"not a btrfs filesystem"* ]] && print_error "Root filesystem isn't btrfs"
+
 printf "Detecting snapshots ...\n" >&2 ;
 
 ## Submenu name
-distro=$(awk -F "=" '/^NAME=/ {gsub(/"/, "", $2); print $2}' /etc/os-release)
+distro=$(awk -F "=" '/^NAME=/ {gsub(/"/, "", $2); print $2}' /etc/os-release) # escape '
 submenuname=${GRUB_BTRFS_SUBMENUNAME:-"${distro:-Linux} snapshots"}
 ## Limit snapshots to show in the Grub menu (default=50)
 limit_snap_show="${GRUB_BTRFS_LIMIT:-50}"
@@ -72,9 +93,13 @@ btrfs_subvolume_sort="--sort=${GRUB_BTRFS_SUBVOLUME_SORT:-"-rootid"}"
 grub_directory=${GRUB_BTRFS_GRUB_DIRNAME:-"/boot/grub"}
 ## Customize BOOT directory, where kernels/initrams/microcode is saved.
 boot_directory=${GRUB_BTRFS_BOOT_DIRNAME:-"/boot"}
+## Customize GRUB-BTRFS.cfg directory, where "grub-btrfs.cfg" file is saved
+grub_btrfs_directory=${GRUB_BTRFS_GBTRFS_DIRNAME:-${grub_directory}}
+## Customize directory where "grub-btrfs.cfg" file is searched for by grub
+grub_btrfs_search_directory=${GRUB_BTRFS_GBTRFS_SEARCH_DIRNAME:-"\${prefix}"}
 ## Password protection management for submenu
 # Protection support for submenu (--unrestricted)
-case "${GRUB_BTRFS_DISABLE_PROTECTION_SUBMENU,,}" in
+case "$(echo "$GRUB_BTRFS_DISABLE_PROTECTION_SUBMENU" | tr '[:upper:]' '[:lower:]')" in
     true)   unrestricted_access_submenu="--unrestricted ";;
     *)      unrestricted_access_submenu=""
 esac
@@ -83,22 +108,41 @@ if [ -n "${GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS}" ] ; then
     protection_authorized_users="--users ${GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS} "
 fi
 
-## Probe informations of Root and Boot devices
+## Probe information of Root and Boot devices
 # Probe info "Root partition"
 root_device=$(${grub_probe} --target=device /) # Root device
 root_uuid=$(${grub_probe} --device ${root_device} --target="fs_uuid" 2>/dev/null) # UUID of the root device
 root_uuid_subvolume=$(btrfs subvolume show / 2>/dev/null) || print_error "UUID of the root subvolume is not available"; # If UUID of root subvolume is not available, then exit
-root_uuid_subvolume=$(awk -F":" 'match($1, /(^[ \t]+UUID)/) {sub(/^[ \t]+/, "", $2); print $2}' <<< "$root_uuid_subvolume") # UUID of the root subvolume
+root_uuid_subvolume=$(awk -F":" 'match($1, /(^[ \t]+UUID)/) {sub(/^[ \t]+/, "", $2); print $2}' <<< "$root_uuid_subvolume") # UUID of the root subvolume '
 # Probe info "Boot partition"
 boot_device=$(${grub_probe} --target=device ${boot_directory}) # Boot device
 boot_uuid=$(${grub_probe} --device ${boot_device} --target="fs_uuid" 2>/dev/null) # UUID of the boot device
 boot_uuid_subvolume=$(btrfs subvolume show "$boot_directory" 2>/dev/null) || boot_uuid_subvolume=" UUID: $root_uuid_subvolume"; # If boot folder isn't a subvolume, then UUID=root_uuid_subvolume
-boot_uuid_subvolume=$(awk -F":" 'match($1, /(^[ \t]+UUID)/) {sub(/^[ \t]+/, "", $2); print $2}' <<< "$boot_uuid_subvolume") # UUID of the boot subvolume
+boot_uuid_subvolume=$(awk -F":" 'match($1, /(^[ \t]+UUID)/) {sub(/^[ \t]+/, "", $2); print $2}' <<< "$boot_uuid_subvolume") # UUID of the boot subvolume '
 boot_hs=$(${grub_probe} --device ${boot_device} --target="hints_string" 2>/dev/null) # hints string
 boot_fs=$(${grub_probe} --device ${boot_device} --target="fs" 2>/dev/null) # Type filesystem of boot device
 
+# Enable LUKS encrypted devices support
+case "$(echo "$GRUB_BTRFS_ENABLE_CRYPTODISK" | tr '[:upper:]' '[:lower:]')" in
+    true)
+            list_insmods=()
+            list_insmods+=("insmod gzio")
+            list_insmods+=("insmod part_gpt")
+            list_insmods+=("insmod cryptodisk")
+            list_insmods+=("insmod luks")
+            list_insmods+=("insmod gcry_rijndael")
+            list_insmods+=("insmod gcry_rijndael")
+            list_insmods+=("insmod gcry_sha256")
+            list_insmods+=("insmod ${boot_fs}")
+            list_insmods+=("cryptomount -u $(echo $GRUB_CMDLINE_LINUX_DEFAULT | grep -o -P '(?<=cryptdevice=UUID=).*(?=:cryptdev)')")
+            ;;
+    *)
+            list_insmods=("insmod ${boot_fs}")
+            ;;
+esac
+
 ## Parameters passed to the kernel
-kernel_parameters="$GRUB_CMDLINE_LINUX $GRUB_CMDLINE_LINUX_DEFAULT"
+kernel_parameters="$GRUB_CMDLINE_LINUX $GRUB_CMDLINE_LINUX_DEFAULT $GRUB_BTRFS_SNAPSHOT_KERNEL_PARAMETERS"
 ## Mount point location
 grub_btrfs_mount_point=$(mktemp -dt grub-btrfs.XXXXXXXXXX)
 ## Class for theme
@@ -107,7 +151,7 @@ CLASS="--class snapshots --class gnu-linux --class gnu --class os"
 oldIFS=$IFS
 ## Detect uuid requirement (lvm,btrfs...)
 check_uuid_required() {
-if [ "x${root_uuid}" = "x" ] || [ "x${GRUB_DISABLE_LINUX_UUID}" = "xtrue" ] \
+if [ "${root_uuid}" = "" ] || [ "${GRUB_DISABLE_LINUX_UUID}" = "true" ] \
     || ! test -e "/dev/disk/by-uuid/${root_uuid}" \
     || ( test -e "${root_device}" && uses_abstraction "${root_device}" lvm ); then
     LINUX_ROOT_DEVICE=${root_device}
@@ -125,7 +169,7 @@ detect_rootflags()
 
 unmount_grub_btrfs_mount_point()
 {
-if [[ -d "$grub_btrfs_mount_point" ]]; then
+if [ -d "$grub_btrfs_mount_point" ]; then
     local wait=true
     local wait_max=0
     printf "Unmount %s .." "$grub_btrfs_mount_point" >&2;
@@ -135,7 +179,7 @@ if [[ -d "$grub_btrfs_mount_point" ]]; then
             if umount "$grub_btrfs_mount_point" >/dev/null 2>&1; then
                 wait=false # umount successful
                 printf " Success\n" >&2;
-            elif [[ $wait_max = 10 ]]; then
+            elif [ $wait_max -eq 10 ]; then
                 printf "\nWarning: Unable to unmount %s in %s\n" "$root_device" "$grub_btrfs_mount_point" >&2;
                 break;
             else
@@ -147,9 +191,9 @@ if [[ -d "$grub_btrfs_mount_point" ]]; then
             printf " Success\n" >&2;
         fi
     done
-    if [[ "$wait" != true ]]; then
+    if [ "$wait" != true ]; then
         if ! rm -d "$grub_btrfs_mount_point" >/dev/null 2>&1; then
-            printf "Unable to delete %s: Device or ressource is busy\n" "$grub_btrfs_mount_point" >&2;
+            printf "Unable to delete %s: Device or resource is busy\n" "$grub_btrfs_mount_point" >&2;
         fi
     fi
 fi
@@ -158,7 +202,7 @@ fi
 ## Create entry
 entry()
 {
-echo "$@" >> "$grub_directory/grub-btrfs.new"
+    echo "$@" >> "$grub_btrfs_directory/grub-btrfs.new"
 }
 
 ## menu entries
@@ -168,10 +212,10 @@ make_menu_entries()
     entry "submenu '${title_menu}' {
     submenu '${title_submenu}' { echo }"
     for k in "${name_kernel[@]}"; do
-        [[ ! -f "${boot_dir}"/"${k}" ]] && continue;
+        [ ! -f "${boot_dir}"/"${k}" ] && continue;
         kversion=${k#*"-"}
         for i in "${name_initramfs[@]}"; do
-            if [[ "${name_initramfs}" != "x" ]] ; then
+            if [ "${name_initramfs}" != "x" ] ; then
                 # prefix_i=${i%%"-"*}
                 suffix_i=${i#*"-"}
                 # alt_suffix_i=${i##*"-"}
@@ -182,7 +226,7 @@ make_menu_entries()
                 else continue;
                 fi
                 for u in "${name_microcode[@]}"; do
-                    if [[ "${name_microcode}" != "x" ]] ; then
+                    if [ "${name_microcode}" != "x" ] ; then
                     entry "
     menuentry '  "${k}" & "${i}" & "${u}"' ${CLASS} "\$menuentry_id_option" 'gnulinux-snapshots-$boot_uuid' {"
                     else
@@ -193,17 +237,26 @@ make_menu_entries()
         if [ x\$feature_all_video_module = xy ]; then
         insmod all_video
         fi
-        set gfxpayload=keep
-        insmod ${boot_fs}
+        set gfxpayload=keep"
+        for j in "${insmods[@]}"; do
+            entry "\
+        ${j}"
+        done
+        entry "\
         if [ x\$feature_platform_search_hint = xy ]; then
             search --no-floppy --fs-uuid  --set=root ${boot_hs} ${boot_uuid}
         else
             search --no-floppy --fs-uuid  --set=root ${boot_uuid}
+        fi"
+        if [ "${SUSE_BTRFS_SNAPSHOT_BOOTING:-"false"}" = "true" ]; then
+            entry "\
+        set btrfs_subvolid=5"
         fi
+        entry "\
         echo 'Loading Snapshot: "${snap_date_trim}" "${snap_dir_name_trim}"'
         echo 'Loading Kernel: "${k}" ...'
         linux \"${boot_dir_root_grub}/"${k}"\" root="${LINUX_ROOT_DEVICE}" ${kernel_parameters} ${rootflags}subvol=\""${snap_dir_name_trim}"\""
-                    if [[ "${name_microcode}" != "x" ]] ; then
+                    if [ "${name_microcode}" != "x" ] ; then
                         entry "\
         echo 'Loading Microcode & Initramfs: "${u}" "${i}" ...'
         initrd \"${boot_dir_root_grub}/"${u}"\" \"${boot_dir_root_grub}/"${i}"\""
@@ -217,7 +270,7 @@ make_menu_entries()
                 done
             else
                 for u in "${name_microcode[@]}"; do
-                    if [[ "${name_microcode}" != "x" ]] ; then
+                    if [ "${name_microcode}" != "x" ] ; then
                     entry "
     menuentry '  "${k}" & "${u}"' ${CLASS} "\$menuentry_id_option" 'gnulinux-snapshots-$boot_uuid' {"
                     else
@@ -234,11 +287,16 @@ make_menu_entries()
             search --no-floppy --fs-uuid  --set=root ${boot_hs} ${boot_uuid}
         else
             search --no-floppy --fs-uuid  --set=root ${boot_uuid}
+        fi"
+        if [ "${SUSE_BTRFS_SNAPSHOT_BOOTING:-"false"}" = "true" ]; then
+            entry "\
+        set btrfs_subvolid=5"
         fi
+        entry "\
         echo 'Loading Snapshot: "${snap_date_trim}" "${snap_dir_name_trim}"'
         echo 'Loading Kernel: "${k}" ...'
         linux \"${boot_dir_root_grub}/"${k}"\" root="${LINUX_ROOT_DEVICE}" ${kernel_parameters} ${rootflags}subvol=\""${snap_dir_name_trim}"\""
-                    if [[ "${name_microcode}" != "x" ]] ; then
+                    if [ "${name_microcode}" != "x" ] ; then
                         entry "\
         echo 'Loading Microcode: "${u}" ...'
         initrd \"${boot_dir_root_grub}/"${u}"\""
@@ -272,7 +330,7 @@ snapshot_list()
     IFS=$'\n'
     for snap in $(btrfs subvolume list -sa "${btrfs_subvolume_sort}" /); do # Parse btrfs snapshots
         IFS=$oldIFS
-        snap=($snap)
+        snap=(${snap})
         local path_snapshot=${snap[@]:13:${#snap[@]}}
         if [ "$path_snapshot" = "DELETED" ]; then continue; fi # Discard deleted snapshots
         [[ ${path_snapshot%%"/"*} == "<FS_TREE>" ]] && path_snapshot=${path_snapshot#*"/"} # Remove the "<FS_TREE>" string at the beginning of the path
@@ -280,7 +338,7 @@ snapshot_list()
         # ignore specific path during run "grub-mkconfig"
         if [ -n "${GRUB_BTRFS_IGNORE_SPECIFIC_PATH}" ] ; then
             for isp in "${GRUB_BTRFS_IGNORE_SPECIFIC_PATH[@]}" ; do
-                [[ "${path_snapshot}" == "${isp}" ]] && continue 2;
+                [ "${path_snapshot}" = "${isp}" ] && continue 2;
             done
         fi
         if [ -n "${GRUB_BTRFS_IGNORE_PREFIX_PATH}" ] ; then
@@ -288,30 +346,38 @@ snapshot_list()
                 [[ "${path_snapshot}" == "${isp}"/* ]] && continue 2;
             done
         fi
-        [[ ! -d "$grub_btrfs_mount_point/$path_snapshot/boot" ]] && continue; # Discard snapshots without /boot folder
+        [ ! -d "$grub_btrfs_mount_point/$path_snapshot/boot" ] && continue; # Discard snapshots without /boot folder
 
-        # Parse Snapper & timeshift informations
+        # Parse Snapper & timeshift & yabsnap information
         local type_snapshot="N/A"
         local description_snapshot="N/A"
+        
+        # path to yabsnap snapshot meta data
+        local yabsnap_info="$grub_btrfs_mount_point/${path_snapshot%"/"*}/$(echo "${snap[13]}" | awk -F'/' '{print $3 "-meta.json"}')"
+
         if [[ -s "$grub_btrfs_mount_point/${path_snapshot%"/"*}/$snapper_info" ]] ; then
             type_snapshot=$(awk -F"<|>" 'match($2, /^type/) {print $3}' "$grub_btrfs_mount_point/${path_snapshot%"/"*}/$snapper_info") # search matching string beginning "type"
             description_snapshot=$(awk -F"<|>" 'match($2, /^description/) {print $3}' "$grub_btrfs_mount_point/${path_snapshot%"/"*}/$snapper_info") # search matching string beginning "description"
         elif [[ -s "$grub_btrfs_mount_point/${path_snapshot%"/"*}/$timeshift_info" ]] ; then
             type_snapshot=$(awk -F" : " 'match($1, /^[ \t]+"tags"/) {gsub(/"|,/,"");print $2}' "$grub_btrfs_mount_point/${path_snapshot%"/"*}/$timeshift_info") # search matching string beginning "tags"
-            description_snapshot=$(awk -F" : " 'match($1, /^[ \t]+"comments"/) {gsub(/"|,/,"");print $2}' "$grub_btrfs_mount_point/${path_snapshot%"/"*}/$timeshift_info") # search matching string beginning "comments"
+            description_snapshot=$(awk -F" : " 'match($1, /^[ \t]+"comments"/) {gsub(/"|,/,"");print $2}' "$grub_btrfs_mount_point/${path_snapshot%"/"*}/$timeshift_info") # search matching string beginning "comments" fix '
+        elif [[ -s $yabsnap_info ]] ; then
+            type_snapshot=$(grep -P '^\s*"trigger"' $yabsnap_info | awk -F'"' '{print $4}') # search matching string beginning "trigger"
+            description_snapshot=$(grep -P '^\s*"comment"' $yabsnap_info | awk -F'"' '{print $4}') # search matching string beginning "comment"
         fi
-        [[ -z "$type_snapshot" ]] && type_snapshot=("N/A")
-        [[ -z "$description_snapshot" ]] && description_snapshot=("N/A")
+
+        [ -z "$type_snapshot" ] && type_snapshot=("N/A")
+        [ -z "$description_snapshot" ] && description_snapshot=("N/A")
 
         # ignore specific {type,tag,description} of snapshot during run "grub-mkconfig"
         if [ -n "${GRUB_BTRFS_IGNORE_SNAPSHOT_TYPE}" ] ; then
             for ist in "${GRUB_BTRFS_IGNORE_SNAPSHOT_TYPE[@]}" ; do
-                [[ "${type_snapshot}" == "${ist}" ]] && continue 2;
+                [ "${type_snapshot}" = "${ist}" ] && continue 2;
             done
         fi
         if [ -n "${GRUB_BTRFS_IGNORE_SNAPSHOT_DESCRIPTION}" ] ; then
             for isd in "${GRUB_BTRFS_IGNORE_SNAPSHOT_DESCRIPTION[@]}" ; do
-                [[ "${description_snapshot}" == "${isd}" ]] && continue 2;
+                [ "${description_snapshot}" = "${isd}" ] && continue 2;
             done
         fi
 
@@ -326,21 +392,21 @@ snapshot_list()
     local max_date_length=0
     for i in "${date_snapshots[@]}"; do
         local length="${#i}"
-        [[ "$length" -gt "$max_date_length" ]] && max_date_length=$length
+        [ "$length" -gt "$max_date_length" ] && max_date_length=$length
     done
 
     # Find max length of a snapshot name, needed for pretty formatting
     local max_path_length=0
     for i in "${path_snapshots[@]}"; do
         local length="${#i}"
-        [[ "$length" -gt "$max_path_length" ]] && max_path_length=$length
+        [ "$length" -gt "$max_path_length" ] && max_path_length=$length
     done
 
     # Find max length of a snapshot type, needed for pretty formatting
     local max_type_length=0
     for i in "${type_snapshots[@]}"; do
         local length="${#i}"
-        [[ "$length" -gt "$max_type_length" ]] && max_type_length=$length
+        [ "$length" -gt "$max_type_length" ] && max_type_length=$length
     done
 
     # Find max length of a snapshot description, needed for pretty formatting
@@ -381,14 +447,14 @@ detect_kernel()
     for okernel in  "${boot_dir}"/vmlinuz-* \
                     "${boot_dir}"/vmlinux-* \
                     "${boot_dir}"/kernel-* ; do
-        [[ ! -f "${okernel}" ]] && continue;
+        [ ! -f "${okernel}" ] && continue;
         list_kernel+=("$okernel")
     done
 
     # Custom name kernel in "GRUB_BTRFS_NKERNEL"
     if [ -n "${GRUB_BTRFS_NKERNEL}" ] ; then
         for ckernel in "${boot_dir}/${GRUB_BTRFS_NKERNEL[@]}" ; do
-            [[ ! -f "${ckernel}" ]] && continue;
+            [ ! -f "${ckernel}" ] && continue;
             list_kernel+=("$ckernel")
         done
     fi
@@ -402,14 +468,14 @@ detect_initramfs()
     for oinitramfs in   "${boot_dir}"/initrd.img-* \
                         "${boot_dir}"/initramfs-* \
                         "${boot_dir}"/initrd-* ; do
-        [[ ! -f "${oinitramfs}" ]] && continue;
+        [ ! -f "${oinitramfs}" ] && continue;
         list_initramfs+=("$oinitramfs")
     done
 
     # Custom name initramfs in "GRUB_BTRFS_NINIT"
     if [ -n "${GRUB_BTRFS_NINIT}" ] ; then
         for cinitramfs in "${boot_dir}/${GRUB_BTRFS_NINIT[@]}" ; do
-            [[ ! -f "${cinitramfs}" ]] && continue;
+            [ ! -f "${cinitramfs}" ] && continue;
             list_initramfs+=("$cinitramfs")
         done
     fi
@@ -422,13 +488,9 @@ detect_microcode()
     list_ucode=()
     # Original intel/amd microcode (auto-detect)
     # See "https://www.gnu.org/software/grub/manual/grub/html_node/Simple-configuration.html"
-    for oiucode in  "${boot_dir}"/intel-uc.img \
-                    "${boot_dir}"/intel-ucode.img \
-                    "${boot_dir}"/amd-uc.img \
-                    "${boot_dir}"/amd-ucode.img \
-                    "${boot_dir}"/early_ucode.cpio \
-                    "${boot_dir}"/microcode.cpio; do
-        [[ ! -f "${oiucode}" ]] && continue;
+    for oiucode in ${GRUB_EARLY_INITRD_LINUX_STOCK} ; do
+        oiucode="${boot_dir}/${oiucode}"
+        [ ! -f "${oiucode}" ] && continue;
         list_ucode+=("$oiucode")
     done
 
@@ -455,6 +517,7 @@ title_format()
             if [[ "${#var}" -lt "${#title_column[${GRUB_BTRFS_TITLE_FORMAT[$key],,}]}" ]]; then # Add extra spaces if length of $var is smaller than the length of column, needed for pretty formatting
                 printf -v var "%-$(((${#title_column[${GRUB_BTRFS_TITLE_FORMAT[$key],,}]}-${#var})+${#var}))s" "${var}";
             fi
+		    var="$(sed  "s/'//g"  <(echo "${var}"))"
             title_menu+="${var}|"
             title_submenu+=" $(trim "${var}") |"
     done
@@ -474,7 +537,7 @@ header_menu()
             local lenght_title_column_right=$(((${#var}-lenght_title_column_left)+1)) #+1 is necessary for extra "|" character
             header_entry+=$(printf "%${lenght_title_column_left}s%${lenght_title_column_right}s" "${title_column[${GRUB_BTRFS_TITLE_FORMAT[$key],,}]}" "|") # Final "|" is for visuals only
         done
-    sed -i "1imenuentry '|${header_entry}' { echo }" "$grub_directory/grub-btrfs.new" # First "|" is for visuals only
+    sed -i "1imenuentry '|${header_entry}' { echo }" "$grub_btrfs_directory/grub-btrfs.new" # First "|" is for visuals only
 }
 
 ## List of kernels, initramfs and microcode in snapshots
@@ -483,7 +546,7 @@ boot_bounded()
     # Initialize menu entries
     IFS=$'\n'
     for item in $(snapshot_list); do
-        [[ ${limit_snap_show} -le 0 ]] && break; # fix: limit_snap_show=0
+        [ "${limit_snap_show}" -le 0 ] && break; # fix: limit_snap_show=0
         IFS=$oldIFS
         parse_snapshot_list
         boot_dir="$grub_btrfs_mount_point/$snap_dir_name_trim$boot_directory"
@@ -497,14 +560,15 @@ boot_bounded()
         detect_rootflags
         title_format
         boot_dir_root_grub="$(make_system_path_relative_to_its_root "${boot_dir}")" # convert "boot_directory" to root of GRUB (e.g /boot become /)
+        insmods=("${list_insmods[@]##*"/"}")
         make_menu_entries
         # show snapshot found during run "grub-mkconfig"
-        if [[ "${GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND:-"true"}" = "true" ]]; then
+        if [ "${GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND:-"true"}" = "true" ]; then
             printf "Found snapshot: %s\n" "$item" >&2 ;
         fi
         # Limit snapshots found during run "grub-mkconfig"
         count_limit_snap=$((1+count_limit_snap))
-        [[ $count_limit_snap -ge $limit_snap_show ]] && break;
+        [ "$count_limit_snap" -ge "$limit_snap_show" ] && break;
     done
     IFS=$oldIFS
 }
@@ -524,55 +588,72 @@ boot_separate()
     # Initialize menu entries
     IFS=$'\n'
     for item in $(snapshot_list); do
-        [[ ${limit_snap_show} -le 0 ]] && break; # fix: limit_snap_show=0
+        [ "${limit_snap_show}" -le 0 ] && break; # fix: limit_snap_show=0
         IFS=$oldIFS
         parse_snapshot_list
         detect_rootflags
         title_format
         make_menu_entries
         # show snapshot found during run "grub-mkconfig"
-        if [[ "${GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND:-"true"}" = "true" ]]; then
+        if [ "${GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND:-"true"}" = "true" ]; then
             printf "Found snapshot: %s\n" "$item" >&2 ;
         fi
         # Limit snapshots found during run "grub-mkconfig"
         count_limit_snap=$((1+count_limit_snap))
-        [[ $count_limit_snap -ge $limit_snap_show ]] && break;
+        [ "$count_limit_snap" -ge "$limit_snap_show" ] && break;
     done
     IFS=$oldIFS
 }
 
-rm -f "$grub_directory/grub-btrfs.new"
-> "$grub_directory/grub-btrfs.new" # Create a "grub-btrfs.new" file in "grub_directory"
+rm -f "$grub_btrfs_directory/grub-btrfs.new"
+true > "$grub_btrfs_directory/grub-btrfs.new" # Create a "grub-btrfs.new" file in "grub_btrfs_directory"
+# Create a backup of the "$grub_btrfs_directory/grub-btrfs.cfg" file if exist
+if [ -e "$grub_btrfs_directory/grub-btrfs.cfg" ]; then
+	mv -f "$grub_btrfs_directory/grub-btrfs.cfg" "$grub_btrfs_directory/grub-btrfs.cfg.bkp"
+fi
 # Create mount point then mounting
-[[ ! -d $grub_btrfs_mount_point ]] && mkdir -p "$grub_btrfs_mount_point"
-mount -o ro,subvolid=5 /dev/disk/by-uuid/"$root_uuid" "$grub_btrfs_mount_point/"
+[ ! -d "$grub_btrfs_mount_point" ] && mkdir -p "$grub_btrfs_mount_point"
+mount -o ro,subvolid=5 /dev/disk/by-uuid/"$root_uuid" "$grub_btrfs_mount_point/" > /dev/null
 trap "unmount_grub_btrfs_mount_point" EXIT # unmounting mount point on EXIT signal
 count_warning_menuentries=0 # Count menuentries
 count_limit_snap=0 # Count snapshots
 check_uuid_required
 # Detects if /boot is a separate partition
-[[ "${GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION,,}" == "true" ]] && printf "Override boot partition detection : enable \n" >&2 && boot_separate;
-if [[ "$root_uuid" != "$boot_uuid" ]] || [[ "$root_uuid_subvolume" != "$boot_uuid_subvolume" ]]; then boot_separate ; else boot_bounded ; fi
+[ "$(echo "$GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION}" | tr '[:upper:]' '[:lower:]')" = "true" ] && printf "Override boot partition detection : enable \n" >&2 && boot_separate;
+if [ "$root_uuid" != "$boot_uuid" ] || [ "$root_uuid_subvolume" != "$boot_uuid_subvolume" ]; then boot_separate ; else boot_bounded ; fi
+# Make a submenu in GRUB (grub.cfg)
+cat << EOF
+if [ ! -e "${grub_btrfs_search_directory}/grub-btrfs.cfg" ]; then
+echo ""
+else
+submenu '${submenuname}' ${protection_authorized_users}${unrestricted_access_submenu}{
+    configfile "${grub_btrfs_search_directory}/grub-btrfs.cfg"
+}
+fi
+EOF
 # Show warn, menuentries exceeds 250 entries
-[[ $count_warning_menuentries -ge 250 ]] && printf "Generated %s total GRUB entries. You might experience issues loading snapshots menu in GRUB.\n" "${count_warning_menuentries}" >&2 ;
+[ $count_warning_menuentries -ge 250 ] && printf "Generated %s total GRUB entries. You might experience issues loading snapshots menu in GRUB.\n" "${count_warning_menuentries}" >&2 ;
 # Show total found snapshots
-if [[ "${GRUB_BTRFS_SHOW_TOTAL_SNAPSHOTS_FOUND:-"true"}" = "true" && -n "${count_limit_snap}" && "${count_limit_snap}" != "0" ]]; then
+if [ "${GRUB_BTRFS_SHOW_TOTAL_SNAPSHOTS_FOUND:-"true"}" = "true" ] && [ -n "${count_limit_snap}" ]  && [ "${count_limit_snap}" != "0" ]; then
     printf "Found %s snapshot(s)\n" "${count_limit_snap}" >&2 ;
 fi
-# if no snapshot found, exit
-if [[ "${count_limit_snap}" = "0" || -z "${count_limit_snap}" ]]; then
+# if no snapshot found, delete the "$grub_btrfs_directory/grub-btrfs.new" file and the "$grub_btrfs_directory/grub-btrfs.cfg.bkp" file and exit
+if [ "${count_limit_snap}" = "0" ] || [ -z "${count_limit_snap}" ]; then
+    rm -f "$grub_btrfs_directory/grub-btrfs.new" "$grub_btrfs_directory/grub-btrfs.cfg.bkp"
     print_error "No snapshots found."
 fi
-# Make a submenu in GRUB (grub.cfg) and move "grub-btrfs.new" to "grub-btrfs.cfg"
+# Move "grub-btrfs.new" to "grub-btrfs.cfg"
 header_menu
-if "${bindir}/${GRUB_BTRFS_SCRIPT_CHECK:-grub-script-check}" "$grub_directory/grub-btrfs.new"; then
-    cat "$grub_directory/grub-btrfs.new" > "$grub_directory/grub-btrfs.cfg"
-    rm -f "$grub_directory/grub-btrfs.new"
-    cat << EOF
-submenu '${submenuname}' ${protection_authorized_users}${unrestricted_access_submenu}{
-    configfile "\${prefix}/grub-btrfs.cfg"
-}
-EOF
+if "${bindir}/${GRUB_BTRFS_SCRIPT_CHECK:-grub-script-check}" "$grub_btrfs_directory/grub-btrfs.new"; then
+    cat "$grub_btrfs_directory/grub-btrfs.new" > "$grub_btrfs_directory/grub-btrfs.cfg"
+    rm -f "$grub_btrfs_directory/grub-btrfs.new" "$grub_btrfs_directory/grub-btrfs.cfg.bkp"
 else
-    print_error "Syntax errors are detected in generated grub-btrfs.cfg file."
+if [ -e "$grub_btrfs_directory/grub-btrfs.cfg.bkp" ]; then
+        mv -f "$grub_btrfs_directory/grub-btrfs.cfg.bkp" "$grub_btrfs_directory/grub-btrfs.cfg"
 fi
+	print_error "Syntax errors were detected in generated ${grub_btrfs_directory}/grub-btrfs.new file. The old grub-btrfs.cfg file (if present) have been restored."
+fi
+
+# warn when this script is run but there is no entry in grub.cfg
+grep "snapshots-btrfs" "${grub_directory}/grub.cfg" >/dev/null 2>&1 || printf "\nWARNING: '%s' needs to run at least once to generate the snapshots (sub)menu entry in grub the main menu. \
+After that this script can run alone to generate the snapshot entries.\n\n" "${GRUB_BTRFS_MKCONFIG:-grub-mkconfig}" >&2 ;

Makefile

@@ -5,39 +5,88 @@ INITCPIO ?= false
 SYSTEMD ?= true
 OPENRC ?= false
 
+BOOT_DIR_DEBIAN ?= /boot/grub
+BOOT_DIR_FEDORA ?= /boot/grub2
+
+GRUB_UPDATE_EXCLUDE ?= false
+INSTALL_DOCS ?= true
+
 SHARE_DIR = $(DESTDIR)$(PREFIX)/share
 LIB_DIR = $(DESTDIR)$(PREFIX)/lib
 BIN_DIR = $(DESTDIR)$(PREFIX)/bin
+MAN_DIR = $(SHARE_DIR)/man
 
-.PHONY: install uninstall help
+TEMP_DIR = ./temp
+
+
+.PHONY: install uninstall clean help
 
 install:
 	@if test "$(shell id -u)" != 0; then \
 		echo "You are not root, run this target as root please."; \
 		exit 1; \
 	fi
+	@echo "					     	   Installing "
+	@echo
+	@echo "       ::::::::  :::::::::  :::    ::: :::::::::               ::::::::: ::::::::::: :::::::::  :::::::::: ::::::::      "
+	@echo "      :+:    :+: :+:    :+: :+:    :+: :+:    :+:              :+:    :+:    :+:     :+:    :+: :+:       :+:    :+:     "
+	@echo "     +:+        +:+    +:+ +:+    +:+ +:+    +:+              +:+    +:+    +:+     +:+    +:+ +:+       +:+             "
+	@echo "    :#:        +#++:++#:  +#+    +:+ +#++:++#+ +#++:++#++:++ +#++:++#+     +#+     +#++:++#:  :#::+::#  +#++:++#++       "
+	@echo "   +#+   +#+# +#+    +#+ +#+    +#+ +#+    +#+              +#+    +#+    +#+     +#+    +#+ +#+              +#+        "
+	@echo "  #+#    #+# #+#    #+# #+#    #+# #+#    #+#              #+#    #+#    #+#     #+#    #+# #+#       #+#    #+#         "
+	@echo "  ########  ###    ###  ########  #########               #########     ###     ###    ### ###        ########           "
+	@echo
+	@echo "  For further information visit https://github.com/Antynea/grub-btrfs or read the man page: 'man grub-btrfs'"
+	@echo
+	@rm -rf "${TEMP_DIR}"
+	@mkdir "${TEMP_DIR}"
+	@chmod 777 ${TEMP_DIR}
+	@cp manpages/grub-btrfs.8.man ${TEMP_DIR}/grub-btrfs.8
+	@if test "$(INSTALL_DOCS)" = true; then \
+		echo "Installing manpages..."; \
+		install -Dm644 -t "${MAN_DIR}/man8" "${TEMP_DIR}/grub-btrfs.8"; \
+	fi
+	@cp manpages/grub-btrfsd.8.man ${TEMP_DIR}/grub-btrfsd.8
+	@if test "$(INSTALL_DOCS)" = true; then \
+		install -Dm644 -t "${MAN_DIR}/man8" "${TEMP_DIR}/grub-btrfsd.8"; \
+	fi
 	@install -Dm755 -t "$(DESTDIR)/etc/grub.d/" 41_snapshots-btrfs
 	@install -Dm644 -t "$(DESTDIR)/etc/default/grub-btrfs/" config
+	@install -Dm744 -t "$(BIN_DIR)/" grub-btrfsd;
 	@# Systemd init system
 	@if test "$(SYSTEMD)" = true; then \
-		install -Dm644 -t "$(LIB_DIR)/systemd/system/" grub-btrfs.path; \
-		install -Dm644 -t "$(LIB_DIR)/systemd/system/" grub-btrfs.service; \
+		echo "Installing systemd .service file"; \
+		install -Dm644 -t "$(LIB_DIR)/systemd/system/" grub-btrfsd.service; \
 	 fi
 	@# OpenRC init system
 	@if test "$(OPENRC)" = true; then \
-		install -Dm744 -t "$(BIN_DIR)/" grub-btrfs-openrc; \
-		install -Dm744 -t "$(DESTDIR)/etc/init.d/" grub-btrfsd; \
+		echo "Installing openRC init.d & conf.d file"; \
+		install -Dm744 grub-btrfsd.initd "$(DESTDIR)/etc/init.d/grub-btrfsd"; \
+		install -Dm644 grub-btrfsd.confd "$(DESTDIR)/etc/conf.d/grub-btrfsd"; \
 	 fi
 	@# Arch Linux like distros only :
 	@if test "$(INITCPIO)" = true; then \
+		echo "Installing initcpio hook"; \
 		install -Dm644 "initramfs/Arch Linux/overlay_snap_ro-install" "$(LIB_DIR)/initcpio/install/grub-btrfs-overlayfs"; \
 		install -Dm644 "initramfs/Arch Linux/overlay_snap_ro-hook" "$(LIB_DIR)/initcpio/hooks/grub-btrfs-overlayfs"; \
 	 fi
-	@install -Dm644 -t "$(SHARE_DIR)/licenses/$(PKGNAME)/" LICENSE
-	@install -Dm644 -t "$(SHARE_DIR)/doc/$(PKGNAME)/" README.md
-	@install -Dm644 "initramfs/readme.md" "$(SHARE_DIR)/doc/$(PKGNAME)/initramfs-overlayfs.md"
+	@if test "$(INSTALL_DOCS)" = true; then \
+		echo "Installing docs..."; \
+		install -Dm644 -t "$(SHARE_DIR)/licenses/$(PKGNAME)/" LICENSE; \
+		install -Dm644 -t "$(SHARE_DIR)/doc/$(PKGNAME)/" README.md; \
+		install -Dm644 "initramfs/readme.md" "$(SHARE_DIR)/doc/$(PKGNAME)/initramfs-overlayfs.md"; \
+	fi
+	@if command -v grub-mkconfig > /dev/null && [ -e "$(BOOT_DIR_DEBIAN)/grub.cfg" ] && test "$(GRUB_UPDATE_EXCLUDE)" = false; then \
+		echo "Updating the GRUB menu..."; \
+		grub-mkconfig -o "$(BOOT_DIR_DEBIAN)/grub.cfg"; \
+	 fi
+	@if command -v grub2-mkconfig > /dev/null && [ -e "$(BOOT_DIR_FEDORA)/grub.cfg" ] && test "$(GRUB_UPDATE_EXCLUDE)" = false; then \
+		echo "Updating the GRUB menu..."; \
+		grub2-mkconfig -o "$(BOOT_DIR_FEDORA)/grub.cfg"; \
+	fi
 
 uninstall:
+	@echo "Uninstalling grub-btrfs"
 	@if test "$(shell id -u)" != 0; then \
 		echo "You are not root, run this target as root please."; \
 		exit 1; \
@@ -46,12 +95,14 @@ uninstall:
 	 rm -f "$${grub_dirname:-/boot/grub}/grub-btrfs.cfg"
 	@rm -f "$(DESTDIR)/etc/default/grub-btrfs/config"
 	@rm -f "$(DESTDIR)/etc/grub.d/41_snapshots-btrfs"
-	@rm -f "$(LIB_DIR)/systemd/system/grub-btrfs.path"
-	@rm -f "$(LIB_DIR)/systemd/system/grub-btrfs.service"
-	@rm -f "$(BIN_DIR)/grub-btrfs-openrc;"
+	@rm -f "$(LIB_DIR)/systemd/system/grub-btrfsd.service"
+	@rm -f "$(BIN_DIR)/grub-btrfsd;"
 	@rm -f "$(DESTDIR)/etc/init.d/grub-btrfsd;"
+	@rm -f "$(DESTDIR)/etc/conf.d/grub-btrfsd;"
 	@rm -f "$(LIB_DIR)/initcpio/install/grub-btrfs-overlayfs"
 	@rm -f "$(LIB_DIR)/initcpio/hooks/grub-btrfs-overlayfs"
+	@rm -f "$(MAN_DIR)/man8/grub-btrfs.8.bz2"
+	@rm -f "$(MAN_DIR)/man8/grub-btrfsd.8.bz2"
 	@# Arch Linux UNlike distros only :
 	@if test "$(INITCPIO)" != true && test -d "$(LIB_DIR)/initcpio"; then \
 		rmdir --ignore-fail-on-non-empty "$(LIB_DIR)/initcpio/install" || :; \
@@ -64,23 +115,39 @@ uninstall:
 	@rmdir --ignore-fail-on-non-empty "$(SHARE_DIR)/doc/$(PKGNAME)/" || :
 	@rmdir --ignore-fail-on-non-empty "$(SHARE_DIR)/licenses/$(PKGNAME)/" || :
 	@rmdir --ignore-fail-on-non-empty "$(DESTDIR)/etc/default/grub-btrfs" || :
+	@if command -v grub-mkconfig > /dev/null && [ -e "$(BOOT_DIR_DEBIAN)/grub.cfg" ] && test "$(GRUB_UPDATE_EXCLUDE)" = false; then \
+                echo "Updating the GRUB menu..."; \
+                grub-mkconfig -o "$(BOOT_DIR_DEBIAN)/grub.cfg"; \
+         fi
+	@if command -v grub2-mkconfig > /dev/null && [ -e "$(BOOT_DIR_FEDORA)/grub.cfg" ] && test "$(GRUB_UPDATE_EXCLUDE)" = false; then \
+		echo "Updating the GRUB menu..."; \
+		grub2-mkconfig -o "$(BOOT_DIR_FEDORA)/grub.cfg"; \
+	fi
+
+clean:
+	@echo "Deleting ./temp"
+	@rm -rf "${TEMP_DIR}"
 
 help:
 	@echo
 	@echo "Usage: $(MAKE) [ <parameter>=<value> ... ] [ <action> ]"
+	@echo "Example: $(MAKE) OPENRC=true SYSTEMD=false install"
 	@echo
 	@echo "  actions: install"
 	@echo "           uninstall"
 	@echo "           help"
 	@echo
-	@echo "  parameter | type | description                    | defaults"
-	@echo "  ----------+------+--------------------------------+----------------------------"
-	@echo "  DESTDIR   | path | install destination            | <unset>"
-	@echo "  PREFIX    | path | system tree prefix             | '/usr'"
-	@echo "  SHARE_DIR | path | shared data location           | '\$$(DESTDIR)\$$(PREFIX)/share'"
-	@echo "  LIB_DIR   | path | system libraries location      | '\$$(DESTDIR)\$$(PREFIX)/lib'"
-	@echo "  PKGNAME   | name | name of the ditributed package | 'grub-btrfs'"
-	@echo "  INITCPIO  | bool | include mkinitcpio hook        | false"
-	@echo "  SYSTEMD   | bool | include unit files             | true"
-	@echo "  OPENRC    | bool | include OpenRc daemon          | false"
-	@echo
+	@echo "  parameter           | type | description                                           | defaults"
+	@echo "  --------------------+------+-------------------------------------------------------+----------------------------"
+	@echo "  DESTDIR             | path | install destination                                   | <unset>"
+	@echo "  PREFIX              | path | system tree prefix                                    | '/usr'"
+	@echo "  BOOT_DIR_DEBIAN     | path | boot data location (Debian, Ubuntu, Gentoo, Arch...)  | '/boot/grub'"
+	@echo "  BOOT_DIR_FEDORA     | path | boot data location (Fedora, RHEL, CentOS, Rocky...)   | '/boot/grub2'"
+	@echo "  SHARE_DIR           | path | shared data location                                  | '\$$(DESTDIR)\$$(PREFIX)/share'"
+	@echo "  LIB_DIR             | path | system libraries location                             | '\$$(DESTDIR)\$$(PREFIX)/lib'"
+	@echo "  PKGNAME             | name | name of the distributed package                       | 'grub-btrfs'"
+	@echo "  INITCPIO            | bool | include mkinitcpio hook                               | false"
+	@echo "  SYSTEMD             | bool | include unit files                                    | true"
+	@echo "  OPENRC              | bool | include OpenRc daemon                                 | false"
+	@echo "  GRUB_UPDATE_EXCLUDE | bool | Do not update grub after installation                 | false"
+	@echo

README.md

@@ -1,39 +1,37 @@
 [![GitHub release](https://img.shields.io/github/release/Antynea/grub-btrfs.svg)](https://github.com/Antynea/grub-btrfs/releases)
 ![](https://img.shields.io/github/license/Antynea/grub-btrfs.svg)
 
-## grub-btrfs 
+## 💻 grub-btrfs 
 
-This is a version 4.xx of grub-btrfs
 ##### BTC donation address: `1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt`
 - - -
-### Description :
-Improves Grub by adding "btrfs snapshots" to the Grub menu.
+### 🔎 Description:
+grub-btrfs improves the grub bootloader by adding a btrfs snapshots sub-menu, allowing the user to boot into snapshots.
 
-You can boot your system on a "snapshot" from the Grub menu.  
-Supports manual snapshots, snapper, timeshift ...
+grub-btrfs supports manual snapshots as well as snapper, timeshift, and yabsnap created snapshots.
 
-##### Warning: booting on read-only snapshots can be tricky
+##### Warning: booting read-only snapshots can be tricky
 
-If you choose to do it, `/var/log` or even `/var` must be on a separate subvolume.  
-Otherwise, make sure your snapshots are writeable.  
+If you wish to use read-only snapshots, `/var/log` or even `/var` must be on a separate subvolume.
+Otherwise, make sure your snapshots are writable.
 See [this ticket](https://github.com/Antynea/grub-btrfs/issues/92) for more info.
 
-This project includes its own solution.  
+This project includes its own solution.
 Refer to the [documentation](https://github.com/Antynea/grub-btrfs/blob/master/initramfs/readme.md).
 
 - - -
-### What does grub-btrfs v4.xx do :
-* Automatically List snapshots existing on root partition (btrfs).
-* Automatically Detect if "/boot" is in separate partition.
-* Automatically Detect kernel, initramfs and intel/amd microcode in "/boot" directory on snapshots.
-* Automatically Create corresponding "menuentry" in `grub.cfg`
-* Automatically detect the type/tags and descriptions/comments of snapper/timeshift snapshots.
-* Automatically generate `grub.cfg` if you use the provided systemd service.
+### ✨ What features does grub-btrfs have?
+* Automatically lists snapshots existing on the btrfs root partition.
+* Automatically detect if `/boot` is in a separate partition.
+* Automatically detect kernel, initramfs and Intel/AMD microcode in `/boot` directory within snapshots.
+* Automatically create corresponding menu entries in `grub.cfg`
+* Automatically detect the type/tags/triggers and descriptions/comments of Snapper/Timeshift/Yabsnap snapshots.
+* Automatically generate `grub.cfg` if you use the provided Systemd/ OpenRC service.
 
 - - -
-### Installation :
+### 🛠️ Installation:
 #### Arch Linux
-The package is available in the community repository [grub-btrfs](https://archlinux.org/packages/community/any/grub-btrfs/)
+The package is available in the extra repository [grub-btrfs](https://archlinux.org/packages/extra/any/grub-btrfs/)
 ```
 pacman -S grub-btrfs
 ```
@@ -44,110 +42,286 @@ If you have not activated the GURU yet, do so by running:
 ```
 emerge -av app-eselect/eselect-repository 
 eselect repository enable guru 
-emerge --sync 
+emaint sync -r guru 
 ```
+If you are using Systemd on Gentoo, make sure the USE-Flag `systemd` is set. (Either globally in make.conf or in package.use for the package app-backup/grub-btrfs)
+Without Systemd USE-Flag the OpenRC-daemon of grub-btrfs will be installed.
 
-Now merge grub-btrfs via 
+Emerge grub-btrfs via 
 `emerge app-backup/grub-btrfs`
 
-#### Manual
-* Run `make install` or look into Makefile for instructions on where to put each file.
+#### Kali Linux
+[grub-btrfs](http://pkg.kali.org/pkg/grub-btrfs) is available in the Kali Linux repository and can be installed with:  
+```
+apt install grub-btrfs
+```
+Booting into read-only snapshots is fully supported when choosing btrfs as the file system during a standard Kali Linux installation following [this walk-through](https://www.kali.org/docs/installation/btrfs/).
+
+#### Manual installation
+* Run `make install`
 * Run `make help` to check what options are available. 
 * Dependencies:
   * [btrfs-progs](https://archlinux.org/packages/core/x86_64/btrfs-progs/)
   * [grub](https://archlinux.org/packages/core/x86_64/grub/)
   * [bash >4](https://archlinux.org/packages/core/x86_64/bash/)
-  * [gawk ](https://archlinux.org/packages/core/x86_64/gawk/)
-
-#### NOTE: All distros
-Generate your Grub menu after installation for the changes to take effect.  
-For example:  
-On **Arch Linux** or **Gentoo** use `grub-mkconfig -o /boot/grub/grub.cfg`.  
-On **Fedora** use `grub2-mkconfig -o /boot/grub2/grub.cfg`  
-On **Debian-like** distribution `update-grub` is an alias to `grub-mkconfig ...`
-- - -
-### Customization :
-
-You have the possibility to modify many parameters in `/etc/default/grub-btrfs/config`.  
-See [config file](https://github.com/Antynea/grub-btrfs/blob/master/config) for more information.
+  * [gawk](https://archlinux.org/packages/core/x86_64/gawk/)
+  * (only when using the grub-btrfsd daemon)[inotify-tools](https://archlinux.org/packages/extra/x86_64/inotify-tools/)
 
 - - -
-### Automatically update grub :
-#### Systemd
-1. If you would like grub-btrfs menu to automatically update when a snapshot is created or deleted:
-* Use `systemctl enable grub-btrfs.path`.
-  * `grub-btrfs.path` automatically (re)generates `grub-btrfs.cfg` when a modification appears in `/.snapshots` mount point (by default).
-  * If the `/.snapshots` mount point is already mounted, then use `systemctl start grub-btrfs.path` to start monitoring.  
-    Otherwise, the unit will automatically start monitoring when the mount point will be available.
-* If your snapshots location aren't mounted in `/.snapshots`, you must modify `grub-btrfs.path` unit using  
-`systemctl edit --full grub-btrfs.path` and run `systemctl reenable grub-btrfs.path` for changes take effect.  
-To find out the name of the `.mount` unit  
-use `systemctl list-units -t mount`.  
-	* For example: Timeshift mounts its snapshot folder in `/run/timeshift/backup/timeshift-btrfs/snapshots`.
+### 📚 Manual usage of grub-btrfs
+To manually generate grub snapshot entries you can run `sudo /etc/grub.d/41_snapshots-btrfs` which updates `grub-btrfs.cfg`. You then need to regenerate the GRUB configuration by running one of the following commands:
 
-		Use `systemctl edit --full grub-btrfs.path`.
-		Then replace the whole block by:
-		```
-		[Unit]
-		Description=Monitors for new snapshots
-		DefaultDependencies=no
-		Requires=run-timeshift-backup.mount
-		After=run-timeshift-backup.mount
-		BindsTo=run-timeshift-backup.mount
+* On **Arch Linux** or **Gentoo** use `grub-mkconfig -o /boot/grub/grub.cfg`.  
+* On **Fedora** use `grub2-mkconfig -o /boot/grub2/grub.cfg`  
+* On **Debian and Ubuntu based** distributions `update-grub` is a script that runs `grub-mkconfig ...`
 
-		[Path]
-		PathModified=/run/timeshift/backup/timeshift-btrfs/snapshots
+This process can be automated to occur whenever you create or delete snapshots but this process is slightly different depending upon your distributions choice on init system. See the relevant instructions for your init system below.
 
-		[Install]
-		WantedBy=run-timeshift-backup.mount
-		```
-		Then save and finally run `systemctl reenable grub-btrfs.path` for changes take effect.  
-		Optional:  
-		If the `/run/timeshift/backup/timeshift-btrfs/snapshots` mount point is already mounted,  
-		then use `systemctl start grub-btrfs.path` to start monitoring.  
-		Otherwise, the unit will automatically start monitoring when the mount point will be available.  
-	* You can view your change to `systemctl cat grub-btrfs.path`.
-	* To revert change use `systemctl revert grub-btrfs.path`.
+### ⚙️ Customization:
 
-2. If you would like grub-btrfs menu to automatically update on system restart/ shutdown:  
-[Look at this comment](https://github.com/Antynea/grub-btrfs/issues/138#issuecomment-766918328)  
-Currently not implemented
-##
-#### OpenRC
-1. If you would like grub-btrfs menu to automatically update when a snapshot is created or deleted:
-* Use `rc-config add grub-btrfsd default`, to start the grub-btrfsd daemon the next time the system boots. 
-	* To start `grub-btrfsd` right now, run `rc-service grub-btrfsd start`
-	* `grub-btrfsd` automatically watches the snapshot directory of timeshift (/run/timeshift/backup/timeshift-btrfs/snapshots)
-	and updates the grub-menu when a change occurs.
-* Currently untested for snapper
+You have the possibility to modify many parameters in `/etc/default/grub-btrfs/config`.
+For further information see [config file](https://github.com/Antynea/grub-btrfs/blob/master/config) or `man grub-btrfs`
 
-2. If you would like grub-btrfs menu to automatically update on system restart/ shutdown:
-Just add the following script as `/etc/local.d/grub-btrfs-update.stop`
-	```
-	#!/bin/bash
-	
-	description="Update the grub btrfs snapshots menu"
-	name="grub-btrfs-update"
-	
-	depend()
-	{
-	  use localmount
-	}
-	
-	bash -c 'if [ -s "${GRUB_BTRFS_GRUB_DIRNAME:-/boot/grub}/grub-btrfs.cfg" ]; then /etc/grub.d/41_snapshots-btrfs; else {GRUB_BTRFS_MKCONFIG:-grub-mkconfig} -o {GRUB_BTRFS_GRUB_DIRNAME:-/boot/grub}/grub.cfg; fi' 
-	```
-	
-	Make your script executeable with `chmod a+x /etc/local.d/grub-btrfs-update.stop`.
+#### Warning:
+Some file locations and command names differ from distribution to distribution. Initially the configuration is set up to work with Arch and Gentoo (and many other distributions) out of the box, which are using the `grub-mkconfig` command. 
+However Fedora, for example, uses a different command, `grub2-mkconfig`.
+Edit the `GRUB_BTRFS_MKCONFIG` variable in `/etc/default/grub-btrfs/config` file to reflect this. (e.g. `GRUB_BTRFS_MKCONFIG=/sbin/grub2-mkconfig` for Fedora)
 
-* The extension ".stop" at the end of the filename indicates to locald that this script should be run at shutdown. 
- If you want to run the menu update on startup instead, rename the file to `grub-btrfs-update.start`
-* Works for snapper and timeshift
+On most distributions, the grub installation resides in `/boot/grub`. If grub is installed in a different place, change the variable `GRUB_BTRFS_MKCONFIG` in the config file accordingly. For Fedora this is `GRUB_BTRFS_GRUB_DIRNAME="/boot/grub2"`. The command to check the grub scripts is different on some system, for Fedora it is `GRUB_BTRFS_SCRIPT_CHECK=grub2-script-check`
+
+#### Customization of the grub-btrfsd daemon
+
+Grub-btrfs comes with a daemon script that automatically updates the grub menu when it sees a snapshot being created or deleted in a directory it is given via command line. You must install `inotify-tools` before you can use grub-btrfsd.
+
+The daemon can be configured by passing different command line arguments to it. 
+The available arguments are:
+* `SNAPSHOTS_DIRS`
+This argument specifies the (space separated) paths where grub-btrfsd looks for newly created snapshots and snapshot deletions. It is usually defined by the program used to make snapshots.
+E.g. for Snapper or Yabsnap this would be `/.snapshots`. It is possible to define more than one directory here, all directories will inherit the same settings (recursive etc.).
+This argument is not necessary to provide if `--timeshift-auto` is set. 
+* `-c / --no-color`
+Disable colors in output.
+* `-l / --log-file`
+This arguments specifies a file where grub-btrfsd should write log messages.
+* `-r / --recursive`
+Watch the snapshots directory recursively
+* `-s / --syslog`
+* `-o / --timeshift-old`
+Look for snapshots in `/run/timeshift/backup/timeshift-btrfs` instead of `/run/timeshift/$PID/backup/timeshift-btrfs.` This is to be used for Timeshift versions <22.06. You must also use `--timeshift-auto` if using this option.
+* `-t / --timeshift-auto`
+This is a flag to activate the auto-detection of the path where Timeshift stores snapshots. Newer versions (>=22.06) of Timeshift mount their snapshots to `/run/timeshift/$PID/backup/timeshift-btrfs`. Where `$PID` is the process ID of the currently running Timeshift session. The PID changes every time Timeshift is opened. grub-btrfsd can automatically take care of the detection of the correct PID and directory if this flag is set. In this case the argument `SNAPSHOTS_DIRS` has no effect.
+* `-v / --verbose`
+Let the log of the daemon be more verbose
+* `-h / --help`
+Displays a short help message.
+- - - 
+### 🪀 Automatically update grub upon snapshot creation or deletion
+Grub-btrfsd is a daemon that watches the snapshot directory for you and updates the grub menu automatically every time a snapshot is created or deleted.
+By default this daemon watches the directory `/.snapshots` for changes (creation or deletion of snapshots) and triggers the grub menu creation and re-installation of grub if any changes are noticed.
+Therefore, if Snapper or Yabsnap is used with its default directory, the daemon can just be started and nothing needs to be configured. See the instructions below to configure grub-btrfsd for use with Timeshift or when using an alternative snapshots directory with Snapper/Yabsnap.
+- - - 
+#### grub-btrfsd systemd instructions
+To start the daemon run:
+```bash
+sudo systemctl start grub-btrfsd
+```
+
+To activate it during system startup, run:
+```bash
+sudo systemctl enable grub-btrfsd
+```
+
+##### 💼 Snapshots not in `/.snapshots` when using systemd
+By default the daemon is watching the directory `/.snapshots`. If the daemon should watch a different directory, it can be edited with:
+```bash
+sudo systemctl edit --full grub-btrfsd 
+```
+You need to edit the `/.snapshots` part in the line that says `ExecStart=/usr/bin/grub-btrfsd --syslog /.snapshots`.
+This is what the file should look like afterwards:
+``` bash
+[Unit]
+Description=Regenerate grub-btrfs.cfg
+
+[Service]
+Type=simple
+LogLevelMax=notice
+# Set the possible paths for `grub-mkconfig`
+Environment="PATH=/sbin:/bin:/usr/sbin:/usr/bin"
+# Load environment variables from the configuration
+EnvironmentFile=/etc/default/grub-btrfs/config
+# Start the daemon, usage of it is:
+# grub-btrfsd [-h, --help] [-t, --timeshift-auto] [-l, --log-file LOG_FILE] SNAPSHOTS_DIRS
+# SNAPSHOTS_DIRS         Snapshot directories to watch, without effect when --timeshift-auto
+# Optional arguments:
+# -t, --timeshift-auto  Automatically detect Timeshifts snapshot directory
+# -o, --timeshift-old   Activate for timeshift versions <22.06
+# -l, --log-file        Specify a logfile to write to
+# -v, --verbose         Let the log of the daemon be more verbose
+# -s, --syslog          Write to syslog
+ExecStart=/usr/bin/grub-btrfsd --syslog /.snapshots
+
+[Install]
+WantedBy=multi-user.target
+```
+
+When done, the service should be restarted with:
+``` bash
+sudo systemctl restart grub-btrfsd 
+```
+
+##### 🌟 Using Timeshift with systemd
+Newer Timeshift versions (>= 22.06) create a new directory named after their process ID in `/run/timeshift` every time they are started. The PID will be different every time.
+Therefore the daemon cannot simply watch a directory. It monitors `/run/timeshift` and if a directory is created it gets Timeshifts current PID then watches a directory in that newly created directory from Timeshift.
+To activate this mode of the daemon, `--timeshift-auto` must be passed to the daemon as a command line argument.
+
+To pass `--timeshift-auto` to grub-btrfsd, the .service file of grub-btrfsd can be edited with
+```bash
+sudo systemctl edit --full grub-btrfsd 
+```
+
+The line that contains:
+```bash 
+ExecStart=/usr/bin/grub-btrfsd /.snapshots --syslog
+
+```
+
+Should be modified to read:
+``` bash
+ExecStart=/usr/bin/grub-btrfsd --syslog --timeshift-auto
+```
+
+The modified file should look like this:
+``` bash
+[Unit]
+Description=Regenerate grub-btrfs.cfg
+
+[Service]
+Type=simple
+LogLevelMax=notice
+# Set the possible paths for `grub-mkconfig`
+Environment="PATH=/sbin:/bin:/usr/sbin:/usr/bin"
+# Load environment variables from the configuration
+EnvironmentFile=/etc/default/grub-btrfs/config
+# Start the daemon, usage of it is:
+# grub-btrfsd [-h, --help] [-t, --timeshift-auto] [-l, --log-file LOG_FILE] SNAPSHOTS_DIRS
+# SNAPSHOTS_DIRS         Snapshot directories to watch, without effect when --timeshift-auto
+# Optional arguments:
+# -t, --timeshift-auto  Automatically detect Timeshifts snapshot directory
+# -l, --log-file        Specify a logfile to write to
+# -v, --verbose         Let the log of the daemon be more verbose
+# -s, --syslog          Write to syslog
+ExecStart=/usr/bin/grub-btrfsd --syslog --timeshift-auto
+
+[Install]
+WantedBy=multi-user.target
+```
+
+If you are using an older release of Timeshift (before 22.06), you also need to add `--timeshift-old` so that your ExecStart line would look like:
+
+```
+ExecStart=/usr/bin/grub-btrfsd --syslog --timeshift-auto --timeshift-old
+```
+
+When done, the service must be restarted with:
+``` bash
+sudo systemctl restart grub-btrfsd 
+```
+
+Note:
+You can view your change with `systemctl cat grub-btrfsd`.
+To revert all the changes use `systemctl revert grub-btrfsd`.
 
-##### Warning :
-by default, `grub-mkconfig` command is used.  
-Might be `grub2-mkconfig` on some systems (Fedora ...).   
-Edit `GRUB_BTRFS_MKCONFIG` variable in `/etc/default/grub-btrfs/config` file to reflect this.
 - - -
+#### grub-btrfsd OpenRC instructions
+To start the daemon run:
+```bash
+sudo rc-service grub-btrfsd start 
+```
+
+To activate it during system startup, run:
+```bash
+sudo rc-config add grub-btrfsd default 
+```
+
+##### 💼 Snapshots not in `/.snapshots` for OpenRC
+By default the daemon is watching the directory `/.snapshots`. If the daemon should watch a different directory, it can be edited by passing different arguments to it.
+Arguments are passed to grub-btrfsd via the file `/etc/conf.d/grub-btrfsd`. 
+The variable `snapshots` defines the path the daemon will monitor for snapshots.
+
+After editing, the file should look like this:
+``` bash
+# Copyright 2022 Pascal Jaeger
+# Distributed under the terms of the GNU General Public License v3
+
+## Where to locate the root snapshots
+snapshots="/.snapshots" # Snapper in the root directory
+#snapshots="/run/timeshift/backup/timeshift-btrfs/snapshots" # Timeshift < v22.06
+
+## Optional arguments to run with the daemon
+# Append options to this like this:
+# optional_args="--syslog --timeshift-auto --verbose"
+# Possible options are:
+# -t, --timeshift-auto  Automatically detect Timeshifts snapshot directory for timeshift >= 22.06
+# -o, --timeshift-old   Look for snapshots in directory of Timeshift <v22.06 (requires --timeshift-auto)
+# -l, --log-file        Specify a logfile to write to
+# -v, --verbose         Let the log of the daemon be more verbose
+# -s, --syslog          Write to syslog
+optional_args="--syslog"
+```
+
+After that, the daemon should be restarted with:
+``` bash
+sudo rc-service grub-btrfsd restart
+```
+
+##### 🔒 Snapshots on LUKS encrypted devices
+By default, grub-btrfs generates entries that does not load modules for dealing with encrypted devices.
+Enable the `GRUB_BTRFS_ENABLE_CRYPTODISK` variable in `/etc/default/grub-btrfs/config` to load said modules and then execute the steps to mount encrypted root after selecting the snapshot.
+
+- - -
+### Troubleshooting
+If you experience problems with grub-btrfs don't hesitate [to file an issue](https://github.com/Antynea/grub-btrfs/issues/new/choose).
+
+#### What version of grub-btrfs am I running?
+When requesting help or reporting bugs in grub-btrfs, please run:
+``` bash
+sudo /etc/grub.d/41_snapshots-btrfs --version
+```
+or 
+``` bash
+sudo /usr/bin/grub-btrfsd --help
+```
+to get the currently running version of grub-btrfs and include this information in your ticket.
+
+#### Running grub-btrfsd in verbose mode
+If you have problems with the daemon, you can run it with the `--verbose`-flag. To do so you can run:
+``` bash
+sudo /usr/bin/grub-btrfsd --verbose --timeshift-auto` (for timeshift)
+# or 
+sudo /usr/bin/grub-btrfsd /.snapshots --verbose` (for snapper/yabsnap)
+```
+Or pass `--verbose` to the daemon using the Systemd .service file or the OpenRC conf.d file respectively.
+
+For additional information on the daemon and its arguments, run `grub-btrfsd -h` or `man grub-btrfsd`
+
+- - -
+### Development
+Grub-btrfs uses a rudimentary system of automatic versioning to tell apart different commits. This is helpful when users report problems and it is not immediately clear what version they are using. 
+We therefore have the following script in `.git/hooks/pre-commit`:
+
+``` bash
+#!/bin/sh
+
+echo "Doing pre commit hook with version bump"
+version="$(git describe --tags --abbrev=0)-$(git rev-parse --abbrev-ref HEAD)-$(date -u -Iseconds)"
+echo "New version is ${version}"
+sed -i "s/GRUB_BTRFS_VERSION=.*/GRUB_BTRFS_VERSION=${version}/" config
+git add config
+```
+
+This automatically sets the version in the `config`-file to `[lasttag]-[branch-name]-[current-date-in-UTC]`.
+In order to create a Tag we don't want to have this long version. In this case we set the version manually in `config` and commit with `git commit --no-verify`. This avoids running the hook. 
+
 ### Special thanks for assistance and contributions
 * [Maxim Baz](https://github.com/maximbaz)
 * [Schievel1](https://github.com/Antynea/grub-btrfs/discussions/173#discussioncomment-1438790)

config

@@ -1,5 +1,8 @@
 #!/usr/bin/env bash
 
+
+GRUB_BTRFS_VERSION=4.13-yabsnap_info_support-2024-03-06T13:43:57+00:00
+
 # Disable grub-btrfs.
 # Default: "false"
 #GRUB_BTRFS_DISABLE="true"
@@ -46,7 +49,14 @@
 # Default: ("")
 #GRUB_BTRFS_CUSTOM_MICROCODE=("custom-ucode.img" "custom-uc.img "custom_ucode.cpio")
 
-# Comma seperated mount options to be used when booting a snapshot.
+# Additional kernel command line parameters that should be passed to the kernel
+# when booting a snapshot.
+# For dracut based distros this could be useful to pass "rd.live.overlay.overlayfs=1"
+# or "rd.live.overlay.readonly=1" to the Kernel for booting snapshots read only.
+# Default: ""
+#GRUB_BTRFS_SNAPSHOT_KERNEL_PARAMETERS="rd.live.overlay.overlayfs=1"
+
+# Comma separated mount options to be used when booting a snapshot.
 # They can be defined here as well as in the "/" line inside the respective snapshots'
 # "/etc/fstab" files.  Mount options found in both places are combined, and this variable
 # takes priority over `fstab` entries.
@@ -64,13 +74,15 @@ GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("@")
 # Any path starting with the specified string will be ignored.
 # e.g : if `prefix path` = @, all snapshots beginning with "@/..." will be ignored.
 # Default: ("var/lib/docker" "@var/lib/docker" "@/var/lib/docker")
-GRUB_BTRFS_IGNORE_PREFIX_PATH=("var/lib/docker" "@var/lib/docker" "@/var/lib/docker")
+GRUB_BTRFS_IGNORE_PREFIX_PATH=("var/lib/docker" "@var/lib/docker" "@/var/lib/docker" "var/lib/containers" "@var/lib/containers" "@/var/lib/containers")
 
 # Ignore specific type/tag of snapshot during run "grub-mkconfig".
 # For snapper:
 # Type = single, pre, post.
 # For Timeshift:
 # Tag = boot, ondemand, hourly, daily, weekly, monthly.
+# For yabsnap:
+# Trigger = S, I, U.
 # Default: ("")
 #GRUB_BTRFS_IGNORE_SNAPSHOT_TYPE=("")
 
@@ -86,9 +98,7 @@ GRUB_BTRFS_IGNORE_PREFIX_PATH=("var/lib/docker" "@var/lib/docker" "@/var/lib/doc
 #GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION="true"
 
 # Location of the folder containing the "grub.cfg" file.
-# Use by grub-btrfs to save the file "grub-btrfs.cfg".
 # Might be grub2 on some systems.
-# For example, on Fedora with EFI : "/boot/efi/EFI/fedora"
 # Default: "/boot/grub"
 #GRUB_BTRFS_GRUB_DIRNAME="/boot/grub2"
 
@@ -97,6 +107,24 @@ GRUB_BTRFS_IGNORE_PREFIX_PATH=("var/lib/docker" "@var/lib/docker" "@/var/lib/doc
 # Default: "/boot"
 #GRUB_BTRFS_BOOT_DIRNAME="/boot"
 
+# Location where grub-btrfs.cfg should be saved.
+# Some distributions (like OpenSuSE) store those files at the snapshot directory
+# instead of boot. Be aware that this directory must be available for grub during
+# startup of the system.
+# Default: $GRUB_BTRFS_GRUB_DIRNAME
+#GRUB_BTRFS_GBTRFS_DIRNAME="/boot/grub"
+
+# Location of the directory where Grub searches for the grub-btrfs.cfg file.
+# Some distributions (like OpenSuSE) store those file at the snapshot directory
+# instead of boot. Be aware that this directory must be available for grub during
+# startup of the system.
+# Default: "\${prefix}" # This is a grub variable that resolves to where grub is
+# installed. (like /boot/grub, /boot/efi/grub)
+# NOTE: If variables of grub are used here (like ${prefix}) they need to be escaped
+# with `\` before the `$`
+#GRUB_BTRFS_GBTRFS_SEARCH_DIRNAME="\${prefix}"
+
+
 # Name/path of grub-mkconfig command, use by "grub-btrfs.service"
 # Might be 'grub2-mkconfig' on some systems (Fedora ...)
 # Default paths are /sbin:/bin:/usr/sbin:/usr/bin,
@@ -130,3 +158,7 @@ GRUB_BTRFS_IGNORE_PREFIX_PATH=("var/lib/docker" "@var/lib/docker" "@/var/lib/doc
 # doesn't work if GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS isn't empty
 # Default: "false"
 #GRUB_BTRFS_DISABLE_PROTECTION_SUBMENU="true"
+
+# Enable booting from snapshots stored on LUKS encrypted devices
+# Default: "false"
+#GRUB_BTRFS_ENABLE_CRYPTODISK="true"

grub-btrfs-openrc

@@ -1,6 +0,0 @@
-#!/bin/sh
-echo $$ > /run/grub-btrfsd.pid
-
-while true; do sleep 1 && inotifywait -e create -e delete /run/timeshift/backup/timeshift-btrfs/snapshots && sleep 5 && if [ -s "${GRUB_BTRFS_GRUB_DIRNAME:-/boot/grub}/grub-btrfs.cfg" ]; then /etc/grub.d/41_snapshots-btrfs; else ${GRUB_BTRFS_MKCONFIG:-grub-mkconfig} -o ${GRUB_BTRFS_GRUB_DIRNAME:-/boot/grub}/grub.cfg; fi  ; done
-
-

grub-btrfs.path

@@ -1,12 +0,0 @@
-[Unit]
-Description=Monitors for new snapshots
-DefaultDependencies=no
-Requires=\x2esnapshots.mount
-After=\x2esnapshots.mount
-BindsTo=\x2esnapshots.mount
-
-[Path]
-PathModified=/.snapshots
-
-[Install]
-WantedBy=\x2esnapshots.mount

grub-btrfs.service

@@ -1,11 +0,0 @@
-[Unit]
-Description=Regenerate grub-btrfs.cfg
-
-[Service]
-Type=oneshot
-# Set the possible paths for `grub-mkconfig`
-Environment="PATH=/sbin:/bin:/usr/sbin:/usr/bin"
-# Load environment variables from the configuration
-EnvironmentFile=/etc/default/grub-btrfs/config
-# Regenerate just '/boot/grub/grub-btrfs.cfg' if it exists and is not empty, else regenerate the whole grub menu
-ExecStart=bash -c 'if [ -s "${GRUB_BTRFS_GRUB_DIRNAME:-/boot/grub}/grub-btrfs.cfg" ]; then /etc/grub.d/41_snapshots-btrfs; else ${GRUB_BTRFS_MKCONFIG:-grub-mkconfig} -o ${GRUB_BTRFS_GRUB_DIRNAME:-/boot/grub}/grub.cfg; fi' 

grub-btrfsd

@@ -1,14 +1,340 @@
-#!/sbin/openrc-run
-# Copyright 1999-2021 Gentoo Foundation
-# Distributed under the terms of the GNU General Public License v2
+#!/usr/bin/env bash
+# Copyright 2023 Pascal Jaeger
+# Distributed under the terms of the GNU General Public License v3
+# Update GRUB when new BTRFS snapshots are created.
 
-name="grub-btrfs daemon"
-command="/usr/bin/grub-btrfs-openrc"
-pidfile="/run/{RC_SVCNAME}.pid"
-command_background=true
-
-depend() {
-   use localmount
+sighandler() {
+    trap '""' SIGINT SIGTERM
+    vlog "Parent $$: Received signal SIGINT/ SIGTERM"
+    kill 0
+    wait
+    exit 0
 }
 
+setcolors() {
+    if [ "${1}" = true ]; then
+          GREEN=$'\033[0;32m'
+          RED=$'\033[0;31m'
+          CYAN=$'\033[;36m'
+          RESET=$'\033[0m'
+    fi
+    if [ "${1}" = false ]; then
+          GREEN=$'\033[0;0m'
+          RED=$'\033[0;0m'
+          CYAN=$'\033[;0m'
+          RESET=$'\033[0m'
+    fi
+}
 
+print_help() {
+    echo "${CYAN}[?] Usage:"
+    echo "${0##*/} [-h, --help] [-c, --no-color] [-l, --log-file LOG_FILE] [-r, --recursive] [-s, --syslog] [-t, --timeshift-auto] [-v, --verbose] SNAPSHOTS_DIRS"
+    echo
+    echo "SNAPSHOTS_DIRS         Snapshot directories to watch, without effect when --timeshift-auto"
+    echo
+    echo "Optional arguments:"
+    echo "-c, --no-color        Disable colors in output"
+    echo "-l, --log-file        Specify a logfile to write to"
+    echo "-r, --recursive       Watch snapshots directory recursively"
+    echo "-s, --syslog          Write to syslog"
+    echo "-o, --timeshift-old   Look for snapshots in directory of Timeshift <v22.06 (requires --timeshift-auto)"
+    echo "-t, --timeshift-auto  Automatically detect Timeshifts snapshot directory"
+    echo "-v, --verbose         Let the log of the daemon be more verbose"
+    echo "-h, --help            Display this message"
+    echo
+    echo "Version ${GRUB_BTRFS_VERSION}${RESET}"
+}
+
+log() {
+    echo "${2}"$1"${RESET}"
+    if [ ${syslog} = true ]; then
+          logger -p user.notice -t ${0##*/}"["$$"]" "$1"
+    fi
+    if [ ${#logfile} -gt 1  ]; then
+          echo "$(date) ${1}" >> "${logfile}"
+    fi
+}
+
+vlog() {
+    if [ ${verbose} = true ]; then
+          echo "${2}"$1"${RESET}"
+          if [ ${syslog} = true ]; then
+                logger -p user.notice -t ${0##*/} "$1"
+          fi
+          if [ ${#logfile} -gt 1  ]; then
+                echo "$(date) ${1}" >> "${logfile}"
+          fi
+    fi
+}
+
+err() {
+    echo "${2}"${1}"${RESET}" >&2
+    if [ ${syslog} = true ]; then
+          logger -p user.error -t ${0##*/} "$1"
+    fi
+    if [ ${#logfile} -gt 1  ]; then
+          echo "$(date) error: ${1}" >> "${logfile}"
+    fi
+}
+
+parse_arguments() {
+    while getopts :l:ctvrsh-: opt; do
+            case "$opt" in
+                -)
+                    case "${OPTARG}" in
+                        no-color)
+                            setcolors false
+                            ;;
+                        log-file)
+                            logfile="${!OPTIND}"; OPTIND=$(( $OPTIND + 1 ))
+                            ;;
+                        timeshift-auto)
+                            timeshift_auto=true
+                            ;;
+                        timeshift-old)
+                            timeshift_old=true
+                            ;;
+                        verbose)
+                            verbose=true
+                            ;;
+                        recursive)
+                            recursive=true
+                            ;;
+                        syslog)
+                            syslog=true
+                            ;;
+                        help)
+                            print_help
+                            exit 0
+                            ;;
+                        *)
+                            if [ "$OPTERR" = 1 ] && [ "${optspec:0:1}" != ":" ]; then
+                                  err "[!] Unknown option --${OPTARG}" "${RED}" >&2
+                                  echo
+                            fi
+                            print_help
+                            exit 1
+                            ;;
+                    esac;;
+                c)
+                    setcolors false
+                    ;;
+                l)
+                    logfile="${OPTARG}"
+                    ;;
+                t)
+                    timeshift_auto=true
+                    ;;
+                o)
+                    timeshift_old=true
+                    ;;
+                v)
+                    verbose=true
+                    ;;
+                r)
+                    recursive=true
+                    ;;
+                s)
+                    syslog=true
+                    ;;
+                h)
+                    print_help
+                    exit 0
+                    ;;
+                *)
+                    if [ "$OPTERR" = 1 ] || [ "${optspec:0:1}" = ":" ]; then
+                          err "[!] Non-option argument: '-${OPTARG}'" "${RED}" >&2
+                          echo
+                    fi
+                    print_help
+                    exit 1
+                    ;;
+            esac
+    done
+}
+
+checks() {
+    # check if inotify exists, see issue #227
+    if ! command -v inotifywait >/dev/null 2>&1; then
+          err "[!] inotifywait was not found, exiting. Is inotify-tools installed?" "${RED}" >&2
+          exit 1
+    fi
+
+    if [ ${timeshift_auto} = false ] && [ ${timeshift_old} = true ]; then
+          err "[!] Flag --timeshift-old requires flag --timeshift-auto" "${RED}" >&2
+          exit 1
+    fi
+
+    if ! [ ${timeshift_auto} = true ]; then
+          for snapdir in "${snapdirs[@]}"
+              do
+                  if ! [ -d ${snapdir} ]; then
+                        err "[!] No directory found at ${snapdir}" "${RED}" >&2
+                        err "[!] Please specify a valid snapshot directory" "${RED}" >&2
+                        exit 1
+                  fi
+          done
+    fi
+}
+
+setup() {
+    if [ ${#logfile} -gt 1  ]; then
+          touch "${logfile}"
+          echo "GRUB-BTRFSD log $(date)" >> "${logfile}"
+    fi
+
+    if [ ${verbose} = true ]; then
+          inotify_qiet_flag=""
+    else
+        inotify_qiet_flag=" -q -q "
+    fi
+
+    if [ ${recursive} = true ]; then
+          inotify_recursive_flag=" -r "
+    else
+        inotify_recursive_flag=""
+    fi
+
+    if [ ${timeshift_auto} = true ]; then
+          watchtime=15
+          [ -d /run/timeshift ] || mkdir /run/timeshift
+    else
+        watchtime=0
+    fi
+}
+
+create_grub_menu() {
+    #  create the grub submenu of the whole grub menu, depending on whether the submenu already exists
+    #  and gives feedback if it worked
+    if grep "snapshots-btrfs" "${GRUB_BTRFS_GRUB_DIRNAME:-/boot/grub}"/grub.cfg; then
+    	  if  /etc/grub.d/41_snapshots-btrfs; then
+		        log "Grub submenu recreated" "${GREEN}"
+          else
+		      err "[!] Error during grub submenu creation (grub-btrfs error)" "${RED}"
+          fi
+    else
+        if ${GRUB_BTRFS_MKCONFIG:-grub-mkconfig} -o "${GRUB_BTRFS_GRUB_DIRNAME:-/boot/grub}"/grub.cfg; then
+		      log "Grub menu recreated" "${GREEN}"
+	    else
+		    err "[!] Error during grub menu creation (grub/ grub-btrfs error)" "${RED}"
+	    fi
+    fi
+}
+
+set_snapshot_dir() {
+    # old timeshift has it's snapshot dir in a different location
+    if [ "${timeshift_old}" = true ]; then
+          snapdir="/run/timeshift/backup/timeshift-btrfs/snapshots"
+    else
+        snapdir="/run/timeshift/${timeshift_pid}/backup/timeshift-btrfs/snapshots"
+    fi
+}
+
+daemon_function() {
+    trap 'vlog "$BASHPID: Received SIGINT/ SIGTERM"; exit 0' SIGINT SIGTERM
+    # start the actual daemon
+    snapdir=$1
+    vlog "Subdaemon function started, PID: $BASHPID" "${GREEN}"
+    vlog "${BASHPID}: Entering infinite while for $snapdir" "${GREEN}"
+    vlog "${BASHPID}: Snapshot dir watchtimeout: $watchtime"
+    while true; do
+            runs=false
+            if [ ${timeshift_auto} = true ] && ! [ "${timeshift_pid}" -gt 0 ] ; then
+                  # watch the timeshift folder for a folder that is created when timeshift starts up
+                  sleep 1 # for safety so the outer while is not going crazy
+                  if [ "${timeshift_pid}" -eq -2 ]; then
+                        log "${BASHPID}: detected timeshift shutdown"
+                  fi
+                  timeshift_pid=$(ps ax | awk '{sub(/.*\//, "", $5)} $5 ~ /timeshift/ {print $1}')
+                  if [ "${#timeshift_pid}" -gt 0 ]; then
+                        set_snapshot_dir
+                        log "${BASHPID}: detected running Timeshift at daemon startup, PID is: $timeshift_pid"
+                        vlog "${BASHPID}: new snapshots directory is $snapdir"
+                  else
+                      log "Watching /run/timeshift for timeshift to start"
+                      inotifywait ${inotify_qiet_flag} -e create -e delete /run/timeshift && {
+                          sleep 1
+                          timeshift_pid=$(ps ax | awk '{sub(/.*\//, "", $5)} $5 ~ /timeshift/ {print $1}')
+                          set_snapshot_dir
+                          log "${BASHPID}: detected Timeshift startup, PID is: $timeshift_pid" "${CYAN}"
+                          vlog "${BASHPID}: new snapshots directory is $snapdir" "${CYAN}"
+                          (create_grub_menu) # create the grub menu once immediately in a forking process. Snapshots from commandline using timeshift --create need this
+                      }
+                  fi
+                  runs=false
+            else
+                while [ -d "$snapdir" ]; do
+                        # watch the actual snapshots folder for a new snapshot or a deletion of a snapshot
+                        if [ ${runs} = false ] && [ ${verbose} = false ]; then
+                              log "${BASHPID}: Watching $snapdir for new snapshots..." "${CYAN}"
+                        else
+                            vlog "${BASHPID}: Watching $snapdir for new snapshots..." "${CYAN}"
+                        fi
+                        runs=true
+                        inotifywait ${inotify_qiet_flag} ${inotify_recursive_flag} -e create -e delete -e unmount -t "$watchtime" "$snapdir" && {
+                            log "${BASHPID}: Detected snapshot creation/ deletion, recreating Grub menu" "${CYAN}"
+                            sleep 5
+                            create_grub_menu
+                        }
+                        sleep 1
+                done
+                timeshift_pid=-2
+            fi
+            if ! [ ${timeshift_auto} = true ] && ! [ -d "${snapdir}" ] ; then # in case someone deletes the snapshots folder (in snapper mode) to prevent the while loop from going wild
+                  break
+            fi
+    done
+}
+
+main() {
+    # init
+    timeshift_pid=-1
+    watchtime=0
+    logfile=0
+    snapshots=-1
+    timeshift_auto=false
+    timeshift_old=false
+    verbose=false
+    syslog=false
+    recursive=false
+    trap sighandler SIGINT SIGTERM
+
+    setcolors true # normally we want colors
+
+    sysconfdir="/etc"
+    grub_btrfs_config="${sysconfdir}/default/grub-btrfs/config"
+    # source config file
+    [ -f "$grub_btrfs_config" ] && . "$grub_btrfs_config"
+    [ -f "${sysconfdir}/default/grub" ] && . "${sysconfdir}/default/grub"
+
+    parse_arguments "${@}"
+    shift $(( OPTIND - 1 ))
+    snapdirs=( "${@}" )
+
+    vlog "Arguments:"
+    vlog "Snapshot directories: ${snapdirs[*]}"
+    vlog "Timestift autodetection: $timeshift_auto"
+    vlog "Timeshift old: $timeshift_old"
+    vlog "Logfile: $logfile"
+    vlog "Recursive: $recursive"
+
+    checks
+    setup
+
+    log  "grub-btrfsd starting up..." "${GREEN}"
+
+    if [ ${timeshift_auto} = true ] ; then
+          daemon_function "timeshift" &
+    else
+        # for all dirs that got passed to the script, start a new fork with that dir
+        for snapdir in "${snapdirs[@]}"
+            do
+                vlog "starting daemon watching $snapdir..."
+                daemon_function "${snapdir}" &
+        done
+    fi
+    wait # wait for forks to finish, kill child forks if SIGTERM is sent
+    exit 0
+}
+
+main "${@}"

grub-btrfsd.confd

@@ -0,0 +1,17 @@
+# Copyright 2023 Pascal Jaeger
+# Distributed under the terms of the GNU General Public License v3
+
+## Where to locate the root snapshots
+snapshots="/.snapshots" # Snapper in the root directory
+#snapshots="/run/timeshift/backup/timeshift-btrfs/snapshots" # Timeshift < v22.06
+
+## Optional arguments to run with the daemon
+# Append options to this like this:
+# optional_args="--syslog --timeshift-auto --verbose"
+# Possible options are:
+# -t, --timeshift-auto  Automatically detect Timeshifts snapshot directory for timeshift >= 22.06
+# -o, --timeshift-old   Look for snapshots in directory of Timeshift <v22.06 (requires --timeshift-auto)
+# -l, --log-file        Specify a logfile to write to
+# -v, --verbose         Let the log of the daemon be more verbose
+# -s, --syslog          Write to syslog
+optional_args="--syslog"

grub-btrfsd.initd

@@ -0,0 +1,13 @@
+#!/sbin/openrc-run
+# Copyright 2023 Pascal Jaeger
+# Distributed under the terms of the GNU General Public License v3
+
+name="grub-btrfs daemon"
+command="/usr/bin/grub-btrfsd"
+command_args="$optional_args ${snapshots}"
+pidfile="/run/{RC_SVCNAME}.pid"
+command_background=true
+
+depend() {
+   use localmount
+}

grub-btrfsd.service

@@ -0,0 +1,23 @@
+[Unit]
+Description=Regenerate grub-btrfs.cfg
+
+[Service]
+Type=simple
+LogLevelMax=notice
+# Set the possible paths for `grub-mkconfig`
+Environment="PATH=/sbin:/bin:/usr/sbin:/usr/bin"
+# Load environment variables from the configuration
+EnvironmentFile=/etc/default/grub-btrfs/config
+# Start the daemon, usage of it is:
+# grub-btrfsd [-h, --help] [-t, --timeshift-auto] [-l, --log-file LOG_FILE] SNAPSHOTS_DIRS
+# SNAPSHOTS_DIRS         Snapshot directories to watch, without effect when --timeshift-auto
+# Optional arguments:
+# -t, --timeshift-auto  Automatically detect Timeshifts snapshot directory
+# -o, --timeshift-old   Activate for timeshift versions <22.06
+# -l, --log-file        Specify a logfile to write to
+# -v, --verbose         Let the log of the daemon be more verbose
+# -s, --syslog          Write to syslog
+ExecStart=/usr/bin/grub-btrfsd --syslog /.snapshots
+
+[Install]
+WantedBy=multi-user.target

initramfs/readme.md

@@ -39,7 +39,11 @@ You notice that the name of the `hook` must match the name of the 2 installed fi
 Re-generate your initramfs  
 `mkinitcpio -P` (option -P means, all preset present in `/etc/mkinitcpio.d`)
 
+#### Dracut based distros
+Distributions that use Dracut to make their initramfs (many of the Fedora based Distros) simply have to pass either `rd.live.overlay.readonly=1` (to boot into the snapshot read only) or `rd.live.overlay.overlayfs=1` (to act like a livedisk, that is files can be changed but changes will be lost on the next boot) to their kernel command line in grub. 
+Grub-btrfs provides the variable `GRUB_BTRFS_SNAPSHOT_KERNEL_PARAMETERS` to add any command to the kernel command line. Set it to `GRUB_BTRFS_SNAPSHOT_KERNEL_PARAMETERS="rd.live.overlay.overlayfs=1"` to make snapshots immutable when booted into. 
+After changing this run `sudo /etc/grub.d/41_snapshots-btrfs` to generate a new snapshot-submenu with the parameter added. 
+
 #### Other distribution
-Refer to your distribution's documentation  
-or contribute to this project to add a paragraph.
+Refer to your distribution's documentation or contribute to this project to add a paragraph.
 #

manpages/grub-btrfs.8.man

@@ -0,0 +1,288 @@
+.TH "grub-btrfs" "8" 
+
+.SH "NAME"
+.PP
+grub-btrfs - Automatically add btrfs-Snapshots as a Grub submenu
+
+.SH "SYNOPSIS"
+.PP
+\fC/etc/grub.d/41_snapshots\-btrfs [\-V, \-\-version]\fP
+
+.SH "DESCRIPTION"
+.PP
+Improves grub by adding “btrfs snapshots” to the grub menu.
+
+.PP
+You can boot your system on a “snapshot” from the grub menu.
+Supports manual snapshots, snapper and timeshift.
+Features of grub-btrfs:
+.IP \(em 4
+Automatically list snapshots existing on root partition (btrfs).
+.IP \(em 4
+Automatically detect if /boot is in separate partition.
+.IP \(em 4
+Automatically detect kernel, initramfs and intel/amd microcode in /boot directory on snapshots.
+.IP \(em 4
+Automatically create corresponding “menuentry” in grub.cfg
+.IP \(em 4
+Automatically detect the type/tags and descriptions/comments of snapper/timeshift snapshots.
+.IP \(em 4
+Automatically generate grub.cfg if you use the provided systemd service.
+
+.SH "CONFIGURATION"
+.PP
+grub-btrfs is configured via the file \fC/etc/default/grub\-btrfs/config\fP.
+Possible options are:
+
+.SS "GENERAL"
+.SS "\fCGRUB_BTRFS_DISABLE\fP"
+.PP
+Disable grub-btrfs if true.
+.IP \(em 4
+Default: “false”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_DISABLE="true"\fP
+
+.SS "\fCGRUB_BTRFS_TITLE_FORMAT\fP"
+.PP
+The snapshot entries submenu in Grub are added according to this line. It is possible to change to order of the fields.
+.IP \(em 4
+Default: (“date” “snapshot” “type” “description”)
+.IP \(em 4
+Example: \fCGRUB_BTRFS_TITLE_FORMAT=("date" "snapshot" "type" "description")\fP
+
+.SS "\fCGRUB_BTRFS_LIMIT\fP"
+.PP
+Maximum number of snapshots in the GRUB snapshots sub menu.
+.IP \(em 4
+Default: “50”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_LIMIT="50"\fP
+
+.SS "\fCGRUB_BTRFS_SUBVOLUME_SORT\fP"
+.PP
+Sort the found subvolumes by “ogeneration” or “generation” or “path” or “rootid”.
+.IP \(em 4
+See Sorting section in
+.BR btrfs-subvolume (8)
+.PP
+“-rootid” means list snapshot by new ones first.
+.IP \(em 4
+Default: “-rootid”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_SUBVOLUME_SORT="+ogen,\-gen,path,rootid"\fP
+
+.SS "\fCGRUB_BTRFS_SHOW_SNAPSHOTS_FOUND\fP"
+.PP
+Show snapshots found during run “grub-mkconfig”
+.IP \(em 4
+Default: “true”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_SHOW_SNAPSHOTS_FOUND="false"\fP
+
+.SS "\fCGRUB_BTRFS_ROOTFLAGS\fP"
+.PP
+Comma separated mount options to be used when booting a snapshot.
+They can be defined here as well as in the “/” line inside the respective snapshots’
+“/etc/fstab” files.  Mount options found in both places are combined, and this variable
+takes priority over `fstab` entries.
+NB: Do NOT include “subvol=...” or “subvolid=...” here.
+.IP \(em 4
+Default: “”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_ROOTFLAGS="space_cache,commit=10,norecovery"\fP
+
+.SS "\fCGRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION\fP"
+.PP
+By default “grub-btrfs” automatically detects your boot partition,
+either located at the system root or on a separate partition or in a subvolume,
+Change to “true” if your boot partition is not detected as separate.
+.IP \(em 4
+Default: “false”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION="true"\fP
+
+.SS "\GRUB_BTRFS_ENABLE_CRYPTODISK\fP"
+.PP
+Enable booting from snapshots stored on LUKS encrypted devices
+.IP \(em 4
+Default: “false”
+.IP \(em 4
+Example: \GRUB_BTRFS_ENABLE_CRYPTODISK="true"\fP
+
+.SS "CUSTOM KERNELS"
+.SS "\fCGRUB_BTRFS_NKERNEL\fP / \fCGRUB_BTRFS_NINIT\fP / \fCGRUB_BTRFS_CUSTOM_MICROCODE\fP"
+.PP
+By default, “grub-btrfs” automatically detects most existing kernels, initramfs and microcode.
+Customs kernel, initramfs and microcodes that are not detected can be added in these variables.
+.IP \(em 4
+Default: (“”)
+.IP \(em 4
+Example: \fCGRUB_BTRFS_NKERNEL=("kernel\-5.19.4\-custom" "vmlinux\-5.19.4\-custom")\fP
+\fCGRUB_BTRFS_NINIT=("initramfs\-5.19.4\-custom.img" "initrd\-5.19.4\-custom.img" "otherinit\-5.19.4\-custom.gz")\fP
+\fCGRUB_BTRFS_CUSTOM_MICROCODE=("custom\-ucode.img" "custom\-uc.img "custom_ucode.cpio")\fP
+
+.SS "\fCGRUB_BTRFS_SNAPSHOT_KERNEL_PARAMETERS\fP"
+.PP
+Additional kernel command line parameters that should be passed to the kernelwhen
+booting a snapshot.
+For dracut based distros this could be useful to pass “rd.live.overlay.overlayfs=1”
+or “rd.live.overlay.readonly=1” to the Kernel for booting read only snapshots.
+.IP \(em 4
+Default: “”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_SNAPSHOT_KERNEL_PARAMETERS="rd.live.overlay.overlayfs=1"\fP
+
+.SS "SNAPSHOT FILTERING"
+.SS "\fCGRUB_BTRFS_IGNORE_SPECIFIC_PATH\fP"
+.PP
+Ignore specific path during run “grub-mkconfig”.
+Only exact paths are ignored.
+e.g : if `specific path` = @, only `@` snapshot will be ignored.
+.IP \(em 4
+Default: (“@”)
+.IP \(em 4
+Example: \fCGRUB_BTRFS_IGNORE_SPECIFIC_PATH=("@home")\fP
+
+.SS "\fCGRUB_BTRFS_IGNORE_PREFIX_PATH\fP"
+.PP
+Ignore prefix path during run “grub-mkconfig”.
+Any path starting with the specified string will be ignored.
+e.g : if `prefix path` = @, all snapshots beginning with “@/...” will be ignored.
+.IP \(em 4
+Default: (“var/lib/docker” “@var/lib/docker” “@/var/lib/docker”)
+.IP \(em 4
+Example: \fCGRUB_BTRFS_IGNORE_PREFIX_PATH=("var/lib/docker" "@var/lib/docker" "@/var/lib/docker")\fP
+
+.SS "\fCGRUB_BTRFS_IGNORE_SNAPSHOT_TYPE\fP"
+.PP
+Ignore specific type/tag of snapshot during run “grub-mkconfig”.
+For snapper:
+Type = single, pre, post.
+For Timeshift:
+Tag = boot, ondemand, hourly, daily, weekly, monthly.
+.IP \(em 4
+Default: (“”)
+.IP \(em 4
+Example: \fCGRUB_BTRFS_IGNORE_SNAPSHOT_TYPE=("ondemand")\fP
+
+.SS "\fCGRUB_BTRFS_IGNORE_SNAPSHOT_DESCRIPTION\fP"
+.PP
+Ignore specific description of snapshot during run “grub-mkconfig”.
+.IP \(em 4
+Default: (“”)
+.IP \(em 4
+Example: \fCGRUB_BTRFS_IGNORE_SNAPSHOT_DESCRIPTION=("timeline")\fP
+
+.SS "DISTRIBUTION DEPENDENT SETTINGS"
+.SS "\fCGRUB_BTRFS_BOOT_DIRNAME\fP"
+.PP
+Location of kernels/initramfs/microcode.
+Used by “grub-btrfs” to detect the boot partition and the location of kernels, initramfs and microcodes.
+.IP \(em 4
+Default: “/boot”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_BOOT_DIRNAME="/"\fP
+
+.SS "\fCGRUB_BTRFS_GRUB_DIRNAME\fP"
+.PP
+Location of the folder containing the “grub.cfg” file.
+Might be grub2 on some systems.
+For example, on Fedora with EFI : “/boot/efi/EFI/fedora”
+.IP \(em 4
+Default: “/boot/grub”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_GRUB_DIRNAME="/boot/grub2"\fP
+
+.SS "\fCGRUB_BTRFS_GBTRFS_DIRNAME\fP"
+.PP
+Location where grub-btrfs.cfg should be saved.
+Some distributions (like OpenSuSE) store those file at the snapshot directory
+instead of boot. Be aware that this directory must be available for grub during
+startup of the system.
+.IP \(em 4
+Default: \fC$GRUB_BTRFS_GRUB_DIRNAME\fP
+.IP \(em 4
+Example: \fCGRUB_BTRFS_GBTRFS_DIRNAME="/.snapshots"\fP
+
+.SS "\fCGRUB_BTRFS_GBTRFS_SEARCH_DIRNAME\fP"
+.PP
+Location of the directory where Grub searches for the grub-btrfs.cfg file.
+Some distributions (like OpenSuSE) store those file at the snapshot directory
+instead of boot. Be aware that this directory must be available for grub during
+startup of the system.
+.IP \(em 4
+Default: “\${prefix}” (This is a grub variable that resolves to where grub is
+.PP
+installed. (like /boot/grub, /boot/efi/grub))
+.IP \(em 4
+NOTE: If variables of grub are used here like ${prefix}, they need to be escaped
+.PP
+with `$\` before the `$`
+.IP \(em 4
+Example: \fCGRUB_BTRFS_GBTRFS_SEARCH_DIRNAME="\${prefix}"\fP
+
+.SS "\fCGRUB_BTRFS_MKCONFIG\fP"
+.PP
+Name/path of the command to generate the grub menu, used by “grub-btrfs.service”
+Might be ’grub2-mkconfig’ on some systems (e.g. Fedora)
+Default paths are /sbin:/bin:/usr/sbin:/usr/bin, if your path is missing, report it on the upstream project.
+You can use the name of the command only or full the path.
+.IP \(em 4
+Default: grub-mkconfig
+.IP \(em 4
+Example: \fCGRUB_BTRFS_MKCONFIG=/sbin/grub2\-mkconfig\fP
+
+.SS "\fCGRUB_BTRFS_SCRIPT_CHECK\fP"
+.PP
+Name of grub-script-check command, used by “grub-btrfs”
+Might be ’grub2-script-check’ on some systems (e.g. Fedora)
+.IP \(em 4
+Default: grub-script-check
+.IP \(em 4
+Example: \fCGRUB_BTRFS_SCRIPT_CHECK=grub2\-script\-check\fP
+
+.SS "\fCGRUB_BTRFS_MKCONFIG_LIB\fP"
+.PP
+Path of grub-mkconfig\d\s-2lib\s+2\u file, used by “grub-btrfs”
+Might be ’/usr/share/grub2/grub-mkconfig\d\s-2lib\s+2\u’ on some systems (e.g. Opensuse)
+.IP \(em 4
+Default: /usr/share/grub/grub-mkconfig\d\s-2lib\s+2\u
+.IP \(em 4
+Example: \fCGRUB_BTRFS_MKCONFIG_LIB=/usr/share/grub2/grub\-mkconfig_lib\fP
+
+.SS "SECURITY"
+.SS "\fCGRUB_BTRFS_PROTECTION_AUTHORIZED_USERS\fP"
+.PP
+Password protection management for submenu, snapshots
+Refer to the Grub documentation \fIhttps://www.gnu.org/software/grub/manual/grub/grub.html#Authentication-and-authorisation\fP
+and this comment \fIhttps://github.com/Antynea/grub-btrfs/issues/95#issuecomment-682295660\fP
+Add authorized usernames separate by comma (userfoo,userbar).
+When Grub’s password protection is enabled, the superuser is authorized by default, it is not necessary to add it
+.IP \(em 4
+Default: “”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_PROTECTION_AUTHORIZED_USERS="userfoo,userbar"\fP
+
+.SS "\fCGRUB_BTRFS_DISABLE_PROTECTION_SUBMENU\fP"
+.PP
+Disable authentication support for submenu of Grub-btrfs only (--unrestricted)
+does not work if GRUB\d\s-2BTRFS\s+2\u\d\s-2PROTECTION\s+2\u\d\s-2AUTHORIZED\s+2\u\d\s-2USERS\s+2\u is not empty
+.IP \(em 4
+Default: “false”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_DISABLE_PROTECTION_SUBMENU="true"\fP
+
+.SH "FILES"
+.PP
+/etc/default/grub-btrfs/config
+
+.SH "SEE ALSO"
+.IR btrfs (8)
+.IR btrfs-subvolume (8)
+.IR grub-btrfsd (8)
+.IR grub-mkconfig (8)
+
+.SH "COPYRIGHT"
+.PP
+Copyright (c) 2022 Pascal Jäger

manpages/grub-btrfs.8.org

@@ -0,0 +1,215 @@
+#+title: grub-btrfs
+#+author: Pascal Jaeger
+#+MAN_CLASS_OPTIONS: :section-id "8"
+
+* NAME
+    grub-btrfs - Automatically add btrfs-Snapshots as a Grub submenu
+
+* SYNOPSIS
+~/etc/grub.d/41_snapshots-btrfs [-V, --version]~
+
+* DESCRIPTION
+Improves grub by adding "btrfs snapshots" to the grub menu.
+
+You can boot your system on a "snapshot" from the grub menu.
+Supports manual snapshots, snapper and timeshift.
+Features of grub-btrfs:
+- Automatically list snapshots existing on root partition (btrfs).
+- Automatically detect if /boot is in separate partition.
+- Automatically detect kernel, initramfs and intel/amd microcode in /boot directory on snapshots.
+- Automatically create corresponding "menuentry" in grub.cfg
+- Automatically detect the type/tags and descriptions/comments of snapper/timeshift snapshots.
+- Automatically generate grub.cfg if you use the provided systemd service.
+
+* CONFIGURATION
+grub-btrfs is configured via the file ~/etc/default/grub-btrfs/config~.
+Possible options are:
+
+** GENERAL
+
+*** ~GRUB_BTRFS_DISABLE~
+Disable grub-btrfs if true.
+- Default: "false"
+- Example: ~GRUB_BTRFS_DISABLE="true"~
+
+*** ~GRUB_BTRFS_TITLE_FORMAT~
+The snapshot entries submenu in Grub are added according to this line. It is possible to change to order of the fields.
+- Default: ("date" "snapshot" "type" "description")
+- Example: ~GRUB_BTRFS_TITLE_FORMAT=("date" "snapshot" "type" "description")~
+
+*** ~GRUB_BTRFS_LIMIT~
+Maximum number of snapshots in the GRUB snapshots sub menu.
+- Default: "50"
+- Example: ~GRUB_BTRFS_LIMIT="50"~
+
+*** ~GRUB_BTRFS_SUBVOLUME_SORT~
+Sort the found subvolumes by "ogeneration" or "generation" or "path" or "rootid".
+- See Sorting section in
+#+BEGIN_MAN
+.BR btrfs-subvolume (8)
+#+END_MAN
+"-rootid" means list snapshot by new ones first.
+- Default: "-rootid"
+- Example: ~GRUB_BTRFS_SUBVOLUME_SORT="+ogen,-gen,path,rootid"~
+
+*** ~GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND~
+Show snapshots found during run "grub-mkconfig"
+- Default: "true"
+- Example: ~GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND="false"~
+
+*** ~GRUB_BTRFS_ROOTFLAGS~
+Comma separated mount options to be used when booting a snapshot.
+They can be defined here as well as in the "/" line inside the respective snapshots'
+"/etc/fstab" files.  Mount options found in both places are combined, and this variable
+takes priority over `fstab` entries.
+NB: Do NOT include "subvol=..." or "subvolid=..." here.
+- Default: ""
+- Example: ~GRUB_BTRFS_ROOTFLAGS="space_cache,commit=10,norecovery"~
+
+*** ~GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION~
+By default "grub-btrfs" automatically detects your boot partition,
+either located at the system root or on a separate partition or in a subvolume,
+Change to "true" if your boot partition is not detected as separate.
+- Default: "false"
+- Example: ~GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION="true"~
+
+*** ~GRUB_BTRFS_ENABLE_CRYPTODISK~
+Enable booting from snapshots stored on LUKS encrypted devices
+- Default: "false"
+- Example: ~GRUB_BTRFS_ENABLE_CRYPTODISK="true"~
+
+** CUSTOM KERNELS
+
+*** ~GRUB_BTRFS_NKERNEL~ / ~GRUB_BTRFS_NINIT~ / ~GRUB_BTRFS_CUSTOM_MICROCODE~
+By default, "grub-btrfs" automatically detects most existing kernels, initramfs and microcode.
+Customs kernel, initramfs and microcodes that are not detected can be added in these variables.
+- Default: ("")
+- Example: ~GRUB_BTRFS_NKERNEL=("kernel-5.19.4-custom" "vmlinux-5.19.4-custom")~
+          ~GRUB_BTRFS_NINIT=("initramfs-5.19.4-custom.img" "initrd-5.19.4-custom.img" "otherinit-5.19.4-custom.gz")~
+          ~GRUB_BTRFS_CUSTOM_MICROCODE=("custom-ucode.img" "custom-uc.img "custom_ucode.cpio")~
+
+*** ~GRUB_BTRFS_SNAPSHOT_KERNEL_PARAMETERS~
+Additional kernel command line parameters that should be passed to the kernelwhen
+booting a snapshot.
+For dracut based distros this could be useful to pass "rd.live.overlay.overlayfs=1"
+or "rd.live.overlay.readonly=1" to the Kernel for booting read only snapshots.
+- Default: ""
+- Example: ~GRUB_BTRFS_SNAPSHOT_KERNEL_PARAMETERS="rd.live.overlay.overlayfs=1"~
+
+** SNAPSHOT FILTERING
+
+*** ~GRUB_BTRFS_IGNORE_SPECIFIC_PATH~
+Ignore specific path during run "grub-mkconfig".
+Only exact paths are ignored.
+e.g : if `specific path` = @, only `@` snapshot will be ignored.
+- Default: ("@")
+- Example: ~GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("@home")~
+
+*** ~GRUB_BTRFS_IGNORE_PREFIX_PATH~
+Ignore prefix path during run "grub-mkconfig".
+Any path starting with the specified string will be ignored.
+e.g : if `prefix path` = @, all snapshots beginning with "@/..." will be ignored.
+- Default: ("var/lib/docker" "@var/lib/docker" "@/var/lib/docker")
+- Example: ~GRUB_BTRFS_IGNORE_PREFIX_PATH=("var/lib/docker" "@var/lib/docker" "@/var/lib/docker")~
+
+*** ~GRUB_BTRFS_IGNORE_SNAPSHOT_TYPE~
+Ignore specific type/tag of snapshot during run "grub-mkconfig".
+For snapper:
+Type = single, pre, post.
+For Timeshift:
+Tag = boot, ondemand, hourly, daily, weekly, monthly.
+- Default: ("")
+- Example: ~GRUB_BTRFS_IGNORE_SNAPSHOT_TYPE=("ondemand")~
+
+*** ~GRUB_BTRFS_IGNORE_SNAPSHOT_DESCRIPTION~
+Ignore specific description of snapshot during run "grub-mkconfig".
+- Default: ("")
+- Example: ~GRUB_BTRFS_IGNORE_SNAPSHOT_DESCRIPTION=("timeline")~
+
+** DISTRIBUTION DEPENDENT SETTINGS
+
+*** ~GRUB_BTRFS_BOOT_DIRNAME~
+Location of kernels/initramfs/microcode.
+Used by "grub-btrfs" to detect the boot partition and the location of kernels, initramfs and microcodes.
+- Default: "/boot"
+- Example: ~GRUB_BTRFS_BOOT_DIRNAME="/"~
+
+*** ~GRUB_BTRFS_GRUB_DIRNAME~
+Location of the folder containing the "grub.cfg" file.
+Might be grub2 on some systems.
+For example, on Fedora with EFI : "/boot/efi/EFI/fedora"
+- Default: "/boot/grub"
+- Example: ~GRUB_BTRFS_GRUB_DIRNAME="/boot/grub2"~
+
+*** ~GRUB_BTRFS_GBTRFS_DIRNAME~
+ Location where grub-btrfs.cfg should be saved.
+ Some distributions (like OpenSuSE) store those file at the snapshot directory
+ instead of boot. Be aware that this directory must be available for grub during
+ startup of the system.
+- Default: ~$GRUB_BTRFS_GRUB_DIRNAME~
+- Example: ~GRUB_BTRFS_GBTRFS_DIRNAME="/.snapshots"~
+
+*** ~GRUB_BTRFS_GBTRFS_SEARCH_DIRNAME~
+Location of the directory where Grub searches for the grub-btrfs.cfg file.
+Some distributions (like OpenSuSE) store those file at the snapshot directory
+instead of boot. Be aware that this directory must be available for grub during
+startup of the system.
+- Default: "\${prefix}" (This is a grub variable that resolves to where grub is
+installed. (like /boot/grub, /boot/efi/grub))
+- NOTE: If variables of grub are used here like ${prefix}, they need to be escaped
+with `\` before the `$`
+- Example: ~GRUB_BTRFS_GBTRFS_SEARCH_DIRNAME="\${prefix}"~
+
+*** ~GRUB_BTRFS_MKCONFIG~
+Name/path of the command to generate the grub menu, used by
+#+BEGIN_MAN
+.BR grub-btrfsd (8)
+#+END_MAN
+Might be 'grub2-mkconfig' on some systems (e.g. Fedora)
+Default paths are /sbin:/bin:/usr/sbin:/usr/bin, if your path is missing, report it on the upstream project.
+You can use the name of the command only or full the path.
+- Default: grub-mkconfig
+- Example: ~GRUB_BTRFS_MKCONFIG=/sbin/grub2-mkconfig~
+
+*** ~GRUB_BTRFS_SCRIPT_CHECK~
+Name of grub-script-check command, used by "grub-btrfs"
+Might be 'grub2-script-check' on some systems (e.g. Fedora)
+- Default: grub-script-check
+- Example: ~GRUB_BTRFS_SCRIPT_CHECK=grub2-script-check~
+
+*** ~GRUB_BTRFS_MKCONFIG_LIB~
+Path of grub-mkconfig_lib file, used by "grub-btrfs"
+Might be '/usr/share/grub2/grub-mkconfig_lib' on some systems (e.g. Opensuse)
+- Default: /usr/share/grub/grub-mkconfig_lib
+- Example: ~GRUB_BTRFS_MKCONFIG_LIB=/usr/share/grub2/grub-mkconfig_lib~
+
+** SECURITY
+
+*** ~GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS~
+Password protection management for submenu, snapshots
+Refer to the Grub documentation https://www.gnu.org/software/grub/manual/grub/grub.html#Authentication-and-authorisation
+and this comment https://github.com/Antynea/grub-btrfs/issues/95#issuecomment-682295660
+Add authorized usernames separate by comma (userfoo,userbar).
+When Grub's password protection is enabled, the superuser is authorized by default, it is not necessary to add it
+- Default: ""
+- Example: ~GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS="userfoo,userbar"~
+
+*** ~GRUB_BTRFS_DISABLE_PROTECTION_SUBMENU~
+Disable authentication support for submenu of Grub-btrfs only (--unrestricted)
+does not work if GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS is not empty
+- Default: "false"
+- Example: ~GRUB_BTRFS_DISABLE_PROTECTION_SUBMENU="true"~
+
+* FILES
+/etc/default/grub-btrfs/config
+
+* SEE ALSO
+#+BEGIN_MAN
+.IR btrfs (8)
+.IR btrfs-subvolume (8)
+.IR grub-btrfsd (8)
+.IR grub-mkconfig (8)
+#+END_MAN
+
+* COPYRIGHT
+Copyright (c) 2022 Pascal Jäger

manpages/grub-btrfsd.8.man

@@ -0,0 +1,84 @@
+.TH "grub-btrfsd" "8" 
+
+.SH "NAME"
+.PP
+grub-btrfsd - An OpenRC daemon to automatically update the grub menu with
+.BR grub-btrfs (8)
+.PP
+when a new btrfs snapshot is created.
+
+.SH "SYNOPSIS"
+.PP
+\fCgrub\-btrfsd [\-h, \-\-help] [\-c, \-\-no\-color] [\-l, \-\-log\-file LOG_FILE] [\-r, \-\-recursive] [\-s, \-\-syslog] [\-t, \-\-timeshift\-auto] [\-o, \-\-timeshift\-old] [\-v, \-\-verbose] SNAPSHOTS_DIRS\fP
+
+.SH "DESCRIPTION"
+.PP
+Grub-btrfsd is a shell script which is meant to be run as a daemon.
+Grub-btrfsd watches a directory where btrfs-snapshots are created or deleted via inotifywait and runs grub-mkconfig (if grub-mkconfig never ran before since grub-btrfs was installed) or \fC/etc/grub.d/41_snapshots\-btrfs\fP (when grub-mkconfig ran before with grub-btrfs installed) when something in that directory changes.
+
+.SH "OPTIONS"
+.SS "\fCSNAPSHOTS_DIRS\fP"
+.PP
+This argument specifies the (space separated) paths where grub-btrfsd looks for newly created snapshots and snapshot deletions. It is usually defined by the program used to make snapshots.
+E.g. for Snapper this would be \fC/.snapshots\fP. It is possible to define more than one directory here, all directories will inherit the same settings (recursive etc.).
+This argument is not necessary to provide if \fC\-\-timeshift\-auto\fP is set.
+
+.SS "\fC\-c / \-\-no\-color\fP"
+.PP
+Disable colors in output.
+
+.SS "\fC\-l / \-\-log\-file\fP"
+.PP
+This arguments specifies a file where grub-btrfsd should write log messages.
+
+.SS "\fC\-r / \-\-recursive\fP"
+.PP
+Watch snapshot directory recursively
+
+.SS "\fC\-s / \-\-syslog\fP"
+.PP
+Write to syslog
+
+.SS "\fC\-t / \-\-timeshift\-auto\fP"
+.PP
+This is a flag to activate the auto detection of the path where Timeshift stores snapshots. Newer versions (>=22.06) of Timeshift mount their snapshots to \fC/run/timeshift/$PID/backup/timeshift\-btrfs\fP. Where \fC$PID\fP is the process ID of the currently running Timeshift session. The PID is changing every time Timeshift is opened. grub-btrfsd can automatically take care of the detection of the correct PID and directory if this flag is set. In this case the argument \fCSNAPSHOTS_DIRS\fP has no effect.
+
+.SS "\fC\-o / \-\-timeshift\-old\fP"
+.PP
+Look for snapshots in \fC/run/timeshift/backup/timeshift\-btrfs\fP instead of \fC/run/timeshift/$PID/backup/timeshift\-btrfs\fP. This is to be used for Timeshift versions <22.06.
+
+.SS "\fC\-v / \-\-verbose\fP"
+.PP
+Let the log of the daemon be more verbose
+
+.SS "\fC\-h / \-\-help\fP"
+.PP
+Displays a short help message.
+
+.SH "CONFIGURATION"
+.PP
+The daemon is usually configured via the file \fC/etc/conf.d/grub\-btrfsd\fP on openrc-init systems and \fCsudo systemctl edit \-\-full grub\-btrfsd\fP on systemd systems. In this file the arguments (See OPTIONS), that OpenRC passes to the daemon when it is started, can be configured.
+
+.SS "NOTES"
+.PP
+A common configuration for Snapper would be to set \fCSNAPSHOTS_DIR\fP to \fC/.snapshots\fP and not to set \fC\-\-timeshift\-auto\fP.
+For Timeshift \fC\-\-timeshift\-auto\fP is set to true and \fCSNAPSHOTS_DIR\fP can be left as is.
+
+.SH "FILES"
+.PP
+\fC/etc/conf.d/grub\-btrfsd\fP
+\fC/usr/lib/systemd/system/grub\-btrfsd.service\fP
+
+.SH "SEE ALSO"
+.IR btrfs (8)
+.IR btrfs-subvolume (8)
+.IR grub-btrfsd (8)
+.IR grub-mkconfig (8)
+.IR inotifywait (1)
+.IR openrc (8)
+.IR rc-service (8)
+.IR timeshift (1)
+
+.SH "COPYRIGHT"
+.PP
+Copyright (c) 2022 Pascal Jäger

manpages/grub-btrfsd.8.org

@@ -0,0 +1,73 @@
+#+title: grub-btrfsd
+#+author: Pascal Jaeger
+#+MAN_CLASS_OPTIONS: :section-id "8"
+
+* NAME
+grub-btrfsd - An OpenRC daemon to automatically update the grub menu with
+#+BEGIN_MAN
+.BR grub-btrfs (8)
+#+END_MAN
+when a new btrfs snapshot is created.
+
+* SYNOPSIS
+~grub-btrfsd [-h, --help] [-c, --no-color] [-l, --log-file LOG_FILE] [-r, --recursive] [-s, --syslog] [-t, --timeshift-auto] [-o, --timeshift-old] [-v, --verbose] SNAPSHOTS_DIRS~
+
+* DESCRIPTION
+Grub-btrfsd is a shell script which is meant to be run as a daemon.
+Grub-btrfsd watches a directory where btrfs-snapshots are created or deleted via inotifywait and runs grub-mkconfig (if grub-mkconfig never ran before since grub-btrfs was installed) or ~/etc/grub.d/41_snapshots-btrfs~ (when grub-mkconfig ran before with grub-btrfs installed) when something in that directory changes.
+
+* OPTIONS
+** ~SNAPSHOTS_DIRS~
+This argument specifies the (space separated) paths where grub-btrfsd looks for newly created snapshots and snapshot deletions. It is usually defined by the program used to make snapshots.
+E.g. for Snapper this would be ~/.snapshots~. It is possible to define more than one directory here, all directories will inherit the same settings (recursive etc.).
+This argument is not necessary to provide if ~--timeshift-auto~ is set.
+
+** ~-c / --no-color~
+Disable colors in output.
+
+** ~-l / --log-file~
+This arguments specifies a file where grub-btrfsd should write log messages.
+
+** ~-r / --recursive~
+Watch snapshot directory recursively
+
+** ~-s / --syslog~
+Write to syslog
+
+** ~-t / --timeshift-auto~
+This is a flag to activate the auto detection of the path where Timeshift stores snapshots. Newer versions (>=22.06) of Timeshift mount their snapshots to ~/run/timeshift/$PID/backup/timeshift-btrfs~. Where ~$PID~ is the process ID of the currently running Timeshift session. The PID is changing every time Timeshift is opened. grub-btrfsd can automatically take care of the detection of the correct PID and directory if this flag is set. In this case the argument ~SNAPSHOTS_DIRS~ has no effect.
+
+** ~-o / --timeshift-old~
+Look for snapshots in ~/run/timeshift/backup/timeshift-btrfs~ instead of ~/run/timeshift/$PID/backup/timeshift-btrfs~. This is to be used for Timeshift versions <22.06.
+
+** ~-v / --verbose~
+Let the log of the daemon be more verbose
+
+** ~-h / --help~
+Displays a short help message.
+
+* CONFIGURATION
+The daemon is usually configured via the file ~/etc/conf.d/grub-btrfsd~ on openrc-init systems and ~sudo systemctl edit --full grub-btrfsd~ on systemd systems. In this file the arguments (See OPTIONS), that OpenRC passes to the daemon when it is started, can be configured.
+
+** NOTES
+A common configuration for Snapper would be to set ~SNAPSHOTS_DIR~ to ~/.snapshots~ and not to set ~--timeshift-auto~.
+For Timeshift ~--timeshift-auto~ is set to true and ~SNAPSHOTS_DIR~ can be left as is.
+
+* FILES
+~/etc/conf.d/grub-btrfsd~
+~/usr/lib/systemd/system/grub-btrfsd.service~
+
+* SEE ALSO
+#+BEGIN_MAN
+.IR btrfs (8)
+.IR btrfs-subvolume (8)
+.IR grub-btrfsd (8)
+.IR grub-mkconfig (8)
+.IR inotifywait (1)
+.IR openrc (8)
+.IR rc-service (8)
+.IR timeshift (1)
+#+END_MAN
+
+* COPYRIGHT
+Copyright (c) 2022 Pascal Jäger

temp/grub-btrfs.8

@@ -0,0 +1,280 @@
+.TH "grub-btrfs" "8" 
+
+.SH "NAME"
+.PP
+grub-btrfs - Automatically add btrfs-Snapshots as a Grub submenu
+
+.SH "SYNOPSIS"
+.PP
+\fC/etc/grub.d/41_snapshots\-btrfs [\-V, \-\-version]\fP
+
+.SH "DESCRIPTION"
+.PP
+Improves grub by adding “btrfs snapshots” to the grub menu.
+
+.PP
+You can boot your system on a “snapshot” from the grub menu.
+Supports manual snapshots, snapper and timeshift.
+Features of grub-btrfs:
+.IP \(em 4
+Automatically list snapshots existing on root partition (btrfs).
+.IP \(em 4
+Automatically detect if /boot is in separate partition.
+.IP \(em 4
+Automatically detect kernel, initramfs and intel/amd microcode in /boot directory on snapshots.
+.IP \(em 4
+Automatically create corresponding “menuentry” in grub.cfg
+.IP \(em 4
+Automatically detect the type/tags and descriptions/comments of snapper/timeshift snapshots.
+.IP \(em 4
+Automatically generate grub.cfg if you use the provided systemd service.
+
+.SH "CONFIGURATION"
+.PP
+grub-btrfs is configured via the file \fC/etc/default/grub\-btrfs/config\fP.
+Possible options are:
+
+.SS "GENERAL"
+.SS "\fCGRUB_BTRFS_DISABLE\fP"
+.PP
+Disable grub-btrfs if true.
+.IP \(em 4
+Default: “false”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_DISABLE="true"\fP
+
+.SS "\fCGRUB_BTRFS_TITLE_FORMAT\fP"
+.PP
+The snapshot entries submenu in Grub are added according to this line. It is possible to change to order of the fields.
+.IP \(em 4
+Default: (“date” “snapshot” “type” “description”)
+.IP \(em 4
+Example: \fCGRUB_BTRFS_TITLE_FORMAT=("date" "snapshot" "type" "description")\fP
+
+.SS "\fCGRUB_BTRFS_LIMIT\fP"
+.PP
+Maximum number of snapshots in the GRUB snapshots sub menu.
+.IP \(em 4
+Default: “50”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_LIMIT="50"\fP
+
+.SS "\fCGRUB_BTRFS_SUBVOLUME_SORT\fP"
+.PP
+Sort the found subvolumes by “ogeneration” or “generation” or “path” or “rootid”.
+.IP \(em 4
+See Sorting section in
+.BR btrfs-subvolume (8)
+.PP
+“-rootid” means list snapshot by new ones first.
+.IP \(em 4
+Default: “-rootid”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_SUBVOLUME_SORT="+ogen,\-gen,path,rootid"\fP
+
+.SS "\fCGRUB_BTRFS_SHOW_SNAPSHOTS_FOUND\fP"
+.PP
+Show snapshots found during run “grub-mkconfig”
+.IP \(em 4
+Default: “true”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_SHOW_SNAPSHOTS_FOUND="false"\fP
+
+.SS "\fCGRUB_BTRFS_ROOTFLAGS\fP"
+.PP
+Comma separated mount options to be used when booting a snapshot.
+They can be defined here as well as in the “/” line inside the respective snapshots’
+“/etc/fstab” files.  Mount options found in both places are combined, and this variable
+takes priority over `fstab` entries.
+NB: Do NOT include “subvol=...” or “subvolid=...” here.
+.IP \(em 4
+Default: “”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_ROOTFLAGS="space_cache,commit=10,norecovery"\fP
+
+.SS "\fCGRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION\fP"
+.PP
+By default “grub-btrfs” automatically detects your boot partition,
+either located at the system root or on a separate partition or in a subvolume,
+Change to “true” if your boot partition is not detected as separate.
+.IP \(em 4
+Default: “false”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION="true"\fP
+
+.SS "CUSTOM KERNELS"
+.SS "\fCGRUB_BTRFS_NKERNEL\fP / \fCGRUB_BTRFS_NINIT\fP / \fCGRUB_BTRFS_CUSTOM_MICROCODE\fP"
+.PP
+By default, “grub-btrfs” automatically detects most existing kernels, initramfs and microcode.
+Customs kernel, initramfs and microcodes that are not detected can be added in these variables.
+.IP \(em 4
+Default: (“”)
+.IP \(em 4
+Example: \fCGRUB_BTRFS_NKERNEL=("kernel\-5.19.4\-custom" "vmlinux\-5.19.4\-custom")\fP
+\fCGRUB_BTRFS_NINIT=("initramfs\-5.19.4\-custom.img" "initrd\-5.19.4\-custom.img" "otherinit\-5.19.4\-custom.gz")\fP
+\fCGRUB_BTRFS_CUSTOM_MICROCODE=("custom\-ucode.img" "custom\-uc.img "custom_ucode.cpio")\fP
+
+.SS "\fCGRUB_BTRFS_SNAPSHOT_KERNEL_PARAMETERS\fP"
+.PP
+Additional kernel command line parameters that should be passed to the kernelwhen
+booting a snapshot.
+For dracut based distros this could be useful to pass “rd.live.overlay.overlayfs=1”
+or “rd.live.overlay.readonly=1” to the Kernel for booting read only snapshots.
+.IP \(em 4
+Default: “”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_SNAPSHOT_KERNEL_PARAMETERS="rd.live.overlay.overlayfs=1"\fP
+
+.SS "SNAPSHOT FILTERING"
+.SS "\fCGRUB_BTRFS_IGNORE_SPECIFIC_PATH\fP"
+.PP
+Ignore specific path during run “grub-mkconfig”.
+Only exact paths are ignored.
+e.g : if `specific path` = @, only `@` snapshot will be ignored.
+.IP \(em 4
+Default: (“@”)
+.IP \(em 4
+Example: \fCGRUB_BTRFS_IGNORE_SPECIFIC_PATH=("@home")\fP
+
+.SS "\fCGRUB_BTRFS_IGNORE_PREFIX_PATH\fP"
+.PP
+Ignore prefix path during run “grub-mkconfig”.
+Any path starting with the specified string will be ignored.
+e.g : if `prefix path` = @, all snapshots beginning with “@/...” will be ignored.
+.IP \(em 4
+Default: (“var/lib/docker” “@var/lib/docker” “@/var/lib/docker”)
+.IP \(em 4
+Example: \fCGRUB_BTRFS_IGNORE_PREFIX_PATH=("var/lib/docker" "@var/lib/docker" "@/var/lib/docker")\fP
+
+.SS "\fCGRUB_BTRFS_IGNORE_SNAPSHOT_TYPE\fP"
+.PP
+Ignore specific type/tag of snapshot during run “grub-mkconfig”.
+For snapper:
+Type = single, pre, post.
+For Timeshift:
+Tag = boot, ondemand, hourly, daily, weekly, monthly.
+.IP \(em 4
+Default: (“”)
+.IP \(em 4
+Example: \fCGRUB_BTRFS_IGNORE_SNAPSHOT_TYPE=("ondemand")\fP
+
+.SS "\fCGRUB_BTRFS_IGNORE_SNAPSHOT_DESCRIPTION\fP"
+.PP
+Ignore specific description of snapshot during run “grub-mkconfig”.
+.IP \(em 4
+Default: (“”)
+.IP \(em 4
+Example: \fCGRUB_BTRFS_IGNORE_SNAPSHOT_DESCRIPTION=("timeline")\fP
+
+.SS "DISTRIBUTION DEPENDENT SETTINGS"
+.SS "\fCGRUB_BTRFS_BOOT_DIRNAME\fP"
+.PP
+Location of kernels/initramfs/microcode.
+Used by “grub-btrfs” to detect the boot partition and the location of kernels, initramfs and microcodes.
+.IP \(em 4
+Default: “/boot”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_BOOT_DIRNAME="/"\fP
+
+.SS "\fCGRUB_BTRFS_GRUB_DIRNAME\fP"
+.PP
+Location of the folder containing the “grub.cfg” file.
+Might be grub2 on some systems.
+For example, on Fedora with EFI : “/boot/efi/EFI/fedora”
+.IP \(em 4
+Default: “/boot/grub”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_GRUB_DIRNAME="/boot/grub2"\fP
+
+.SS "\fCGRUB_BTRFS_GBTRFS_DIRNAME\fP"
+.PP
+Location where grub-btrfs.cfg should be saved.
+Some distributions (like OpenSuSE) store those file at the snapshot directory
+instead of boot. Be aware that this directory must be available for grub during
+startup of the system.
+.IP \(em 4
+Default: \fC$GRUB_BTRFS_GRUB_DIRNAME\fP
+.IP \(em 4
+Example: \fCGRUB_BTRFS_GBTRFS_DIRNAME="/.snapshots"\fP
+
+.SS "\fCGRUB_BTRFS_GBTRFS_SEARCH_DIRNAME\fP"
+.PP
+Location of the directory where Grub searches for the grub-btrfs.cfg file.
+Some distributions (like OpenSuSE) store those file at the snapshot directory
+instead of boot. Be aware that this directory must be available for grub during
+startup of the system.
+.IP \(em 4
+Default: “\${prefix}” (This is a grub variable that resolves to where grub is
+.PP
+installed. (like /boot/grub, /boot/efi/grub))
+.IP \(em 4
+NOTE: If variables of grub are used here like ${prefix}, they need to be escaped
+.PP
+with `$\` before the `$`
+.IP \(em 4
+Example: \fCGRUB_BTRFS_GBTRFS_SEARCH_DIRNAME="\${prefix}"\fP
+
+.SS "\fCGRUB_BTRFS_MKCONFIG\fP"
+.PP
+Name/path of the command to generate the grub menu, used by “grub-btrfs.service”
+Might be ’grub2-mkconfig’ on some systems (e.g. Fedora)
+Default paths are /sbin:/bin:/usr/sbin:/usr/bin, if your path is missing, report it on the upstream project.
+You can use the name of the command only or full the path.
+.IP \(em 4
+Default: grub-mkconfig
+.IP \(em 4
+Example: \fCGRUB_BTRFS_MKCONFIG=/sbin/grub2\-mkconfig\fP
+
+.SS "\fCGRUB_BTRFS_SCRIPT_CHECK\fP"
+.PP
+Name of grub-script-check command, used by “grub-btrfs”
+Might be ’grub2-script-check’ on some systems (e.g. Fedora)
+.IP \(em 4
+Default: grub-script-check
+.IP \(em 4
+Example: \fCGRUB_BTRFS_SCRIPT_CHECK=grub2\-script\-check\fP
+
+.SS "\fCGRUB_BTRFS_MKCONFIG_LIB\fP"
+.PP
+Path of grub-mkconfig\d\s-2lib\s+2\u file, used by “grub-btrfs”
+Might be ’/usr/share/grub2/grub-mkconfig\d\s-2lib\s+2\u’ on some systems (e.g. Opensuse)
+.IP \(em 4
+Default: /usr/share/grub/grub-mkconfig\d\s-2lib\s+2\u
+.IP \(em 4
+Example: \fCGRUB_BTRFS_MKCONFIG_LIB=/usr/share/grub2/grub\-mkconfig_lib\fP
+
+.SS "SECURITY"
+.SS "\fCGRUB_BTRFS_PROTECTION_AUTHORIZED_USERS\fP"
+.PP
+Password protection management for submenu, snapshots
+Refer to the Grub documentation \fIhttps://www.gnu.org/software/grub/manual/grub/grub.html#Authentication-and-authorisation\fP
+and this comment \fIhttps://github.com/Antynea/grub-btrfs/issues/95#issuecomment-682295660\fP
+Add authorized usernames separate by comma (userfoo,userbar).
+When Grub’s password protection is enabled, the superuser is authorized by default, it is not necessary to add it
+.IP \(em 4
+Default: “”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_PROTECTION_AUTHORIZED_USERS="userfoo,userbar"\fP
+
+.SS "\fCGRUB_BTRFS_DISABLE_PROTECTION_SUBMENU\fP"
+.PP
+Disable authentication support for submenu of Grub-btrfs only (--unrestricted)
+does not work if GRUB\d\s-2BTRFS\s+2\u\d\s-2PROTECTION\s+2\u\d\s-2AUTHORIZED\s+2\u\d\s-2USERS\s+2\u is not empty
+.IP \(em 4
+Default: “false”
+.IP \(em 4
+Example: \fCGRUB_BTRFS_DISABLE_PROTECTION_SUBMENU="true"\fP
+
+.SH "FILES"
+.PP
+/etc/default/grub-btrfs/config
+
+.SH "SEE ALSO"
+.IR btrfs (8)
+.IR btrfs-subvolume (8)
+.IR grub-btrfsd (8)
+.IR grub-mkconfig (8)
+
+.SH "COPYRIGHT"
+.PP
+Copyright (c) 2022 Pascal Jäger

temp/grub-btrfsd.8

@@ -0,0 +1,84 @@
+.TH "grub-btrfsd" "8" 
+
+.SH "NAME"
+.PP
+grub-btrfsd - An OpenRC daemon to automatically update the grub menu with
+.BR grub-btrfs (8)
+.PP
+when a new btrfs snapshot is created.
+
+.SH "SYNOPSIS"
+.PP
+\fCgrub\-btrfsd [\-h, \-\-help] [\-c, \-\-no\-color] [\-l, \-\-log\-file LOG_FILE] [\-r, \-\-recursive] [\-s, \-\-syslog] [\-t, \-\-timeshift\-auto] [\-o, \-\-timeshift\-old] [\-v, \-\-verbose] SNAPSHOTS_DIRS\fP
+
+.SH "DESCRIPTION"
+.PP
+Grub-btrfsd is a shell script which is meant to be run as a daemon.
+Grub-btrfsd watches a directory where btrfs-snapshots are created or deleted via inotifywait and runs grub-mkconfig (if grub-mkconfig never ran before since grub-btrfs was installed) or \fC/etc/grub.d/41_snapshots\-btrfs\fP (when grub-mkconfig ran before with grub-btrfs installed) when something in that directory changes.
+
+.SH "OPTIONS"
+.SS "\fCSNAPSHOTS_DIRS\fP"
+.PP
+This argument specifies the (space separated) paths where grub-btrfsd looks for newly created snapshots and snapshot deletions. It is usually defined by the program used to make snapshots.
+E.g. for Snapper this would be \fC/.snapshots\fP. It is possible to define more than one directory here, all directories will inherit the same settings (recursive etc.).
+This argument is not necessary to provide if \fC\-\-timeshift\-auto\fP is set.
+
+.SS "\fC\-c / \-\-no\-color\fP"
+.PP
+Disable colors in output.
+
+.SS "\fC\-l / \-\-log\-file\fP"
+.PP
+This arguments specifies a file where grub-btrfsd should write log messages.
+
+.SS "\fC\-r / \-\-recursive\fP"
+.PP
+Watch snapshot directory recursively
+
+.SS "\fC\-s / \-\-syslog\fP"
+.PP
+Write to syslog
+
+.SS "\fC\-t / \-\-timeshift\-auto\fP"
+.PP
+This is a flag to activate the auto detection of the path where Timeshift stores snapshots. Newer versions (>=22.06) of Timeshift mount their snapshots to \fC/run/timeshift/$PID/backup/timeshift\-btrfs\fP. Where \fC$PID\fP is the process ID of the currently running Timeshift session. The PID is changing every time Timeshift is opened. grub-btrfsd can automatically take care of the detection of the correct PID and directory if this flag is set. In this case the argument \fCSNAPSHOTS_DIRS\fP has no effect.
+
+.SS "\fC\-o / \-\-timeshift\-old\fP"
+.PP
+Look for snapshots in \fC/run/timeshift/backup/timeshift\-btrfs\fP instead of \fC/run/timeshift/$PID/backup/timeshift\-btrfs\fP. This is to be used for Timeshift versions <22.06.
+
+.SS "\fC\-v / \-\-verbose\fP"
+.PP
+Let the log of the daemon be more verbose
+
+.SS "\fC\-h / \-\-help\fP"
+.PP
+Displays a short help message.
+
+.SH "CONFIGURATION"
+.PP
+The daemon is usually configured via the file \fC/etc/conf.d/grub\-btrfsd\fP on openrc-init systems and \fCsudo systemctl edit \-\-full grub\-btrfsd\fP on systemd systems. In this file the arguments (See OPTIONS), that OpenRC passes to the daemon when it is started, can be configured.
+
+.SS "NOTES"
+.PP
+A common configuration for Snapper would be to set \fCSNAPSHOTS_DIR\fP to \fC/.snapshots\fP and not to set \fC\-\-timeshift\-auto\fP.
+For Timeshift \fC\-\-timeshift\-auto\fP is set to true and \fCSNAPSHOTS_DIR\fP can be left as is.
+
+.SH "FILES"
+.PP
+\fC/etc/conf.d/grub\-btrfsd\fP
+\fC/usr/lib/systemd/system/grub\-btrfsd.service\fP
+
+.SH "SEE ALSO"
+.IR btrfs (8)
+.IR btrfs-subvolume (8)
+.IR grub-btrfsd (8)
+.IR grub-mkconfig (8)
+.IR inotifywait (1)
+.IR openrc (8)
+.IR rc-service (8)
+.IR timeshift (1)
+
+.SH "COPYRIGHT"
+.PP
+Copyright (c) 2022 Pascal Jäger