.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "wpaperd-output" "5" "2025-04-11"
.PP
.SH NAME
.PP
wpaperd-output - format used by wpaperd to define the various displays
.PP
.SH DESCRIPTION
.PP
The wpaperd configuration file contains the information about each display, the corresponding
wallpaper and its settings.\& This file is located in XDG_CONFIG_HOME/wpaperd/config.\&toml
(which defaults to $HOME/.\&config/wpaperd/config.\&toml).\&
.PP
.SH SYNTAX
.PP
This file is a simple TOML configuration divided in sections, one for each display.\&
.PP
.SS SECTION
.PP
Each section is named after the display identifier.\& If you are using \fIsway\fR, you can lookup
the output identifier by calling:
.PP
.nf
.RS 4
$ swaymsg -t get_outputs
.fi
.RE
.PP
On Hyprland, you can do it with:
.PP
.nf
.RS 4
$ hyprctl monitors
.fi
.RE
.PP
The configuration file for \fBwpaperd\fR is located in `XDG_CONFIG_HOME/wpaperd/config.\&toml`
(which defaults to `~/.\&config/wpaperd/config.\&toml`).\& Each section
represents a different display and can contain the following keys:
.PP
.PD 0
.IP \(bu 4
`path`, path to the image to use as wallpaper or to a directory to pick the wallpaper from
.IP \(bu 4
`duration`, how much time the image should be displayed until it is changed with 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.\& (\fIOptional\fR)
.IP \(bu 4
`sorting`, choose the sorting order.\& Valid options are `ascending`, `descending`, and `random`,
with the default being `random`.\& This is only valid when path points to a directory.\& (\fIOptional\fR)
.IP \(bu 4
`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 corner, changing the aspect ratio
- `tile` shows the image multiple times horizontally and vertically to fill the screen
.IP \(bu 4
`transition_time`, how many milliseconds should the transition run.\& (\fIOptional\fR, `300` by default).\&
.IP \(bu 4
`queue_size`, decide how big the queue should be when `path` is set a directory and `sorting` is
 set to `random`.\& (\fIOptional\fR, `10` by default)
.IP \(bu 4
`initial_transition`, whether or not to transition from the initial black screen (\fIOptional\fR, `true` by default)

.PD
.PP
.SS DEFAULT SECTION
.PP
The section "\fBdefault\fR" will be used as base for the all the display configuration; the section
"\fBany\fR" will be used for all the displays that are not explictly listed.\& This allows to have a
flexible configuration without repeating any settings.\& \fIwpaperd\fR will check the configuration at
startup and each time it changes and provide help when it is incorrect.\&
.PP
.SH EXAMPLE
.PP
The simplest configuration looks like this:
.PP
.nf
.RS 4
[DP-3]
path = "/home/danyspin97/github_octupus\&.png"

[DP-4]
path = "/home/danyspin97/Wallpapers"
duration = "30m"
.fi
.RE
.PP
A more complex configuration is also possible:
.PP
.nf
.RS 4
[default]
duration = "30m"
mode = "center"
sorting = "ascending"

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

[DP-3]
path = "/home/danyspin97/Wallpapers"
.fi
.RE
.PP
.SH AUTHOR
Maintained by Danilo Spinella <danilo.\&spinella@suse.\&com>.\&