Regolith Desktop

https://regolith-desktop.com/docs
Admin
Regolith Desktop is a modern, highly configurable desktop environment built on Ubuntu, focusing on...
Tokens:20,703
Snippets:238
Trust Score:7.6
Update:10 months ago
Show doc for...
Tokens:
Raw
### Install All Available Looks (Debian/Ubuntu)

Source: https://regolith-desktop.com/docs/using-regolith/configuration

Installs all Regolith 'look' packages available in the configured repositories using a wildcard with apt. This command will install multiple theme packages simultaneously.

```bash
sudo apt install regolith-look-*
```

--------------------------------

### List Available Regolith Looks

Source: https://regolith-desktop.com/docs/using-regolith/configuration

Lists all available Regolith look packages on the system using apt. This helps users discover and select specific looks to install.

```bash
apt list | grep regolith-look-

```

--------------------------------

### Install Packages via Command Line (apt)

Source: https://regolith-desktop.com/docs/howtos/find-install-packages

Installs packages using the `apt` command with `sudo` privileges. Requires the package name as input. Output is the confirmation of package installation.

```bash
sudo apt install <package name>
```

```bash
sudo apt install i3xrocks-battery
```

--------------------------------

### Install Official Regolith Looks

Source: https://regolith-desktop.com/docs/using-regolith/configuration

Installs all official Regolith looks using apt. This may include fonts, themes, and wallpapers. Users concerned about disk space can uninstall unused looks later.

```bash
sudo apt install regolith-look-*

```

--------------------------------

### Find Packages via Command Line (apt)

Source: https://regolith-desktop.com/docs/howtos/find-install-packages

Utilizes the `apt` command to search for packages. It can list installed packages using `--installed` or all available packages. Input is a package name or pattern. Output is a list of matching packages.

```bash
apt list --installed <package name>
apt list <package name>
```

```bash
$ apt list regolith-look-*
apt list --installed i3xrocks-*
```

--------------------------------

### Install Laptop Battery Status Indicator

Source: https://regolith-desktop.com/docs/using-regolith/configuration

Installs the 'i3xrocks-battery' package, which provides the current battery status for laptops.

```bash
sudo apt install i3xrocks-battery

```

--------------------------------

### Install Gruvbox Look (Debian/Ubuntu)

Source: https://regolith-desktop.com/docs/using-regolith/configuration

Installs the 'gruvbox' theme for Regolith Desktop using apt, then sets and refreshes the session to apply the new look. This process assumes the 'gruvbox' look package is available in the repositories.

```bash
sudo apt install regolith-look-gruvbox
regolith-look set gruvbox
regolith-look refresh
```

--------------------------------

### Install Recommended Status Indicators

Source: https://regolith-desktop.com/docs/using-regolith/configuration

Installs a set of recommended status indicator packages for new Regolith users. These provide information such as focused window name, rofication, system info, app launcher, and memory usage.

```bash
sudo apt install i3xrocks-focused-window-name i3xrocks-rofication i3xrocks-info i3xrocks-app-launcher i3xrocks-memory

```

--------------------------------

### Install Regolith with Sway Session and Nord Look

Source: https://regolith-desktop.com/docs/using-regolith/install

This command demonstrates installing Regolith with a specific Wayland session (`regolith-session-sway`) and the Nord look theme. This is an alternative to the default flashback session and lascaille look, offering a different user experience.

```bash
sudo apt install regolith-desktop regolith-session-sway regolith-look-nord
```

--------------------------------

### Git Commit Examples for regolith-lightdm-config

Source: https://regolith-desktop.com/docs/reference/releases/regolith-3

This Git commit example shows a fix for the default session and the addition of a new wallpaper in the `regolith-lightdm-config` component.

```git
729dd65 fix: default session. feat: new wallpapper
```

--------------------------------

### Search for Available Looks (Debian/Ubuntu)

Source: https://regolith-desktop.com/docs/using-regolith/configuration

Searches for available Regolith 'look' packages using the apt package manager. The pattern `^regolith-look-` ensures that only packages starting with this prefix are listed.

```bash
apt search ^regolith-look-
```

--------------------------------

### Update APT and Install Regolith Desktop Base

Source: https://regolith-desktop.com/docs/using-regolith/install

After adding the repository and key, this command updates the APT package list and installs the core Regolith desktop packages, including the base desktop environment, a session (e.g., flashback), and a look theme (e.g., lascaille).

```bash
sudo apt update
sudo apt install regolith-desktop regolith-session-flashback regolith-look-lascaille
```

--------------------------------

### Install Regolith on ARM Systems

Source: https://regolith-desktop.com/docs/using-regolith/install

