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>
101 lines
1.9 KiB
Scdoc
101 lines
1.9 KiB
Scdoc
waybar-gamemode(5)
|
|
|
|
# NAME
|
|
|
|
waybar - gamemode module
|
|
|
|
# DESCRIPTION
|
|
|
|
The *gamemode* module displays if any game or application is running with ++
|
|
Feral Gamemode optimizations.
|
|
|
|
# CONFIGURATION
|
|
|
|
*format*: ++
|
|
typeof: string ++
|
|
default: {glyph} ++
|
|
The text format.
|
|
|
|
*format-alt*: ++
|
|
typeof: string ++
|
|
default: {glyph} {count} ++
|
|
The text format when toggled.
|
|
|
|
*tooltip*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Option to disable tooltip on hover.
|
|
|
|
*tooltip-format*: ++
|
|
typeof: string ++
|
|
default: Games running: {count} ++
|
|
The text format of the tooltip.
|
|
|
|
*hide-not-running*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Defines if the module should be hidden if no games are running.
|
|
|
|
*use-icon*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Defines if the module should display a GTK icon instead of the specified *glyph*
|
|
|
|
*glyph*: ++
|
|
typeof: string ++
|
|
default: ++
|
|
The string icon to display. Only visible if *use-icon* is set to false.
|
|
|
|
*icon-name*: ++
|
|
typeof: string ++
|
|
default: input-gaming-symbolic ++
|
|
The GTK icon to display. Only visible if *use-icon* is set to true.
|
|
|
|
*icon-size*: ++
|
|
typeof: unsigned integer ++
|
|
default: 20 ++
|
|
Defines the size of the icons.
|
|
|
|
*icon-spacing*: ++
|
|
typeof: unsigned integer ++
|
|
default: 4 ++
|
|
Defines the spacing between the icon and the text.
|
|
|
|
*expand*: ++
|
|
typeof: bool ++
|
|
default: false ++
|
|
Enables this module to consume all left over space dynamically.
|
|
|
|
# FORMAT REPLACEMENTS
|
|
|
|
*{glyph}*: The string icon glyph to use instead.
|
|
|
|
*{count}*: The number of games running with gamemode optimizations.
|
|
|
|
# TOOLTIP FORMAT REPLACEMENTS
|
|
|
|
*{count}*: The number of games running with gamemode optimizations.
|
|
|
|
# EXAMPLES
|
|
|
|
```
|
|
"gamemode": {
|
|
"format": "{glyph}",
|
|
"format-alt": "{glyph} {count}",
|
|
"glyph": "",
|
|
"hide-not-running": true,
|
|
"use-icon": true,
|
|
"icon-name": "input-gaming-symbolic",
|
|
"icon-spacing": 4,
|
|
"icon-size": 20,
|
|
"tooltip": true,
|
|
"tooltip-format": "Games running: {count}"
|
|
}
|
|
|
|
```
|
|
|
|
# STYLE
|
|
|
|
- *#gamemode*
|
|
- *#gamemode.running*
|