tobias/waybar
1
0
Fork 0
mirror of https://github.com/rad4day/Waybar.git synced 2023-12-21 10:22:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #529 from fuzxi/master

Browse Source 
[Corrected] Add info on "on-click-middle" option to custom module man page
This commit is contained in:
Alex 2020-01-06 13:37:08 +01:00 committed by GitHub
commit d294352845
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 150 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
man/waybar-backlight.5.scd
View File

@ -36,6 +36,10 @@ The *backlight* module displays the current backlight level.
typeof: string ++ typeof: string ++
Command to execute when the module is clicked. Command to execute when the module is clicked.
*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 the module is right clicked. Command to execute when the module is right clicked.

6
man/waybar-battery.5.scd
View File

@ -54,7 +54,11 @@ The *battery* module displays the current capacity and state (eg. charging) of y
typeof: string ++ typeof: string ++
Command to execute when clicked on the module. Command to execute when clicked on the module.
*on-click-right*: ++ *on-click-middle*: ++
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
*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.

4
man/waybar-clock.5.scd
View File

@ -32,6 +32,10 @@ The *clock* module displays the current date and time.
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.

4
man/waybar-cpu.5.scd
View File

@ -36,6 +36,10 @@ The *cpu* module displays the current cpu utilization.
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.

4
man/waybar-custom.5.scd
View File

@ -59,6 +59,10 @@ Addressed by *custom/<name>*
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.

4
man/waybar-disk.5.scd
View File

@ -39,6 +39,10 @@ Addressed by *disk*
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.

4
man/waybar-idle-inhibitor.5.scd
View File

@ -31,6 +31,10 @@ screensaving, also known as "presentation mode".
typeof: string ++ typeof: string ++
Command to execute when clicked on the module. A click also toggles the state Command to execute when clicked on the module. A click also toggles the state
*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.

4
man/waybar-memory.5.scd
View File

@ -38,6 +38,10 @@ Addressed by *memory*
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.

124
man/waybar-mpd.5.scd
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

4
man/waybar-network.5.scd
View File

@ -64,6 +64,10 @@ Addressed by *network*
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.

4
man/waybar-pulseaudio.5.scd
View File

@ -59,6 +59,10 @@ Additionally you can control the volume by scrolling *up* or *down* while the cu
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.

4
man/waybar-sway-mode.5.scd
View File

@ -29,6 +29,10 @@ Addressed by *sway/mode*
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.

4
man/waybar-sway-window.5.scd
View File

@ -29,6 +29,10 @@ Addressed by *sway/window*
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.

70
man/waybar-temperature.5.scd
View File

@ -13,67 +13,71 @@ The *temperature* module displays the current temperature from a thermal zone.
Addressed by *temperature* Addressed by *temperature*
*thermal-zone*: ++ *thermal-zone*: ++
typeof: integer ++ typeof: integer ++
The thermal zone, as in */sys/class/thermal/*. The thermal zone, as in */sys/class/thermal/*.
*hwmon-path*: ++ *hwmon-path*: ++
typeof: string ++ typeof: string ++
The temperature path to use, e.g. */sys/class/hwmon/hwmon2/temp1_input* instead of one in */sys/class/thermal/*. The temperature path to use, e.g. */sys/class/hwmon/hwmon2/temp1_input* instead of one in */sys/class/thermal/*.
*critical-threshold*: ++ *critical-threshold*: ++
typeof: integer ++ typeof: integer ++
The threshold before it is considered critical (Celcius). The threshold before it is considered critical (Celcius).
*interval*: ++ *interval*: ++
typeof: integer ++ typeof: integer ++
default: 10 ++ default: 10 ++
The interval in which the information gets polled. The interval in which the information gets polled.
*format-critical*: ++ *format-critical*: ++
typeof: string ++ typeof: string ++
The format to use when temperature is considered critical The format to use when temperature is considered critical
*format*: ++ *format*: ++
typeof: string ++ typeof: string ++
default: {temperatureC}°C ++ default: {temperatureC}°C ++
The format (Celcius/Farenheit) in which the temperature should be displayed. The format (Celcius/Farenheit) in which the temperature should be displayed.
*format-icons*: ++ *format-icons*: ++
typeof: array ++ typeof: array ++
Based on the current temperature (Celcius) and *critical-threshold* if available, the corresponding icon gets selected. The order is *low* to *high*. Based on the current temperature (Celcius) and *critical-threshold* if available, the corresponding icon gets selected. The order is *low* to *high*.
*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 characters the module should display. The maximum length in characters the module should display.
*on-click*: ++ *on-click*: ++
typeof: string ++ typeof: string ++
Command to execute when you clicked on the module. Command to execute when you 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.
*tooltip*: ++ *tooltip*: ++
typeof: bool ++ typeof: bool ++
default: true ++ default: true ++
Option to disable tooltip on hover. Option to disable tooltip on hover.
# FORMAT REPLACEMENTS # FORMAT REPLACEMENTS