AlexandClaude Opus 4.8
a3b39cfcf6
Port information that previously lived only in the GitHub wiki into the authoritative scdoc man pages, so the man pages become the single source of truth for module documentation. 33 man pages enriched (options, format replacements, actions, style selectors, troubleshooting and implementation notes). Additions were verified against the source; stale/incorrect wiki entries were deliberately not ported. All pages still compile with scdoc. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
94 lines
1.9 KiB
Scdoc
94 lines
1.9 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.
|
|
|
|
*on-click*: ++
|
|
typeof: string ++
|
|
Command to execute when clicked on the module.
|
|
|
|
*on-click-middle*: ++
|
|
typeof: string ++
|
|
Command to execute when you middle clicked on the module using mousewheel.
|
|
|
|
*on-click-right*: ++
|
|
typeof: string ++
|
|
Command to execute when you right clicked on the module.
|
|
|
|
*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": "{}",
|
|
"on-click": "swaymsg input type:keyboard xkb_switch_layout next",
|
|
},
|
|
|
|
"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*).
|