From 2d3e238b317538d5afe1f779e1835874c17f1abb Mon Sep 17 00:00:00 2001 From: Luc Date: Fri, 25 Aug 2023 17:44:30 +0200 Subject: [PATCH] Added titles and updated headings --- .../Application-launcher.md | 8 +++-- docs/void-desktop-setup/Audio.md | 6 ++-- docs/void-desktop-setup/Auto-mounting.md | 2 ++ .../Automatic-decryption.md | 8 ++--- docs/void-desktop-setup/Bluetooth.md | 2 ++ .../Display-configuration.md | 4 ++- .../Essential-applications.md | 2 ++ .../Firmware-and-drivers.md | 30 +++++++++---------- docs/void-desktop-setup/Home.md | 5 ---- .../Installation-with-LVM.md | 2 ++ docs/void-desktop-setup/Installation.md | 2 ++ docs/void-desktop-setup/Laptop-management.md | 2 ++ docs/void-desktop-setup/Linux-lts.md | 2 ++ docs/void-desktop-setup/Localtime.md | 2 ++ docs/void-desktop-setup/Logging.md | 2 ++ docs/void-desktop-setup/Login-manager.md | 2 ++ .../void-desktop-setup/Network-filesystems.md | 4 ++- docs/void-desktop-setup/Network.md | 2 ++ docs/void-desktop-setup/Notifications.md | 6 ++-- docs/void-desktop-setup/Post-install.md | 4 ++- .../Provisioning-with-LVM.md | 2 ++ docs/void-desktop-setup/Provisioning.md | 2 ++ docs/void-desktop-setup/Repositories.md | 4 ++- docs/void-desktop-setup/Screenshots.md | 2 ++ docs/void-desktop-setup/Secure-boot.md | 2 ++ docs/void-desktop-setup/Session-manager.md | 2 ++ docs/void-desktop-setup/Taskbar.md | 2 ++ docs/void-desktop-setup/Users.md | 4 ++- docs/void-desktop-setup/Using-swap.md | 2 ++ docs/void-desktop-setup/Window-manager.md | 2 ++ 30 files changed, 84 insertions(+), 37 deletions(-) diff --git a/docs/void-desktop-setup/Application-launcher.md b/docs/void-desktop-setup/Application-launcher.md index a6b3054..09c1fbb 100644 --- a/docs/void-desktop-setup/Application-launcher.md +++ b/docs/void-desktop-setup/Application-launcher.md @@ -1,6 +1,8 @@ +# Application launcher + An application launcher may be used to easily start applications in Wayfire. -#### Tofi +## Tofi For a fast and lightweight application launcher it's recommended to use `tofi` which starts in a few miliseconds if configured correctly. To install it: @@ -22,7 +24,7 @@ binding_launcher = KEY_S command_launcher = tofi-drun | xargs /bin/bash -c -- & exit ``` -#### Wofi +## Wofi Although the `wofi` package is no longer maintained and is generally less optimised compared to `tofi` it does have some important features that `tofi` does not have. Such as, a better positioning protocol. @@ -46,7 +48,7 @@ binding_launcher = KEY_S command_launcher = wofi --show drun ``` -#### Wlogout +## Wlogout Wlogout may be used as a specific launcher for power management options. Such as, reboot, suspend and to power off the system. diff --git a/docs/void-desktop-setup/Audio.md b/docs/void-desktop-setup/Audio.md index c9ec14c..8f25daf 100644 --- a/docs/void-desktop-setup/Audio.md +++ b/docs/void-desktop-setup/Audio.md @@ -1,3 +1,5 @@ +# Audio + To obtain audio the `pipewire` server will be used with an `alsa-pipewire` plugin in combination with `wireplumber` as session manager. They may be installed with: @@ -35,7 +37,7 @@ Pipewire needs to be started by Wayfire. audio = pipewire ``` -### Audio control +## Audio control To obtain some control over the audio `pavucontrol`, `pamixer` and `pa-notify` may be installed. @@ -62,7 +64,7 @@ To be notified when changing the volume `pa-notify` may be used. It needs to be audio_notify = sleep 1; pa-notify -t 2 ``` -### Music control +## Music control To control music and other media `playerctl` may be used. diff --git a/docs/void-desktop-setup/Auto-mounting.md b/docs/void-desktop-setup/Auto-mounting.md index 42fae65..5b275d1 100644 --- a/docs/void-desktop-setup/Auto-mounting.md +++ b/docs/void-desktop-setup/Auto-mounting.md @@ -1,3 +1,5 @@ +# Auto-mounting + `udiskie` will be used to automatically mount drives. It may be installed with. ``` diff --git a/docs/void-desktop-setup/Automatic-decryption.md b/docs/void-desktop-setup/Automatic-decryption.md index b499575..cdabb7b 100644 --- a/docs/void-desktop-setup/Automatic-decryption.md +++ b/docs/void-desktop-setup/Automatic-decryption.md @@ -1,8 +1,8 @@ -(unfinished) +# Automatic decryption *(unfinished)* Using Clevis it's possible to automatically decrypt the system upon startup. But because we haven't been able to figure out how to create a functional template file for that we'll have to compile it ourselves. Note that you must use the `booster` initramfs. (A lot more information about the possibilities from clevis can be found on the [ArchWiki](https://wiki.archlinux.org/title/Clevis)) -#### Installing José +## Installing José First we have to compile [José](https://github.com/latchset/jose), a "C-language implementation of Javascript Object Signing and Encryption". José is a dependency of Clevis. First install the dependencies needed to compile josé. @@ -26,7 +26,7 @@ $ ninja # ninja install ``` -#### Installing Clevis +## Installing Clevis After having installed José install the other dependencies. @@ -49,7 +49,7 @@ $ ninja -C build # ninja -C build install ``` -#### Acquiring automatic decryption +## Acquiring automatic decryption To bind our LUKS volume to TPM with clevis simply enter this command: diff --git a/docs/void-desktop-setup/Bluetooth.md b/docs/void-desktop-setup/Bluetooth.md index 86dbc8b..5885189 100644 --- a/docs/void-desktop-setup/Bluetooth.md +++ b/docs/void-desktop-setup/Bluetooth.md @@ -1,3 +1,5 @@ +# Bluetooth + Bluetooth functionality may be obtained by enabling `bluetoothd`. Its packages may be installed by: ``` diff --git a/docs/void-desktop-setup/Display-configuration.md b/docs/void-desktop-setup/Display-configuration.md index f5787cc..f36a823 100644 --- a/docs/void-desktop-setup/Display-configuration.md +++ b/docs/void-desktop-setup/Display-configuration.md @@ -1,3 +1,5 @@ +# Display configuration + To configure the displays of the systems it's necessary to either configure them through `.config/wayfire.ini` or use an external application like `kanshi`. To install kanshi: @@ -22,7 +24,7 @@ And make sure `kanshi` gets started by Wayfire by adding it to auto start. outputs = kanshi ``` -#### Color-temperature adjustment +## Color-temperature adjustment For changing the day/night gamma install `wlsunset`. diff --git a/docs/void-desktop-setup/Essential-applications.md b/docs/void-desktop-setup/Essential-applications.md index ef719c8..1eea744 100644 --- a/docs/void-desktop-setup/Essential-applications.md +++ b/docs/void-desktop-setup/Essential-applications.md @@ -1,3 +1,5 @@ +# Essential applications + Some essential applications and packages. ``` diff --git a/docs/void-desktop-setup/Firmware-and-drivers.md b/docs/void-desktop-setup/Firmware-and-drivers.md index 6f3176f..3d5a5d5 100644 --- a/docs/void-desktop-setup/Firmware-and-drivers.md +++ b/docs/void-desktop-setup/Firmware-and-drivers.md @@ -1,54 +1,56 @@ -### GPU drivers +# Firmware and drivers + +## GPU drivers It is necessary for a graphical enviroment to install GPU drivers. To install the drivers for your GPU use one of the following commands: -##### For Intel +### For Intel ``` # xbps-install -Sy linux-firmware-intel mesa mesa-dri vulkan-loader mesa-vulkan-intel intel-video-accel ``` -##### For AMD +### For AMD ``` # xbps-install -Sy linux-firmware-amd vulkan-loader mesa-vulkan-radeon amdvlk xf86-video-amdgpu mesa-vaapi mesa-vdpau mesa-dri ``` -##### For Nvidia (*glibc only*) +### For Nvidia (*glibc only*) ``` # xbps-install -Sy nvidia nvidia-opencl ``` -#### 32-bit drivers +### 32-bit drivers (Only applicable to glibc as Void Linux musl only supports 64-bit) To run 32-bit applications like some videogames it will also be necessary to install the 32-bit drivers: -##### For Intel +#### For Intel ``` # xbps-install -Sy mesa-32bit mesa-dri-32bit mesa-vulkan-intel-32bit vulkan-loader-32bit ``` -##### For AMD +#### For AMD ``` # xbps-install -Sy vulkan-loader-32bit amdvlk-32bit mesa-32bit mesa-dri-32bit ``` -##### For Nvidia +#### For Nvidia ``` # xbps-install -Sy nvidia-libs-32bit ``` -### CPU firmware +## CPU firmware To keep the firmware of your CPU up to date it is necessary to install the correct microcode: -#### For Intel +### For Intel (The Intel microcode requires that you are using the nonfree repository) @@ -62,17 +64,13 @@ And regenerate the initramfs: # xbps-reconfigure -f linux ``` - - -#### For AMD +### For AMD ``` # xbps-install -Sy linux-firmware-amd ``` - - -### Nvidia + Wayland +## Nvidia and wayland For Nvidia to work correctly with Wayfire you'll have to add the boot parameter to `/boot/loader/void-options.conf`. diff --git a/docs/void-desktop-setup/Home.md b/docs/void-desktop-setup/Home.md index 0ef4305..8437351 100644 --- a/docs/void-desktop-setup/Home.md +++ b/docs/void-desktop-setup/Home.md @@ -1,8 +1,3 @@ ---- -gitea: none -include_toc: false ---- - # A Void Linux installation This install is based on the [EFI boot stub](https://mth.st/blog/void-efistub/) blog entry of [Matthias Totschnig](https://mth.st/), the [Void Handbook](https://docs.voidlinux.org/about/index.html) and the Void Linux [man pages](https://man.voidlinux.org/man-pages.7). This guide focuses on a Void Linux x86_64 glibc/musl install on uefi. In this install gummiboot is used as bootloader and the root partition will be encrypted. \ No newline at end of file diff --git a/docs/void-desktop-setup/Installation-with-LVM.md b/docs/void-desktop-setup/Installation-with-LVM.md index eddee8a..2a0f636 100644 --- a/docs/void-desktop-setup/Installation-with-LVM.md +++ b/docs/void-desktop-setup/Installation-with-LVM.md @@ -1,3 +1,5 @@ +# Installation with LVM + To install the Void Linux distribution on the system, the encrypted partition and the efi partition have to be mounted to the main system. ``` diff --git a/docs/void-desktop-setup/Installation.md b/docs/void-desktop-setup/Installation.md index efeae0f..299da5f 100644 --- a/docs/void-desktop-setup/Installation.md +++ b/docs/void-desktop-setup/Installation.md @@ -1,3 +1,5 @@ +# Installation + To install the Void Linux distribution on the system, the encrypted partition and the efi partition have to be mounted to the main system. ``` diff --git a/docs/void-desktop-setup/Laptop-management.md b/docs/void-desktop-setup/Laptop-management.md index b633f20..cc6b27b 100644 --- a/docs/void-desktop-setup/Laptop-management.md +++ b/docs/void-desktop-setup/Laptop-management.md @@ -1,3 +1,5 @@ +# Laptop management + To obtain enhanced battery lifespan, `tlp` and `tlpui` may be installed. The `tlpui` application may be used to monitor the general configuration of `tlp`. ``` diff --git a/docs/void-desktop-setup/Linux-lts.md b/docs/void-desktop-setup/Linux-lts.md index 301ec5b..571c064 100644 --- a/docs/void-desktop-setup/Linux-lts.md +++ b/docs/void-desktop-setup/Linux-lts.md @@ -1,3 +1,5 @@ +# Linux-lts + It might be desirable to install an LTS kernel for better stability. This can be done by: ``` diff --git a/docs/void-desktop-setup/Localtime.md b/docs/void-desktop-setup/Localtime.md index bda7725..c8b0271 100644 --- a/docs/void-desktop-setup/Localtime.md +++ b/docs/void-desktop-setup/Localtime.md @@ -1,3 +1,5 @@ +# Localtime + A "Network Time Protocol Daemon" (nptd for short) can sync the system clock with internet standard time servers. The `chrony` daemon is used as ntpd. Install it by: ``` diff --git a/docs/void-desktop-setup/Logging.md b/docs/void-desktop-setup/Logging.md index 5c55292..220e55b 100644 --- a/docs/void-desktop-setup/Logging.md +++ b/docs/void-desktop-setup/Logging.md @@ -1,3 +1,5 @@ +# Logging + Logging may be benificial to spot certain misbehaviours or errors in the system. The `socklog-void` package will be used as logging daemon. ``` diff --git a/docs/void-desktop-setup/Login-manager.md b/docs/void-desktop-setup/Login-manager.md index a095f3d..98940e4 100644 --- a/docs/void-desktop-setup/Login-manager.md +++ b/docs/void-desktop-setup/Login-manager.md @@ -1,3 +1,5 @@ +# Login manager + To make it easier to log into the system, set up a login manager. For a minimal and wayland-compatible login manager use `greetd` with `gtkgreet`. Install them with: ``` diff --git a/docs/void-desktop-setup/Network-filesystems.md b/docs/void-desktop-setup/Network-filesystems.md index c3c6d07..9a0a440 100644 --- a/docs/void-desktop-setup/Network-filesystems.md +++ b/docs/void-desktop-setup/Network-filesystems.md @@ -1,6 +1,8 @@ +# Network filesystems + Network filesystems may be used for enhanced workflow between multiple devices and persistance of storage. -#### Samba +## Samba Samba is such a Network filesystem protocol that may be used between different platforms. To use it install. diff --git a/docs/void-desktop-setup/Network.md b/docs/void-desktop-setup/Network.md index 14c3aad..4370e5f 100644 --- a/docs/void-desktop-setup/Network.md +++ b/docs/void-desktop-setup/Network.md @@ -1,3 +1,5 @@ +# Network + NetworkManager will be used as Network daemon due to its versatility. The package was already installed with the installation, thereby it only needs to be symlinked to `/var/service` to function. ``` diff --git a/docs/void-desktop-setup/Notifications.md b/docs/void-desktop-setup/Notifications.md index 9e27a89..ebf8f2e 100644 --- a/docs/void-desktop-setup/Notifications.md +++ b/docs/void-desktop-setup/Notifications.md @@ -1,4 +1,6 @@ -### SwayNC +# Notifications + +## SwayNC For a more robust notification deamon it's recommended to use SwayNotificationCenter which also provides a *notifications center* which can be heavily customised. @@ -49,7 +51,7 @@ And }, ``` -### Mako +## Mako For a very minimal notification deamon it's recommended to use Mako. It can be used to display notifications from the session-bus. diff --git a/docs/void-desktop-setup/Post-install.md b/docs/void-desktop-setup/Post-install.md index 240bd6a..25f426a 100644 --- a/docs/void-desktop-setup/Post-install.md +++ b/docs/void-desktop-setup/Post-install.md @@ -1,4 +1,6 @@ -The post install section elaborates on the installation and configuration of certain applications. To simplify this and the subsequent sections, reference is made to pre-made configuration files with `{config-files-repo}`. +# Post installation + +The post installation section elaborates on the installation and configuration of certain applications. To simplify this and the subsequent sections, reference is made to pre-made configuration files with `{config-files-repo}`. A configuration files repository may be chosen to one's preference, by cloning them with the `git` command. It is recommended to do this once a user has been created. diff --git a/docs/void-desktop-setup/Provisioning-with-LVM.md b/docs/void-desktop-setup/Provisioning-with-LVM.md index 27ce727..b7fa9cd 100644 --- a/docs/void-desktop-setup/Provisioning-with-LVM.md +++ b/docs/void-desktop-setup/Provisioning-with-LVM.md @@ -1,3 +1,5 @@ +# Provisioning with LVM + First off the drive should be partitioned, possibly with `fdisk` or `cfdisk`. It should have atleast two partitions with one `EFI System` Partition and one `Linux filesystem` partition. It should look something like this: diff --git a/docs/void-desktop-setup/Provisioning.md b/docs/void-desktop-setup/Provisioning.md index 0fa8eab..ff5cfa5 100644 --- a/docs/void-desktop-setup/Provisioning.md +++ b/docs/void-desktop-setup/Provisioning.md @@ -1,3 +1,5 @@ +# Provisioning + First off the drive should be partitioned, possibly with `fdisk` or `cfdisk`. It should have atleast two partitions with one `EFI System` Partition and one `Linux filesystem` partition. It should look something like this: diff --git a/docs/void-desktop-setup/Repositories.md b/docs/void-desktop-setup/Repositories.md index 93a2db0..088dd8d 100644 --- a/docs/void-desktop-setup/Repositories.md +++ b/docs/void-desktop-setup/Repositories.md @@ -1,3 +1,5 @@ +# Repositories + To install the official Void Linux 32-bit and nonfree repositories simply install their respective packages: * For glibc @@ -18,7 +20,7 @@ And update the repositories: # xbps-install -S ``` -#### Our unofficial extra repository +## xbps-ample There is also our unofficial extra repository for some additional packages and some packages which are needed for the graphical installation. To use those add them to `/etc/xbps.d/00-repository-ample.conf`, diff --git a/docs/void-desktop-setup/Screenshots.md b/docs/void-desktop-setup/Screenshots.md index 8af62c3..b87e4b4 100644 --- a/docs/void-desktop-setup/Screenshots.md +++ b/docs/void-desktop-setup/Screenshots.md @@ -1,3 +1,5 @@ +# Screenshots + To be able to make screenshots on the system the packages `grim`, `slurp` and `wl-clipboard` will need to be installed. ``` diff --git a/docs/void-desktop-setup/Secure-boot.md b/docs/void-desktop-setup/Secure-boot.md index 8cbace0..1d3495e 100644 --- a/docs/void-desktop-setup/Secure-boot.md +++ b/docs/void-desktop-setup/Secure-boot.md @@ -1,3 +1,5 @@ +# Secure boot + Secure boot is sometimes a necessity when working with a windows dual boot on laptops and also an extra layer of protection for your system. For linux to work with secureboot it's necessary to enroll keys using sbctl. diff --git a/docs/void-desktop-setup/Session-manager.md b/docs/void-desktop-setup/Session-manager.md index 3672931..7a6eed9 100644 --- a/docs/void-desktop-setup/Session-manager.md +++ b/docs/void-desktop-setup/Session-manager.md @@ -1,3 +1,5 @@ +# Session manager + To use a graphical enviroment it is necessary to start a seat and session manager. For a minimal install it is recommended to use `seatd`, `turnstile` and `polkit`. To install those run: ``` diff --git a/docs/void-desktop-setup/Taskbar.md b/docs/void-desktop-setup/Taskbar.md index 72db1a7..0d7496b 100644 --- a/docs/void-desktop-setup/Taskbar.md +++ b/docs/void-desktop-setup/Taskbar.md @@ -1,3 +1,5 @@ +# Taskbar + For the taskbar it is recommended to use Waybar since it's wayland native and has enough functionality. Furthermore network manager applet will be used to display network status and to easily configure network settings. To install both, in combination with some necessary fonts. diff --git a/docs/void-desktop-setup/Users.md b/docs/void-desktop-setup/Users.md index 31ff926..9891456 100644 --- a/docs/void-desktop-setup/Users.md +++ b/docs/void-desktop-setup/Users.md @@ -1,3 +1,5 @@ +# Users + A user should be added to improve security of the system. ``` @@ -54,7 +56,7 @@ $ cp {config-files-repo}/bash/.bashrc .bashrc $ cp {config-files-repo}/bash/.bash_profile .bash_profile ``` -#### User directories +## User directories It is generally beneficial to set default user directories. To obtain some consistency in the `home` directory. This may be obtained with the `xdg-user-dirs` package. diff --git a/docs/void-desktop-setup/Using-swap.md b/docs/void-desktop-setup/Using-swap.md index d76fc85..ad697ca 100644 --- a/docs/void-desktop-setup/Using-swap.md +++ b/docs/void-desktop-setup/Using-swap.md @@ -1,3 +1,5 @@ +# Using swap + Swap can be utilised by the system to free up space in RAM. For most use cases it is recommend to create a swapfile that is one and a half times the size of your RAM. To create a swapfile of 8 GB use: diff --git a/docs/void-desktop-setup/Window-manager.md b/docs/void-desktop-setup/Window-manager.md index 06d8a81..04178a4 100644 --- a/docs/void-desktop-setup/Window-manager.md +++ b/docs/void-desktop-setup/Window-manager.md @@ -1,3 +1,5 @@ +# Window manager + There are many different window managers and desktop environments which can provide a decent experience. Wayfire is a functional, relatively lightweight and good looking wayland window manager and will be used for this install. To install a barebones Wayfire use: