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>
119 lines
3.1 KiB
Scdoc
119 lines
3.1 KiB
Scdoc
waybar-systemd-failed-units(5)
|
|
|
|
# NAME
|
|
|
|
waybar - systemd failed units monitor module
|
|
|
|
# DESCRIPTION
|
|
|
|
The *systemd-failed-units* module displays the number of failed systemd units.
|
|
|
|
# CONFIGURATION
|
|
|
|
Addressed by *systemd-failed-units*
|
|
|
|
*format*: ++
|
|
typeof: string ++
|
|
default: *{nr_failed} failed* ++
|
|
The format, how information should be displayed. This format is used when other formats aren't specified.
|
|
|
|
*format-ok*: ++
|
|
typeof: string ++
|
|
This format is used when there are no failing units.
|
|
|
|
*user*: ++
|
|
typeof: bool ++
|
|
default: *true* ++
|
|
Option to count user systemd units.
|
|
|
|
*system*: ++
|
|
typeof: bool ++
|
|
default: *true* ++
|
|
Option to count systemwide (PID=1) systemd units.
|
|
|
|
*hide-on-ok*: ++
|
|
typeof: bool ++
|
|
default: *true* ++
|
|
Option to hide this module when there are no failed units.
|
|
|
|
*tooltip-format*: ++
|
|
typeof: string ++
|
|
default: *System: {system_state}\nUser: {user_state}\nFailed units ({nr_failed}):\n{failed_units_list}* ++
|
|
Tooltip format shown when there are failed units.
|
|
|
|
*tooltip-format-ok*: ++
|
|
typeof: string ++
|
|
default: *System: {system_state}\nUser: {user_state}* ++
|
|
Tooltip format used when there are no failed units.
|
|
|
|
*tooltip-unit-format*: ++
|
|
typeof: string ++
|
|
default: *{name}: {description}* ++
|
|
Format used to render each failed unit inside the tooltip. Each item is prefixed with a bullet.
|
|
|
|
*menu*: ++
|
|
typeof: string ++
|
|
Action that pops up the menu.
|
|
|
|
*menu-file*: ++
|
|
typeof: string ++
|
|
Location of the menu descriptor file. There needs 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 leftover space dynamically.
|
|
|
|
# FORMAT REPLACEMENTS
|
|
|
|
*{nr_failed_system}*: Number of failed units from systemwide (PID=1) systemd.
|
|
|
|
*{nr_failed_user}*: Number of failed units from user systemd.
|
|
|
|
*{nr_failed}*: Number of total failed units.
|
|
|
|
*{system_state}:* State of the systemd system session.
|
|
|
|
*{user_state}:* State of the systemd user session.
|
|
|
|
*{overall_state}:* Overall state of the systemd and user session. ("ok" or "degraded")
|
|
|
|
*{failed_units_list}:* Bulleted list of failed units using *tooltip-unit-format*. Empty when
|
|
there are no failed units. This replacement is only available in *tooltip-format* and
|
|
*tooltip-format-ok*; it is not supplied to *format*/*format-ok* and using it there breaks
|
|
label rendering.
|
|
|
|
The *tooltip-unit-format* string supports the following replacements:
|
|
|
|
*{name}*: Unit name ++
|
|
*{description}*: Unit description ++
|
|
*{load_state}*: Unit load state ++
|
|
*{active_state}*: Unit active state ++
|
|
*{sub_state}*: Unit sub state ++
|
|
*{scope}*: Either *system* or *user* depending on where the unit originated
|
|
|
|
# EXAMPLES
|
|
|
|
```
|
|
"systemd-failed-units": {
|
|
"hide-on-ok": false,
|
|
"format": "✗ {nr_failed}",
|
|
"format-ok": "✓",
|
|
"system": true,
|
|
"user": false,
|
|
"tooltip-format": "{nr_failed} failed units:\n{failed_units_list}",
|
|
"tooltip-unit-format": "{scope}: {name} ({active_state})",
|
|
}
|
|
```
|
|
|
|
# STYLE
|
|
|
|
- *#systemd-failed-units*
|
|
- *#systemd-failed-units.ok*
|
|
- *#systemd-failed-units.degraded*
|