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>
151 lines
2.9 KiB
Scdoc
151 lines
2.9 KiB
Scdoc
waybar-upower(5)
|
|
|
|
# NAME
|
|
|
|
waybar - upower module
|
|
|
|
# DESCRIPTION
|
|
|
|
The *upower* module displays the main battery capacity with all other upower
|
|
compatible devices in the tooltip.
|
|
|
|
# CONFIGURATION
|
|
|
|
*native-path*: ++
|
|
typeof: string ++
|
|
default: ++
|
|
The battery to monitor. Refer to the https://upower.freedesktop.org/docs/UpDevice.html#UpDevice--native-path ++
|
|
Can be obtained using `upower --dump`
|
|
|
|
*model*: ++
|
|
typeof: string ++
|
|
default: ++
|
|
The battery to monitor, based on the model. (this option is ignored if *native-path* is given). ++
|
|
Can be obtained using `upower --dump`
|
|
|
|
*icon-size*: ++
|
|
typeof: integer ++
|
|
default: 20 ++
|
|
Defines the size of the icons.
|
|
|
|
*format*: ++
|
|
typeof: string ++
|
|
default: {percentage} ++
|
|
The text format.
|
|
|
|
*format-alt*: ++
|
|
typeof: string ++
|
|
default: {percentage} {time} ++
|
|
The text format when toggled.
|
|
|
|
*hide-if-empty*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Defines visibility of the module if no devices can be found.
|
|
|
|
*tooltip*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Option to disable tooltip on hover.
|
|
|
|
*tooltip-spacing*: ++
|
|
typeof: integer ++
|
|
default: 4 ++
|
|
Defines the spacing between the tooltip device name and device battery ++
|
|
status.
|
|
|
|
*tooltip-padding*: ++
|
|
typeof: integer ++
|
|
default: 4 ++
|
|
Defines the spacing between the tooltip window edge and the tooltip content.
|
|
|
|
*tooltip-format*: ++
|
|
typeof: string ++
|
|
default: ++
|
|
The format used for each device line shown in the tooltip. Accepts the ++
|
|
same replacements as *format*.
|
|
|
|
*on-click*: ++
|
|
typeof: string ++
|
|
Command to execute when clicked on the module.
|
|
|
|
*show-icon*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Option to disable battery icon.
|
|
|
|
*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.
|
|
|
|
# FORMAT REPLACEMENTS
|
|
|
|
*{percentage}*: The battery capacity in percentage
|
|
|
|
*{time}*: An estimated time either until empty or until fully charged ++
|
|
depending on the charging state.
|
|
|
|
*{temperature}*: The battery temperature in degrees Celsius.
|
|
|
|
*{model}*: The model name of the device.
|
|
|
|
*{native-path}*: The native path of the device.
|
|
|
|
# EXAMPLES
|
|
|
|
```
|
|
"upower": {
|
|
"icon-size": 20,
|
|
"hide-if-empty": true,
|
|
"tooltip": true,
|
|
"tooltip-spacing": 20
|
|
}
|
|
|
|
```
|
|
```
|
|
"upower": {
|
|
"native-path": "/org/bluez/hci0/dev_D4_AE_41_38_D0_EF",
|
|
"icon-size": 20,
|
|
"hide-if-empty": true,
|
|
"tooltip": true,
|
|
"tooltip-spacing": 20
|
|
}
|
|
|
|
```
|
|
```
|
|
"upower": {
|
|
"native-path": "battery_sony_controller_battery_d0o27o88o32ofcoee",
|
|
"icon-size": 20,
|
|
"hide-if-empty": true,
|
|
"tooltip": true,
|
|
"tooltip-spacing": 20
|
|
}
|
|
```
|
|
```
|
|
"upower": {
|
|
"show-icon": false,
|
|
"hide-if-empty": true,
|
|
"tooltip": true,
|
|
"tooltip-spacing": 20
|
|
}
|
|
|
|
```
|
|
|
|
# STYLE
|
|
|
|
- *#upower*
|
|
- *#upower.charging*
|
|
- *#upower.discharging*
|
|
- *#upower.full*
|
|
- *#upower.empty*
|
|
- *#upower.unknown-status*
|