LinuxCommandLibrary

swww

Change the desktop wallpaper using various effects

TLDR

Set wallpaper

$ swww img [path/to/image]
copy

Set wallpaper to specified outputs
$ swww img [[-o|--outputs]] [output1,output2,...] [path/to/image]
copy

Restore last wallpaper
$ swww restore
copy

Kill daemon
$ swww kill
copy

Display output information
$ swww query
copy

SYNOPSIS

swww [command] [options] [image]

PARAMETERS

img
    Sets the wallpaper to the specified image path. This is the main command for setting a wallpaper.

scale
    Specifies how the image should be scaled. Possible values are: 'fill' (default), 'fit', 'center', 'tile', 'stretch'.

transition
    Sets the transition effect used when changing wallpapers. Available effects include: 'fade' (default), 'wipe', 'zoom', 'blur'.

transition-duration
    Sets the duration of the transition effect in seconds (default: 1.0).

transition-fps
    Specifies the target FPS for transitions.

--blur
    Applies a blur effect to the wallpaper.

--grayscale
    Converts the wallpaper to grayscale.

--colorize
    Colorizes the wallpaper with the specified color (e.g., '#RRGGBB').

--bg
    Set a default background color.

--help
    Displays a help message and exits.

--version
    Displays the version information and exits.

output
    Specify target output to apply wallpaper

off
    Turn off the wallpaper

query
    Query wallpaper information

DESCRIPTION

swww is a fast and efficient wallpaper setter for Wayland compositors. It's designed with performance and flexibility in mind, leveraging OpenGL for image scaling and providing a wide range of options to customize the wallpaper appearance.

swww supports multiple image formats, tiling modes (e.g., fill, fit, center, tile), and effects (e.g., blur, grayscale, colorize). It can also create smooth transitions between wallpapers, making it suitable for dynamic wallpaper setups.

It differs from alternatives through speed, minimal dependencies, and its explicit focus on Wayland. swww aims to provide reliable and highly customisable experience for Wayland users.

CAVEATS

swww relies on OpenGL and requires a Wayland compositor that supports the `wp-presentation` protocol to function properly. It may not work on all Wayland compositors.

Performance may vary depending on the image size, scaling mode, and selected effects.

CONFIGURATION

swww primarily operates through command-line arguments. There is no central configuration file. Integration with other tools can be achieved through scripting and/or running the swww as daemon with background job.

HISTORY

swww was created to address the need for a performant and customizable wallpaper setter specifically designed for Wayland. Its development focused on utilizing OpenGL for efficient image manipulation and providing a clean and minimal API for users.

SEE ALSO

hyprpaper(1), wayland(7)

Copied to clipboard