waybar/man/waybar-backlight.5.scd

93 lines
2.1 KiB
Plaintext
Raw Permalink Normal View History

2019-08-24 16:39:46 +02:00
waybar-backlight(5)
# NAME
waybar - backlight module
# DESCRIPTION
The *backlight* module displays the current backlight level.
2019-08-24 22:46:56 +02:00
# CONFIGURATION
2019-08-24 16:39:46 +02:00
2020-04-12 18:41:44 +02:00
*interval*: ++
2019-08-24 16:39:46 +02:00
typeof: integer ++
default: 2 ++
The interval in which information gets polled.
2020-04-12 18:41:44 +02:00
*format*: ++
2019-08-24 16:39:46 +02:00
typeof: string ++
default: {percent}% ++
The format, how information should be displayed. On {} data gets inserted.
2020-04-12 18:41:44 +02:00
*max-length*: ++
2019-08-24 16:39:46 +02:00
typeof: integer ++
The maximum length in characters the module should display.
2021-02-01 17:34:51 +01:00
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
*align*: ++
typeof: float ++
The alignment of the text, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.
2019-08-24 16:39:46 +02:00
2020-04-12 18:41:44 +02:00
*rotate*: ++
2019-08-24 16:39:46 +02:00
typeof: integer ++
Positive value to rotate the text label.
2020-04-12 18:41:44 +02:00
*states*: ++
2022-11-07 08:30:01 +01:00
typeof: object ++
A number of backlight states which get activated on certain brightness levels. See *waybar-states(5)*.
2019-08-24 16:39:46 +02:00
2020-04-12 18:41:44 +02:00
*on-click*: ++
2019-08-24 16:39:46 +02:00
typeof: string ++
Command to execute when the module is clicked.
2019-12-29 05:19:11 +01:00
*on-click-middle*: ++
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
2020-04-12 18:35:41 +02:00
*on-click-right*: ++
2019-08-24 16:39:46 +02:00
typeof: string ++
Command to execute when the module is right clicked.
2020-04-12 18:35:41 +02:00
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
2020-04-12 18:41:44 +02:00
*on-scroll-up*: ++
2019-08-24 16:39:46 +02:00
typeof: string ++
Command to execute when performing a scroll up on the module. This replaces the default behaviour of brightness control.
2019-08-24 16:39:46 +02:00
2020-04-12 18:41:44 +02:00
*on-scroll-down*: ++
2019-08-24 16:39:46 +02:00
typeof: string
Command to execute when performing a scroll down on the module. This replaces the default behaviour of brightness control.
2019-08-24 16:39:46 +02:00
2020-04-12 18:41:44 +02:00
*smooth-scrolling-threshold*: ++
2019-08-24 16:39:46 +02:00
typeof: double
Threshold to be used when scrolling.
*reverse-scrolling*: ++
typeof: bool ++
Option to reverse the scroll direction.
*scroll-step*: ++
typeof: float ++
default: 1.0 ++
The speed in which to change the brightness when scrolling.
2019-08-24 22:46:56 +02:00
# EXAMPLE:
2019-08-24 16:39:46 +02:00
```
"backlight": {
"device": "intel_backlight",
"format": "{percent}% {icon}",
"format-icons": ["", ""]
}
```
2019-08-24 22:46:56 +02:00
# STYLE
2019-08-24 16:39:46 +02:00
2019-08-24 18:44:29 +02:00
- *#backlight*