Alex
8ff8ceeca2
The backlight module only enumerated and monitored the udev "backlight" subsystem, so keyboard-backlight LEDs in the "leds" class (e.g. white:kbd_backlight, platform::kbd_backlight) were never discovered and the module fell back to the default when pointed at one. Enumerate and monitor the "leds" subsystem in addition to "backlight". Those LEDs expose the same brightness/max_brightness attributes, so the read path is unchanged. Each device now records its subsystem so the login1 SetBrightness call targets the correct one. Automatic device selection still prefers a "backlight" device and only falls back to a "leds" device when named explicitly or when no screen backlight exists. Fixes #2848.
150 lines
3.9 KiB
Scdoc
150 lines
3.9 KiB
Scdoc
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.
|
|
|
|
*device*: ++
|
|
typeof: string ++
|
|
The name of the preferred backlight device to display. If left empty, a device will be chosen automatically. ++
|
|
Both screen backlights (the udev *backlight* subsystem) and keyboard backlights (LEDs in the udev *leds* subsystem, e.g. *white:kbd_backlight*) are supported; name such an LED here to control it. When left empty, a screen backlight is always preferred for automatic selection.
|
|
|
|
*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 accept.
|
|
|
|
*align*: ++
|
|
typeof: float ++
|
|
The alignment of the label within the module, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.
|
|
|
|
*justify*: ++
|
|
typeof: string ++
|
|
The alignment of the text within the module's label, allowing options 'left', 'right', or 'center' to define the positioning.
|
|
|
|
*rotate*: ++
|
|
typeof: integer ++
|
|
Positive value to rotate the text label (in 90 degree increments).
|
|
|
|
*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 mouse scroll wheel.
|
|
|
|
*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 ++
|
|
default: false ++
|
|
Option to reverse the scroll direction for devices other than a mouse (touchpad, trackpad, etc).
|
|
|
|
*reverse-mouse-scrolling*: ++
|
|
typeof: bool ++
|
|
default: false ++
|
|
Option to reverse the scroll direction for mice.
|
|
|
|
*scroll-step*: ++
|
|
typeof: float ++
|
|
default: 1.0 ++
|
|
The speed at which to change the brightness when scrolling.
|
|
|
|
*min-brightness*: ++
|
|
typeof: double ++
|
|
default: 0.0 ++
|
|
The minimum brightness of the backlight.
|
|
|
|
*tooltip*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Option to disable tooltip on hover.
|
|
|
|
*tooltip-format*: ++
|
|
typeof: string ++
|
|
Text to be displayed in the tooltip.
|
|
|
|
*menu*: ++
|
|
typeof: string ++
|
|
Action that popups the menu.
|
|
|
|
*menu-file*: ++
|
|
typeof: string ++
|
|
Location of the menu descriptor file. There need to be an element of type
|
|
GtkMenu with id *menu*
|
|
|
|
*menu-actions*: ++
|
|
typeof: array ++
|
|
The actions corresponding to the buttons of the menu.
|
|
|
|
*expand*: ++
|
|
typeof: bool ++
|
|
default: false ++
|
|
Enables this module to consume all left over space dynamically.
|
|
|
|
# FORMAT REPLACEMENTS
|
|
|
|
*{percent}*: The current brightness in percent.
|
|
|
|
*{percent_exp}*: The current brightness in percent, adjusted with a power curve to better match perceived brightness.
|
|
|
|
*{icon}*: The icon from *format-icons* chosen according to *{percent}*.
|
|
|
|
*{icon_exp}*: The icon from *format-icons* chosen according to *{percent_exp}*.
|
|
|
|
# EXAMPLE:
|
|
|
|
```
|
|
"backlight": {
|
|
"device": "intel_backlight",
|
|
"format": "{percent}% {icon}",
|
|
"format-icons": ["", ""]
|
|
}
|
|
```
|
|
|
|
# STYLE
|
|
|
|
- *#backlight*
|