Merge branch 'FedoraBTRFS' of https://github.com/leventbesli/linutil into FedoraBTRFS

2024-11-22 13:22:28 +00:00 · 2024-10-09 16:50:24 +03:00 · 2024-10-09 16:50:24 +03:00 · 504bde9fd8
commit 504bde9fd8
parent fed5afcbec 79eb752552
35 changed files with 498 additions and 171 deletions
--- a/.cargo/config.toml
+++ b/.cargo/config.toml
@ -0,0 +1,2 @@
+[alias]
+xtask = "run --package xtask --"
--- a/.github/mkdocs.yml
+++ b/.github/mkdocs.yml
@ -6,7 +6,7 @@ nav:
  - Introduction: 'index.md'
  - User Guide: 'userguide.md'
  - Contributing:
-      - Contributing Guide: 'contribute.md'
+      - Contributing Guide: 'contributing.md'
      - Roadmap: 'roadmap.md'
  - Documentation:
      - Known Issues: 'KnownIssues.md'
--- a/.github/workflows/github-pages.yml
+++ b/.github/workflows/github-pages.yml
@ -20,6 +20,17 @@ jobs:
        with:
          fetch-depth: '0'  # Fetch all commit history for all branches as well as tags.

+      - name: Copy Contributing Guidelines
+        run: |
+          echo "<!-- THIS FILE IS GENERATED AUTOMATICALLY. EDIT .github/CONTRIBUTING.md -->\n\n$(cat .github/CONTRIBUTING.md)" > 'docs/contributing.md'
+
+      - uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: Commit Contributing Guidelines
+          file_pattern: "docs/contributing.md"
+          add_options: '--force'
+        if: success()
+
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
--- a/.github/workflows/linutil.yml
+++ b/.github/workflows/linutil.yml
@ -89,19 +89,20 @@ jobs:
          version: ${{ env.version }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

-      - name: Install vhs
+      - name: Setup Preview
        run: |
-          wget 'https://github.com/charmbracelet/vhs/releases/download/v0.8.0/vhs_0.8.0_amd64.deb'
-          sudo apt install -y ffmpeg
-          sudo snap install ttyd --classic
-          sudo dpkg -i 'vhs_0.8.0_amd64.deb'
+          echo "$(pwd)/build" >> $GITHUB_PATH
      
-      - name: Build the preview
+      - name: Generate preview 
+        uses: charmbracelet/vhs-action@v2.1.0
+        with:
+          path: "docs/assets/preview.tape"
+
+      - name: Move preview
        run: |
-          export PATH="$(pwd)/build:$PATH"
-          vhs docs/assets/preview.tape -o docs/assets/preview.gif
+          mv preview.gif docs/assets/preview.gif

-      - name: Upload the preview
+      - name: Upload preview
        uses: stefanzweifel/git-auto-commit-action@v5
        with:
          commit_message: Preview for ${{ env.version }}
--- a/.github/workflows/shellcheck.yml
+++ b/.github/workflows/shellcheck.yml
@ -14,17 +14,42 @@ jobs:
      - uses: actions/checkout@v4
      - run: git fetch origin ${{ github.base_ref }}

-      - name: Download and set up shellcheck
+      - name: Download, setup, and run ShellCheck
+        shell: bash {0}
        run : |
-          wget https://github.com/koalaman/shellcheck/releases/download/v0.10.0/shellcheck-v0.10.0.linux.x86_64.tar.xz
-          tar -xf shellcheck-v0.10.0.linux.x86_64.tar.xz
-          cd shellcheck-v0.10.0
-          chmod +x shellcheck
+          SC_URL="https://github.com/koalaman/shellcheck/releases/download/v0.10.0/shellcheck-v0.10.0.linux.x86_64.tar.xz"
+          curl -fsSL "$SC_URL" | tar -Jx
+          chmod +x "./shellcheck-v0.10.0/shellcheck"

-      - name: Run shellcheck
-        run: |
-          for file in $(git diff --name-only origin/${{ github.base_ref }} HEAD core/tabs); do
+          error=0
+          files_to_check=$(git diff --name-only origin/${{ github.base_ref }} HEAD core/tabs)
+
+          for file in $files_to_check; do
              if [[ "$file" == *.sh ]] && [[ -f "$file" ]]; then
-                  ./shellcheck-v0.10.0/shellcheck -S error "$file"
+                  sc_output=$(./shellcheck-v0.10.0/shellcheck -fgcc -Serror "$file")
+                  iter_safe_parsed_errors=$(echo -e "$sc_output" | sed -n 's/\(.\+\)\:\([0-9]\+\)\:\([0-9]\+\)\: \(.*\)/::error file=\1,line=\2,col=\3::\4/p' | sed 's/ /:space:/g')
+
+                  for error in $iter_safe_parsed_errors; do
+                      echo "$error" | sed 's/:space:/ /g'
+                      error=1
+                  done
+
+                  tabs_detected=$(grep -nP '^\t+\S+' "$file")
+
+                  # fast fail on the action runner would fail immediately if there weren't any tabs found
+                  # this check makes sure that we don't continue if there's something really weird going on
+                  if [ "$?" = "2" ]; then
+                      echo "::error file=$file::There was a critical error while grepping $file, aborting"
+                      exit 1
+                  fi
+
+                  iter_safe_parsed_tabs_detected=$(echo "$tabs_detected" | sed -n 's,\([0-9]\+\).*,::error file='"$file"'\,line=\1::Found tab indentations,p' | sed 's/ /:space:/g')
+
+                  for error in $iter_safe_parsed_tabs_detected; do
+                      echo "$error" | sed 's/:space:/ /g'
+                      error=1
+                  done
              fi
          done
+
+          exit $error
--- a/.github/workflows/typos.yml
+++ b/.github/workflows/typos.yml
@ -0,0 +1,15 @@
+name: Check for typos
+
+on:
+  [push, pull_request, workflow_dispatch]
+
+jobs:
+  check-typos:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - run: git fetch origin ${{ github.base_ref }}
+
+      - name: Run spellcheck
+        uses: crate-ci/typos@v1.25.0
--- a/.github/workflows/xtask.yml
+++ b/.github/workflows/xtask.yml
@ -0,0 +1,58 @@
+name: XTasks
+
+on:
+  pull_request:
+    paths:
+      - "xtask"
+      - "Cargo.toml"
+      - "Cargo.lock"
+      - ".cargo"
+      - "core/tabs"
+      - "docs"
+  push:
+    paths:
+      - "xtask"
+      - "Cargo.toml"
+      - "Cargo.lock"
+      - ".cargo"
+      - "core/tabs"
+      - "docs"
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  docgen:
+    name: DocGen
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache Cargo registry
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/registry
+          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: ${{ runner.os }}-cargo-registry-
+
+      - name: Cache Cargo index
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/git
+          key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: ${{ runner.os }}-cargo-index-
+
+      - name: Run cargo xtask docgen
+        run: cargo xtask docgen
+
+      - name: Check uncommitted documentation changes
+        run: |
+          git diff
+          git diff-files --quiet \
+            || (echo "Run 'cargo xtask docgen' and push the changes" \
+            && exit 1)
--- a/Cargo.lock
+++ b/Cargo.lock
@ -165,9 +165,9 @@ dependencies = [

 [[package]]
 name = "cc"
-version = "1.1.18"
+version = "1.1.28"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b62ac837cdb5cb22e10a256099b4fc502b1dfe560cb282963a974d7abd80e476"
+checksum = "2e80e3b6a3ab07840e1cae9b0666a63970dc28e8ed5ffbcdacbfc760c281bfc1"
 dependencies = [
 "shlex",
 ]
@ -194,9 +194,9 @@ dependencies = [

 [[package]]
 name = "clap"
-version = "4.5.18"
+version = "4.5.19"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b0956a43b323ac1afaffc053ed5c4b7c1f1800bacd1683c353aabbb752515dd3"
+checksum = "7be5744db7978a28d9df86a214130d106a89ce49644cbc4e3f0c22c3fba30615"
 dependencies = [
 "clap_builder",
 "clap_derive",
@ -204,9 +204,9 @@ dependencies = [

 [[package]]
 name = "clap_builder"
-version = "4.5.18"
+version = "4.5.19"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4d72166dd41634086d5803a47eb71ae740e61d84709c36f3c34110173db3961b"
+checksum = "a5fbc17d3ef8278f55b282b2a2e75ae6f6c7d4bb70ed3d0382375104bfafdb4b"
 dependencies = [
 "anstream",
 "anstyle",
@ -972,6 +972,12 @@ version = "1.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "a2eb9349b6444b326872e140eb1cf5e7c522154d69e7a0ffb0fb81c06b37543f"

+[[package]]
+name = "streaming-iterator"
+version = "0.1.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2b2231b7c3057d5e4ad0156fb3dc807d900806020c5ffa3ee6ff2c8c76fb8520"
+
 [[package]]
 name = "strsim"
 version = "0.11.1"
@ -1028,18 +1034,18 @@ dependencies = [

 [[package]]
 name = "thiserror"
-version = "1.0.63"
+version = "1.0.64"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c0342370b38b6a11b6cc11d6a805569958d54cfa061a29969c3b5ce2ea405724"
+checksum = "d50af8abc119fb8bb6dbabcfa89656f46f84aa0ac7688088608076ad2b459a84"
 dependencies = [
 "thiserror-impl",
 ]

 [[package]]
 name = "thiserror-impl"
-version = "1.0.63"
+version = "1.0.64"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a4558b58466b9ad7ca0f102865eccc95938dca1a74a856f2b57b6629050da261"
+checksum = "08904e7672f5eb876eaaf87e0ce17857500934f4981c4a0ab2b4aa98baac7fc3"
 dependencies = [
 "proc-macro2",
 "quote",
@ -1082,13 +1088,14 @@ dependencies = [

 [[package]]
 name = "tree-sitter"
-version = "0.23.0"
+version = "0.24.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "20f4cd3642c47a85052a887d86704f4eac272969f61b686bdd3f772122aabaff"
+checksum = "23b84f60031bf8245b563a80c92c1034e557a914f7958f474bc0afa2eed78b98"
 dependencies = [
 "cc",
 "regex",
 "regex-syntax",
+ "streaming-iterator",
 "tree-sitter-language",
 ]

@ -1104,12 +1111,13 @@ dependencies = [

 [[package]]
 name = "tree-sitter-highlight"
-version = "0.23.0"
+version = "0.24.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "395d7a477a4504fd7d5e4d003e0dd41bd5b9c4985d53592a943a8354ec452dae"
+checksum = "5c727fb31f816c09fc54dc0e971d101318926866f7261b2acb820e84a61bf52d"
 dependencies = [
 "lazy_static",
 "regex",
+ "streaming-iterator",
 "thiserror",
 "tree-sitter",
 ]
@ -1410,6 +1418,13 @@ version = "0.0.19"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "d135d17ab770252ad95e9a872d365cf3090e3be864a34ab46f48555993efc904"

+[[package]]
+name = "xtask"
+version = "24.9.28"
+dependencies = [
+ "linutil_core",
+]
+
 [[package]]
 name = "zerocopy"
 version = "0.7.35"
--- a/Cargo.toml
+++ b/Cargo.toml
@ -1,12 +1,14 @@
 [workspace.package]
 license = "MIT"
 version = "24.9.28"
+edition = "2021"

 [workspace.dependencies]
 ego-tree = "0.6.2"

 [workspace]
-members = ["tui", "core"]
+members = ["tui", "core", "xtask"]
+default-members = ["tui", "core"]
 resolver = "2"

 [patch.crates-io]
--- a/README.md
+++ b/README.md
@ -49,7 +49,7 @@ makepkg -si

 Replace `<package>` with your preferred package.

-If you use [yay](https://github.com/Jguer/yay), [paru](https://github.com/Morganamilo/paru) or any other [AUR Helper](https://wiki.archlinux.org/title/AUR_helpers), it's even simplier:
+If you use [yay](https://github.com/Jguer/yay), [paru](https://github.com/Morganamilo/paru) or any other [AUR Helper](https://wiki.archlinux.org/title/AUR_helpers), it's even simpler:

 ```bash
 paru -S linutil
--- a/_typos.toml
+++ b/_typos.toml
@ -0,0 +1,7 @@
+[files]
+extend-exclude = ["tui/cool_tips.txt"]
+
+[default]
+extend-ignore-identifiers-re = [
+    "ratatui",
+]
--- a/core/tabs/applications-setup/grub-theme.sh
+++ b/core/tabs/applications-setup/grub-theme.sh
@ -4,8 +4,12 @@

 themeinstall(){
    mkdir -p "$HOME/.local/share"
-    cd "$HOME/.local/share" && git clone "https://github.com/ChrisTitusTech/Top-5-Bootloader-Themes"
-    cd "$HOME/.local/share/Top-5-Bootloader-Themes"
+    cd "$HOME/.local/share"
+    if [ -d 'Top-5-Bootloader-Themes' ]; then
+        rm -rf 'Top-5-Bootloader-Themes'
+    fi
+    git clone "https://github.com/ChrisTitusTech/Top-5-Bootloader-Themes"
+    cd "Top-5-Bootloader-Themes"
    "$ESCALATION_TOOL" ./install.sh
 }

--- a/core/tabs/applications-setup/zsh-setup.sh
+++ b/core/tabs/applications-setup/zsh-setup.sh
@ -44,6 +44,7 @@ RPROMPT='%F{15}(%F{166}%D{%H:%M}%F{15})%f'
 EOL

  # Ensure /etc/zsh/zshenv sets ZDOTDIR to the user's config directory
+  [ ! -f /etc/zsh/zshenv ] && "$ESCALATION_TOOL" mkdir -p /etc/zsh && "$ESCALATION_TOOL" touch /etc/zsh/zshenv
  echo "export ZDOTDIR=\"$HOME/.config/zsh\"" | "$ESCALATION_TOOL" tee -a /etc/zsh/zshenv
 }

--- a/core/tabs/security/firewall-baselines.sh
+++ b/core/tabs/security/firewall-baselines.sh
@ -30,7 +30,7 @@ configureUFW() {
    printf "%b\n" "${YELLOW}Allowing port 80/tcp (UFW)${RC}"
    "$ESCALATION_TOOL" ufw allow 80/tcp

-    printf "%b\n" "${YELLO}Allowing port 443/tcp (UFW)${RC}"
+    printf "%b\n" "${YELLOW}Allowing port 443/tcp (UFW)${RC}"
    "$ESCALATION_TOOL" ufw allow 443/tcp

    printf "%b\n" "${YELLOW}Denying Incoming Packets by Default(UFW)${RC}"
--- a/core/tabs/system-setup/arch/server-setup.sh
+++ b/core/tabs/system-setup/arch/server-setup.sh
@ -216,7 +216,7 @@ echo -ne "
 ------------------------------------------------------------------------
    THIS WILL FORMAT AND DELETE ALL DATA ON THE DISK
    Please make sure you know what you are doing because
-    after formating your disk there is no way to get data back
+    after formatting your disk there is no way to get data back
    *****BACKUP YOUR DATA BEFORE CONTINUING*****
    ***I AM NOT RESPONSIBLE FOR ANY DATA LOSS***
 ------------------------------------------------------------------------
@ -328,7 +328,7 @@ echo -ne "
 pacman -S --noconfirm --needed gptfdisk btrfs-progs glibc
 echo -ne "
 -------------------------------------------------------------------------
-                    Formating Disk
+                    Formatting Disk
 -------------------------------------------------------------------------
 "
 umount -A --recursive /mnt # make sure everything is unmounted before we start
--- a/core/tabs/system-setup/compile-setup.sh
+++ b/core/tabs/system-setup/compile-setup.sh
@ -15,30 +15,30 @@ installDepend() {
            else
                printf "%b\n" "${GREEN}Multilib is already enabled.${RC}"
            fi
-            "$AUR_HELPER" -S --needed --noconfirm "$DEPENDENCIES"
+            "$AUR_HELPER" -S --needed --noconfirm $DEPENDENCIES
            ;;
        apt-get|nala)
            COMPILEDEPS='build-essential'
            "$ESCALATION_TOOL" "$PACKAGER" update
            "$ESCALATION_TOOL" dpkg --add-architecture i386
            "$ESCALATION_TOOL" "$PACKAGER" update
-            "$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" "$COMPILEDEPS"
+            "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES $COMPILEDEPS
            ;;
        dnf)
            COMPILEDEPS='@development-tools'
            "$ESCALATION_TOOL" "$PACKAGER" update
            "$ESCALATION_TOOL" "$PACKAGER" config-manager --set-enabled powertools
-            "$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" $COMPILEDEPS
+            "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES $COMPILEDEPS
            "$ESCALATION_TOOL" "$PACKAGER" install -y glibc-devel.i686 libgcc.i686
            ;;
        zypper)
            COMPILEDEPS='patterns-devel-base-devel_basis'
            "$ESCALATION_TOOL" "$PACKAGER" refresh 
-            "$ESCALATION_TOOL" "$PACKAGER" --non-interactive install "$DEPENDENCIES" "$COMPILEDEPS"
+            "$ESCALATION_TOOL" "$PACKAGER" --non-interactive install $DEPENDENCIES $COMPILEDEPS
            "$ESCALATION_TOOL" "$PACKAGER" --non-interactive install libgcc_s1-gcc7-32bit glibc-devel-32bit
            ;;
        *)
-            "$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES"
+            "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES
            ;;
    esac
 }
--- a/core/tabs/system-setup/fedora/configure-dnf.sh
+++ b/core/tabs/system-setup/fedora/configure-dnf.sh
@ -10,7 +10,7 @@ configureDNF() {
            echo "fastestmirror=True" | "$ESCALATION_TOOL" tee -a /etc/dnf/dnf.conf > /dev/null
            echo "defaultyes=True" | "$ESCALATION_TOOL" tee -a /etc/dnf/dnf.conf > /dev/null            
            "$ESCALATION_TOOL" "$PACKAGER" -y install dnf-plugins-core
-            printf "%b\n" "${GREEN}DNF Configured Succesfully...${RC}"
+            printf "%b\n" "${GREEN}DNF Configured Successfully.${RC}"
            ;;
        *)
            printf "%b\n" "${RED}Unsupported distribution: $DTYPE${RC}"
--- a/core/tabs/system-setup/fedora/nvidia-proprietary-driver-setup.sh
+++ b/core/tabs/system-setup/fedora/nvidia-proprietary-driver-setup.sh
@ -3,7 +3,7 @@
 . ../../common-script.sh
 # This script allows user to download proprietary drivers for nvidia in fedora

-# It also disables noveau nvidia drivers
+# It also disables nouveau nvidia drivers

 # Installation guide link: https://rpmfusion.org/Howto/NVIDIA

--- a/core/tabs/system-setup/gaming-setup.sh
+++ b/core/tabs/system-setup/gaming-setup.sh
@ -23,7 +23,7 @@ installDepend() {
                ncurses lib32-ncurses vulkan-icd-loader lib32-vulkan-icd-loader ocl-icd lib32-ocl-icd libva lib32-libva \
                gst-plugins-base-libs lib32-gst-plugins-base-libs sdl2"

-            $AUR_HELPER -S --needed --noconfirm "$DEPENDENCIES" "$DISTRO_DEPS"
+            $AUR_HELPER -S --needed --noconfirm $DEPENDENCIES $DISTRO_DEPS
            ;;
        apt-get|nala)
            DISTRO_DEPS="libasound2 libsdl2 wine64 wine32"
@ -33,24 +33,24 @@ installDepend() {
            "$ESCALATION_TOOL" "$PACKAGER" install -y software-properties-common
            "$ESCALATION_TOOL" apt-add-repository contrib -y
            "$ESCALATION_TOOL" "$PACKAGER" update
-            "$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" "$DISTRO_DEPS"
+            "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES $DISTRO_DEPS
            ;;
        dnf)
            if [ "$(rpm -E %fedora)" -le 41 ]; then 
                "$ESCALATION_TOOL" "$PACKAGER" install ffmpeg ffmpeg-libs -y
-                "$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES"
+                "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES
            else
                printf "%b\n" "${CYAN}Fedora < 41 detected. Installing rpmfusion repos.${RC}"
                "$ESCALATION_TOOL" "$PACKAGER" install https://mirrors.rpmfusion.org/free/fedora/rpmfusion-free-release-"$(rpm -E %fedora)".noarch.rpm https://mirrors.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-"$(rpm -E %fedora)".noarch.rpm -y
                "$ESCALATION_TOOL" "$PACKAGER" config-manager --enable fedora-cisco-openh264 -y
-                "$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES"
+                "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES
            fi
            ;;
        zypper)
-            "$ESCALATION_TOOL" "$PACKAGER" -n install "$DEPENDENCIES"
+            "$ESCALATION_TOOL" "$PACKAGER" -n install $DEPENDENCIES
            ;;
        *)
-            "$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES"
+            "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES
            ;;
    esac
 }
@ -59,7 +59,7 @@ installAdditionalDepend() {
    case "$PACKAGER" in
        pacman)
            DISTRO_DEPS='steam lutris goverlay'
-            "$ESCALATION_TOOL" "$PACKAGER" -S --needed --noconfirm "$DISTRO_DEPS"
+            "$ESCALATION_TOOL" "$PACKAGER" -S --needed --noconfirm $DISTRO_DEPS
            ;;
        apt-get|nala)
            version=$(git -c 'versionsort.suffix=-' ls-remote --tags --sort='v:refname' https://github.com/lutris/lutris |
--- a/core/tabs/system-setup/remove-snaps.sh
+++ b/core/tabs/system-setup/remove-snaps.sh
@ -3,6 +3,7 @@
 . ../common-script.sh

 removeSnaps() {
+    if command_exists snap; then
        case "$PACKAGER" in
            pacman)
                "$ESCALATION_TOOL" "$PACKAGER" -Rns snapd
@ -13,10 +14,7 @@ removeSnaps() {
                    "$ESCALATION_TOOL" apt-mark hold snapd
                fi
                ;;
-        dnf)
-            "$ESCALATION_TOOL" "$PACKAGER" remove snapd
-            ;;
-        zypper)
+            dnf|zypper)
                "$ESCALATION_TOOL" "$PACKAGER" remove snapd
                ;;
            *)
@ -24,6 +22,10 @@ removeSnaps() {
                exit 1
                ;;
        esac
+        printf "%b\n" "${GREEN}Successfully removed snaps.${RC}"
+    else
+        printf "%b\n" "${GREEN}Snapd is not installed.${RC}"
+    fi
 }

 checkEnv
--- a/core/tabs/system-setup/system-cleanup.sh
+++ b/core/tabs/system-setup/system-cleanup.sh
@ -23,7 +23,7 @@ cleanup_system() {
            ;;
        pacman)
            "$ESCALATION_TOOL" "$PACKAGER" -Sc --noconfirm
-            "$ESCALATION_TOOL" "$PACKAGER" -Rns "$(pacman -Qtdq)" --noconfirm
+            "$ESCALATION_TOOL" "$PACKAGER" -Rns $(pacman -Qtdq) --noconfirm > /dev/null 2>&1
            ;;
        *)
            printf "%b\n" "${RED}Unsupported package manager: ""$PACKAGER""${RC}"
--- a/core/tabs/utils/tab_data.toml
+++ b/core/tabs/utils/tab_data.toml
@ -16,60 +16,66 @@ values = [":0", ":1", ":2", ":3", ":4", ":5", ":6", ":7", ":8", ":9"]

 [[data.entries]]
 name = "Auto Detect Displays"
-description = "This utility is designed to detect and apply recommended configuration for monitors connected with your system"
+description = "This script is designed to detect and apply recommended configuration for monitors connected with your system"
 script = "monitor-control/auto_detect_displays.sh"

 [[data.entries]]
 name = "Change Orientation"
-description = "This utility is designed to change the orientation of monitors in your system"
+description = "This script is designed to change the orientation of monitors in your system"
 script = "monitor-control/change_orientation.sh"

 [[data.entries]]
 name = "Disable Monitor"
-description = "This utility is designed to disable a monitor in your system"
+description = "This script is designed to disable a monitor in your system"
 script = "monitor-control/disable_monitor.sh"

 [[data.entries]]
 name = "Duplicate Displays"
-description = "This utility is designed to duplicate display among multi-monitor setup in your system"
+description = "This script is designed to duplicate display among multi-monitor setup in your system"
 script = "monitor-control/duplicate_displays.sh"

 [[data.entries]]
 name = "Enable Monitor"
-description = "This utility is designed to enable a monitor in your system"
+description = "This script is designed to enable a monitor in your system"
 script = "monitor-control/enable_monitor.sh"

 [[data.entries]]
 name = "Extend Displays"
-description = "This utility is designed to extend display among multi-monitor setup in your system"
+description = "This script is designed to extend display among multi-monitor setup in your system"
 script = "monitor-control/extend_displays.sh"

 [[data.entries]]
 name = "Manage Arrangement"
-description = "This utility is designed to arrange monitors in multi-monitor setup in your system"
+description = "This script is designed to arrange monitors in multi-monitor setup in your system"
 script = "monitor-control/manage_arrangement.sh"

 [[data.entries]]
 name = "Reset Scaling"
-description = "This utility is designed to reset scaling of a monitor in your system"
+description = "This script is designed to reset scaling of a monitor in your system"
 script = "monitor-control/reset_scaling.sh"
 matches = true

 [[data.entries]]
 name = "Scale Monitors"
-description = "This utility is designed to change the scaling of monitors in your system"
+description = "This script is designed to change the scaling of monitors in your system"
 script = "monitor-control/scale_monitor.sh"

 [[data.entries]]
 name = "Set Brightness"
 script = "monitor-control/set_brightness.sh"
+description = "This script is designed to change the Brightness of monitors connected to your system"
 matches = true

 [[data.entries]]
 name = "Set Primary Monitor"
-description = "This utility is designed to set a Primary monitor in your system"
+description = "This script is designed to set a Primary monitor in your system"
 script = "monitor-control/set_primary_monitor.sh"

+[[data.entries]]
+name = "Set Resolution"
+description = "This script is designed to change the resolution of monitors connected to your system"
+script = "monitor-control/set_resolutions.sh"
+
 [[data]]
 name = "User Account Manager"

--- a/docs/assets/preview.tape
+++ b/docs/assets/preview.tape
@ -61,13 +61,14 @@ Require linutil
 Require sh

 Set Shell "bash"
-Set FontSize 32
-Set Width 3200
-Set Height 1800
+Set FontFamily "JetBrainsMono Nerd Font"
+Set FontSize 24
+Set Width 1920
+Set Height 1080

 Sleep 1s

-Type "linutil -t compatible" Sleep 1s  Enter
+Type "linutil" Sleep 1s  Enter

 Sleep 5s

--- a/docs/contributing.md
+++ b/docs/contributing.md
@ -1,4 +1,4 @@
-# How to Contribute?
+<!-- THIS FILE IS GENERATED AUTOMATICALLY. EDIT .github/CONTRIBUTING.md -->\n\n# Contributing Guidelines for Linutil

 Thank you for considering contributing to Linutil! We appreciate your effort in helping improve this project. To ensure that your contributions align with the goals and quality standards of Linutil, please follow these guidelines:

@ -40,22 +40,28 @@ cd linutil
 - **Make small, targeted PRs**: Focus on one feature or fix per pull request. This makes it easier to review and increases the likelihood of acceptance.
 - **Avoid combining unrelated changes**: PRs that tackle multiple unrelated issues are harder to review and might be rejected because of a single problem.

-## 8. Code Review and Feedback
+## 8. Understand and Test the Code You Write
+
+- **Review your code**: Before submitting your changes, take the time to review your code for readability, efficiency and performance. Consider how your changes affect the project.
+- **Avoid using LLMs**: Don't submit AI-generated code without reviewing and testing it first. Ensure that any code you submit is thoroughly understood and meets the project's standards.
+- **Testing Requirements**: Failure to conduct testing after multiple requests may result in the closure of your Pull Request.
+
+## 9. Code Review and Feedback

 - **Expect feedback**: PRs will undergo code review. Be open to feedback and willing to make adjustments as needed.
 - **Participate in reviews**: If you feel comfortable, review other contributors' PRs as well. Peer review is a great way to learn and ensure high-quality contributions.

-## 9. Contributing Is More Than Just Code
+## 10. Contributing Is More Than Just Code

 - **Test the tool**: Running tests and providing feedback on how the tool works in different environments is a valuable contribution.
 - **Write well-formed issues**: Clearly describe bugs or problems you encounter, providing as much detail as possible, including steps to reproduce the issue.
 - **Propose reasonable feature requests**: When suggesting new features, ensure they fit within the scope, style, and design of the project. Provide clear reasoning and use cases.

-## 10. Documentation
+## 11. Documentation

 - **Update the documentation**: If your change affects the functionality, please update the relevant documentation files to reflect this.

-## 11. License
+## 12. License

 - **Agree to the license**: By contributing to Linutil, you agree that your contributions will be licensed under the project's MIT license.

--- a/linutil.desktop
+++ b/linutil.desktop
@ -1,6 +1,7 @@
 [Desktop Entry]
 Name=Linutil
-Exec=sh -c "$HOME/.local/bin/linutil"
+Comment=Distro-agnostic toolbox designed to simplify everyday Linux tasks
+Exec=sh -c '/usr/bin/linutil || $HOME/.cargo/bin/linutil || linutil'
 Icon=utilities-terminal
 Type=Application
 Terminal=true
--- a/man/linutil.1
+++ b/man/linutil.1
@ -0,0 +1,65 @@
+.\" manpage for Linutil
+.TH "linutil" "1" "October 2024" "" "Linutil Manual"
+
+.SH NAME
+linutil \- Chris Titus Tech's Linux Toolbox
+
+.SH SYNOPSIS
+\fBlinutil [OPTIONS]\fR
+
+.SH DESCRIPTION
+Linutil is a distro-agnostic toolbox designed to simplify everyday Linux tasks.
+.br
+It helps you set up applications and optimize your system for specific use cases. The utility is actively developed in Rust, providing performance and reliability.
+
+.SH LIVE VERSION
+To get started with the live version, pick which branch you would like to use, then run the command in your terminal:
+.TP
+\fBStable Branch\fR
+curl -fsSL https://christitus.com/linux | sh
+.TP
+\fBDevelopement branch\fR
+curl -fsSL https://christitus.com/linuxdev | sh
+
+.SH OPTIONS
+.TP
+\fB\-t\fR, \fB\-\-theme\fR \fI<theme>\fR
+Set the theme to use in the TUI.
+.br
+Possible values:
+\fIdefault\fR,
+\fIcompatible\fR.
+.br
+Defaults to \fIdefault\fR.
+
+.TP
+\fB\-\-override\-validation\fR
+Show all available entries, disregarding compatibility checks. (\fBUNSAFE\fR)
+
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help.
+
+.SH SUPPORT
+If you find Linutil helpful, please consider giving it a star on GitHub to show your support!
+https://github.com/ChrisTitusTech/linutil
+
+.SH DOCUMENTATION
+For comprehensive information on how to use Linutil, visit the Official Linutil Documentation.
+https://christitustech.github.io/linutil
+
+.SH AUTHOR
+Written by Adam Perkowski.
+<adas1per@protonmail.com>
+
+.SH REPORTING BUGS
+Since the project is still in active development, you may encounter some issues.
+.br
+Please consider submitting feedback if you do.
+https://github.com/ChrisTitusTech/linutil/issues
+
+.SH COPYRIGHT
+Copyright (c) 2024 Chris Titus.
+.br
+MIT License.
+https://opensource.org/license/MIT
--- a/tui/Cargo.toml
+++ b/tui/Cargo.toml
@ -7,7 +7,7 @@ edition = "2021"
 license.workspace = true
 repository = "https://github.com/ChrisTitusTech/linutil/tree/main/tui"
 version.workspace = true
-include = ["src/*.rs", "Cargo.toml", "build.rs", "cool_tips.txt"]
+include = ["src/*.rs", "Cargo.toml", "build.rs", "cool_tips.txt", "../man/linutil.1"]
 build = "build.rs"

 [features]
@ -15,7 +15,7 @@ default = ["tips"]
 tips = ["rand"]

 [dependencies]
-clap = { version = "4.5.18", features = ["derive"] }
+clap = { version = "4.5.19", features = ["derive"] }
 crossterm = "0.28.1"
 ego-tree = { workspace = true }
 oneshot = "0.1.8"
@ -26,7 +26,7 @@ temp-dir = "0.1.14"
 unicode-width = "0.2.0"
 rand = { version = "0.8.5", optional = true }
 linutil_core = { path = "../core", version = "24.9.28" }
-tree-sitter-highlight = "0.23.0"
+tree-sitter-highlight = "0.24.2"
 tree-sitter-bash = "0.23.1"
 anstyle = "1.0.8"
 ansi-to-tui = "6.0.0"
--- a/tui/src/floating_text.rs
+++ b/tui/src/floating_text.rs
@ -24,18 +24,12 @@ use tree_sitter_bash as hl_bash;
 use tree_sitter_highlight::{self as hl, HighlightEvent};
 use zips::zip_result;

-pub enum FloatingTextMode {
-    Preview,
-    Description,
-    ActionsGuide,
-}
-
 pub struct FloatingText {
    pub src: Vec<String>,
    max_line_width: usize,
    v_scroll: usize,
    h_scroll: usize,
-    mode_title: &'static str,
+    mode_title: String,
 }

 macro_rules! style {
@ -130,7 +124,7 @@ fn get_lines_owned(s: &str) -> Vec<String> {
 }

 impl FloatingText {
-    pub fn new(text: String, mode: FloatingTextMode) -> Self {
+    pub fn new(text: String, title: &str) -> Self {
        let src = get_lines(&text)
            .into_iter()
            .map(|s| s.to_string())
@ -139,14 +133,14 @@ impl FloatingText {
        let max_line_width = max_width!(src);
        Self {
            src,
-            mode_title: Self::get_mode_title(mode),
+            mode_title: title.to_string(),
            max_line_width,
            v_scroll: 0,
            h_scroll: 0,
        }
    }

-    pub fn from_command(command: &Command, mode: FloatingTextMode) -> Option<Self> {
+    pub fn from_command(command: &Command, title: String) -> Option<Self> {
        let (max_line_width, src) = match command {
            Command::Raw(cmd) => {
                // just apply highlights directly
@ -169,21 +163,13 @@ impl FloatingText {

        Some(Self {
            src,
-            mode_title: Self::get_mode_title(mode),
+            mode_title: title,
            max_line_width,
            h_scroll: 0,
            v_scroll: 0,
        })
    }

-    fn get_mode_title(mode: FloatingTextMode) -> &'static str {
-        match mode {
-            FloatingTextMode::Preview => "Command Preview",
-            FloatingTextMode::Description => "Command Description",
-            FloatingTextMode::ActionsGuide => "Important Actions Guide",
-        }
-    }
-
    fn scroll_down(&mut self) {
        if self.v_scroll + 1 < self.src.len() {
            self.v_scroll += 1;
@ -214,7 +200,7 @@ impl FloatContent for FloatingText {
        // Define the Block with a border and background color
        let block = Block::default()
            .borders(Borders::ALL)
-            .title(self.mode_title)
+            .title(self.mode_title.clone())
            .title_alignment(ratatui::layout::Alignment::Center)
            .title_style(Style::default().reversed())
            .style(Style::default());
@ -292,7 +278,7 @@ impl FloatContent for FloatingText {

    fn get_shortcut_list(&self) -> (&str, Box<[Shortcut]>) {
        (
-            self.mode_title,
+            &self.mode_title,
            Box::new([
                Shortcut::new("Scroll down", ["j", "Down"]),
                Shortcut::new("Scroll up", ["k", "Up"]),
--- a/tui/src/state.rs
+++ b/tui/src/state.rs
@ -1,10 +1,8 @@
-use std::rc::Rc;
-
 use crate::{
    confirmation::{ConfirmPrompt, ConfirmStatus},
    filter::{Filter, SearchAction},
    float::{Float, FloatContent},
-    floating_text::{FloatingText, FloatingTextMode},
+    floating_text::FloatingText,
    hint::{create_shortcut_list, Shortcut},
    running_command::RunningCommand,
    theme::Theme,
@ -21,6 +19,7 @@ use ratatui::{
    widgets::{Block, Borders, List, ListState, Paragraph},
    Frame,
 };
+use std::rc::Rc;
 use temp_dir::TempDir;

 const MIN_WIDTH: u16 = 77;
@ -54,7 +53,7 @@ pub struct AppState {
    /// This stack keeps track of our "current directory". You can think of it as `pwd`. but not
    /// just the current directory, all paths that took us here, so we can "cd .."
    visit_stack: Vec<NodeId>,
-    /// This is the state asociated with the list widget, used to display the selection in the
+    /// This is the state associated with the list widget, used to display the selection in the
    /// widget
    selection: ListState,
    filter: Filter,
@ -655,10 +654,10 @@ impl AppState {
    }

    fn enable_preview(&mut self) {
-        if let Some(node) = self.get_selected_node() {
-            if let Some(preview) =
-                FloatingText::from_command(&node.command, FloatingTextMode::Preview)
-            {
+        if let Some(list_node) = self.get_selected_node() {
+            let mut preview_title = "[Preview] - ".to_string();
+            preview_title.push_str(list_node.name.as_str());
+            if let Some(preview) = FloatingText::from_command(&list_node.command, preview_title) {
                self.spawn_float(preview, 80, 80);
            }
        }
@ -666,7 +665,7 @@ impl AppState {

    fn enable_description(&mut self) {
        if let Some(command_description) = self.get_selected_description() {
-            let description = FloatingText::new(command_description, FloatingTextMode::Description);
+            let description = FloatingText::new(command_description, "Command Description");
            self.spawn_float(description, 80, 80);
        }
    }
@ -732,7 +731,7 @@ impl AppState {

    fn toggle_task_list_guide(&mut self) {
        self.spawn_float(
-            FloatingText::new(ACTIONS_GUIDE.to_string(), FloatingTextMode::ActionsGuide),
+            FloatingText::new(ACTIONS_GUIDE.to_string(), "Important Actions Guide"),
            80,
            80,
        );
--- a/xtask/Cargo.toml
+++ b/xtask/Cargo.toml
@ -0,0 +1,8 @@
+[package]
+name = "xtask"
+version.workspace = true
+license.workspace = true
+edition.workspace = true
+
+[dependencies]
+linutil_core = { path = "../core" }
--- a/xtask/src/docgen.rs
+++ b/xtask/src/docgen.rs
@ -0,0 +1,60 @@
+use std::fs;
+
+use linutil_core::Command;
+
+use crate::path;
+use crate::DynError;
+
+pub const USER_GUIDE: &str = "userguide.md";
+
+pub fn userguide() -> Result<String, DynError> {
+    let mut md = String::new();
+    md.push_str("<!-- THIS FILE IS GENERATED BY cargo xtask docgen -->\n# Walkthrough\n");
+
+    let tabs = linutil_core::get_tabs(false).1;
+
+    for tab in tabs {
+        #[cfg(debug_assertions)]
+        println!("Tab: {}", tab.name);
+
+        md.push_str(&format!("\n## {}\n\n", tab.name));
+
+        for entry in tab.tree {
+            if entry.command == Command::None {
+                #[cfg(debug_assertions)]
+                println!("  Directory: {}", entry.name);
+
+                if entry.name != "root".to_string() {
+                    md.push_str(&format!("\n### {}\n\n", entry.name));
+                }
+
+                /* let current_dir = &entry.name;
+
+                if *current_dir != "root".to_string() {
+                    md.push_str(&format!(
+                        "\n<details><summary>{}</summary>\n\n",
+                        current_dir
+                    ));
+                } */ // Commenting this for now, might be a good idea later
+            } else {
+                if !entry.description.is_empty() {
+                    #[cfg(debug_assertions)]
+                    println!("    Entry: {}", entry.name);
+                    #[cfg(debug_assertions)]
+                    println!("      Description: {}", entry.description);
+
+                    md.push_str(&format!("- **{}**: {}\n", entry.name, entry.description));
+                } /* else {
+                      md.push_str(&format!("- **{}**\n", entry.name));
+                  } */ // https://github.com/ChrisTitusTech/linutil/pull/753
+            }
+        }
+    }
+
+    Ok(md)
+}
+
+pub fn write(file: &str, data: &str) {
+    let path = path::docs().join(file);
+    fs::write(path, data).unwrap_or_else(|_| panic!("Could not write to {}", file));
+}
--- a/xtask/src/main.rs
+++ b/xtask/src/main.rs
@ -0,0 +1,40 @@
+mod docgen;
+mod path;
+
+use std::{env, error::Error};
+
+type DynError = Box<dyn Error>;
+
+pub mod tasks {
+    use crate::docgen::USER_GUIDE;
+    use crate::docgen::{userguide, write};
+    use crate::DynError;
+
+    pub fn docgen() -> Result<(), DynError> {
+        write(USER_GUIDE, &userguide()?);
+        Ok(())
+    }
+
+    pub fn print_help() {
+        println!(
+            "
+Usage: `cargo xtask <task>`
+
+    Tasks:
+        docgen: Generate Markdown files.
+"
+        );
+    }
+}
+
+fn main() -> Result<(), DynError> {
+    let task = env::args().nth(1);
+    match task {
+        None => tasks::print_help(),
+        Some(t) => match t.as_str() {
+            "docgen" => tasks::docgen()?,
+            invalid => return Err(format!("Invalid task: {}", invalid).into()),
+        },
+    };
+    Ok(())
+}
--- a/xtask/src/path.rs
+++ b/xtask/src/path.rs
@ -0,0 +1,12 @@
+use std::path::{Path, PathBuf};
+
+pub fn project_root() -> PathBuf {
+    Path::new(env!("CARGO_MANIFEST_DIR"))
+        .parent()
+        .unwrap()
+        .to_path_buf()
+}
+
+pub fn docs() -> PathBuf {
+    project_root().join("docs/")
+}