AlexandClaude Opus 4.8
72fdf77c19
A full man<->code consistency audit surfaced options, format placeholders
and CSS classes that were implemented but undocumented, documented but not
implemented (some causing fmt crashes when copied from examples), and
defaults that disagreed with the code. This aligns the docs with the code
and fixes a few genuine code gaps.
Docs:
- Add the missing waybar-user(5) man page (and register it in meson.build)
- Document previously-undocumented options/placeholders/CSS across many
modules (custom image-path/image-name/icon-size, graph_type/width/
datapoints; battery smooth-power; wireplumber format-source/only-physical;
mpris {position}/prefer-album-artist; network {signalStrengthApp}/compact
bandwidth; pulseaudio {source_volume}/{source_desc}; upower {temperature}/
{model}/{native-path}; wwan {power_state}/{imei}; tray ignore-list; and
many CSS state classes: .sink-muted, .source-muted, .workspace-hover, etc.)
- Correct documented defaults to match the code (hyprland format {name},
gamemode {count}, cpu-graph interval 5, cava input_delay 4, niri taskbar
icon-size 16, disk/gps/wayfire formats, menu-actions object type, ...)
- Remove placeholders/options that do not apply (custom-graph {icon}/format/
format-icons/rotate) and fix crashing examples (wwan {mode}, gps
format-no-fix); note cava background/foreground/continuous_rendering are
cava-config-file options
Code:
- bluetooth: accept the documented `controller` key as a synonym of
`controller-alias` (the option was silently ignored)
- mango/workspaces: supply the documented `{name}` fmt arg (was missing ->
fmt::format threw)
- privacy: read `tooltip` as a bool (was guarded on isString(), so the
documented `tooltip: false` was silently ignored)
All man pages validated with scdoc 1.11.4. Not compiled locally (no gtkmm);
C++ build relies on CI.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
134 lines
3.2 KiB
Scdoc
134 lines
3.2 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 ++
|
|
Option to reverse the scroll direction.
|
|
|
|
*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.
|
|
|
|
*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*
|