From 5b844dfb2d253c364b518b41a586b7f12a6d5f7f Mon Sep 17 00:00:00 2001 From: David Harder Date: Thu, 26 Oct 2023 11:56:31 -0500 Subject: [PATCH] Run prettier on everything (#422) --- .../advanced-config/eopkg-configuration.md | 10 +-- docs/packaging/creating-a-new-package.md | 2 +- docs/packaging/index.md | 8 +- docs/packaging/packaging-practices.md | 3 + docs/packaging/prepare-for-packaging.md | 14 +-- docs/packaging/procedures/maintainership.md | 2 +- .../procedures/request-a-package-update.md | 2 +- docs/packaging/submitting-a-pull-request.md | 2 +- docs/packaging/testing-a-package.md | 2 +- docs/packaging/your-first-package-update.md | 1 + docs/user/contributing/testing-an-iso.md | 4 +- docs/user/editions/plasma/configuration.md | 89 ++++++++++++------- docs/user/editions/plasma/index.md | 2 +- docs/user/editions/plasma/tips-and-tricks.md | 57 ++++++------ docs/user/hardware/compatibility/wifi.md | 1 - docs/user/hardware/index.md | 22 ++--- docs/user/intro.md | 1 - docs/user/privacy.md | 10 +-- docs/user/quick-start/default-applications.md | 2 - docs/user/software/configuration_files.md | 31 ++++--- docs/user/software/development/containers.md | 2 +- docs/user/software/development/index.md | 2 +- docs/user/software/development/web.md | 13 +-- docs/user/troubleshooting/boot-rescue.md | 9 +- 24 files changed, 160 insertions(+), 131 deletions(-) diff --git a/docs/packaging/advanced-config/eopkg-configuration.md b/docs/packaging/advanced-config/eopkg-configuration.md index 95525caf1..e2aa91b58 100644 --- a/docs/packaging/advanced-config/eopkg-configuration.md +++ b/docs/packaging/advanced-config/eopkg-configuration.md @@ -21,11 +21,11 @@ Once the file has been copied, you can edit it with your text editor of choice. Most keys in the config you'll probably want to leave untouched. However, some are useful to know about: -| Key | Description | Values | -| -------------------------------------------------------------------------------- | ------------- | -| generateDebug | Whether or not debug symbol subpackages will be generated | True / False | -| jobs | How many building jobs to use when compiling the source | auto / number | -| retry_attempts | How many times to retry downloading a package during install | number | +| Key | Description | Values | +| -------------- | ------------------------------------------------------------ | ------------- | +| generateDebug | Whether or not debug symbol subpackages will be generated | True / False | +| jobs | How many building jobs to use when compiling the source | auto / number | +| retry_attempts | How many times to retry downloading a package during install | number | ## Restoring defaults diff --git a/docs/packaging/creating-a-new-package.md b/docs/packaging/creating-a-new-package.md index be76d6312..6a20f7908 100644 --- a/docs/packaging/creating-a-new-package.md +++ b/docs/packaging/creating-a-new-package.md @@ -10,7 +10,7 @@ This page will take you through the steps required to build a new package for th :::note -**Please [look to see if an issue has been filed](https://github.com/getsolus/packages/issues?q=label%3A%22Package+Request%22) and *accepted* for the software or library you intend to package**. If there is an existing request, please add a link to it in your pull request. Ex: +**Please [look to see if an issue has been filed](https://github.com/getsolus/packages/issues?q=label%3A%22Package+Request%22) and _accepted_ for the software or library you intend to package**. If there is an existing request, please add a link to it in your pull request. Ex: ``` This PR resolves software request https://github.com/getsolus/packages/issues/123 diff --git a/docs/packaging/index.md b/docs/packaging/index.md index 3e0484dd9..28907244d 100644 --- a/docs/packaging/index.md +++ b/docs/packaging/index.md @@ -25,7 +25,9 @@ Please check the following: 1. [Update your development environment](update-dev-environment.md) 2. Prepare the package directory and build the package - * For a new package that does not yet exist in the repos see [Creating a New Package](creating-a-new-package.md) - * For updating a package that already is in the repos see [Updating an Existing Package](updating-an-existing-package.md) + +- For a new package that does not yet exist in the repos see [Creating a New Package](creating-a-new-package.md) +- For updating a package that already is in the repos see [Updating an Existing Package](updating-an-existing-package.md) + 3. [Test the Package](testing-a-package.md) -4. [Submit a Pull Request for Review](submitting-a-pull-request.md) \ No newline at end of file +4. [Submit a Pull Request for Review](submitting-a-pull-request.md) diff --git a/docs/packaging/packaging-practices.md b/docs/packaging/packaging-practices.md index 157ca36b6..c8bfc3d43 100644 --- a/docs/packaging/packaging-practices.md +++ b/docs/packaging/packaging-practices.md @@ -94,10 +94,12 @@ All new packages or updates to packages should abide by the [SPDX 3.x](https://s :::note Build dependencies should be ordered according to the following rules in `package.yml`: + 1. `pkgconfig` dependencies before explicitly named dependencies 2. Each of these two groups in so-called ASCIIbetical order (that is, alphabetical order with all uppercase letters before lowercase letters, and digits/punctuation before letters, [see here](https://en.wikipedia.org/wiki/ASCII#Character_order)) Example: + ```yaml builddeps : @@ -113,6 +115,7 @@ builddeps : - python-poetry - swig ``` + ::: ### Background diff --git a/docs/packaging/prepare-for-packaging.md b/docs/packaging/prepare-for-packaging.md index 7eeee55cc..1f6c97ef7 100644 --- a/docs/packaging/prepare-for-packaging.md +++ b/docs/packaging/prepare-for-packaging.md @@ -128,13 +128,13 @@ ln -s ~/solus-packages/common/Scripts/helpers.zsh ~/.zshrc.d/solus-monorepo-help You should now have the following available from your shell: -| Function | Description | Usage | -| ----------------- | -------------------------------------------------------------------------------------------------- | ---------- | -| **gotosoluspkgs** | Change directory to the solus monorepo from anywhere on the filesystem. | `gotosoluspkgs` -| **goroot** | When in the solus monorepo, change directory to the root directory of the git repository. | `goroot` -| **gotopkg** | Change directory to any solus package. You can type part of the package name then double press `Tab` to get autocompletion for this function. | `gotopkg firefox` -| **whatuses** | Find out what packages use a library by reading the `abi_used_libs` files. | `whatuses libfoobar.so.1` -| **whatprovides** | Find out what package provides a library by reading the `abi_libs` files. | `whatprovides libfoobar.so.1.` +| Function | Description | Usage | +| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | +| **gotosoluspkgs** | Change directory to the solus monorepo from anywhere on the filesystem. | `gotosoluspkgs` | +| **goroot** | When in the solus monorepo, change directory to the root directory of the git repository. | `goroot` | +| **gotopkg** | Change directory to any solus package. You can type part of the package name then double press `Tab` to get autocompletion for this function. | `gotopkg firefox` | +| **whatuses** | Find out what packages use a library by reading the `abi_used_libs` files. | `whatuses libfoobar.so.1` | +| **whatprovides** | Find out what package provides a library by reading the `abi_libs` files. | `whatprovides libfoobar.so.1.` | ## Building Packages diff --git a/docs/packaging/procedures/maintainership.md b/docs/packaging/procedures/maintainership.md index 371e9651f..b860be6b4 100644 --- a/docs/packaging/procedures/maintainership.md +++ b/docs/packaging/procedures/maintainership.md @@ -47,4 +47,4 @@ This file is used to indicate primary maintainership for this package. A package - Name Surname - Matrix: REPLACEME - Email: REPLACEME -``` \ No newline at end of file +``` diff --git a/docs/packaging/procedures/request-a-package-update.md b/docs/packaging/procedures/request-a-package-update.md index 2c6eb54ec..197be1f4f 100644 --- a/docs/packaging/procedures/request-a-package-update.md +++ b/docs/packaging/procedures/request-a-package-update.md @@ -17,4 +17,4 @@ You will be asked in the form to provide the following information: - Description: Explanation as to the value-add of updating this package. - Link to source tarball/zip file. Note: master.zip files **are not permitted**. We require versioned tarballs, for example: "1.2.3.tar.gz". -Please put this into a new [issue](https://github.com/getsolus/packages/issues/new?assignees=&labels=Package+Request&projects=&template=request-package-update.yaml). \ No newline at end of file +Please put this into a new [issue](https://github.com/getsolus/packages/issues/new?assignees=&labels=Package+Request&projects=&template=request-package-update.yaml). diff --git a/docs/packaging/submitting-a-pull-request.md b/docs/packaging/submitting-a-pull-request.md index ef800e271..e81952561 100644 --- a/docs/packaging/submitting-a-pull-request.md +++ b/docs/packaging/submitting-a-pull-request.md @@ -10,7 +10,7 @@ Please refrain from submitting a pull request for the following instances: - For a package that is yet to be accepted for inclusion by a member of the Solus Staff team. Search [open package requests](https://github.com/getsolus/packages/issues?q=label%3A%22Package+Request%22) to see if there is an open request for the package. We welcome you to politely reach out via the package request issue or our Support room on [Matrix](/docs/user/contributing/getting-involved#matrix-chat) if you deem the review of the request to be time-sensitive in nature. -- If your pull request is a Work In Progress / WIP. Pull requests that are completed or are marked as *request for comments* (RFC) are accepted. For RFC request please ensure your patch title contains `[RFC]` and is marked as 'draft'. WIP patches clutter the issue tracker and make patch review by Solus Staff more time consuming and introduces unnecessary work. +- If your pull request is a Work In Progress / WIP. Pull requests that are completed or are marked as _request for comments_ (RFC) are accepted. For RFC request please ensure your patch title contains `[RFC]` and is marked as 'draft'. WIP patches clutter the issue tracker and make patch review by Solus Staff more time consuming and introduces unnecessary work. ## Final Branch Review diff --git a/docs/packaging/testing-a-package.md b/docs/packaging/testing-a-package.md index 444403290..5417009ee 100644 --- a/docs/packaging/testing-a-package.md +++ b/docs/packaging/testing-a-package.md @@ -11,6 +11,7 @@ After building a package, it must be tested against the unstable repo before a p You will use the .eopkg file(s) created by the build process for testing. ## Install the `.eopkg` Files + To install your new package, run the following command in the directory where you built the package. Include **all** `.eopkg` files that were built. ```bash @@ -38,4 +39,3 @@ To remove these files, run: ```bash go-task clean ``` - diff --git a/docs/packaging/your-first-package-update.md b/docs/packaging/your-first-package-update.md index 1a5753fe9..4d814a425 100644 --- a/docs/packaging/your-first-package-update.md +++ b/docs/packaging/your-first-package-update.md @@ -22,6 +22,7 @@ Switch to the directory containing the `nano` recipe: ```bash cd packages/n/nano ``` + Alternatively, if you've set up the [Monorepo Helper Functions](docs/packaging/prepare-for-packaging#set-up-monorepo-helper-functions-optional) you can replace the above to steps by these simple commands: ```bash diff --git a/docs/user/contributing/testing-an-iso.md b/docs/user/contributing/testing-an-iso.md index a8237d7c5..4e9444364 100644 --- a/docs/user/contributing/testing-an-iso.md +++ b/docs/user/contributing/testing-an-iso.md @@ -29,8 +29,8 @@ When testing, try to keep different types of users in mind. For instance, would This functionality might be affected by the settings of the VM. -- Copy and paste works from host to guest *before* install, while booted into the live ISO -- Copy and paste works *after* installation and rebooting the VM +- Copy and paste works from host to guest _before_ install, while booted into the live ISO +- Copy and paste works _after_ installation and rebooting the VM ## For the specific release diff --git a/docs/user/editions/plasma/configuration.md b/docs/user/editions/plasma/configuration.md index d8bcf8c42..9a6cd03bb 100644 --- a/docs/user/editions/plasma/configuration.md +++ b/docs/user/editions/plasma/configuration.md @@ -6,44 +6,51 @@ summary: Learn how to customize and configure the Plasma Desktop on Solus. # Configuration ## Opening System Settings + You can open the system settings in Solus Plasma using any of the following methods: -| Method | Description | -|------------------|------------------------------------------------------------------------| -| Application menu | Open the application menu and go to **Settings** > **System Settings** | -| KRunner | Press `Alt + F2` or `Alt + Space`, type `systemsettings`, and press Enter | -| Terminal | Open a terminal window and execute `systemsettings` | +| Method | Description | +| ---------------- | ------------------------------------------------------------------------- | +| Application menu | Open the application menu and go to **Settings** > **System Settings** | +| KRunner | Press `Alt + F2` or `Alt + Space`, type `systemsettings`, and press Enter | +| Terminal | Open a terminal window and execute `systemsettings` | ## Date and Time + 1. In the [**System Settings**](#opening-system-settings) screen, go to **Personalization** > **Regional Settings** > **Date and Time**. 2. Configure the date and time of your system. - If you want Solus to set the date and time automatically, select **Set date and time automatically**. - If you want to set the date and time manually, clear the **Set date and time automatically** checkbox, then use the available controls. - ![Plasma date and time settings](configuration/date-time.png) -1. (Optional) Configure the time zone of your system. + ![Plasma date and time settings](configuration/date-time.png) +3. (Optional) Configure the time zone of your system. 1. Go to the **Time Zone** tab. 2. Select a time zone from the list. -2. Click **Apply**. -3. (Optional) Customize how the time and date display in the bottom panel. +4. Click **Apply**. +5. (Optional) Customize how the time and date display in the bottom panel. 1. Right-click the digital clock widget on the bottom panel. 2. Select **Configure Digital Clock...** 3. Configure the available settings as needed. ## Default Applications + ### Configuring Default Applications from System Settings + In the [**System Settings**](#opening-system-settings) screen, go to **Personalization** > **Applications** > **Default Applications**, then use the menus to select your preferred default applications. ![Default applications](configuration/default-apps-screen.png) ### Configuring Default Applications from the File Manager + 1. Open Dolphin. 2. Navigate to the folder that contains the file you want to open. 3. Right-click the file. - ![Context menu](configuration/file-context-menu-default-app.png) + ![Context menu](configuration/file-context-menu-default-app.png) + 4. Go to **Open With** > **Other Application**. - The **Choose Application** dialog appears. + The **Choose Application** dialog appears. + 5. Choose the application you want to use from the list. 6. Select **Remember application association for all files of type [file type]**. 7. Click **OK**. @@ -62,10 +69,10 @@ Press `Super + P` to access the screen layout settings. 2. Select the display you want to configure. 3. Configure the available settings as needed. ![Screen settings available in Solus Plasma](configuration/screen-configuration.png) -4. Click **Apply**. - +4. Click **Apply**. ## Keyboard Layout + ### Configuring Keyboard Layouts :::caution Important @@ -75,20 +82,22 @@ If you need to input languages that do not use Latin characters (for example, Ch ::: 1. In the [**System Settings**](#opening-system-settings) screen, go to **Input Devices** > **Keyboard** > **Layouts**. - + The layouts screen appears. ![Keyboard layouts](configuration/keyboard-layouts.png) + 2. Select **Configure layouts**. 3. Configure keyboard layouts as you need. - To add a keyboard layout click **Add**, select a layout from the list, and click **OK**. - To remove a keyboard layout select a layout from the list and click **Remove**. - To order the list of keyboard layouts, select a layout from the list, then use the **Move Up** and **Move Down** buttons to reorder the list. 4. Configure a keyboard shortcut to switch between layouts by using the options under **Shortcuts for Switching Layout**. - - To use the default shortcuts Solus Plasma provides, use the **Main shortcuts** and **3rd level shortcuts** options. - - To use a custom shortcut, use the **Alternative shortcut** option. -5. Click **Apply**. + - To use the default shortcuts Solus Plasma provides, use the **Main shortcuts** and **3rd level shortcuts** options. + - To use a custom shortcut, use the **Alternative shortcut** option. +5. Click **Apply**. ### Using IBus + Solus Plasma includes IBus installed by default. However, you need to enable and integrate IBus with Plasma before usage. :::caution Important @@ -99,11 +108,13 @@ Using IBus overrides the configuration in the **Layouts** section of **System Se 1. Open the `/home/[username]/.bashrc` file with a text editor. 2. Add the following lines at the end of the file. + ``` export GTK_IM_MODULE=ibus export QT_IM_MODULE=ibus export XMODIFIERS=@im=ibus ``` + 3. Save the file. 4. Configure IBus to autostart. 1. In the [**System Settings**](#opening-system-settings) screen, go to **Workspace** > **Startup and Shutdown** > **Autostart**. @@ -113,7 +124,7 @@ export XMODIFIERS=@im=ibus 6. Configure keyboard layouts as you need. 1. Open **IBus Preferences** from the application launcher. 2. In the **Input Method** tab, add the keyboard layout you need. - + :::caution Important Some keyboard layouts require [installing additional packages](../../software/localization/ibus.md). @@ -121,20 +132,23 @@ Some keyboard layouts require [installing additional packages](../../software/lo ::: ## Mouse and Touchpad + 1. In the [**System Settings**](#opening-system-settings) screen, go to the appropriate configuration screen: - To configure the mouse, go to **Input Devices** > **Mouse**. - ![Mouse settings](configuration/mouse-settings.png) - - To configure the touchpad, go to **Input Devices** > **Touchpad**. - ![Touchpad settings](configuration/touchpad-settings.png) + ![Mouse settings](configuration/mouse-settings.png) + - To configure the touchpad, go to **Input Devices** > **Touchpad**. + ![Touchpad settings](configuration/touchpad-settings.png) 2. Configure the available settings as needed. 3. Click **Apply**. ## Network Settings + The **Networks** widget on the bottom panel allows you to perform frequent networking tasks, such as connecting to a Wi-Fi network or enabling airplane mode. ![Networks widget](configuration/networks-widget.png) ### Connecting to a Hidden Wi-Fi Network + 1. In the **System Settings** screen, go to **Network** > **Connections**. 2. Click the **Add new connection** icon (+). 3. Select **Wi-Fi**. @@ -142,6 +156,7 @@ The **Networks** widget on the bottom panel allows you to perform frequent netwo The **New Connection** window appears. ![New connection settings](configuration/new-wifi-network.png) + 5. In the **Wi-Fi** tab, specify the name (SSID) and basic network settings. 6. In the **Wi-Fi Security** tab, configure the password or other authentication settings. 7. Use the **IPv4**, **IPv6** and **General configuration** tabs to configure additional settings, such as DNS servers. @@ -154,7 +169,7 @@ The **Networks** widget on the bottom panel allows you to perform frequent netwo The **Audio Volume** widget on the bottom panel allows you to perform the following tasks: | Task | Description | -|--------------------------------------|---------------------------------------------------------------------------------------------------------| +| ------------------------------------ | ------------------------------------------------------------------------------------------------------- | | Select the active output device | Select any of the available output devices to change the active output device of your system. | | Select the active input device | Select any of the available input devices to change the active input device of your system. | | Control the volume of a device | Use the sliders to adjust the master volume of an input/output device. | @@ -164,17 +179,21 @@ The **Audio Volume** widget on the bottom panel allows you to perform the follow ## Users ### Adding User Accounts + 1. In the [**System Settings**](#opening-system-settings) screen, go to **Personalization** > **Users**. 2. Click **Add New User**. 3. Configure the necessary settings. ![Add user account](configuration/add-user-account.png) + 4. Click **Create** The **Authentication Required** window appears. -5. Specify your user password and click **OK**. + +5. Specify your user password and click **OK**. ### Removing User Accounts + 1. In the [**System Settings**](#opening-system-settings) screen, go to **Personalization** > **Users**. 2. Select an account from the user list. 3. Click **Delete User**. @@ -183,7 +202,9 @@ The **Audio Volume** widget on the bottom panel allows you to perform the follow ![Keep or delete user files](configuration/keep-delete-files.png) # User Interface + ## Customizing the Desktop + The **Desktop Settings** screen allows you to customize various aspects of your desktop, such as the wallpaper and the desktop icons. To open **Desktop Settings** screen, right-click anywhere on the desktop and select **Configure Desktop and Wallpaper...**. ![Desktop context menu](configuration/desktop-context-menu.png) @@ -191,7 +212,7 @@ The **Desktop Settings** screen allows you to customize various aspects of your The following table describes how to customize the desktop using the **Desktop Folder Settings** screen. | Section | Description | -|--------------------------------------------|--------------------------------------------------------------------------------------| +| ------------------------------------------ | ------------------------------------------------------------------------------------ | | Change the wallpaper | Go to the **Wallpaper** section, choose an image from the list, and click **OK**. | | Hide the desktop icons | Go to the **Wallpaper** section, change **Layout** to **Desktop**, and click **OK**. | | Configure mouse gestures | Go to the **Mouse Actions** section to setup mouse gestures. | @@ -206,7 +227,8 @@ The following table describes how to customize the desktop using the **Desktop F ::: ## Virtual Desktops -Plasma allows you to have multiple desktops on your computer. + +Plasma allows you to have multiple desktops on your computer. Virtual desktops are helpful to keep tasks organized and avoid clutter. For example, you could have one virtual desktop for work, one for school, and one for personal use. @@ -219,6 +241,7 @@ Solus Plasma has one virtual desktop and one row by default. ::: ### Creating Virtual Desktops + 1. In the [**System Settings**](#opening-system-settings) screen, go to **Workspace** > **Workspace Behavior** > **Virtual Desktops**. 2. Define the number of rows in the grid. 3. Create a new virtual desktop. @@ -226,11 +249,12 @@ Solus Plasma has one virtual desktop and one row by default. 2. (Optional) Click the **Rename** button to change the name of the virtual desktop. 4. Repeat the previous step to add multiple virtual desktops. - :::caution + :::caution Plasma arranges the desktops by the rows automatically. ::: + 5. (Optional) Configure the behavior of the virtual desktops. - **Navigation wraps around**: Lets you cycle through your virtual desktops in a loop using keyboard shortcuts or mouse gestures. - **Show animation when switching**: Displays animations when switching between virtual desktops. @@ -246,13 +270,14 @@ Plasma displays the virtual desktop grid next to the application launcher button ::: ### Switching Between Virtual Desktops + The following table outlines the methods to change between desktops in Solus Plasma. -|Method |Description | -|-------------------------------------|-------------------------------------------------------------------------------------------------------------------| -|Using the applet in the bottom panel |Use the the virtual desktop grid next to the application launcher button to change between your virtual desktops. | -|Using mouse gestures |Move the mouse pointer anywhere in the desktop, then move the mouse wheel to change between your virtual desktops. | -|Using keyboard shortcuts |Open System Settings, go to **Workspace** > **Shortcuts** > **KWin**, then search for `desktop` to see the available keyboard shortcuts to switch between virtual desktops | +| Method | Description | +| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Using the applet in the bottom panel | Use the the virtual desktop grid next to the application launcher button to change between your virtual desktops. | +| Using mouse gestures | Move the mouse pointer anywhere in the desktop, then move the mouse wheel to change between your virtual desktops. | +| Using keyboard shortcuts | Open System Settings, go to **Workspace** > **Shortcuts** > **KWin**, then search for `desktop` to see the available keyboard shortcuts to switch between virtual desktops | ![Keyboard shortcuts to switch between desktops](configuration/switch-desktop-shortcut-list.png) @@ -260,4 +285,4 @@ The following table outlines the methods to change between desktops in Solus Pla Some of the keyboard shortcuts are disabled by default. -::: \ No newline at end of file +::: diff --git a/docs/user/editions/plasma/index.md b/docs/user/editions/plasma/index.md index 806a53725..48314b2bf 100644 --- a/docs/user/editions/plasma/index.md +++ b/docs/user/editions/plasma/index.md @@ -15,7 +15,7 @@ To learn more about the Plasma desktop and KDE, refer to the following pages: - [https://kde.org/announcements/](https://kde.org/announcements/) - [https://kde.org/support/](https://kde.org/support/) -*** +--- [Configuration](configuration) diff --git a/docs/user/editions/plasma/tips-and-tricks.md b/docs/user/editions/plasma/tips-and-tricks.md index d14fa4090..ca52d854b 100644 --- a/docs/user/editions/plasma/tips-and-tricks.md +++ b/docs/user/editions/plasma/tips-and-tricks.md @@ -16,7 +16,7 @@ To see the complete list of keyboard shortcuts available on your system, open th The following table shows some of the keyboard shortcuts available in Solus Plasma. | Keyboard Shortcut | Action | -| ----------------------------| ---------------------------------------------------------------------- | +| --------------------------- | ---------------------------------------------------------------------- | | `Alt` + `F2` | Opens KRunner | | `Alt` + `Space` | Opens KRunner | | `Alt` + `F4` | Closes the active window on the desktop | @@ -30,6 +30,7 @@ The following table shows some of the keyboard shortcuts available in Solus Plas | `Super` + `Shift` + `Print` | Captures a rectangular region of the screen | ## Using KRunner + KRunner is a system-wide desktop search and launcher app available on Solus Plasma. KRunner allows you to perform a variety of actions such as launching apps, executing commands, search files and open open system settings. Open KRunner by pressing `Alt` + `F2` or `Alt` + `Space`. @@ -38,18 +39,18 @@ Open KRunner by pressing `Alt` + `F2` or `Alt` + `Space`. The following table outlines the actions you can perform using KRunner. -|Action |Description | -|------------------------------------------------|-------------------------------------------------------------------------------------------------| -|Open an application |Enter the name of the application, then select the application from the list. | -|Run a command |Enter the command you want to run and press `Enter`. | -|See the man pages of a command |Add `#` before a command name and press enter (Example, `#wget`). | -|Terminate a program |Enter `kill [application name]` and press `Enter` (Example: `kill firefox`) | -|Do math operations |Enter `=` followed by the calculation you want to perform (Examples: `=2*2`, `=5!`, `=sin(20)`). | -|Unit conversions |Enter `[measurement] to [destination unit]` (Examples: `200 mi to km`). | -|Currency conversions |Enter `[amount] to [destination currency]`. You can use the ISO code or the name of the currencies to do the conversion (Examples: `200 CAD to NOK`, `50 koruna to yen`).| -|Check the time of other countries or time zones |Enter `time [country]` or `time [time zone]` (Examples: `time finland`, `time gmt-1`). | -|Open files and folders |Enter the name of a file or folder, then select an entry from the list. | -|Switch between windows |Enter the name of an open window and select an entry from the **Windows** list. | +| Action | Description | +| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Open an application | Enter the name of the application, then select the application from the list. | +| Run a command | Enter the command you want to run and press `Enter`. | +| See the man pages of a command | Add `#` before a command name and press enter (Example, `#wget`). | +| Terminate a program | Enter `kill [application name]` and press `Enter` (Example: `kill firefox`) | +| Do math operations | Enter `=` followed by the calculation you want to perform (Examples: `=2*2`, `=5!`, `=sin(20)`). | +| Unit conversions | Enter `[measurement] to [destination unit]` (Examples: `200 mi to km`). | +| Currency conversions | Enter `[amount] to [destination currency]`. You can use the ISO code or the name of the currencies to do the conversion (Examples: `200 CAD to NOK`, `50 koruna to yen`). | +| Check the time of other countries or time zones | Enter `time [country]` or `time [time zone]` (Examples: `time finland`, `time gmt-1`). | +| Open files and folders | Enter the name of a file or folder, then select an entry from the list. | +| Switch between windows | Enter the name of an open window and select an entry from the **Windows** list. | :::info @@ -64,15 +65,15 @@ Dolphin is the file manager included by default in Solus Plasma. Dolphin has mul The following table describes some of the keyboard shortcuts you can use in Dolphin. -|Action |Description | -|-----------------------------------------------|--------------------------------------------------------------------------------------| -|Create a new folder |Press `F10` to create a new folder. | -|Enabling dual-pane mode |Press `F3` to enable dual-pane mode. | -|Open multiple tabs |Press `Ctrl` + `T` to open multiple Dolphin tabs. | -|Open a terminal window in the current location |Press `Alt` + `Shift` + `F4` to open a terminal window in the location you have open. | -|Show/hide hidden files |Press `Ctrl` + `H` to show/hide hidden files. | -|Show/hide the side panel |Press `F9` to show/hide the **Places** side panel. | -|Switch between the view modes |Press `Ctrl` + `1` to display icons in _icons_ view, press `Ctrl` + `2` to display icons in _compact_ view, or press `Ctrl` + `3` to display icons in _details_ view; | +| Action | Description | +| ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Create a new folder | Press `F10` to create a new folder. | +| Enabling dual-pane mode | Press `F3` to enable dual-pane mode. | +| Open multiple tabs | Press `Ctrl` + `T` to open multiple Dolphin tabs. | +| Open a terminal window in the current location | Press `Alt` + `Shift` + `F4` to open a terminal window in the location you have open. | +| Show/hide hidden files | Press `Ctrl` + `H` to show/hide hidden files. | +| Show/hide the side panel | Press `F9` to show/hide the **Places** side panel. | +| Switch between the view modes | Press `Ctrl` + `1` to display icons in _icons_ view, press `Ctrl` + `2` to display icons in _compact_ view, or press `Ctrl` + `3` to display icons in _details_ view; | ## Context Menu @@ -80,9 +81,9 @@ The _Plasma_ desktop provides a variety of context menus. Context menus display The following table describes some of the context menus available in Plasma. -|Context menu |Description | -|----------------------|-----------------------------------------------------------------------------------------| -|Bottom panel settings |Right-click on an empty space of the bottom panel to open the bottom panel context menu. | -|Widget settings |Right-click on any widget in the bottom panel to open the widget context menu. | -|Desktop settings |Right-click anywhere on the desktop to open the desktop context menu. | -|File |Right-click a file to open the file context menu. | +| Context menu | Description | +| --------------------- | ---------------------------------------------------------------------------------------- | +| Bottom panel settings | Right-click on an empty space of the bottom panel to open the bottom panel context menu. | +| Widget settings | Right-click on any widget in the bottom panel to open the widget context menu. | +| Desktop settings | Right-click anywhere on the desktop to open the desktop context menu. | +| File | Right-click a file to open the file context menu. | diff --git a/docs/user/hardware/compatibility/wifi.md b/docs/user/hardware/compatibility/wifi.md index 7b5d0ff5b..1ea9de1d8 100644 --- a/docs/user/hardware/compatibility/wifi.md +++ b/docs/user/hardware/compatibility/wifi.md @@ -57,7 +57,6 @@ This list should not suggest that _only_- such devices listed below are compatib - Ralink RT5390 - Ralink RT3070 - ## Realtek - Realtek RTL8101E/RTL8102E diff --git a/docs/user/hardware/index.md b/docs/user/hardware/index.md index d69d8e0e7..3b63d4ac2 100755 --- a/docs/user/hardware/index.md +++ b/docs/user/hardware/index.md @@ -54,14 +54,14 @@ If there are proprietary drivers that can be installed, they will show up in the ### Supported Drivers -| Vendor | Drivers | -| ----------- | --------------------------- | -| Asus | piper | -| Broadcom | broadcom-sta | -| Logitech | piper | -| Nvidia | 470, Main Series | -| Razer | openrazer | -| Roccat | piper | -| SteelSeries | piper | -| VMWare | open-vm-tools | -| XBox | xone | +| Vendor | Drivers | +| ----------- | ---------------- | +| Asus | piper | +| Broadcom | broadcom-sta | +| Logitech | piper | +| Nvidia | 470, Main Series | +| Razer | openrazer | +| Roccat | piper | +| SteelSeries | piper | +| VMWare | open-vm-tools | +| XBox | xone | diff --git a/docs/user/intro.md b/docs/user/intro.md index 0784a80d8..18776b0e8 100644 --- a/docs/user/intro.md +++ b/docs/user/intro.md @@ -28,7 +28,6 @@ For the most part, Solus will work with the majority of hardware out-of-the-box. We believe that Solus is for everyone. Each installation comes with a sane set of default applications for the majority of people, but everyone uses Solus for their own reasons. This section is intended to help you install other software to better suit your needs. - **[Contributing](/docs/category/contributing)** Solus is not a commercial project. It is built and maintained by volunteers who use Solus every day and have a passion for making it better. Whatever your skill-level or knowledge about Linux and Solus, this section will show you how to contribute to Solus. diff --git a/docs/user/privacy.md b/docs/user/privacy.md index fb329261f..53a17e021 100644 --- a/docs/user/privacy.md +++ b/docs/user/privacy.md @@ -11,9 +11,9 @@ - You may view the forum without providing personal data - Cookies are used to store login information - We collect personal information when you register for an account: - - *Username* and (optional) *password* for account identification and authorization. - - *Email address* for account recovery and notifications. - - (optional) *Third party login information* to allow signing in using an SSO provider like *GitHub*. + - _Username_ and (optional) _password_ for account identification and authorization. + - _Email address_ for account recovery and notifications. + - (optional) _Third party login information_ to allow signing in using an SSO provider like _GitHub_. - This information will be retained and processed to authenticate logins. The information will be retained until you delete your account. ### Third Party Hosts @@ -34,8 +34,7 @@ Solus cannot control how data is collected and processed on the third party host #### Matrix - The Solus matrix rooms are hosted by the Matrix.org homeserver -- [Matrix.org Homeserver Privacy Notice](https://matrix.org/legal/privacy-notice) - +- [Matrix.org Homeserver Privacy Notice](https://matrix.org/legal/privacy-notice) ## Your rights under the GDPR @@ -44,4 +43,3 @@ If you are covered by the [GDPR](https://gdpr.eu/) you have rights as a data sub ## Privacy Contact Any concerns or requests about personal data should be sent to [privacy@getsol.us](mailto:privacy@getsol.us) - diff --git a/docs/user/quick-start/default-applications.md b/docs/user/quick-start/default-applications.md index 0cb27acdc..48f5ffba5 100644 --- a/docs/user/quick-start/default-applications.md +++ b/docs/user/quick-start/default-applications.md @@ -46,7 +46,6 @@ Each Linux desktop environment has its own graphical application for managing fi ![Dolphin Screenshot](default-applications/dolphin.jpg) - # Office Suite Solus comes pre-installed with [LibreOffice](https://libreoffice.org), an office suite that is capable of replacing MicrosoftTM Office for the most common tasks. @@ -142,4 +141,3 @@ Finnish language support is provided by installing `libreoffice-voikko`. After i ## Haruna ![Haruna Screenshot](default-applications/haruna.jpg) - diff --git a/docs/user/software/configuration_files.md b/docs/user/software/configuration_files.md index c311d7574..87808a5f9 100644 --- a/docs/user/software/configuration_files.md +++ b/docs/user/software/configuration_files.md @@ -13,12 +13,11 @@ Solus uses a "stateless" system configuration. For what that means see [Stateles ::: -| Type | Applies to | Location(s) | Priority | -|-----------------------------------------------------------------------------------|-------------------------|-----------------|------------| -| **User**
- preserved during package updates | Per-user | `~/.config/`
`~/`
others | Highest | -| **System**
- preserved during package updates | All users on the system | `/etc/` | | -| **OS provided** (aka defaults)
- **overridden** by package updates | All users on the system | `/usr/share/defaults/` | Lowest | - +| Type | Applies to | Location(s) | Priority | +| ----------------------------------------------------------------------- | ----------------------- | ---------------------------------- | -------- | +| **User**
- preserved during package updates | Per-user | `~/.config/`
`~/`
others | Highest | +| **System**
- preserved during package updates | All users on the system | `/etc/` | | +| **OS provided** (aka defaults)
- **overridden** by package updates | All users on the system | `/usr/share/defaults/` | Lowest | A user configuration file overrides the system configuration, and the system configuration overrides the OS provided configuration. If no user configuration is provided, then the system configuration is used, and if no system configuration is provided, then the OS provided configuration is used. @@ -26,13 +25,13 @@ Different software expects user configuration files in different places. Many so Some common configuration files: -| Software | Configuration files | -|--------------|----------------------------------------------------------------------------------| -| apcupsd |`/etc/changeme`| -| cups |`/etc/cups/`| -| [samba](/docs/user/software/networking/samba) | `/etc/samba/smb.conf`
`/usr/share/defaults/samba/` | -| pam | `/etc/pam.d/`
`/usr/share/defaults/etc/pam.d/` | -| ssh | `$HOME/.ssh/`
`/usr/share/defaults/etc/ssh/` | -| ssl | `/etc/ssl/`
`/usr/share/defaults/etc/ssl/` | -| [tigervnc](docs/user/software/networking/tigervnc) | `$HOME/.vnc/xstartup` | -| [xrdp](docs/user/software/networking/xrdp) | `/etc/X11/Xwrapper.config` | \ No newline at end of file +| Software | Configuration files | +| -------------------------------------------------- | ------------------------------------------------------- | +| apcupsd | `/etc/changeme` | +| cups | `/etc/cups/` | +| [samba](/docs/user/software/networking/samba) | `/etc/samba/smb.conf`
`/usr/share/defaults/samba/` | +| pam | `/etc/pam.d/`
`/usr/share/defaults/etc/pam.d/` | +| ssh | `$HOME/.ssh/`
`/usr/share/defaults/etc/ssh/` | +| ssl | `/etc/ssl/`
`/usr/share/defaults/etc/ssl/` | +| [tigervnc](docs/user/software/networking/tigervnc) | `$HOME/.vnc/xstartup` | +| [xrdp](docs/user/software/networking/xrdp) | `/etc/X11/Xwrapper.config` | diff --git a/docs/user/software/development/containers.md b/docs/user/software/development/containers.md index 1720155d6..a853edc87 100644 --- a/docs/user/software/development/containers.md +++ b/docs/user/software/development/containers.md @@ -1,6 +1,6 @@ # Containers -Containers are a popular method to run and configure applications in a confined environment without directly installing the application and all it's dependencies. Solus provides the following container technologies: +Containers are a popular method to run and configure applications in a confined environment without directly installing the application and all it's dependencies. Solus provides the following container technologies: ## Docker diff --git a/docs/user/software/development/index.md b/docs/user/software/development/index.md index e6202d85e..c02ed9eb1 100755 --- a/docs/user/software/development/index.md +++ b/docs/user/software/development/index.md @@ -19,7 +19,7 @@ sudo eopkg install -c system.devel The `system.devel` component installs libraries and packages for software development, such as `clang`, `gcc`, and `make`. -*** +--- [**Android**](android) diff --git a/docs/user/software/development/web.md b/docs/user/software/development/web.md index 3ead4c25b..25f4b9a90 100644 --- a/docs/user/software/development/web.md +++ b/docs/user/software/development/web.md @@ -16,6 +16,7 @@ Solus provides multiple web servers for local testing of web applications. ::: ## Caddy + Caddy is installed with a default configuration that you can customize as needed. ### Installation @@ -28,7 +29,7 @@ sudo eopkg install caddy ### Configuration -You can configure Caddy using a _Caddyfile_, a text file that contains configuration directives. The default Caddyfile is located at `/usr/share/caddy/Caddyfile`. +You can configure Caddy using a _Caddyfile_, a text file that contains configuration directives. The default Caddyfile is located at `/usr/share/caddy/Caddyfile`. To reload Caddy with a new configuration file, use the following command: @@ -42,8 +43,8 @@ For more information, see the Caddy documentation at [https://caddyserver.com/do You can use the following commands to manage Caddy: -* Enable Caddy on startup and start immediately after enabling: `sudo systemctl enable --now caddy` -* Stop Caddy: `sudo systemctl stop caddy` +- Enable Caddy on startup and start immediately after enabling: `sudo systemctl enable --now caddy` +- Stop Caddy: `sudo systemctl stop caddy` ## httpd (Apache) @@ -60,6 +61,7 @@ sudo eopkg install httpd ### Usage #### Configuration and DocumentRoot + The default configuration files for Apache are located in the `/usr/share/defaults/httpd/` directory. To override the default configuration, create a new file with the `.conf` extension in the `/etc/httpd/conf.d` directory. :::caution Important @@ -85,6 +87,7 @@ SetHandler "proxy:fcgi://127.0.0.1:9000" DirectoryIndex index.php index.html ``` + 3. Execute the following command: `sudo systemctl restart httpd && sudo systemctl restart php-fpm` #### Management @@ -123,5 +126,5 @@ To revert back to the original settings, delete the `/etc/nginx/` folder. You can use the following commands to manage nginx: -* Enable nginx on startup and start immediately after enabling: `sudo systemctl enable --now nginx` -* Stop nginx: `sudo systemctl stop nginx` +- Enable nginx on startup and start immediately after enabling: `sudo systemctl enable --now nginx` +- Stop nginx: `sudo systemctl stop nginx` diff --git a/docs/user/troubleshooting/boot-rescue.md b/docs/user/troubleshooting/boot-rescue.md index 6f43ce6af..25ae93a63 100644 --- a/docs/user/troubleshooting/boot-rescue.md +++ b/docs/user/troubleshooting/boot-rescue.md @@ -43,7 +43,7 @@ Whether you're using GRUB or UEFI, you will need to mount your Solus root (`/`) 1. First we need to be the root user. Type: `sudo su` 2. Next we make a directory where we will mount our local Solus system: `mkdir /target` 3. Now, using `lsblk`, determine the partition of the Solus system. We recommend checking the size of the partition listed and if it matches the size of your Solus install, use that. It will likely be something along the lines of `sda#` or `sdb#`. For NVME drives, the name will look like `nvme0n1px` - Note: If you see "lvm" as the type, the system has LVM partitions. See the next section for how to mount them. + Note: If you see "lvm" as the type, the system has LVM partitions. See the next section for how to mount them. 4. If your root partition is of type sdX / nvme0n1x, replace the "sdX#" in the following command with the partition and mount to the target directory we created: `mount /dev/sdX# /target` #### Encrypted Systems / LVM Systems @@ -53,7 +53,7 @@ If you use LUKS-based encryption, the process will involve decrypting your LUKS 1. If the disk is encrypted, decrypt it by running `cryptsetup luksOpen /dev/sdX# decrypted`, replacing `X#` with the partition you identified, and enter your password when prompted. 2. Next check the output of `lsblk`. This will show you any LVM volumes. You should now see `SolusSystem-Swap` and `SolusSystem-Root`. - For non-encrypted volumes, you may see something like this. In this example, `SolusSystem-Swap` and `SolusSystem-Root` are under "sda2": + For non-encrypted volumes, you may see something like this. In this example, `SolusSystem-Swap` and `SolusSystem-Root` are under "sda2": ```bash NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT @@ -69,7 +69,7 @@ sda 252:0 0 96G 0 disk ... ``` - For decrypted volumes, the output should look similar to this, with `SolusSystem-Swap` and `SolusSystem-Root` being under "decrypted": +For decrypted volumes, the output should look similar to this, with `SolusSystem-Swap` and `SolusSystem-Root` being under "decrypted": ```bash NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT @@ -95,6 +95,7 @@ sdb 8:16 1 7.3G 0 disk If your system uses UEFI as opposed to GRUB, you will also need to mount your EFI System Partition, otherwise referred to as ESP. If you followed our [UEFI guide](/docs/user/quick-start/installation/disks#uefi) during installation of Solus, then in all likelihood your ESP will be about 500mb in size. If you're unsure of the partition, run the following, replacing X with the same letter during your mounting of your root file system, minus the number: For HDD / SDD drives: + ```bash fdisk -o Device,Size,Type -l /dev/sdX ``` @@ -157,7 +158,7 @@ In the event you had an incomplete upgrade, try the following commands: 1. `sudo eopkg rebuild-db` 2. `sudo eopkg up` 3. `sudo eopkg check | grep Broken | awk '{print $4}' | xargs sudo eopkg it --reinstall` - If you see output that starts with "Usage", this means the system has no broken packages. + If you see output that starts with "Usage", this means the system has no broken packages. 4. Try reverting the latest package transaction (this should only be done if the first two steps, followed by the "Re-run System-Wide Configuration Triggers", failed to produce a successful bootup). See [our documentation on history and rollback](/docs/user/package-management/history-and-rollback) for more information, followed by re-applying your updates by running `sudo eopkg up`. ### Correcting disks