This command shows how to modify the `apt` repository line to install Regolith on ARM-based systems. By replacing `amd64` with `arm64`, you ensure that the correct architecture is specified for package downloads.

```bash
echo deb "[arch=arm64 signed-by=/usr/share/keyrings/regolith-archive-keyring.gpg] \
https://archive.regolith-desktop.com/debian/stable bookworm v3.3" | \
sudo tee /etc/apt/sources.list.d/regolith.list
```

--------------------------------

### Search for Available Status Indicators (Debian/Ubuntu)

Source: https://regolith-desktop.com/docs/using-regolith/configuration

Searches for available status indicator packages using the apt package manager. The pattern `^i3xrocks-` ensures that only packages starting with this prefix are listed.

```bash
apt search ^i3xrocks-
```

--------------------------------

### Git Commit Examples for picom

Source: https://regolith-desktop.com/docs/reference/releases/regolith-3

These Git commit examples illustrate updates and fixes for the `picom` component. Changes include enabling config files, updating debian branches, preventing autostart, adding dependencies, and updating packaging.

```git
a959acc fix: update patch to enable config file
5c7f80e fix: update deb branch conf
9133602 fix: prevent picom autostart for regolith compat
df06cae fix: add missing dep
16731b1 fix: update dependencies for v11
d0ebbe8 chore: copy debian packging from v9 branch, add changelog entry
```

--------------------------------

### Git Commit Examples for ilia

Source: https://regolith-desktop.com/docs/reference/releases/regolith-3

These Git commit examples show changes made to the `ilia` component, including adding support checks, fixing single instance issues, configuring deb tools, and launching applications via systemd-run.

```git
b658923 chore: add layer_shell supported check
2e5029a fix: Ensure single instance using Gtk.Application
9c41eaf fix: deb tool config
353aff8 feat: launch apps and commands using systemd-run
```

--------------------------------

### Git Commit Examples for regolith-displayd

Source: https://regolith-desktop.com/docs/reference/releases/regolith-3

These Git commit examples demonstrate changes in the `regolith-displayd` component, focusing on its integration with systemd for daemon management and fixing startup failures.

```git
8c70872 chore: start daemon using systemd instead of regolith-displayd-init
f804063 fix: regolith-displayd first time startup failure via systemd
d72589e chore: let systemd manage regolith-displayd
```

--------------------------------

### Git Commit Examples for regolith-look-extra

Source: https://regolith-desktop.com/docs/reference/releases/regolith-3

This Git commit example addresses a fix for the wallpaper color primary in the `regolith-look-extra` component.

```git
8ea5655 blackhole: Fix wallpaper.color.primary to use defined black
```

--------------------------------

### Git Commit Examples for trawl

Source: https://regolith-desktop.com/docs/reference/releases/regolith-3

This Git commit example shows a feature addition to the `trawl` component, specifically the implementation of absolute versioning for dependencies.

```git
6503886 feat: use absolute versioning for dependencies
```

--------------------------------

### Install and Refresh Battery Status Indicator (Debian/Ubuntu)

Source: https://regolith-desktop.com/docs/using-regolith/configuration

Installs the battery status indicator package and refreshes the Regolith session to apply changes. This command assumes a Debian-based system using apt package manager.

```bash
sudo apt install i3xrocks-battery
regolith-look refresh
```

--------------------------------

### Git Commit Examples for regolith-sway-touchpad-gestures

Source: https://regolith-desktop.com/docs/reference/releases/regolith-3

These Git commit examples show changes to `regolith-sway-touchpad-gestures`, including handling deprecated packages, extracting gesture logic, and fixing compatibility issues across different OS releases.

```git
e84d769 fix: require deprecated package to be removed before replacing
fcfabb1 chore: extract gesture partial to seperate source package for selective install based on target os due to compat issues on jammy
```

--------------------------------

### Install and Refresh i3xrocks Status Indicator (Bash)

Source: https://regolith-desktop.com/docs/howtos/add-remove-blocklets

This snippet shows how to install a specific i3xrocks status indicator package using apt and then refreshes the Regolith look to apply the changes. It requires root privileges for installation.

```bash
sudo apt install i3xrocks-memory
regolith-look refresh
```

--------------------------------

### Git Commit Examples for regolith-wm-config

Source: https://regolith-desktop.com/docs/reference/releases/regolith-3

These Git commit examples highlight various fixes and features for `regolith-wm-config`, such as managing window bindings, improving error handling, customizing lid close behavior, adding screen grab bindings, and integrating with systemd.

