mirror of
https://github.com/rad4day/Waybar.git
synced 2023-12-21 10:22:59 +01:00
a3904ff039
Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
93 lines
2.1 KiB
Markdown
93 lines
2.1 KiB
Markdown
waybar-backlight(5)
|
|
|
|
# NAME
|
|
|
|
waybar - backlight module
|
|
|
|
# DESCRIPTION
|
|
|
|
The *backlight* module displays the current backlight level.
|
|
|
|
# CONFIGURATION
|
|
|
|
*interval*: ++
|
|
typeof: integer ++
|
|
default: 2 ++
|
|
The interval in which information gets polled.
|
|
|
|
*format*: ++
|
|
typeof: string ++
|
|
default: {percent}% ++
|
|
The format, how information should be displayed. On {} data gets inserted.
|
|
|
|
*max-length*: ++
|
|
typeof: integer ++
|
|
The maximum length in characters the module should display.
|
|
|
|
*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.
|
|
|
|
*rotate*: ++
|
|
typeof: integer ++
|
|
Positive value to rotate the text label.
|
|
|
|
*states*: ++
|
|
typeof: object ++
|
|
A number of backlight states which get activated on certain brightness levels. See *waybar-states(5)*.
|
|
|
|
*on-click*: ++
|
|
typeof: string ++
|
|
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*: ++
|
|
typeof: string ++
|
|
Command to execute when the module is right clicked.
|
|
|
|
*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. This replaces the default behaviour of brightness control.
|
|
|
|
*on-scroll-down*: ++
|
|
typeof: string
|
|
Command to execute when performing a scroll down on the module. This replaces the default behaviour of brightness control.
|
|
|
|
*smooth-scrolling-threshold*: ++
|
|
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.
|
|
|
|
# EXAMPLE:
|
|
|
|
```
|
|
"backlight": {
|
|
"device": "intel_backlight",
|
|
"format": "{percent}% {icon}",
|
|
"format-icons": ["", ""]
|
|
}
|
|
```
|
|
|
|
# STYLE
|
|
|
|
- *#backlight*
|