usergide updated with docgen

docs/userguide.md

@@ -1,82 +1,152 @@
+<!-- THIS FILE IS GENERATED BY cargo xtask docgen -->
 # Walkthrough
----
-
-## System Setup
-
-- **System Update**: Starts a system-wide update.
-- **Compile Setup**: Installs tools and dependencies for compiling software.
-- **Gaming Setup**: Configures Steam, Lutris, etc.
-- **Global Theming**: Sets up and manages global themes.
-- **Remove Snaps**: Removes snap packages.
-- **TTY Fonts**: This Script will set the default TTY font to Terminus size 32 Bold
-
-### Arch Setup
-
-- **Paru Setup**: Installs the Paru AUR helper.
-- **Yay Setup**: Installs the Yay AUR helper.
-- **Server Setup**: Installs Arch Linux.
-
-### Fedora Setup
-
-- **RPM Fusion Setup**: Adds RPM Fusion free and nonfree repositories.
-- **Multimedia Codecs**: Installs multimedia codecs and updates multimedia-related packages. Requires RPM Fusion repositories to be set up first.
-- **NVIDIA Proprietary Driver Setup**: Installs proprietary NVIDIA drivers for GPUs from 2014 or later.
-- **Virtualization Setup**: Installs virtualization tools.
-- **Configure DNF**: Optimizes DNF for better speeds.
-- **Btrfs Assistant, Snapper Config, grub-btrfs**: Installs Btrfs Assistant, Snapper, dnf snapper plugin and grub-btrfs. Creates snapper configs. Notice: The /boot configured as a separate EXT4 partition by default in Fedora, so it can't be included in the snapshots. Backup it seperately.
 
 ## Applications Setup
 
-- **Flathub**: Installs Flatpak and Flathub.
-- **Alacritty Setup**: Installs and configures Alacritty for you.
-- **DwmTitus Setup**: Sets up the Dwm window manager.
-- **Kitty Setup**: Installs and configures Kitty for you.
-- **Rofi Setup**: Installs the Rofi application/script launcher.
-- **Zsh Setup**: Installs and configures Zsh for you.
-- **Fastfetch Setup**: Installs and configures Fastfetch.
-- **Linutil Updater**: Updates the Linutil AUR / Crates.io Package.
-- **Linutil Installer**: Installs Linutil via Crates.io or AUR.
-- **Office Suite Setup**: Installs various office suites and PDF viewers (OnlyOffice, LibreOffice, WPS Office, FreeOffice, Evince, Okular, PDF Studio Viewer, PDF Studio).
 
 ### Developer Tools
 
-- **Meld Setup**: Installs Meld, a visual diff and merge tool.
+- **Github Desktop**: GitHub Desktop is a user-friendly application that simplifies the process of managing Git repositories and interacting with GitHub, providing a graphical interface for tasks like committing, branching, and syncing changes.
-- **Ngrok Setup**: Installs Ngrok, a tool for creating secure tunnels to localhost.
+- **Neovim**: Neovim is a refactor, and sometimes redactor, in the tradition of Vim.
-- **Neovim Setup**: Installs and configures Neovim, a Vim-based text editor.
+It is not a rewrite but a continuation and extension of Vim.
-- **VS Code Setup**: Installs Visual Studio Code, a popular text editor.
+This command configures neovim from CTT's neovim configuration.
-- **Sublime Setup**: Installs Sublime Text, a nice text editor for code and markup.
+https://github.com/ChrisTitusTech/neovim
-- **VS Codium Setup**: Installs VS Codium, an open-source build of VS Code.
+- **Sublime Text**: Sublime Text is a fast, lightweight, and customizable text editor known for its simplicity, powerful features, and wide range of plugins for various programming languages.
-- **GitHub Desktop Setup**: Installs GitHub Desktop, a GUI for Git and GitHub.
+- **VS Code**: Visual Studio Code (VS Code) is a lightweight, open-source code editor with built-in support for debugging, version control, and extensions for various programming languages and frameworks.
+- **VS Codium**: VSCodium is a free, open-source version of Visual Studio Code (VS Code) that removes Microsoft-specific telemetry and branding.
+- **Meld**: Meld is a visual diff and merge tool that helps compare files, directories, and version-controlled projects.
+- **Ngrok**: Ngrok is a tool that creates secure, temporary tunnels to expose local servers to the internet for testing and development.
 