```git
1bdd1c4 fix: pull window binding definition out of partial, into root config, to prevent decl ordering issues
c5921b8 fix: specify valid color default. Load best quality image instead of worst.  Only set wallpaper if resolution match found. Cleanup.
44a562c feat: support overriding more keys via resources
66d2f1f fix: specify defaults for trawl. exit on error.  fix errors
29a4c50 fix: import I3SOCK into the systemd environment for sway
8511c1c chore: improve error handling
59cc3ad fix: use gtklock from path
2842af1 fix: update pkg name for touchpad package. remove bin package decl. add soft dep on grimshot.
1f45a52 fix(clamshell): directly execute actions
770bfe7 fix: pull nav binding definition out of partial, into root config, to prevent decl ordering issues
25ff6f1 feat: add 3 bindings for window and screen grabs with grimshot
566714c fix: ensure lid action is applied as per current power state
1ab9c54 fix: ensure lid action is applied as per current power state
824c5f9 feat(sway): add touchpad gestures support
b1f83c7 feat: use systemd-run for terminal and browser
30955c4 feat: customise lid close behaviour based on system state
3cf993c fix: add essential packages to recommends
```

--------------------------------

### Identify and Remove Regolith i3 Workspace Configuration Package

Source: https://regolith-desktop.com/docs/howtos/customize-i3-configuration

This example shows the command-line process to identify the package providing a specific i3 configuration partial and then remove that package using apt. This is useful for uninstalling default settings to make way for custom configurations.

```bash
dpkg -S /usr/share/doc/regolith-i3-workspace-config
dpkg -L regolith-i3-workspace-config
sudo apt remove regolith-i3-workspace-config
```

--------------------------------

### Git Commit Examples for regolith-powerd

Source: https://regolith-desktop.com/docs/reference/releases/regolith-3

These Git commit examples detail changes in `regolith-powerd`, including updating Cargo.toml, adding functionality to pause audio players before suspend, adjusting sleep times, and fixing wallpaper display during locking and idling.

```git
11684f8 chore: update Cargo.toml to match debian
db08cc4 feat: pause all audio players before suspend
c2bb7c3 chore: increase sleep time to account for loading of background image
2c1754c fix: also show the correct wallpaper when locking
b5f72b fix: use correct lock screen program when idling
```

--------------------------------

### Git Commit Examples for sway-audio-idle-inhibit

Source: https://regolith-desktop.com/docs/reference/releases/regolith-3

These are examples of Git commit hashes and messages related to changes in the `sway-audio-idle-inhibit` component. They indicate merges and fixes within the project's version control.

```git
2011f38 Merge branch 'upstream_main' into sync_upstream
a5b9689 fix: depend on sway instead of libwlroots11
```

--------------------------------

### Verify Regolith Version

Source: https://regolith-desktop.com/docs/reference/releases/regolith-3

This command displays the current Regolith version installed on the system. It is useful for verifying the installation after an upgrade. It reads the version information from the `/etc/regolith/version` file.

```shell
$ cat /etc/regolith/version 
REGOLITH_VERSION=3.2
```

--------------------------------

### Launch Regolith Control Center

Source: https://regolith-desktop.com/docs/using-regolith/configuration

Shows how to launch the `regolith-control-center` application, which is used for configuring system settings like locale, date, displays, and networking. It can be launched via the app launcher, a direct keybinding, or from the terminal.

```shell
regolith-control-center
```

--------------------------------

### Set Desktop Wallpaper to Color Gradient

Source: https://regolith-desktop.com/docs/using-regolith/configuration

Configures a desktop wallpaper with a color gradient, specifying primary and secondary colors, and the shading type (e.g., 'vertical'). Requires a look refresh.

```bash
echo "regolith.wallpaper.file: " >> ~/.config/regolith3/Xresources
echo "regolith.wallpaper.color.primary: blue" >> ~/.config/regolith3/Xresources
echo "regolith.wallpaper.color.secondary: green" >> ~/.config/regolith3/Xresources
echo "regolith.wallpaper.color.shading.type: vertical" >> ~/.config/regolith3/Xresources
regolith-look refresh

```

--------------------------------

### Remove Status Indicator Package

Source: https://regolith-desktop.com/docs/using-regolith/configuration

Demonstrates how to remove a specific status indicator package, such as 'i3xrocks-info', from the system using apt.

```bash
sudo apt remove i3xrocks-info

```

--------------------------------

### Set Desktop Wallpaper Image Treatment

Source: https://regolith-desktop.com/docs/using-regolith/configuration

Sets the treatment options for the desktop wallpaper image, such as 'zoom', 'scaled', or 'centered'. The setting is applied via Xresources and requires a look refresh.

