AlexandClaude Opus 4.8
a3b39cfcf6
Port information that previously lived only in the GitHub wiki into the authoritative scdoc man pages, so the man pages become the single source of truth for module documentation. 33 man pages enriched (options, format replacements, actions, style selectors, troubleshooting and implementation notes). Additions were verified against the source; stale/incorrect wiki entries were deliberately not ported. All pages still compile with scdoc. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
149 lines
3.6 KiB
Scdoc
149 lines
3.6 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.
|
|
|
|
*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*
|