.\" 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-mpd" "5" "2024-09-15"
.PP
.SH NAME
.PP
waybar - mpd module
.PP
.SH DESCRIPTION
.PP
The \fBmpd\fR module displays information about a running "Music Player Daemon" instance.\&
.PP
.SH CONFIGURATION
.PP
Addressed by \fBmpd\fR
.PP
\fBserver\fR: 
.br
	typeof: string 
.br
	The network address or Unix socket path of the MPD server.\& If empty, connect to the default host.\&
.PP
\fBport\fR: 
.br
	typeof: integer 
.br
	The port MPD listens to.\& If empty, use the default port.\&
.PP
\fBpassword\fR: 
.br
	typeof: string 
.br
	The password required to connect to the MPD server.\& If empty, no password is sent to MPD.\&
.PP
\fBinterval\fR: 
.br
	typeof: integer
.br
	default: 5 
.br
	The interval in which the connection to the MPD server is retried
.PP
\fBtimeout\fR: 
.br
	typeof: integer
.br
	default: 30 
.br
	The timeout for the connection.\& Change this if your MPD server has a low `connection_timeout` setting
.PP
\fBunknown-tag\fR: 
.br
	typeof: string 
.br
	default: "N/A" 
.br
	The text to display when a tag is not present in the current song, but used in `format`
.PP
\fBformat\fR: 
.br
	typeof: string 
.br
	default: "{album} - {artist} - {title}" 
.br
	Information displayed when a song is playing.\&
.PP
\fBformat-stopped\fR: 
.br
	typeof: string 
.br
	default: "stopped" 
.br
	Information displayed when the player is stopped.\&
.PP
\fBformat-paused\fR: 
.br
	typeof: string 
.br
	This format is used when a song is paused.\&
.PP
\fBformat-disconnected\fR: 
.br
	typeof: string 
.br
	default: "disconnected" 
.br
	Information displayed when the MPD server can'\&t be reached.\&
.PP
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Option to disable tooltip on hover.\&
.PP
\fBtooltip-format\fR: 
.br
	typeof: string 
.br
	default: "MPD (connected)" 
.br
	Tooltip information displayed when connected to MPD.\&
.PP
\fBtooltip-format-disconnected\fR: 
.br
	typeof: string 
.br
	default: "MPD (disconnected)" 
.br
	Tooltip information displayed when the MPD server can'\&t be reached.\&
.PP
\fBartist-len\fR: 
.br
	typeof: integer 
.br
	Maximum length of the Artist tag.\&
.PP
\fBalbum-len\fR: 
.br
	typeof: integer 
.br
	Maximum length of the Album tag.\&
.PP
\fBalbum-artist-len\fR: 
.br
	typeof: integer 
.br
	Maximum length of the Album Artist tag.\&
.PP
\fBtitle-len\fR: 
.br
	typeof: integer 
.br
	Maximum length of the Title tag.\&
.PP
\fBrotate\fR: 
.br
	typeof: integer 
.br
	Positive value to rotate the text label.\&
.PP
\fBmax-length\fR: 
.br
	typeof: integer 
.br
	The maximum length in character the module should display.\&
.PP
\fBmin-length\fR: 
.br
	typeof: integer 
.br
	The minimum length in characters the module should accept.\&
.PP
\fBalign\fR: 
.br
	typeof: float 
.br
	The alignment of the label within the module, where 0 is left-aligned and 1 is right-aligned.\& If the module is rotated, it will follow the flow of the text.\&
.PP
\fBjustify\fR: 
.br
	typeof: string 
.br
	The alignment of the text within the module'\&s label, allowing options '\&left'\&, '\&right'\&, or '\&center'\& to define the positioning.\&
.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-click-right\fR: 
.br
	typeof: string 
.br
	Command to execute when you right-click on the module.\&
.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
\fBstate-icons\fR: 
.br
	typeof: object 
.br
	default: {} 
.br
	Icon to show depending on the play/pause state of the player (\fB{ "playing": ".\&.\&.\&", "paused": ".\&.\&.\&" }\fR)
.PP
\fBconsume-icons\fR: 
.br
	typeof: object 
.br
	default: {} 
.br
	Icon to show depending on the "consume" option (\fB{ "on": ".\&.\&.\&", "off": ".\&.\&.\&" }\fR)
.PP
\fBrandom-icons\fR: 
.br
	typeof: object 
.br
	default: {} 
