mirror of
https://github.com/rad4day/Waybar.git
synced 2023-12-21 10:22:59 +01:00
c8910901e5
Tools like `apropos` and `whatis` use the NAME section to generate their database, so make sure every manpage has it. Also make sure they all have a brief description and make it consistent across the manpages.
73 lines
1.4 KiB
Markdown
73 lines
1.4 KiB
Markdown
waybar-hyprland-workspaces(5)
|
|
|
|
# NAME
|
|
|
|
waybar - hyprland workspaces module
|
|
|
|
# DESCRIPTION
|
|
|
|
The *workspaces* module displays the currently used workspaces in hyprland compositor.
|
|
|
|
# CONFIGURATION
|
|
|
|
Addressed by *hyprland/workspaces*
|
|
|
|
*format*: ++
|
|
typeof: string ++
|
|
default: {id} ++
|
|
The format, how information should be displayed.
|
|
|
|
*format-icons*: ++
|
|
typeof: array ++
|
|
Based on the workspace id and state, the corresponding icon gets selected. See *icons*.
|
|
|
|
*show-special*: ++
|
|
typeof: bool ++
|
|
default: false ++
|
|
If set to true special workspaces will be shown.
|
|
|
|
*all-outputs*: ++
|
|
typeof: bool ++
|
|
default: false ++
|
|
If set to false workspaces group will be shown only in assigned output. Otherwise all workspace groups are shown.
|
|
|
|
# FORMAT REPLACEMENTS
|
|
|
|
*{id}*: id of workspace assigned by compositor
|
|
|
|
*{name}*: workspace name assigned by compositor
|
|
|
|
*{icon}*: Icon, as defined in *format-icons*.
|
|
|
|
# ICONS
|
|
|
|
Additional to workspace name matching, the following *format-icons* can be set.
|
|
|
|
- *default*: Will be shown, when no string match is found.
|
|
- *active*: Will be shown, when workspace is active
|
|
|
|
# EXAMPLES
|
|
|
|
```
|
|
"wlr/workspaces": {
|
|
"format": "{name}: {icon}",
|
|
"format-icons": {
|
|
"1": "",
|
|
"2": "",
|
|
"3": "",
|
|
"4": "",
|
|
"5": "",
|
|
"active": "",
|
|
"default": ""
|
|
},
|
|
"all-outputs": false,
|
|
"show-special": false
|
|
}
|
|
```
|
|
|
|
# Style
|
|
|
|
- *#workspaces*
|
|
- *#workspaces button*
|
|
- *#workspaces button.active*
|