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>
163 lines
4.5 KiB
Scdoc
163 lines
4.5 KiB
Scdoc
waybar-wwan(5) "waybar-wwan" "User Manual"
|
|
|
|
# NAME
|
|
|
|
waybar - wwan module
|
|
|
|
# DESCRIPTION
|
|
|
|
*wwan* module for ModemManager.
|
|
|
|
|
|
# FILES
|
|
|
|
$XDG_CONFIG_HOME/waybar/config ++
|
|
Per user configuration file
|
|
|
|
# ADDITIONAL FILES
|
|
|
|
libmm-glib lives in:
|
|
|
|
. /usr/lib/libmm-glib.so or /usr/lib64/libmm-glib.so
|
|
. /usr/lib/pkgconfig/libmm-glib.pc or /usr/lib64/pkgconfig/libmm-glib.pc
|
|
. /usr/include/libmm-glib
|
|
|
|
# CONFIGURATION
|
|
|
|
*format*: ++
|
|
typeof: string ++
|
|
default: *{state}* ++
|
|
The format, how information should be displayed. This format is used when other formats aren't specified.
|
|
|
|
*format-failed*: ++
|
|
typeof: string ++
|
|
This format is used when the modem cannot start.
|
|
|
|
*format-locked*: ++
|
|
typeof: string ++
|
|
This format is used when the SIM on the modem is locked.
|
|
|
|
*format-disabled*: ++
|
|
typeof: string ++
|
|
This format is used when the modem is disabled.
|
|
|
|
*format-enabled*: ++
|
|
typeof: string ++
|
|
This format is used when the modem is enabled, but isn't registered to any carrier network.
|
|
|
|
*format-searching*: ++
|
|
typeof: string ++
|
|
This format is used when the modem is looking for a carrier network to register to.
|
|
|
|
*format-registered*: ++
|
|
typeof: string ++
|
|
This format is used when the modem is registered to a network, but no data connection is active.
|
|
|
|
*format-connected*: ++
|
|
typeof: string ++
|
|
This format is used when the modem is registered to a network, and there is an active data connection.
|
|
|
|
*format-icons*: ++
|
|
typeof: array/object ++
|
|
Based on the current signal strength, the corresponding icon gets selected. ++
|
|
The order is *low* to *high*. Or by the state if it is an object.
|
|
|
|
*tooltip*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Option to disable tooltip on hover.
|
|
|
|
*tooltip-format*: ++
|
|
typeof: strirng ++
|
|
default: {state} ++
|
|
The format, how information should be displayed in the tooltip. This format is used when other formats aren't specified.
|
|
|
|
*tooltip-format-failed*: ++
|
|
typeof: string ++
|
|
This format is used when the modem cannot start.
|
|
|
|
*tooltip-format-locked*: ++
|
|
typeof: string ++
|
|
This format is used when the SIM on the modem is locked.
|
|
|
|
*tooltip-format-disabled*: ++
|
|
typeof: string ++
|
|
This format is used when the modem is disabled.
|
|
|
|
*tooltip-format-enabled*: ++
|
|
typeof: string ++
|
|
This format is used when the modem is enabled, but isn't registered to any carrier network.
|
|
|
|
*tooltip-format-searching*: ++
|
|
typeof: string ++
|
|
This format is used when the modem is looking for a carrier network to register to.
|
|
|
|
*tooltip-format-registered*: ++
|
|
typeof: string ++
|
|
This format is used when the modem is registered to a network, but no data connection is active.
|
|
|
|
*tooltip-format-connected*: ++
|
|
typeof: string ++
|
|
This format is used when the modem is registered to a network, and there is an active data connection.
|
|
|
|
*interval*: ++
|
|
typeof: integer ++
|
|
default: 5 ++
|
|
The interval in which the WWAN information gets polled (e.g. carrier name).
|
|
|
|
*imei*: ++
|
|
typeof: string ++
|
|
Select only the modem with the corresponding imei.
|
|
|
|
*path*: ++
|
|
typeof: string ++
|
|
Select only the modem with the corresponding hardware path.
|
|
|
|
*hide-disconnected*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Defines if the module should be hidden while the modem does not have an active data connection.
|
|
|
|
|
|
# FORMAT REPLACEMENTS
|
|
|
|
*{state}*: Modem state.
|
|
|
|
*{current_modes}*: List of all the currently active connection modes.
|
|
|
|
*{preferred_mode}*: The preferred connection mode in use.
|
|
|
|
*{signal_quality}*: Signal quality (0-100).
|
|
|
|
*{operator_name}*: Name of the network operator.
|
|
|
|
*{icon}*: Icon selected from *format-icons* according to the signal quality.
|
|
|
|
*{power_state}*: Modem power state (On/Off/Low/Unknown).
|
|
|
|
*{imei}*: Modem equipment identifier (IMEI).
|
|
|
|
# EXAMPLES
|
|
|
|
```
|
|
"wwan": {
|
|
"format": "{state}",
|
|
"format-disabled": "", // an empty format will hide the module
|
|
"format-locked": "SIM Locked",
|
|
"format-connected": "{operator_name} {preferred_mode} | {signal_quality}%"
|
|
"tooltip-format": "{preferred_mode}",
|
|
"tooltip-format-connected": "{current_modes}",
|
|
"hide-disconnected": false
|
|
}
|
|
```
|
|
# STYLE
|
|
|
|
- *#wwan*
|
|
- *#wwan.failed* Applied when the modem cannot start.
|
|
- *#wwan.locked* Applied when the SIM on the modem is locked.
|
|
- *#wwan.disabled* Applied when the modem is disabled.
|
|
- *#wwan.enabled* Applied when the modem is enabled, but isn't registered to any carrier network.
|
|
- *#wwan.searching* Applied when the modem is looking for a carrier network to register to.
|
|
- *#wwan.registered* Applied when the modem is registered to a network, but no data connection is active.
|
|
- *#wwan.connected* Applied when the modem is registered to a network, and there is an active data connection.
|