-## Security Features
+### Communication Apps
 
-- **Firewall Baselines**: Sets up firewall rules.
+- **Discord**: Discord is a versatile communication platform for gamers and communities, offering voice, video, and text chat features.
+- **Jitsi**: Jitsi Meet is an open-source video conferencing tool that allows users to host and join secure meetings directly from their web browsers without the need for downloads.
+- **Signal**: Signal is a privacy-focused messaging app that provides end-to-end encryption for secure text, voice, and video communication.
+- **Slack**: Slack is a collaboration platform designed for team communication, featuring channels, direct messaging, file sharing, and integrations with various productivity tools.
+- **Telegram**: Telegram is a cloud-based messaging app known for its speed and security, offering features like group chats, channels, and end-to-end encrypted calls.
+- **Zoom**: Zoom is a widely-used video conferencing platform that allows users to host virtual meetings, webinars, and online collaboration with features like screen sharing and recording.
+- **Thunderbird**: Thunderbird is a free, open-source email client that offers powerful features like customizable email management, a built-in calendar, and extensive add-ons for enhanced functionality.
+
+### Office Suites
+
+
+### PDF Suites
+
+
+### Web Browsers
+
+- **Brave**: Brave is a free and open-source web browser developed by Brave Software, Inc. based on the Chromium web browser.
+- **Chromium**: Chromium is an open-source web browser project started by Google, to provide the source code for the proprietary Google Chrome browser.
+- **Google Chrome**: Google Chrome is a fast, secure, and free web browser, built for the modern web.
+- **LibreWolf**: LibreWolf is a fork of Firefox, focused on privacy, security, and freedom.
+- **Lynx**: Lynx is a highly configurable text-based web browser for use on cursor-addressable character cell terminals.
+- **Mozilla Firefox**: Mozilla Firefox is a free and open-source web browser developed by the Mozilla Foundation.
+- **Thorium**: Thorium is a Chromium-based browser focused on privacy and performance.
+- **Vivaldi**: Vivaldi is a freeware, cross-platform web browser developed by Vivaldi Technologies.
+- **Alacritty**: Alacritty is a modern terminal emulator that comes with sensible defaults, but allows for extensive configuration. By integrating with other applications, rather than reimplementing their functionality, it manages to provide a flexible set of features with high performance. The supported platforms currently consist of BSD, Linux, macOS and Windows.
+This command installs and condifures alacritty terminal emulator.
+- **Android Debloater**: Universal Android Debloater (UAD) is a tool designed to help users remove bloatware and unnecessary pre-installed applications from Android devices, enhancing performance and user experience.
+- **Bash Prompt**: The .bashrc file is a script that runs every time a new terminal session is started in Unix-like operating systems.
+It is used to configure the shell session, set up aliases, define functions, and more, making the terminal easier to use and more powerful.
+This command configures the key sections and functionalities defined in the .bashrc file from CTT's mybash repository.
+https://github.com/ChrisTitusTech/mybash
+- **Bottles**: Bottles allows Windows software, like applications and games, to run on Linux.
+Bottles also provides tools to categorize, organize and optimize your applications.
+- **DWM-Titus**: DWM is a dynamic window manager for X.
+It manages windows in tiled, monocle and floating layouts.
+All of the layouts can be applied dynamically, optimising the environment for the application in use and the task performed.
+This command installs and configures DWM and a desktop manager.
+The list of patches applied can be found in CTT's DWM repository
+https://github.com/ChrisTitusTech/dwm-titus
+- **Docker**: Docker is an open platform that uses OS-level virtualization to deliver software in packages called containers.
+- **Fastfetch**: Fastfetch is a neofetch-like tool for fetching system information and displaying it prettily.
+It is written mainly in C, with performance and customizability in mind.
+This command installs fastfetch and configures from CTT's mybash repository.
+https://github.com/ChrisTitusTech/mybash
+- **Flatpak / Flathub**: Flatpak is a universal application sandbox for Linux that uses isolated packages from Flathub to prevent conflicts and system alterations, while alleviating dependency concerns.
+This command installs Flatpak and adds the Flathub repository
+- **Grub Theme**: Installs ChrisTitusTech's Top 5 Bootloader Themes script to allow for easy customization of GRUB.
+- **Kitty**: kitty is a free and open-source GPU-accelerated terminal emulator for Linux, macOS, and some BSD distributions, focused on performance and features.
+kitty is written in a mix of C and Python programming languages.
+ This command installs and configures kitty.
+- **Linutil Installer**: Installs a distro-specific Linutil package locally.
+- **Linutil Updater**: Updates your local Linutil crate installation.
+- **Rofi**: Rofi is a window switcher, run dialog, ssh-launcher and dmenu replacement that started as a clone of simpleswitcher, written by Sean Pringle and later expanded by Dave Davenport.
+This command installs and configures rofi with configuration from CTT's DWM repo.
+https://github.com/ChrisTitusTech/dwm-titus
+- **Waydroid**: Waydroid is an emulator that allows you to run Android apps and games on Linux.
+- **ZSH Prompt**: The Z shell is a Unix shell that can be used as an interactive login shell and as a command interpreter for shell scripting. Zsh is an extended Bourne shell with many improvements, including some features of Bash, ksh, and tcsh.
+This command installs ZSH prompt and provides basic configuration.
+
+## Gaming
+
+
+### Diablo II Resurrected
+
+- **Loot Filter**: This is a loot filter for Diablo II Resurrected.
+It's designed to be a simple, clean, and easy to read loot filter that highlights the most important items.
+Works on battle.net and single player.
+No frills, no config, just highlights high runes and other valuable items.
+For more information visit: https://github.com/ChrisTitusTech/d2r-loot-filter
+
+## Security
+
+- **Firewall Baselines (CTT)**: Developed to ease iptables firewall configuration, UFW provides a user friendly way to create an IPv4 or IPv6 host-based firewall.
+This command installs UFW and configures UFW based on CTT's recommended rules.
+For more information visit: https://christitus.com/linux-security-mistakes
+
+## System Setup
+
+
+### Arch Linux
+
+- **Arch Server Setup**: This command installs a minimal arch server setup under 5 minutes.
+- **Paru AUR Helper**: Paru is your standard pacman wrapping AUR helper with lots of features and minimal interaction.
+To know more about AUR helpers visit: https://wiki.archlinux.org/title/AUR_helpers
+- **Yay AUR Helper**: Yet Another Yogurt - An AUR Helper Written in Go.
+To know more about AUR helpers visit: https://wiki.archlinux.org/title/AUR_helpers
+
+### Fedora
+
+- **Configure DNF**: Optimizes DNF for parallel downloads
+- **Multimedia Codecs**: This script is designed to install multimedia codecs, and to ensure RPM Fusion repositories are installed.
+- **Nvidia Proprietary Drivers**: This script is designed to download the proprietary NVIDIA drivers in Fedora.
+- **RPM Fusion**: RPM Fusion provides software that the Fedora Project or Red Hat doesn't want to ship.
+That software is provided as precompiled RPMs for all current Fedora versions and current Red Hat Enterprise Linux or clones versions; you can use the RPM Fusion repositories with tools like yum and PackageKit.
+For more information visit: https://rpmfusion.org/
+- **Virtualization**: Enables Virtualization through dnf
+- **Btrfs Assistant, Snapper Config, grub-btrfs**: Installs Btrfs Assistant, Snapper, dnf snapper plugin and takes the first root(/) and /home snapshots. Enables snapper-timeline and snapper-cleanup services. Installs Grub-Btrfs. Notice: To perform a system recovery via grub-btrfs, perform a restore operation with Btrfs Assistant GUI after booting into the snapshot. Notice: If you used the default Fedora disk partitioning during OS installation, the /boot configured as an separate EXT4 partition. Therefore, it cannot be included in root snapshots. Backup separately.
+- **Build Prerequisites**: This script is designed to handle the installation of various software dependencies across different Linux distributions
+- **Full System Cleanup**: This script is designed to remove unnecessary packages, clean old cache files, remove temporary files, and to empty the trash.
+- **Full System Update**: This command updates your system to the latest packages available for your distro
+- **Gaming Dependencies**: This script is designed to handle the installation of gaming dependencies across different Linux distributions
+- **Global Theme**: This script is designed to handle the installation and configuration of global theming
+- **Remove Snaps**: This script is designed to remove snap
+- **TTY Fonts**: This Script will set the default TTY font to Terminus size 32 Bold
 
 ## Utilities
 