```bash
echo "regolith.wallpaper.options: zoom" >> ~/.config/regolith3/Xresources
regolith-look refresh

```

--------------------------------

### Set Desktop Wallpaper to Primary Color

Source: https://regolith-desktop.com/docs/using-regolith/configuration

Sets the desktop wallpaper to a solid primary color by clearing the wallpaper file path and specifying the color. Requires refreshing the Regolith look.

```bash
echo "regolith.wallpaper.file: " >> ~/.config/regolith3/Xresources
echo "regolith.wallpaper.color.primary: blue" >> ~/.config/regolith3/Xresources
regolith-look refresh

```

--------------------------------

### Customize Super Keybinding in Regolith

Source: https://regolith-desktop.com/docs/using-regolith/configuration

Demonstrates how to change the default 'super' key binding (e.g., from the 'windows' key to 'alt') by modifying the Xresources file. This involves setting `wm.mod` and `wm.alt` values. Ensure the correct Xresources file path is used based on the Regolith version.

```shell
wm.mod: Mod1
wm.alt: Mod4
```

--------------------------------

### Search for i3xrocks Status Indicators (Bash)

Source: https://regolith-desktop.com/docs/howtos/add-remove-blocklets

This command searches for available i3xrocks status indicator packages using apt. It helps users find installable modules for their bar.

```bash
apt search i3xrocks-
```

--------------------------------

### Install dunst Notification System

Source: https://regolith-desktop.com/docs/howtos/replace-notification-system

Installs the dunst notification system and the libnotify-bin utility, which are necessary for enabling pop-up notifications. This command assumes the use of a Debian-based package manager like apt.

```bash
sudo apt install dunst libnotify-bin
```

--------------------------------

### i3 Configuration Includes

Source: https://regolith-desktop.com/docs/reference/configurations

Demonstrates how the root Regolith i3 configuration file loads partials from both system-wide and user-specific directories. This allows for modular configuration management using the 'include' directive.

```i3config
# Include any regolith i3 partials
include /usr/share/regolith/i3/config.d/*

# Include any user i3 partials
include $HOME/.config/regolith2/i3/config.d/*
```

--------------------------------

### Register Regolith Public Key for APT

Source: https://regolith-desktop.com/docs/using-regolith/install

This command downloads and registers the Regolith public GPG key. This is a crucial step for APT to verify the authenticity of packages downloaded from the Regolith repository. The key is stored in a specific location for APT to use.

```bash
wget -qO - https://archive.regolith-desktop.com/regolith.key | \
gpg --dearmor | sudo tee /usr/share/keyrings/regolith-archive-keyring.gpg > /dev/null
```

--------------------------------

### Set Lockscreen Wallpaper Image

Source: https://regolith-desktop.com/docs/using-regolith/configuration

Sets a custom image for the lockscreen wallpaper using the 'regolith.lockscreen.wallpaper.file' Xresources key. The Regolith look must be refreshed after applying the change.

```bash
echo "regolith.lockscreen.wallpaper.file: /usr/share/backgrounds/hardy_wallpaper_uhd.png" >> ~/.config/regolith3/Xresources
regolith-look refresh

```

--------------------------------

### List Monitors with xrandr (i3)

Source: https://regolith-desktop.com/docs/howtos/workspace-on-output

This command lists available monitors and their device names. The output is used to identify the correct monitor name for configuration.

```bash
$ xrandr --listmonitors
Monitors:
 0: +*eDP-1 1920/309x1080/173+0+0  eDP-1

```

--------------------------------

### List Outputs with swaymsg (Sway)

Source: https://regolith-desktop.com/docs/howtos/workspace-on-output

This command is used in Sway to list available outputs and their details. The output helps in identifying the correct output name for configuration.

```bash
$ swaymsg -t get_outputs
Output HDMI-A-2 'ViewSonic Corporation VG2448 V5E192121969' 
[...]

```

--------------------------------

### Test Notifications with dunst

Source: https://regolith-desktop.com/docs/howtos/replace-notification-system

Sends a test notification using the `notify-send` command to verify that the newly installed dunst notification system is functioning correctly and displaying pop-up alerts.

```bash
notify-send test123
```

--------------------------------

### Add Regolith Repository for Debian Testing

Source: https://regolith-desktop.com/docs/using-regolith/install

This command adds the Regolith repository to your system's APT sources, specifically for Debian Testing. It ensures your system can fetch Regolith packages from the testing branch. Note that this may lead to broken dependencies.

```bash
echo deb "[arch=amd64 signed-by=/usr/share/keyrings/regolith-archive-keyring.gpg] \
https://archive.regolith-desktop.com/debian/testing testing main" | \
sudo tee /etc/apt/sources.list.d/regolith.list
```

