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>
101 lines
2.0 KiB
Scdoc
101 lines
2.0 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. Set to *0* for auto size.
|
|
|
|
*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*
|