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>
113 lines
2.7 KiB
Scdoc
113 lines
2.7 KiB
Scdoc
waybar-gps(5) "waybar-gps" "User Manual"
|
|
|
|
# NAME
|
|
|
|
waybar - gps module
|
|
|
|
# DESCRIPTION
|
|
|
|
*gps* module for gpsd.
|
|
|
|
|
|
# FILES
|
|
|
|
$XDG_CONFIG_HOME/waybar/config ++
|
|
Per user configuration file
|
|
|
|
# ADDITIONAL FILES
|
|
|
|
libgps lives in:
|
|
|
|
. /usr/lib/libgps.so or /usr/lib64/libgps.so
|
|
. /usr/lib/pkgconfig/libgps.pc or /usr/lib64/pkgconfig/libgps.pc
|
|
. /usr/include/gps
|
|
|
|
# CONFIGURATION
|
|
|
|
*format*: ++
|
|
typeof: string ++
|
|
default: {mode} ++
|
|
The text format.
|
|
|
|
*tooltip*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Option to disable tooltip on hover.
|
|
|
|
*tooltip-format*: ++
|
|
typeof: string ++
|
|
default: The value of *format* ++
|
|
The text format of the tooltip.
|
|
|
|
*interval*: ++
|
|
typeof: integer ++
|
|
default: 5 ++
|
|
The interval in which the GPS information gets polled (e.g. current speed).
|
|
Significant updates (e.g. the current fix mode) are updated immediately.
|
|
|
|
*hide-disconnected*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Defines if the module should be hidden if there is no GPS receiver.
|
|
|
|
*hide-no-fix*: ++
|
|
typeof: bool ++
|
|
default: false ++
|
|
Defines if the module should be hidden if there is no GPS fix.
|
|
|
|
# FORMAT REPLACEMENTS
|
|
|
|
*{mode}*: Fix mode
|
|
|
|
*{status}*: Technology used for GPS fix. Not all GPS receivers report this.
|
|
|
|
*{latitude}*: Latitude, decimal degrees. Can be NaN.
|
|
|
|
*{latitude_error}*: Latitude uncertainty, meters. Can be NaN.
|
|
|
|
*{longitude}*: Longitude, decimal degrees. Can be NaN.
|
|
|
|
*{longitude_error}*: Longitude uncertainty, meters. Can be NaN.
|
|
|
|
*{altitude_hae}*: Altitude, height above ellipsoid, meters. Can be NaN.
|
|
|
|
*{altitude_msl}*: Longitude, MSL, meters. Can be NaN.
|
|
|
|
*{altitude_error}*: Altitude uncertainty, meters. Can be NaN.
|
|
|
|
*{speed}*: Speed over ground, meters/sec. Can be NaN.
|
|
|
|
*{speed_error}*: Speed uncertainty, meters/sec. Can be NaN.
|
|
|
|
*{climb}*: Vertical speed, meters/sec. Can be NaN.
|
|
|
|
*{climb_error}*: Vertical speed uncertainty, meters/sec. Can be NaN.
|
|
|
|
*{satellites_visible}*: Number of satellites visible from the GPS receiver.
|
|
|
|
*{satellites_used}*: Number of satellites used for the GPS fix.
|
|
|
|
# EXAMPLES
|
|
|
|
```
|
|
"gps": {
|
|
"format": "{mode}",
|
|
"format-disabled": "", // an empty format will hide the module
|
|
"format-fix-none": "No fix",
|
|
"format-fix-3d": "{status}",
|
|
"tooltip-format": "{mode}",
|
|
"tooltip-format-fix-none": "{satellites_visible} satellites visible",
|
|
"tooltip-format-fix-2d": "{satellites_used}/{satellites_visible} satellites used",
|
|
"tooltip-format-fix-3d": "Altitude: {altitude_hae}m",
|
|
"hide-disconnected": false
|
|
}
|
|
```
|
|
# STYLE
|
|
|
|
- *#gps*
|
|
- *#gps.disabled* Applied when GPS is disabled.
|
|
- *#gps.disconnected* Applied when no GPS receiver is present.
|
|
- *#gps.fix-none* Applied when GPS is present, but there is no fix.
|
|
- *#gps.fix-2d* Applied when there is a 2D fix.
|
|
- *#gps.fix-3d* Applied when there is a 3D fix.
|