--------------------------------

### Customize a Default i3 Partial Configuration in Regolith

Source: https://regolith-desktop.com/docs/howtos/customize-i3-configuration

Provides steps to customize a specific default i3 configuration partial in Regolith. This involves ensuring the user config directory exists, copying the default file, making edits, and optionally removing the original package. A restart of i3 or logout/login is required.

```bash
mkdir -p ~/.config/regolith3/i3/config.d
cp /usr/share/regolith/i3/config.d/40_workspace-config ~/.config/regolith3/i3/config.d/
vim ~/.config/regolith3/i3/config.d/40_workspace-config
sudo apt remove regolith-i3-workspace-config
```

--------------------------------

### Stage i3 Config File for Regolith Desktop

Source: https://regolith-desktop.com/docs/howtos/stage-configs

This snippet demonstrates how to copy the default Regolith i3 config file to the user's home directory, enabling Regolith to load the user-staged version instead of the default. This is essential for customizing keybindings or components. Ensure the directory structure is created before copying.

```shell
mkdir -p ~/.config/regolith3/i3
cp /etc/regolith/i3/config ~/.config/regolith3/i3/config
```

--------------------------------

### Remove Rofication Notification System

Source: https://regolith-desktop.com/docs/howtos/replace-notification-system

Removes the default Regolith Rofication notification system and its associated configuration files. This command is used if the package manager does not automatically remove Rofication after installing an alternative.

```bash
sudo apt purge regolith-rofication
```

--------------------------------

### Customize i3xrocks Status Indicator Order (Bash)

Source: https://regolith-desktop.com/docs/howtos/add-remove-blocklets

This example demonstrates how to customize the order of status indicators on the Regolith i3 bar. It involves copying default configuration files to the user's config directory and renaming them to alter their sort order. Finally, it refreshes the Regolith look to apply the changes.

```bash
ls /usr/share/i3xrocks/conf.d/
mkdir -p ~/.config/regolith3/i3xrocks/conf.d
cp /usr/share/i3xrocks/conf.d/01_setup ~/.config/regolith3/i3xrocks/conf.d/01_setup
cp /usr/share/i3xrocks/conf.d/80_battery ~/.config/regolith3/i3xrocks/conf.d/30_battery
cp /usr/share/i3xrocks/conf.d/30_net-traffic ~/.config/regolith3/i3xrocks/conf.d/80_net-traffic
regolith-look refresh
```

--------------------------------

### Configure i3status-rust for Multiple Batteries (TOML)

Source: https://regolith-desktop.com/docs/howtos/multiple-batteries

This snippet demonstrates how to configure i3status-rust to display multiple battery statuses. It involves updating the configuration file (e.g., `~/.config/regolith3/i3status-rust/config.toml`) to include separate blocks for each battery device, specifying the `device` parameter for each.

```shell
cp /etc/regolith/i3status-rust/config.toml ~/.config/regolith3/i3status-rust/config.toml
echo "wm.bar.status_config: ~/.config/regolith3/i3status-rust/config.toml" >> ~/.config/regolith3/Xresources
ls /sys/class/power_supply/

# AC BAT0 BAT1
```

```toml
[[block]]
block = "battery"
interval = 10
[...] 
device = "BAT0"

[[block]]
block = "battery"
interval = 10
[...] 
device = "BAT1"
```

--------------------------------

### Set Xresources Variable for Compositor in Regolith

Source: https://regolith-desktop.com/docs/howtos/customize-i3-configuration

This snippet demonstrates how to override the default compositor program in Regolith using Xresources. It shows the default configuration file and how to add a custom entry to `~/.config/regolith3/Xresources` to specify a different compositor.

```bash
set_from_resource $wm.program.compositor wm.program.compositor /usr/share/regolith-compositor/init
exec_always --no-startup-id $wm.program.compositor
```

```bash
# Use my own home-made compositor
wm.program.compositor: /usr/local/bin/my-compositor
```

--------------------------------

### Add Stable Regolith Repository for Debian/Ubuntu

Source: https://regolith-desktop.com/docs/using-regolith/install

This command adds the stable Regolith repository to your system's APT sources for Debian Bookworm or compatible Ubuntu releases. It specifies the architecture, repository URL, distribution suite, and version for consistent package management.

```bash
echo deb "[arch=amd64 signed-by=/usr/share/keyrings/regolith-archive-keyring.gpg] \
https://archive.regolith-desktop.com/debian/stable bookworm v3.3" | \
sudo tee /etc/apt/sources.list.d/regolith.list
```
Tokens:
Raw