Merge branch 'master' into master

This commit is contained in:
Marc Radau
2020-04-16 14:43:10 +02:00
committed by GitHub
43 changed files with 142 additions and 35 deletions

View File

@ -10,29 +10,29 @@ The *backlight* module displays the current backlight level.
# CONFIGURATION
*interval* ++
*interval*: ++
typeof: integer ++
default: 2 ++
The interval in which information gets polled.
*format* ++
*format*: ++
typeof: string ++
default: {percent}% ++
The format, how information should be displayed. On {} data gets inserted.
*max-length* ++
*max-length*: ++
typeof: integer ++
The maximum length in characters the module should display.
*rotate* ++
*rotate*: ++
typeof: integer ++
Positive value to rotate the text label.
*states* ++
*states*: ++
typeof: array ++
A number of backlight states which get activated on certain brightness levels.
*on-click* ++
*on-click*: ++
typeof: string ++
Command to execute when the module is clicked.
@ -40,19 +40,23 @@ The *backlight* module displays the current backlight level.
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
*on-click-right* ++
*on-click-right*: ++
typeof: string ++
Command to execute when the module is right clicked.
*on-scroll-up* ++
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
*on-scroll-up*: ++
typeof: string ++
Command to execute when performing a scroll up on the module.
*on-scroll-down* ++
*on-scroll-down*: ++
typeof: string
Command to execute when performing a scroll down on the module.
*smooth-scrolling-threshold* ++
*smooth-scrolling-threshold*: ++
typeof: double
Threshold to be used when scrolling.

View File

@ -10,33 +10,33 @@ The *battery* module displays the current capacity and state (eg. charging) of y
# CONFIGURATION
*bat* ++
*bat*: ++
typeof: string ++
The battery to monitor, as in /sys/class/power_supply/ instead of auto detect.
*adapter* ++
*adapter*: ++
typeof: string ++
The adapter to monitor, as in /sys/class/power_supply/ instead of auto detect.
*full-at* ++
*full-at*: ++
typeof: integer ++
Define the max percentage of the battery, usefull for an old battery, e.g. 96
*interval* ++
*interval*: ++
typeof: integer ++
default: 60 ++
The interval in which the information gets polled.
*states* ++
*states*: ++
typeof: array ++
A number of battery states which get activated on certain capacity levels. See *waybar-states(5)*.
*format* ++
*format*: ++
typeof: string ++
default: {capacity}% ++
The format, how the time should be displayed.
*format-time* ++
*format-time*: ++
typeof: string ++
default: {H} h {M} min ++
The format, how the time should be displayed.
@ -62,10 +62,14 @@ The *battery* module displays the current capacity and state (eg. charging) of y
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
*on-click-right* ++
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
*on-scroll-up*: ++
typeof: string ++
Command to execute when scrolling up on the module.
@ -74,11 +78,11 @@ The *battery* module displays the current capacity and state (eg. charging) of y
typeof: string ++
Command to execute when scrolling down on the module.
*smooth-scrolling-threshold* ++
*smooth-scrolling-threshold*: ++
typeof: double ++
Threshold to be used when scrolling.
*tooltip* ++
*tooltip*: ++
typeof: bool ++
default: true ++
Option to disable tooltip on hover.

View File

@ -51,6 +51,10 @@ The *clock* module displays the current date and time.
typeof: string ++
Command to execute when you right clicked on the module.
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
*on-scroll-up*: ++
typeof: string ++
Command to execute when scrolling up on the module.

View File

@ -44,6 +44,10 @@ The *cpu* module displays the current cpu utilization.
typeof: string ++
Command to execute when you right clicked on the module.
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
*on-scroll-up*: ++
typeof: string ++
Command to execute when scrolling up on the module.

View File

@ -73,6 +73,10 @@ Addressed by *custom/<name>*
typeof: string ++
Command to execute when you right clicked on the module.
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
*on-scroll-up*: ++
typeof: string ++
Command to execute when scrolling up on the module.

View File

@ -47,6 +47,10 @@ Addressed by *disk*
typeof: string ++
Command to execute when you right clicked on the module.
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
*on-scroll-up*: ++
typeof: string ++
Command to execute when scrolling up on the module.

View File

@ -39,6 +39,10 @@ screensaving, also known as "presentation mode".
typeof: string ++
Command to execute when you right clicked on the module.
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
*on-scroll-up*: ++
typeof: string ++
Command to execute when scrolling up on the module.

View File

@ -46,6 +46,10 @@ Addressed by *memory*
typeof: string ++
Command to execute when you right clicked on the module.
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
*on-scroll-up*: ++
typeof: string ++
Command to execute when scrolling up on the module.

View File

@ -89,6 +89,10 @@ Addressed by *mpd*
typeof: string ++
Command to execute when you right clicked on the module.
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
*on-scroll-up*: ++
typeof: string ++
Command to execute when scrolling up on the module.

View File

@ -76,6 +76,10 @@ Addressed by *network*
typeof: string ++
Command to execute when you right clicked on the module.
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
*on-scroll-up*: ++
typeof: string ++
Command to execute when scrolling up on the module.

View File

@ -67,6 +67,10 @@ Additionally you can control the volume by scrolling *up* or *down* while the cu
typeof: string ++
Command to execute when you right clicked on the module.
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
*on-scroll-up*: ++
typeof: string ++
Command to execute when scrolling up on the module. This replaces the default behaviour of volume control.

View File

@ -37,6 +37,10 @@ Addressed by *sway/mode*
typeof: string ++
Command to execute when you right clicked on the module.
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
*on-scroll-up*: ++
typeof: string ++
Command to execute when scrolling up on the module.

View File

@ -37,6 +37,10 @@ Addressed by *sway/window*
typeof: string ++
Command to execute when you right clicked on the module.
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
*on-scroll-up*: ++
typeof: string ++
Command to execute when scrolling up on the module.

View File

@ -19,7 +19,7 @@ Addressed by *sway/workspaces*
*format*: ++
typeof: string ++
default: {name} ++
default: {value} ++
The format, how information should be displayed.
*format-icons*: ++
@ -60,9 +60,15 @@ Addressed by *sway/workspaces*
default: empty ++
Lists workspaces that should always be shown, even when non existent
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
# FORMAT REPLACEMENTS
*{name}*: Name of the workspace, as defined by sway.
*{value}*: Name of the workspace, as defined by sway.
*{name}*: Number stripped from workspace value.
*{icon}*: Icon, as defined in *format-icons*.

View File

@ -70,6 +70,10 @@ Addressed by *temperature*
typeof: string ++
Command to execute when you right clicked on the module.
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
*on-scroll-up*: ++
typeof: string ++
Command to execute when scrolling up on the module.

View File

@ -20,6 +20,10 @@ Addressed by *tray*
typeof: integer ++
Defines the spacing between the tray icons.
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
# EXAMPLES
```