Update waybar-mpd.5.scd

This commit is contained in:
fuzxi 2019-12-28 20:14:33 -08:00 committed by Alex
parent f6864e4a43
commit c41cedd407
1 changed files with 64 additions and 60 deletions

View File

@ -13,110 +13,114 @@ The *mpd* module displays information about a running "Music Player Daemon" inst
Addressed by *mpd* Addressed by *mpd*
*server*: ++ *server*: ++
typeof: string ++ typeof: string ++
The network address or Unix socket path of the MPD server. If empty, connect to the default host. The network address or Unix socket path of the MPD server. If empty, connect to the default host.
*port*: ++ *port*: ++
typeof: integer ++ typeof: integer ++
The port MPD listens to. If empty, use the default port. The port MPD listens to. If empty, use the default port.
*interval*: ++ *interval*: ++
typeof: integer++ typeof: integer++
default: 5 ++ default: 5 ++
The interval in which the connection to the MPD server is retried The interval in which the connection to the MPD server is retried
*timeout*: ++ *timeout*: ++
typeof: integer++ typeof: integer++
default: 30 ++ default: 30 ++
The timeout for the connection. Change this if your MPD server has a low `connection_timeout` setting The timeout for the connection. Change this if your MPD server has a low `connection_timeout` setting
*unknown-tag*: ++ *unknown-tag*: ++
typeof: string ++ typeof: string ++
default: "N/A" ++ default: "N/A" ++
The text to display when a tag is not present in the current song, but used in `format` The text to display when a tag is not present in the current song, but used in `format`
*format*: ++ *format*: ++
typeof: string ++ typeof: string ++
default: "{album} - {artist} - {title}" ++ default: "{album} - {artist} - {title}" ++
Information displayed when a song is playing or paused Information displayed when a song is playing or paused
*format-stopped*: ++ *format-stopped*: ++
typeof: string ++ typeof: string ++
default: "stopped" ++ default: "stopped" ++
Information displayed when the player is stopped. Information displayed when the player is stopped.
*format-disconnected*: ++ *format-disconnected*: ++
typeof: string ++ typeof: string ++
default: "disconnected" ++ default: "disconnected" ++
Information displayed when the MPD server can't be reached. Information displayed when the MPD server can't be reached.
*tooltip*: ++ *tooltip*: ++
typeof: bool ++ typeof: bool ++
default: true ++ default: true ++
Option to disable tooltip on hover. Option to disable tooltip on hover.
*tooltip-format*: ++ *tooltip-format*: ++
typeof: string ++ typeof: string ++
default: "MPD (connected)" ++ default: "MPD (connected)" ++
Tooltip information displayed when connected to MPD. Tooltip information displayed when connected to MPD.
*tooltip-format-disconnected*: ++ *tooltip-format-disconnected*: ++
typeof: string ++ typeof: string ++
default: "MPD (disconnected)" ++ default: "MPD (disconnected)" ++
Tooltip information displayed when the MPD server can't be reached. Tooltip information displayed when the MPD server can't be reached.
*rotate*: ++ *rotate*: ++
typeof: integer ++ typeof: integer ++
Positive value to rotate the text label. Positive value to rotate the text label.
*max-length*: ++ *max-length*: ++
typeof: integer ++ typeof: integer ++
The maximum length in character the module should display. The maximum length in character the module should display.
*on-click*: ++ *on-click*: ++
typeof: string ++ typeof: string ++
Command to execute when clicked on the module. Command to execute when clicked on the module.
*on-click-middle*: ++
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
*on-click-right*: ++ *on-click-right*: ++
typeof: string ++ typeof: string ++
Command to execute when you right clicked on the module. Command to execute when you right clicked on the module.
*on-scroll-up*: ++ *on-scroll-up*: ++
typeof: string ++ typeof: string ++
Command to execute when scrolling up on the module. Command to execute when scrolling up on the module.
*on-scroll-down*: ++ *on-scroll-down*: ++
typeof: string ++ typeof: string ++
Command to execute when scrolling down on the module. Command to execute when scrolling down on the module.
*smooth-scrolling-threshold*: ++ *smooth-scrolling-threshold*: ++
typeof: double ++ typeof: double ++
Threshold to be used when scrolling. Threshold to be used when scrolling.
*state-icons*: ++ *state-icons*: ++
typeof: object ++ typeof: object ++
default: {} ++ default: {} ++
Icon to show depending on the play/pause state of the player (*{ "playing": "...", "paused": "..." }*) Icon to show depending on the play/pause state of the player (*{ "playing": "...", "paused": "..." }*)
*consume-icons*: ++ *consume-icons*: ++
typeof: object ++ typeof: object ++
default: {} ++ default: {} ++
Icon to show depending on the "consume" option (*{ "on": "...", "off": "..." }*) Icon to show depending on the "consume" option (*{ "on": "...", "off": "..." }*)
*random-icons*: ++ *random-icons*: ++
typeof: object ++ typeof: object ++
default: {} ++ default: {} ++
Icon to show depending on the "random" option (*{ "on": "...", "off": "..." }*) Icon to show depending on the "random" option (*{ "on": "...", "off": "..." }*)
*repeat-icons*: ++ *repeat-icons*: ++
typeof: object ++ typeof: object ++
default: {} ++ default: {} ++
Icon to show depending on the "repeat" option (*{ "on": "...", "off": "..." }*) Icon to show depending on the "repeat" option (*{ "on": "...", "off": "..." }*)
*single-icons*: ++ *single-icons*: ++
typeof: object ++ typeof: object ++
default: {} ++ default: {} ++
Icon to show depending on the "single" option (*{ "on": "...", "off": "..." }*) Icon to show depending on the "single" option (*{ "on": "...", "off": "..." }*)
# FORMAT REPLACEMENTS # FORMAT REPLACEMENTS