From e78930ef06e7d4fc0af6916a2848fe6e448d2816 Mon Sep 17 00:00:00 2001 From: <> Date: Mon, 30 Sep 2024 22:21:49 +0000 Subject: [PATCH] Deployed 6c08422 with MkDocs version: 1.6.0 --- search/search_index.json | 2 +- sitemap.xml.gz | Bin 127 -> 127 bytes userguide/index.html | 2 +- 3 files changed, 2 insertions(+), 2 deletions(-) diff --git a/search/search_index.json b/search/search_index.json index 75c8ac57..f11b48b1 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the LinUtil Documentation!","text":""},{"location":"#running-the-latest-release-of-linutil","title":"Running the latest release of LinUtil","text":"

To get started, run the following command in your terminal:

"},{"location":"#stable-branch","title":"Stable branch","text":""},{"location":"#curl-fssl-httpschristituscomlinux-sh","title":"
curl -fsSL https://christitus.com/linux | sh\n
","text":""},{"location":"#installation","title":"Installation","text":"

LinUtil is also available as a package in various repositories:

Arch Linux LinUtil can be installed on [Arch Linux](https://archlinux.org) with three different [AUR](https://aur.archlinux.org) packages: - `linutil` - Stable release compiled from source - `linutil-bin` - Stable release pre-compiled - `linutil-git` - Compiled from the last commit (not recommended) by running:
git clone https://aur.archlinux.org/<package>.git\ncd linutil\nmakepkg -si\n
Replace `` 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 simpler:
paru -S linutil\n
Replace `paru` with your preferred helper and `linutil` with your preferred package. Cargo LinUtil can be installed via [Cargo](https://doc.rust-lang.org/cargo) with:
cargo install linutil\n
Note that crates installed using `cargo install` require manual updating with `cargo install --force` (update functionality is [included in LinUtil](https://christitustech.github.io/linutil/userguide/#applications-setup))

After you've ran the command, you should see a GUI on your screen; It will look something like this:

Info

LinUtil is updated weekly as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.

"},{"location":"KnownIssues/","title":"Known Issues","text":""},{"location":"contribute/","title":"How to Contribute?","text":"

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:

"},{"location":"contribute/#1-install-rust","title":"1. Install Rust:","text":"

Make sure you have Rust installed on your machine. You can install it by following the instructions at rust-lang.org.

"},{"location":"contribute/#2-fork-and-clone-the-repo","title":"2. Fork and Clone the repo","text":"
  1. Make a fork of the repo in GitHub
  2. Clone the fork bash git clone https://github.com/YOUR_USERNAME_HERE/linutil.git cd linutil
"},{"location":"contribute/#3-make-your-changes","title":"3. Make your changes","text":""},{"location":"contribute/#4-understand-the-existing-code","title":"4. Understand the existing code","text":""},{"location":"contribute/#5-learn-from-past-pull-requests-prs","title":"5. Learn from Past Pull Requests (PRs)","text":""},{"location":"contribute/#6-write-clean-descriptive-commit-messages","title":"6. Write Clean, Descriptive Commit Messages","text":""},{"location":"contribute/#7-keep-your-pull-requests-prs-small-and-focused","title":"7. Keep Your Pull Requests (PRs) Small and Focused","text":""},{"location":"contribute/#8-code-review-and-feedback","title":"8. Code Review and Feedback","text":""},{"location":"contribute/#9-contributing-is-more-than-just-code","title":"9. Contributing Is More Than Just Code","text":""},{"location":"contribute/#10-documentation","title":"10. Documentation","text":""},{"location":"contribute/#11-license","title":"11. License","text":"

We appreciate your contributions and look forward to collaborating with you to make Linutil better!

"},{"location":"faq/","title":"FAQ's","text":""},{"location":"faq/#how-do-i-uninstall-linutil","title":"How do I uninstall LinUtil?","text":""},{"location":"roadmap/","title":"Roadmap","text":""},{"location":"roadmap/#vision","title":"Vision","text":""},{"location":"roadmap/#goals","title":"Goals","text":""},{"location":"roadmap/#milestones","title":"Milestones","text":""},{"location":"roadmap/#q3-2024","title":"Q3 2024","text":""},{"location":"roadmap/#q4-2024","title":"Q4 2024","text":""},{"location":"roadmap/#community-feedback","title":"Community Feedback","text":""},{"location":"userguide/","title":"Walkthrough","text":""},{"location":"userguide/#system-setup","title":"System Setup","text":""},{"location":"userguide/#arch-setup","title":"Arch Setup","text":""},{"location":"userguide/#fedora-setup","title":"Fedora Setup","text":""},{"location":"userguide/#applications-setup","title":"Applications Setup","text":""},{"location":"userguide/#developer-tools","title":"Developer Tools","text":""},{"location":"userguide/#security-features","title":"Security Features","text":""},{"location":"userguide/#utilities","title":"Utilities","text":""},{"location":"userguide/#monitor-control","title":"Monitor control","text":""},{"location":"userguide/#user-account-manager","title":"User Account Manager","text":""}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the LinUtil Documentation!","text":""},{"location":"#running-the-latest-release-of-linutil","title":"Running the latest release of LinUtil","text":"

To get started, run the following command in your terminal:

"},{"location":"#stable-branch","title":"Stable branch","text":""},{"location":"#curl-fssl-httpschristituscomlinux-sh","title":"
curl -fsSL https://christitus.com/linux | sh\n
","text":""},{"location":"#installation","title":"Installation","text":"

LinUtil is also available as a package in various repositories:

Arch Linux LinUtil can be installed on [Arch Linux](https://archlinux.org) with three different [AUR](https://aur.archlinux.org) packages: - `linutil` - Stable release compiled from source - `linutil-bin` - Stable release pre-compiled - `linutil-git` - Compiled from the last commit (not recommended) by running:
git clone https://aur.archlinux.org/<package>.git\ncd linutil\nmakepkg -si\n
Replace `` 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 simpler:
paru -S linutil\n
Replace `paru` with your preferred helper and `linutil` with your preferred package. Cargo LinUtil can be installed via [Cargo](https://doc.rust-lang.org/cargo) with:
cargo install linutil\n
Note that crates installed using `cargo install` require manual updating with `cargo install --force` (update functionality is [included in LinUtil](https://christitustech.github.io/linutil/userguide/#applications-setup))

After you've ran the command, you should see a GUI on your screen; It will look something like this:

Info

LinUtil is updated weekly as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.

"},{"location":"KnownIssues/","title":"Known Issues","text":""},{"location":"contribute/","title":"How to Contribute?","text":"

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:

"},{"location":"contribute/#1-install-rust","title":"1. Install Rust:","text":"

Make sure you have Rust installed on your machine. You can install it by following the instructions at rust-lang.org.

"},{"location":"contribute/#2-fork-and-clone-the-repo","title":"2. Fork and Clone the repo","text":"
  1. Make a fork of the repo in GitHub
  2. Clone the fork bash git clone https://github.com/YOUR_USERNAME_HERE/linutil.git cd linutil
"},{"location":"contribute/#3-make-your-changes","title":"3. Make your changes","text":""},{"location":"contribute/#4-understand-the-existing-code","title":"4. Understand the existing code","text":""},{"location":"contribute/#5-learn-from-past-pull-requests-prs","title":"5. Learn from Past Pull Requests (PRs)","text":""},{"location":"contribute/#6-write-clean-descriptive-commit-messages","title":"6. Write Clean, Descriptive Commit Messages","text":""},{"location":"contribute/#7-keep-your-pull-requests-prs-small-and-focused","title":"7. Keep Your Pull Requests (PRs) Small and Focused","text":""},{"location":"contribute/#8-code-review-and-feedback","title":"8. Code Review and Feedback","text":""},{"location":"contribute/#9-contributing-is-more-than-just-code","title":"9. Contributing Is More Than Just Code","text":""},{"location":"contribute/#10-documentation","title":"10. Documentation","text":""},{"location":"contribute/#11-license","title":"11. License","text":"

We appreciate your contributions and look forward to collaborating with you to make Linutil better!

"},{"location":"faq/","title":"FAQ's","text":""},{"location":"faq/#how-do-i-uninstall-linutil","title":"How do I uninstall LinUtil?","text":""},{"location":"roadmap/","title":"Roadmap","text":""},{"location":"roadmap/#vision","title":"Vision","text":""},{"location":"roadmap/#goals","title":"Goals","text":""},{"location":"roadmap/#milestones","title":"Milestones","text":""},{"location":"roadmap/#q3-2024","title":"Q3 2024","text":""},{"location":"roadmap/#q4-2024","title":"Q4 2024","text":""},{"location":"roadmap/#community-feedback","title":"Community Feedback","text":""},{"location":"userguide/","title":"Walkthrough","text":""},{"location":"userguide/#system-setup","title":"System Setup","text":""},{"location":"userguide/#arch-setup","title":"Arch Setup","text":""},{"location":"userguide/#fedora-setup","title":"Fedora Setup","text":""},{"location":"userguide/#applications-setup","title":"Applications Setup","text":""},{"location":"userguide/#developer-tools","title":"Developer Tools","text":""},{"location":"userguide/#security-features","title":"Security Features","text":""},{"location":"userguide/#utilities","title":"Utilities","text":""},{"location":"userguide/#monitor-control","title":"Monitor control","text":""},{"location":"userguide/#user-account-manager","title":"User Account Manager","text":""}]} \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index 653acbad44fa8cece7ebe228cda2c49c9ca84f64..b36706df582b7710ac9e211449b4a906cadefeaa 100644 GIT binary patch delta 13 Ucmb=gXP58h;9z+5b0T{M03HDZvj6}9 delta 13 Ucmb=gXP58h;9!V*Kasrx02>_y9RL6T diff --git a/userguide/index.html b/userguide/index.html index 7c307cfe..7d3691f0 100644 --- a/userguide/index.html +++ b/userguide/index.html @@ -1 +1 @@ - User Guide - Chris Titus LinUtil Official Documentation
Skip to content
Announcement: This documentation is still in progress.

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.

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.

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.
  • Ngrok Setup: Installs Ngrok, a tool for creating secure tunnels to localhost.
  • Neovim Setup: Installs and configures Neovim, a Vim-based text editor.
  • VS Code Setup: Installs Visual Studio Code, a popular text editor.
  • Sublime Setup: Installs Sublime Text, a nice text editor for code and markup.
  • VS Codium Setup: Installs VS Codium, an open-source build of VS Code.
  • GitHub Desktop Setup: Installs GitHub Desktop, a GUI for Git and GitHub.

Security Features

  • Firewall Baselines: Sets up firewall rules.

Utilities

  • Wifi Control: Controls WiFi settings.
  • Numlock Control: Sets up Numlock on boot.
  • Bluetooth Control: Controls Bluetooth settings.

Monitor control

  • Reset Scaling: Resets monitor scaling to native resolution.
  • Scale Monitor: Scales smaller monitors to the highest resolution of a bigger monitor.
  • Enable Monitor: Enables a selected monitor.
  • Disable Monitor: Disables a selected monitor.
  • Set Brightness: Adjusts brightness for a selected monitor.
  • Set Resolutions: Sets resolutions for connected monitors.
  • Change Orientation: Changes the orientation of a selected monitor.
  • Extend Displays: Extends displays to the right.
  • Duplicate Displays: Duplicates displays.
  • Manage Arrangement: Manages the arrangement of multiple monitors.
  • Set Primary Monitor: Sets a selected monitor as the main display.
  • Auto Detect Displays: Sets common resolution.

User Account Manager

  • Add User: Creates a new user account.
  • Delete User: Deletes an existing user account.
  • Add to Group: Adds a user to specified groups.
  • Remove from Group: Removes a user from specified groups.
  • Change Password: Changes the password for a user account.
\ No newline at end of file + User Guide - Chris Titus LinUtil Official Documentation
Skip to content
Announcement: This documentation is still in progress.

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.

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.
  • Ngrok Setup: Installs Ngrok, a tool for creating secure tunnels to localhost.
  • Neovim Setup: Installs and configures Neovim, a Vim-based text editor.
  • VS Code Setup: Installs Visual Studio Code, a popular text editor.
  • Sublime Setup: Installs Sublime Text, a nice text editor for code and markup.
  • VS Codium Setup: Installs VS Codium, an open-source build of VS Code.
  • GitHub Desktop Setup: Installs GitHub Desktop, a GUI for Git and GitHub.

Security Features

  • Firewall Baselines: Sets up firewall rules.

Utilities

  • Wifi Control: Controls WiFi settings.
  • Numlock Control: Sets up Numlock on boot.
  • Bluetooth Control: Controls Bluetooth settings.

Monitor control

  • Reset Scaling: Resets monitor scaling to native resolution.
  • Scale Monitor: Scales smaller monitors to the highest resolution of a bigger monitor.
  • Enable Monitor: Enables a selected monitor.
  • Disable Monitor: Disables a selected monitor.
  • Set Brightness: Adjusts brightness for a selected monitor.
  • Set Resolutions: Sets resolutions for connected monitors.
  • Change Orientation: Changes the orientation of a selected monitor.
  • Extend Displays: Extends displays to the right.
  • Duplicate Displays: Duplicates displays.
  • Manage Arrangement: Manages the arrangement of multiple monitors.
  • Set Primary Monitor: Sets a selected monitor as the main display.
  • Auto Detect Displays: Sets common resolution.

User Account Manager

  • Add User: Creates a new user account.
  • Delete User: Deletes an existing user account.
  • Add to Group: Adds a user to specified groups.
  • Remove from Group: Removes a user from specified groups.
  • Change Password: Changes the password for a user account.
\ No newline at end of file