From ac461f38f47f433420142ceaab0a00f1074e9520 Mon Sep 17 00:00:00 2001 From: Michael Aquilina Date: Mon, 26 Aug 2019 15:23:07 +0100 Subject: [PATCH] Add waybar-mpd(5) --- man/waybar-mpd.5.scd | 200 +++++++++++++++++++++++++++++++++++++++++++ meson.build | 1 + 2 files changed, 201 insertions(+) create mode 100644 man/waybar-mpd.5.scd diff --git a/man/waybar-mpd.5.scd b/man/waybar-mpd.5.scd new file mode 100644 index 00000000..621691b0 --- /dev/null +++ b/man/waybar-mpd.5.scd @@ -0,0 +1,200 @@ +waybar-mpd(5) + +# NAME + +waybar - mpd module + +# DESCRIPTION + +The *mpd* module displays the current date and time. + +# CONFIGURATION + +Addressed by *mpd* + +*server*: ++ + typeof: string ++ + The network address or Unix socket path of the MPD server. If empty, connect to the default host. + +*port*: ++ + typeof: integer ++ + The port MPD listens to. If empty, use the default port. + +*interval*: ++ + typeof: integer++ + default: 5 ++ + The interval in which the connection to the MPD server is retried + +*timeout*: ++ + typeof: integer++ + default: 30 ++ + The timeout for the connection. Change this if your MPD server has a low `connection_timeout` setting + +*unknown-tag*: ++ + typeof: string ++ + default: "N/A" ++ + The text to display when a tag is not present in the current song, but used in `format` + +*format*: ++ + typeof: string ++ + default: "{album} - {artist} - {title}" ++ + Information displayed when a song is playing or paused + +*format-stopped*: ++ + typeof: string ++ + default: "stopped" ++ + Information displayed when the player is stopped. + +*format-disconnected*: ++ + typeof: string ++ + default: "disconnected" ++ + Information displayed when the MPD server can't be reached. + +*tooltip*: ++ + typeof: bool ++ + default: true ++ + Option to disable tooltip on hover. + +*tooltip-format*: ++ + typeof: string ++ + default: "MPD (connected)" ++ + Tooltip information displayed when connected to MPD. + +*tooltip-format-disconnected*: ++ + typeof: string ++ + default: "MPD (disconnected)" ++ + Tooltip information displayed when the MPD server can't be reached. + +*rotate*: ++ + typeof: integer ++ + Positive value to rotate the text label. + +*max-length*: ++ + typeof: integer ++ + The maximum length in character the module should display. + +*on-click*: ++ + typeof: string ++ + Command to execute when clicked on the module. + +*on-click-right*: ++ + typeof: string ++ + Command to execute when you right clicked on the module. + +*on-scroll-up*: ++ + typeof: string ++ + Command to execute when scrolling up on the module. + +*on-scroll-down*: ++ + typeof: string ++ + Command to execute when scrolling down on the module. + +*smooth-scrolling-threshold*: ++ + typeof: double ++ + Threshold to be used when scrolling. + +*state-icons*: ++ + typeof: object ++ + default: {} ++ + Icon to show depending on the play/pause state of the player (*{ "playing": "...", "paused": "..." }*) + +*consume-icons*: ++ + typeof: object ++ + default: {} ++ + Icon to show depending on the "consume" option (*{ "on": "...", "off": "..." }*) + +*random-icons*: ++ + typeof: object ++ + default: {} ++ + Icon to show depending on the "random" option (*{ "on": "...", "off": "..." }*) + +*repeat-icons*: ++ + typeof: object ++ + default: {} ++ + Icon to show depending on the "repeat" option (*{ "on": "...", "off": "..." }*) + +*single-icons*: ++ + typeof: object ++ + default: {} ++ + Icon to show depending on the "single" option (*{ "on": "...", "off": "..." }*) + +# FORMAT REPLACEMENTS + +## WHEN PLAYING/PAUSED + +*{artist}*: The artist of the current song + +*{albumArtist}*: The artist of the current album + +*{album}*: The album of the current song + +*{title}*: The title of the current song + +*{date}*: The date of the current song + +*{elapsedTime}*: The current position of the current song. To format as a date/time (see example configuration) + +*{totalTime}*: The length of the current song. To format as a date/time (see example configuration) + +*{stateIcon}*: The icon corresponding the playing or paused status of the player (see *state-icons* option) + +*{consumeIcon}*: The icon corresponding the "consume" option (see *consume-icons* option) + +*{randomIcon}*: The icon corresponding the "random" option (see *random-icons* option) + +*{repeatIcon}*: The icon corresponding the "repeat" option (see *repeat-icons* option) + +*{singleIcon}*: The icon corresponding the "single" option (see *single-icons* option) + + +## WHEN STOPPED + +*{consumeIcon}*: The icon corresponding the "consume" option (see *consume-icons* option) + +*{randomIcon}*: The icon corresponding the "random" option (see *random-icons* option) + +*{repeatIcon}*: The icon corresponding the "repeat" option (see *repeat-icons* option) + +*{singleIcon}*: The icon corresponding the "single" option (see *single-icons* option) + +## WHEN DISCONNECTED + +Currently, no format replacements when disconnected. + +# EXAMPLES + +``` +"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)" +} +``` + +# STYLE + +- *#mpd* +- *#mpd.disconnected* +- *#mpd.stopped* +- *#mpd.playing* +- *#mpd.paused* diff --git a/meson.build b/meson.build index ebe91df4..86d266f1 100644 --- a/meson.build +++ b/meson.build @@ -168,6 +168,7 @@ if scdoc.found() 'waybar-custom.5.scd', 'waybar-idle-inhibitor.5.scd', 'waybar-memory.5.scd', + 'waybar-mpd.5.scd', ] foreach filename : man_files