.br
	Icon to show depending on the "random" option (\fB{ "on": ".\&.\&.\&", "off": ".\&.\&.\&" }\fR)
.PP
\fBrepeat-icons\fR: 
.br
	typeof: object 
.br
	default: {} 
.br
	Icon to show depending on the "repeat" option (\fB{ "on": ".\&.\&.\&", "off": ".\&.\&.\&" }\fR)
.PP
\fBsingle-icons\fR: 
.br
	typeof: object 
.br
	default: {} 
.br
	Icon to show depending on the "single" option (\fB{ "on": ".\&.\&.\&", "off": ".\&.\&.\&" }\fR)
.PP
\fBmenu\fR: 
.br
	typeof: string 
.br
	Action that popups the menu.\&
.PP
\fBmenu-file\fR: 
.br
	typeof: string 
.br
	Location of the menu descriptor file.\& There need to be an element of type
.RS 4
GtkMenu with id \fBmenu\fR
.PP
.RE
\fBmenu-actions\fR: 
.br
	typeof: array 
.br
	The actions corresponding to the buttons of the menu.\&
.PP
.SH FORMAT REPLACEMENTS
.PP
.SS WHEN PLAYING/PAUSED
.PP
\fB{artist}\fR: The artist of the current song
.PP
\fB{albumArtist}\fR: The artist of the current album
.PP
\fB{album}\fR: The album of the current song
.PP
\fB{title}\fR: The title of the current song
.PP
\fB{date}\fR: The date of the current song
.PP
\fB{volume}\fR: The current volume in percent
.PP
\fB{elapsedTime}\fR: The current position of the current song.\& To format as a date/time (see example configuration)
.PP
\fB{totalTime}\fR: The length of the current song.\& To format as a date/time (see example configuration)
.PP
\fB{songPosition}\fR: The position of the current song.\&
.PP
\fB{queueLength}\fR: The length of the current queue.\&
.PP
\fB{stateIcon}\fR: The icon corresponding to the playing or paused status of the player (see \fBstate-icons\fR option)
.PP
\fB{consumeIcon}\fR: The icon corresponding the "consume" option (see \fBconsume-icons\fR option)
.PP
\fB{randomIcon}\fR: The icon corresponding the "random" option (see \fBrandom-icons\fR option)
.PP
\fB{repeatIcon}\fR: The icon corresponding the "repeat" option (see \fBrepeat-icons\fR option)
.PP
\fB{singleIcon}\fR: The icon corresponding the "single" option (see \fBsingle-icons\fR option)
.PP
.PP
.SS WHEN STOPPED
.PP
\fB{consumeIcon}\fR: The icon corresponding the "consume" option (see \fBconsume-icons\fR option)
.PP
\fB{randomIcon}\fR: The icon corresponding the "random" option (see \fBrandom-icons\fR option)
.PP
\fB{repeatIcon}\fR: The icon corresponding the "repeat" option (see \fBrepeat-icons\fR option)
.PP
\fB{singleIcon}\fR: The icon corresponding the "single" option (see \fBsingle-icons\fR option)
.PP
.SS WHEN DISCONNECTED
.PP
Currently, no format replacements when disconnected.\&
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"mpd": {
	"format": "{stateIcon} {consumeIcon}{randomIcon}{repeatIcon}{singleIcon}{artist} - {album} - {title} ({elapsedTime:%M:%S}/{totalTime:%M:%S}) ",
	"format-disconnected": "Disconnected ",
	"format-stopped": "{consumeIcon}{randomIcon}{repeatIcon}{singleIcon}Stopped ",
	"interval": 2,
	"consume-icons": {
		"on": " " // Icon shows only when "consume" is on
	},
	"random-icons": {
		"off": "<span color="#f53c3c"></span> ", // Icon grayed out when "random" is off
		"on": " "
	},
	"repeat-icons": {
		"on": " "
	},
	"single-icons": {
		"on": "1 "
	},
	"state-icons": {
		"paused": "",
		"playing": ""
	},
	"tooltip-format": "MPD (connected)",
	"tooltip-format-disconnected": "MPD (disconnected)"
}
.fi
.RE
.PP
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#mpd\fR
.IP \(bu 4
\fB#mpd.\&disconnected\fR
.IP \(bu 4
\fB#mpd.\&stopped\fR
.IP \(bu 4
\fB#mpd.\&playing\fR
.IP \(bu 4
\fB#mpd.\&paused\fR