linutil/search/search_index.json

{"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":"<p>To get started, run the following command in your terminal:</p>"},{"location":"#stable-branch","title":"Stable branch","text":""},{"location":"#curl-fssl-httpschristituscomlinux-sh","title":"<pre><code>curl -fsSL https://christitus.com/linux | sh\n</code></pre>","text":""},{"location":"#installation","title":"Installation","text":"<p>LinUtil is also available as a package in various repositories:</p> <p></p> 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:  <pre><code>git clone https://aur.archlinux.org/&lt;package&gt;.git\ncd linutil\nmakepkg -si\n</code></pre>  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:  <pre><code>paru -S linutil\n</code></pre>  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:  <pre><code>cargo install linutil\n</code></pre>  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))   <p>After you've ran the command, you should see a GUI on your screen; It will look something like this:</p> <p></p> <p>Info</p> <p>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.</p>"},{"location":"KnownIssues/","title":"Known Issues","text":"<ul> <li>Known Issues</li> </ul>"},{"location":"contribute/","title":"How to Contribute?","text":"<p>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:</p>"},{"location":"contribute/#1-install-rust","title":"1. Install Rust:","text":"<p>Make sure you have Rust installed on your machine. You can install it by following the instructions at rust-lang.org.</p>"},{"location":"contribute/#2-fork-and-clone-the-repo","title":"2. Fork and Clone the repo","text":"<ol> <li>Make a fork of the repo in GitHub</li> <li>Clone the fork <code>bash git clone https://github.com/YOUR_USERNAME_HERE/linutil.git cd linutil</code></li> </ol>"},{"location":"contribute/#3-make-your-changes","title":"3. Make your changes","text":"<ul> <li>Edit the files you want to change: Make your changes to the relevant files.</li> <li>Test your changes: Run <code>cargo run</code> to test your modifications in a local environment and ensure everything works as expected.</li> </ul>"},{"location":"contribute/#4-understand-the-existing-code","title":"4. Understand the existing code","text":"<ul> <li>Have a clear reason: Don\u2019t change the way things are done without a valid reason. If you propose an alteration, be prepared to explain why it\u2019s necessary and how it improves the project.</li> <li>Respect existing conventions: Changes should align with the existing code style, design patterns, and overall project philosophy. If you want to introduce a new way of doing things, justify it clearly.</li> </ul>"},{"location":"contribute/#5-learn-from-past-pull-requests-prs","title":"5. Learn from Past Pull Requests (PRs)","text":"<ul> <li>Check merged PRs: Reviewing merged pull requests can give you an idea of what kind of contributions are accepted and how they are implemented.</li> <li>Study rejected PRs: This is especially important as it helps you avoid making similar mistakes or proposing changes that have already been considered and declined.</li> </ul>"},{"location":"contribute/#6-write-clean-descriptive-commit-messages","title":"6. Write Clean, Descriptive Commit Messages","text":"<ul> <li>Be descriptive: Your commit messages should clearly describe what the change does and why it was made.</li> <li>Use the imperative mood: For example, \"Add feature X\" or \"Fix bug in Y\", rather than \"Added feature X\" or \"Fixed bug in Y\".</li> <li>Keep commits clean: Avoid committing a change and then immediately following it with a fix for that change. Instead, amend your commit or squash it if needed.</li> </ul>"},{"location":"contribute/#7-keep-your-pull-requests-prs-small-and-focused","title":"7. Keep Your Pull Requests (PRs) Small and Focused","text":"<ul> <li>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.</li> <li>Avoid combining unrelated changes: PRs that tackle multiple unrelated issues are harder to review and might be rejected because of a single problem.</li> </ul>"},{"location":"contribute/#8-code-review-and-feedback","title":"8. Code Review and Feedback","text":"<ul> <li>Expect feedback: PRs will undergo code review. Be open to feedback and willing to make adjustments as needed.</li> <li>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.</li> </ul>"},{"location":"contribute/#9-contributing-is-more-than-just-code","title":"9. Contributing Is More Than Just Code","text":"<ul> <li>Test the tool: Running tests and providing feedback on how the tool works in different environments is a valuable contribution.</li> <li>Write well-formed issues: Clearly describe bugs or problems you encounter, providing as much detail as possible, including steps to reproduce the issue.</li> <li>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.</li> </ul>"},{"location":"contribute/#10-documentation","title":"10. Documentation","text":"<ul> <li>Update the documentation: If your change affects the functionality, please update the relevant documentation files to reflect this.</li> </ul>"},{"location":"contribute/#11-license","title":"11. License","text":"<ul> <li>Agree to the license: By contributing to Linutil, you agree that your contributions will be licensed under the project's MIT license.</li> </ul> <p>We appreciate your contributions and look forward to collaborating with you to make Linutil better!</p>"},{"location":"faq/","title":"FAQ's","text":""},{"location":"faq/#how-do-i-uninstall-linutil","title":"How do I uninstall LinUtil?","text":"<ul> <li>You do not have to uninstall LinUtil. As it is a script you run from your terminal it only loads into your RAM. This means as soon as you close LinUtil it will be deleted off your system.</li> </ul>"},{"location":"roadmap/","title":"Roadmap","text":""},{"location":"roadmap/#vision","title":"Vision","text":"<ul> <li>To simplify linux tasks for all users for all distributions; Easily, efficiently, and effortlessly.</li> </ul>"},{"location":"roadmap/#goals","title":"Goals","text":"<ul> <li> Focus on tasks that take time in Linux and automate them. (Example: Removing a user, adding a user, etc. - but mostly BASH scripts with POSIX compliance.)</li> <li> Remove Binary linutil from being tracked in git and make it a github action.</li> <li> Document every function and feature of linutil. (Preview panel description addition)</li> <li> Create a discord server for linutil and invite the community.</li> <li> Power Optimizations for Laptops</li> </ul>"},{"location":"roadmap/#milestones","title":"Milestones","text":""},{"location":"roadmap/#q3-2024","title":"Q3 2024","text":"<ul> <li> Finish the foundation of the project in CLI mode.</li> <li> DENY ALL GUI Pull Requests while CLI and foundation is being established.</li> </ul>"},{"location":"roadmap/#q4-2024","title":"Q4 2024","text":"<ul> <li> GUI Brainstorming and Planning</li> <li> GUI Implementation towards the end of Q4</li> </ul>"},{"location":"roadmap/#community-feedback","title":"Community Feedback","text":"<ul> <li>Encourage community input and suggestions for future development.</li> </ul>"},{"location":"userguide/","title":"Walkthrough","text":""},{"location":"userguide/#system-setup","title":"System Setup","text":"<ul> <li>System Update: Starts a system-wide update.</li> <li>Compile Setup: Installs tools and dependencies for compiling software.</li> <li>Gaming Setup: Configures Steam, Lutris, etc.</li> <li>Global Theming: Sets up and manages global themes.</li> <li>Remove Snaps: Removes snap packages.</li> <li>TTY Fonts: This Script will set the default TTY font to Terminus size 32 Bold</li> </ul>"},{"location":"userguide/#arch-setup","title":"Arch Setup","text":"<ul> <li>Paru Setup: Installs the Paru AUR helper.</li> <li>Yay Setup: Installs the Yay AUR helper.</li> <li>Server Setup: Installs Arch Linux.</li> </ul>"},{"location":"userguide/#fedora-setup","title":"Fedora Setup","text":"<ul> <li>RPM Fusion Setup: Adds RPM Fusion free and nonfree repositories.</li> <li>Multimedia Codecs: Installs multimedia codecs and updates multimedia-related packages. Requires RPM Fusion repositories to be set up first.</li> <li>NVIDIA Proprietary Driver Setup: Installs proprietary NVIDIA drivers for GPUs from 2014 or later.</li> <li>Virtualization Setup: Installs virtualization tools.</li> <li>Configure DNF: Optimizes DNF for better speeds.</li> </ul>"},{"location":"userguide/#applications-setup","title":"Applications Setup","text":"<ul> <li>Flathub: Installs Flatpak and Flathub.</li> <li>Alacritty Setup: Installs and configures Alacritty for you.</li> <li>DwmTitus Setup: Sets up the Dwm window manager.</li> <li>Kitty Setup: Installs and configures Kitty for you.</li> <li>Rofi Setup: Installs the Rofi application/script launcher.</li> <li>Zsh Setup: Installs and configures Zsh for you.</li> <li>Fastfetch Setup: Installs and configures Fastfetch.</li> <li>Linutil Updater: Updates the Linutil AUR / Crates.io Package.</li> <li>Linutil Installer: Installs Linutil via Crates.io or AUR.</li> <li>Office Suite Setup: Installs various office suites and PDF viewers (OnlyOffice, LibreOffice, WPS Office, FreeOffice, Evince, Okular, PDF Studio Viewer, PDF Studio).</li> </ul>"},{"location":"userguide/#developer-tools","title":"Developer Tools","text":"<ul> <li>Meld Setup: Installs Meld, a visual diff and merge tool.</li> <li>Ngrok Setup: Installs Ngrok, a tool for creating secure tunnels to localhost.</li> <li>Neovim Setup: Installs and configures Neovim, a Vim-based text editor.</li> <li>VS Code Setup: Installs Visual Studio Code, a popular text editor.</li> <li>Sublime Setup: Installs Sublime Text, a nice text editor for code and markup.</li> <li>VS Codium Setup: Installs VS Codium, an open-source build of VS Code.</li> <li>GitHub Desktop Setup: Installs GitHub Desktop, a GUI for Git and GitHub.</li> </ul>"},{"location":"userguide/#security-features","title":"Security Features","text":"<ul> <li>Firewall Baselines: Sets up firewall rules.</li> </ul>"},{"location":"userguide/#utilities","title":"Utilities","text":"<ul> <li>Wifi Control: Controls WiFi settings.</li> <li>Numlock Control: Sets up Numlock on boot.</li> <li>Bluetooth Control: Controls Bluetooth settings.</li> </ul>"},{"location":"userguide/#monitor-control","title":"Monitor control","text":"<ul> <li>Reset Scaling: Resets monitor scaling to native resolution.</li> <li>Scale Monitor: Scales smaller monitors to the highest resolution of a bigger monitor.</li> <li>Enable Monitor: Enables a selected monitor.</li> <li>Disable Monitor: Disables a selected monitor.</li> <li>Set Brightness: Adjusts brightness for a selected monitor.</li> <li>Set Resolutions: Sets resolutions for connected monitors.</li> <li>Change Orientation: Changes the orientation of a selected monitor.</li> <li>Extend Displays: Extends displays to the right.</li> <li>Duplicate Displays: Duplicates displays.</li> <li>Manage Arrangement: Manages the arrangement of multiple monitors.</li> <li>Set Primary Monitor: Sets a selected monitor as the main display.</li> <li>Auto Detect Displays: Sets common resolution.</li> </ul>"},{"location":"userguide/#user-account-manager","title":"User Account Manager","text":"<ul> <li>Add User: Creates a new user account.</li> <li>Delete User: Deletes an existing user account.</li> <li>Add to Group: Adds a user to specified groups.</li> <li>Remove from Group: Removes a user from specified groups.</li> <li>Change Password: Changes the password for a user account.</li> </ul>"}]}