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>
81 lines
1.5 KiB
Scdoc
81 lines
1.5 KiB
Scdoc
waybar-sway-language(5)
|
|
|
|
# NAME
|
|
|
|
waybar - sway language module
|
|
|
|
# DESCRIPTION
|
|
|
|
The *language* module displays the current keyboard layout in Sway
|
|
|
|
# CONFIGURATION
|
|
|
|
Addressed by *sway/language*
|
|
|
|
*format*: ++
|
|
typeof: string ++
|
|
default: {} ++
|
|
The format, how layout should be displayed.
|
|
|
|
*hide-single-layout*: ++
|
|
typeof: bool ++
|
|
default: false ++
|
|
Defines visibility of the module if a single layout is configured
|
|
|
|
*tooltip-format*: ++
|
|
typeof: string ++
|
|
default: {} ++
|
|
The format, how layout should be displayed in tooltip.
|
|
|
|
*tooltip*: ++
|
|
typeof: bool ++
|
|
default: true ++
|
|
Option to disable tooltip on hover.
|
|
|
|
*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.
|
|
|
|
*expand*: ++
|
|
typeof: bool ++
|
|
default: false ++
|
|
Enables this module to consume all left over space dynamically.
|
|
|
|
# FORMAT REPLACEMENTS
|
|
|
|
*{short}*: Short name of layout (e.g. "us"). Equals to {}.
|
|
|
|
*{shortDescription}*: Short description of layout (e.g. "en").
|
|
|
|
*{long}*: Long name of layout (e.g. "English (Dvorak)").
|
|
|
|
*{variant}*: Variant of layout (e.g. "dvorak").
|
|
|
|
*{flag}*: Country flag of layout.
|
|
|
|
# EXAMPLES
|
|
|
|
```
|
|
"sway/language": {
|
|
"format": "{}",
|
|
},
|
|
|
|
"sway/language": {
|
|
"format": "{short} {variant}",
|
|
}
|
|
```
|
|
|
|
# STYLE
|
|
|
|
- *#language*
|
|
- *#language.<layout-short-name>* Where *layout-short-name* is the short name of the active layout (e.g. *#language.us* or *#language.de*).
|