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>
89 lines
2.6 KiB
Scdoc
89 lines
2.6 KiB
Scdoc
waybar-power-profiles-daemon(5)
|
|
|
|
# NAME
|
|
|
|
waybar - power-profiles-daemon module
|
|
|
|
# DESCRIPTION
|
|
|
|
The *power-profiles-daemon* module displays the active power-profiles-daemon profile and cycle through the available profiles on click.
|
|
|
|
# FILES
|
|
|
|
$XDG_CONFIG_HOME/waybar/config
|
|
|
|
# CONFIGURATION
|
|
|
|
|
|
[- *Option*
|
|
:- *Typeof*
|
|
:- *Default*
|
|
:= *Description*
|
|
|[ *format*
|
|
:[ string
|
|
:[ "{icon}"
|
|
:[ Message displayed on the bar. {icon} and {profile} are respectively substituted with the icon representing the active profile and its full name.
|
|
|[ *tooltip-format*
|
|
:[ string
|
|
:[ "Power profile: {profile}\\nCPU driver: {cpu_driver}\\nPlatform driver: {platform_driver}"
|
|
:[ Messaged displayed in the module tooltip. {icon} and {profile} are respectively substituted with the icon representing the active profile and its full name. {cpu_driver} and {platform_driver} are substituted with the CPU and platform drivers reported by recent power-profiles-daemon versions. {driver} is kept for backward compatibility: it resolves to the legacy single driver on older daemons and falls back to the CPU driver on recent ones.
|
|
|[ *tooltip*
|
|
:[ bool
|
|
:[ true
|
|
:[ Display the tooltip.
|
|
|[ *format-icons*
|
|
:[ object
|
|
:[ See default value in the example below.
|
|
:[ Icons used to represent the various power-profile. *Note*: the default configuration uses the font-awesome icons. You may want to override it if you don't have this font installed on your system.
|
|
|[ *expand*:
|
|
:[ bool
|
|
:[ false
|
|
:[ Enables this module to consume all left over space dynamically.
|
|
|
|
|
|
|
|
|
|
|
|
# CONFIGURATION EXAMPLES
|
|
|
|
Compact display (default config):
|
|
|
|
```
|
|
"power-profiles-daemon": {
|
|
"format": "{icon}",
|
|
"tooltip-format": "Power profile: {profile}\nCPU driver: {cpu_driver}\nPlatform driver: {platform_driver}",
|
|
"tooltip": true,
|
|
"format-icons": {
|
|
"default": "",
|
|
"performance": "",
|
|
"balanced": "",
|
|
"power-saver": ""
|
|
}
|
|
}
|
|
```
|
|
|
|
Display the full profile name:
|
|
|
|
```
|
|
"power-profiles-daemon": {
|
|
"format": "{icon} {profile}",
|
|
"tooltip-format": "Power profile: {profile}\nCPU driver: {cpu_driver}\nPlatform driver: {platform_driver}",
|
|
"tooltip": true,
|
|
"format-icons": {
|
|
"default": "",
|
|
"performance": "",
|
|
"balanced": "",
|
|
"power-saver": ""
|
|
}
|
|
}
|
|
```
|
|
|
|
# STYLE
|
|
|
|
- *#power-profiles-daemon*
|
|
- *#power-profiles-daemon.performance* Applied when the *performance* profile is active.
|
|
- *#power-profiles-daemon.balanced* Applied when the *balanced* profile is active.
|
|
- *#power-profiles-daemon.power-saver* Applied when the *power-saver* profile is active.
|
|
|
|
*Note*: the module applies a CSS class equal to the name of the active profile, so any additional profile exposed by power-profiles-daemon can be styled by its name.
|