mirror of
				https://github.com/rad4day/Waybar.git
				synced 2025-11-04 09:42:42 +01:00 
			
		
		
		
	Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
		
			
				
	
	
		
			94 lines
		
	
	
		
			2.0 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			94 lines
		
	
	
		
			2.0 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
waybar-wlr-workspaces(5)
 | 
						|
 | 
						|
# NAME
 | 
						|
 | 
						|
waybar - wlr workspaces module
 | 
						|
 | 
						|
# DESCRIPTION
 | 
						|
 | 
						|
The *workspaces* module displays the currently used workspaces in wayland compositor.
 | 
						|
 | 
						|
# CONFIGURATION
 | 
						|
 | 
						|
Addressed by *wlr/workspaces*
 | 
						|
 | 
						|
*format*: ++
 | 
						|
	typeof: string ++
 | 
						|
	default: {name} ++
 | 
						|
	The format, how information should be displayed.
 | 
						|
 | 
						|
*format-icons*: ++
 | 
						|
	typeof: array ++
 | 
						|
	Based on the workspace name and state, the corresponding icon gets selected. See *icons*.
 | 
						|
 | 
						|
*sort-by-name*: ++
 | 
						|
	typeof: bool ++
 | 
						|
	default: true ++
 | 
						|
	Should workspaces be sorted by name.
 | 
						|
 | 
						|
*sort-by-coordinates*: ++
 | 
						|
	typeof: bool ++
 | 
						|
	default: true ++
 | 
						|
	Should workspaces be sorted by coordinates. ++
 | 
						|
	Note that if both  *sort-by-name* and *sort-by-coordinates* are true sort by name will be first. If both are false - sort by id will be performed.
 | 
						|
 | 
						|
*sort-by-number*: ++
 | 
						|
	typeof: bool ++
 | 
						|
	default: false ++
 | 
						|
	If set to true, workspace names will be sorted numerically. Takes presedence over any other sort-by option.
 | 
						|
 | 
						|
*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.
 | 
						|
 | 
						|
*active-only*: ++
 | 
						|
	typeof: bool ++
 | 
						|
	default: false ++
 | 
						|
	If set to true only active or urgent workspaces will be shown.
 | 
						|
 | 
						|
# FORMAT REPLACEMENTS
 | 
						|
 | 
						|
*{name}*: Name of workspace assigned by compositor
 | 
						|
 | 
						|
*{icon}*: Icon, as defined in *format-icons*.
 | 
						|
 | 
						|
# CLICK ACTIONS
 | 
						|
 | 
						|
*activate*: Switch to workspace.
 | 
						|
 | 
						|
*close*: Close the workspace.
 | 
						|
 | 
						|
# 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": ""
 | 
						|
	},
 | 
						|
	"sort-by-number": true
 | 
						|
}
 | 
						|
```
 | 
						|
 | 
						|
# Style
 | 
						|
 | 
						|
- *#workspaces*
 | 
						|
- *#workspaces button*
 | 
						|
- *#workspaces button.active*
 | 
						|
- *#workspaces button.urgent*
 | 
						|
- *#workspaces button.hidden*
 |