-- **Wifi Control**: Controls WiFi settings.
-- **Numlock Control**: Sets up Numlock on boot.
-- **Bluetooth Control**: Controls Bluetooth settings.
 
-### Monitor control
+### Monitor Control
 
-- **Reset Scaling**: Resets monitor scaling to native resolution.
+- **Auto Detect Displays**: This script is designed to detect and apply recommended configuration for monitors connected with your system
-- **Scale Monitor**: Scales smaller monitors to the highest resolution of a bigger monitor.
+- **Change Orientation**: This script is designed to change the orientation of monitors in your system
-- **Enable Monitor**: Enables a selected monitor.
+- **Disable Monitor**: This script is designed to disable a monitor in your system
-- **Disable Monitor**: Disables a selected monitor.
+- **Duplicate Displays**: This script is designed to duplicate display among multi-monitor setup in your system
-- **Set Brightness**: Adjusts brightness for a selected monitor.
+- **Enable Monitor**: This script is designed to enable a monitor in your system
-- **Set Resolutions**: Sets resolutions for connected monitors.
+- **Extend Displays**: This script is designed to extend display among multi-monitor setup in your system
-- **Change Orientation**: Changes the orientation of a selected monitor.
+- **Manage Arrangement**: This script is designed to arrange monitors in multi-monitor setup in your system
-- **Extend Displays**: Extends displays to the right.
+- **Reset Scaling**: This script is designed to reset scaling of a monitor in your system
-- **Duplicate Displays**: Duplicates displays.
+- **Scale Monitors**: This script is designed to change the scaling of monitors in your system
-- **Manage Arrangement**: Manages the arrangement of multiple monitors.
+- **Set Brightness**: This script is designed to change the Brightness of monitors connected to your system
-- **Set Primary Monitor**: Sets a selected monitor as the main display.
+- **Set Primary Monitor**: This script is designed to set a Primary monitor in your system
-- **Auto Detect Displays**: Sets common resolution.
+- **Set Resolution**: This script is designed to change the resolution of monitors connected to your system
 
 ### User Account Manager
 
-- **Add User**: Creates a new user account.
+- **Auto Mount Drive**: This utility is designed to help with automating the process of mounting a drive on to your system.
-- **Delete User**: Deletes an existing user account.
+- **Bluetooth Manager**: This utility is designed to manage bluetooth in your system
-- **Add to Group**: Adds a user to specified groups.
+- **Numlock on Startup**: This utility is designed to configure auto enabling of numlock on boot
-- **Remove from Group**: Removes a user from specified groups.
+- **Ollama**: This utility is designed to manage ollama in your system
-- **Change Password**: Changes the password for a user account.
+- **Service Manager**: This utility is designed to manage services in your system
+- **WiFi Manager**: This utility is designed to manage wifi in your system