wpaperd-output(5)

๐Ÿ“ฆ
version 1.3.0 ยท 4 versions
, in arch rolling

๐Ÿ’… wpaperd-output โ€” the glam little manual page for your displays โœจ

okay so bestie, welcome to wpaperd-output(5) โ€” literally the manual for the format wpaperd uses to define all your displays ๐Ÿ–ฅ๏ธ๐Ÿ’–. Pull up a chair, we're gonna get you looking iconic.


๐ŸŒธ NAME ๐ŸŒธ

wpaperd-output โ€” the format wpaperd uses to define the various displays ๐Ÿซถ


โœจ DESCRIPTION โœจ

the wpaperd config file is where all the display gossip lives: every display, its corresponding wallpaper, and all its settings ๐ŸŽ€. this file sits at XDG_CONFIG_HOME/wpaperd/config.toml, which defaults to $HOME/.config/wpaperd/config.toml. no cap, that's the one ๐Ÿ’…


๐Ÿฆ‹ SYNTAX ๐Ÿฆ‹

it's a simple TOML configuration, divided into sections โ€” one section per display. that's it, that's the vibe โญ

๐ŸŽ€ SECTION ๐ŸŽ€

each section is named after the display identifier ๐Ÿ‘‘. need to find yours?

if you're on sway, look up the output identifier by calling:

$ swaymsg -t get_outputs

on Hyprland, you do it with:

$ hyprctl monitors

the config file for wpaperd lives in XDG_CONFIG_HOME/wpaperd/config.toml (which defaults to ~/.config/wpaperd/config.toml) ๐Ÿ“. each section = a different display, and it can contain these keys:

  • path โ€” the path to the image you wanna use as wallpaper, or a path to a directory to pick the wallpaper from ๐Ÿ–ผ๏ธ
  • duration โ€” how much time the image should be displayed until it gets changed for a new one โณ. it supports a human format for declaring the duration (e.g. 30s or 10m), described [here](https://docs.rs/humantime/latest/humantime/fn.parse_duration.html). this is only valid when path points to a directory. (Optional)
  • sorting โ€” choose the sorting order. valid options are ascending, descending, and random, and the default is random ๐ŸŽฒ. this is only valid when path points to a directory. (Optional)
  • mode โ€” choose how to display the wallpaper when the size is different than the display resolution:
    • fit โ€” shows the entire image with black corners covering the empty space left ๐Ÿ–ค
    • center โ€” centers the image on the screen, leaving out the corners of the image that couldn't fit ๐ŸŽฏ
    • stretch โ€” shows the entire image stretching it to fit the entire screen without leaving any black corners, changing the aspect ratio ๐Ÿ˜ฎโ€๐Ÿ’จ
    • tile โ€” shows the image multiple times horizontally and vertically to fill the screen ๐Ÿงฉ
  • transition_time โ€” how many milliseconds the transition should run for. (Optional, 300 by default)
  • queue_size โ€” decide how big the queue should be when path is set to a directory and sorting is set to random. (Optional, 10 by default)
  • initial_transition โ€” whether or not to transition from the initial black screen. (Optional, true by default)

๐Ÿ’œ DEFAULT SECTION ๐Ÿ’œ

okay this part is so good, listen:

the section "default" gets used as the base for all the display configurations ๐Ÿซถ. and the section "any" gets used for all the displays that are not explicitly listed. so you get a flexible config without repeating any settings โ€” literally so efficient, we love to see it โœจ. wpaperd checks the configuration at startup and each time it changes, and it will provide help when it's incorrect ๐Ÿ™ (it's got your back).


๐Ÿ”ฅ EXAMPLE ๐Ÿ”ฅ

the simplest configuration looks like this:

[DP-3]
path = "/home/danyspin97/github_octupus.png"

[DP-4]
path = "/home/danyspin97/Wallpapers"
duration = "30m"

and a more complex configuration is also possible ๐Ÿ‘€:

[default]
duration = "30m"
mode = "center"
sorting = "ascending"

[any]
path = "/home/danyspin97/default_wallpaper.png"

[DP-3]
path = "/home/danyspin97/Wallpapers"

๐Ÿ‘‘ AUTHOR ๐Ÿ‘‘

maintained by Danilo Spinella <danilo.spinella@suse.com> ๐Ÿ’Œ


fr fr, double-check your path values before you @ me โ€” wpaperd will help you out at startup if something's off, but nobody wants a broken vibe check ๐Ÿ˜ญ

that's the whole page, bestie! ๐ŸŽ€ this one's from the wpaperd-output(5) File Formats Manual, dated 2026-06-24 โ€” go forth and make your desktop absolutely iconic ๐ŸŒˆ๐Ÿ’–๐Ÿฆ‹

๐Ÿ“ฆ where this page comes from