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>
104 lines
2.8 KiB
Scdoc
104 lines
2.8 KiB
Scdoc
waybar-hyprland-window(5)
|
|
|
|
# NAME
|
|
|
|
waybar - hyprland window module
|
|
|
|
# DESCRIPTION
|
|
|
|
The *window* module displays the title of the currently focused window in Hyprland.
|
|
|
|
# CONFIGURATION
|
|
|
|
Addressed by *hyprland/window*
|
|
|
|
*format*: ++
|
|
typeof: string ++
|
|
default: {title} ++
|
|
The format, how information should be displayed. On {} the current window title is displayed.
|
|
|
|
*rewrite*: ++
|
|
typeof: object ++
|
|
Rules to rewrite window title. See *rewrite rules*.
|
|
|
|
*separate-outputs*: ++
|
|
typeof: bool ++
|
|
Show the active window of the monitor the bar belongs to, instead of the focused window.
|
|
|
|
*fallback*: ++
|
|
typeof: string ++
|
|
Text to display when the focused window title is empty (for example when no window is focused).
|
|
|
|
*tooltip-format*: ++
|
|
typeof: string ++
|
|
The format of the tooltip shown on hover. Supports the same replacements as *format*. Requires *tooltip* to be enabled. When unset, the tooltip falls back to the formatted label text. ++
|
|
default: (the formatted label text)
|
|
|
|
*icon*: ++
|
|
typeof: bool ++
|
|
default: false ++
|
|
Option to hide the application icon.
|
|
|
|
*icon-size*: ++
|
|
typeof: integer ++
|
|
default: 24 ++
|
|
Option to change the size of the application icon.
|
|
|
|
*expand*: ++
|
|
typeof: bool ++
|
|
default: false ++
|
|
Enables this module to consume all left over space dynamically.
|
|
|
|
# FORMAT REPLACEMENTS
|
|
See the output of "hyprctl clients" for examples
|
|
|
|
*{title}*: The current title of the focused window.
|
|
|
|
*{initialTitle}*: The initial title of the focused window.
|
|
|
|
*{class}*: The current class of the focused window.
|
|
|
|
*{initialClass}*: The initial class of the focused window.
|
|
|
|
# REWRITE RULES
|
|
|
|
*rewrite* is an object where keys are regular expressions and values are
|
|
rewrite rules if the expression matches. Rules may contain references to
|
|
captures of the expression.
|
|
|
|
Regular expression and replacement follow ECMA-script rules.
|
|
|
|
If no expression matches, the title is left unchanged.
|
|
|
|
Invalid expressions (e.g., mismatched parentheses) are skipped.
|
|
|
|
# EXAMPLES
|
|
|
|
```
|
|
"hyprland/window": {
|
|
"format": "{}",
|
|
"rewrite": {
|
|
"(.*) - Mozilla Firefox": "🌎 $1",
|
|
"(.*) - zsh": "> [$1]"
|
|
}
|
|
}
|
|
```
|
|
|
|
# STYLE
|
|
|
|
- *#window*
|
|
- *window#waybar.empty #window* When no windows are in the workspace
|
|
|
|
The following classes are applied to the entire Waybar rather than just the
|
|
window widget:
|
|
|
|
- *window#waybar.empty* When no windows are in the workspace
|
|
- *window#waybar.solo* When one tiled window is visible in the workspace
|
|
(floating windows may be present)
|
|
- *window#waybar.<app_id>* Where *<app_id>* is the *class* (e.g. *chromium*) of
|
|
the solo tiled window in the workspace (use *hyprctl clients* to see classes)
|
|
- *window#waybar.floating* When there are only floating windows in the workspace
|
|
- *window#waybar.fullscreen* When there is a fullscreen window in the workspace;
|
|
useful with Hyprland's *fullscreen, 1* mode
|
|
- *window#waybar.swallowing* When there is a swallowed window in the workspace
|