.\" Generated by scdoc 1.10.0 .ie \n(.g .ds Aq \(aq .el .ds Aq ' .nh .ad l .\" Begin generated content: .TH "waybar-mpd" "5" "2019-12-31" .P .SH NAME .P waybar - mpd module .P .SH DESCRIPTION .P The \fBmpd\fR module displays information about a running "Music Player Daemon" instance. .P .SH CONFIGURATION .P Addressed by \fBmpd\fR .P \fBserver\fR: .br typeof: string .br The network address or Unix socket path of the MPD server. If empty, connect to the default host. .P \fBport\fR: .br typeof: integer .br The port MPD listens to. If empty, use the default port. .P \fBinterval\fR: .br typeof: integer .br default: 5 .br The interval in which the connection to the MPD server is retried .P \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 .P \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` .P \fBformat\fR: .br typeof: string .br default: "{album} - {artist} - {title}" .br Information displayed when a song is playing or paused .P \fBformat-stopped\fR: .br typeof: string .br default: "stopped" .br Information displayed when the player is stopped. .P \fBformat-disconnected\fR: .br typeof: string .br default: "disconnected" .br Information displayed when the MPD server can't be reached. .P \fBtooltip\fR: .br typeof: bool .br default: true .br Option to disable tooltip on hover. .P \fBtooltip-format\fR: .br typeof: string .br default: "MPD (connected)" .br Tooltip information displayed when connected to MPD. .P \fBtooltip-format-disconnected\fR: .br typeof: string .br default: "MPD (disconnected)" .br Tooltip information displayed when the MPD server can't be reached. .P \fBrotate\fR: .br typeof: integer .br Positive value to rotate the text label. .P \fBmax-length\fR: .br typeof: integer .br The maximum length in character the module should display. .P \fBon-click\fR: .br typeof: string .br Command to execute when clicked on the module. .P \fBon-click-right\fR: .br typeof: string .br Command to execute when you right clicked on the module. .P \fBon-scroll-up\fR: .br typeof: string .br Command to execute when scrolling up on the module. .P \fBon-scroll-down\fR: .br typeof: string .br Command to execute when scrolling down on the module. .P \fBsmooth-scrolling-threshold\fR: .br typeof: double .br Threshold to be used when scrolling. .P \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) .P \fBconsume-icons\fR: .br typeof: object .br default: {} .br Icon to show depending on the "consume" option (\fB{ "on": "...", "off": "..." }\fR) .P \fBrandom-icons\fR: .br typeof: object .br default: {} .br Icon to show depending on the "random" option (\fB{ "on": "...", "off": "..." }\fR) .P \fBrepeat-icons\fR: .br typeof: object .br default: {} .br Icon to show depending on the "repeat" option (\fB{ "on": "...", "off": "..." }\fR) .P \fBsingle-icons\fR: .br typeof: object .br default: {} .br Icon to show depending on the "single" option (\fB{ "on": "...", "off": "..." }\fR) .P .SH FORMAT REPLACEMENTS .P .SS WHEN PLAYING/PAUSED .P \fB{artist}\fR: The artist of the current song .P \fB{albumArtist}\fR: The artist of the current album .P \fB{album}\fR: The album of the current song .P \fB{title}\fR: The title of the current song .P \fB{date}\fR: The date of the current song .P \fB{elapsedTime}\fR: The current position of the current song. To format as a date/time (see example configuration) .P \fB{totalTime}\fR: The length of the current song. To format as a date/time (see example configuration) .P \fB{stateIcon}\fR: The icon corresponding the playing or paused status of the player (see \fBstate-icons\fR option) .P \fB{consumeIcon}\fR: The icon corresponding the "consume" option (see \fBconsume-icons\fR option) .P \fB{randomIcon}\fR: The icon corresponding the "random" option (see \fBrandom-icons\fR option) .P \fB{repeatIcon}\fR: The icon corresponding the "repeat" option (see \fBrepeat-icons\fR option) .P \fB{singleIcon}\fR: The icon corresponding the "single" option (see \fBsingle-icons\fR option) .P .P .SS WHEN STOPPED .P \fB{consumeIcon}\fR: The icon corresponding the "consume" option (see \fBconsume-icons\fR option) .P \fB{randomIcon}\fR: The icon corresponding the "random" option (see \fBrandom-icons\fR option) .P \fB{repeatIcon}\fR: The icon corresponding the "repeat" option (see \fBrepeat-icons\fR option) .P \fB{singleIcon}\fR: The icon corresponding the "single" option (see \fBsingle-icons\fR option) .P .SS WHEN DISCONNECTED .P Currently, no format replacements when disconnected. .P .SH EXAMPLES .P .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": " ", // 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 .P .SH STYLE .P .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fB#mpd\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fB#mpd.disconnected\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fB#mpd.stopped\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fB#mpd.playing\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fB#mpd.paused\fR .RE