.\" 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 "waybar-image" "5" "2024-09-15"
.PP
.SH NAME
.PP
waybar - image module
.PP
.SH DESCRIPTION
.PP
The \fBimage\fR module displays an image from a path.\&
.PP
.SH CONFIGURATION
.PP
\fBpath\fR: 
.br
	typeof: string 
.br
	The path to the image.\&
.PP
\fBexec\fR: 
.br
	typeof: string 
.br
	The path to the script, which should return image path file.\& 
.br
	It will only execute if the path is not set
.PP
\fBsize\fR: 
.br
	typeof: integer 
.br
	The width/height to render the image.\&
.PP
\fBinterval\fR: 
.br
	typeof: integer 
.br
	The interval (in seconds) to re-render the image.\& 
.br
	This is useful if the contents of \fBpath\fR changes.\& 
.br
	If no \fBinterval\fR is defined, the image will only be rendered once.\&
.PP
\fBsignal\fR: 
.br
	typeof: integer 
.br
	The signal number used to update the module.\& 
.br
	This can be used instead of \fBinterval\fR if the file changes irregularly.\& 
.br
	The number is valid between 1 and N, where \fBSIGRTMIN+N\fR = \fBSIGRTMAX\fR.\&
.PP
\fBon-click\fR: 
.br
	typeof: string 
.br
	Command to execute when clicked on the module.\&
.PP
\fBon-click-middle\fR: 
.br
	typeof: string 
.br
	Command to execute when middle-clicked on the module using mousewheel.\&
.PP
\fBon-update\fR: 
.br
	typeof: string 
.br
	Command to execute when the module is updated.\&
.PP
\fBon-scroll-up\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling up on the module.\&
.PP
\fBon-scroll-down\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling down on the module.\&
.PP
\fBsmooth-scrolling-threshold\fR: 
.br
	typeof: double 
.br
	Threshold to be used when scrolling.\&
.PP
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Option to enable tooltip on hover.\&
.PP
.SH SCRIPT OUTPUT
.PP
Similar to the \fBcustom\fR module, output values of the script are \fBnewline\fR separated.\&
The following is the output format:
.PP
.nf
.RS 4
$path\\n$tooltip
.fi
.RE
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"image#album-art": {
	"path": "/tmp/mpd_art",
	"size": 32,
	"interval": 5,
	"on-click": "mpc toggle"
}
.fi
.RE
.PP
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#image\fR
.IP \(bu 4
\fB#image.\&empty\fR