.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "waybar-wlr-workspaces" "5" "2023-02-28"
.P
.SH NAME
.P
waybar - wlr workspaces module
.P
.SH DESCRIPTION
.P
The \fBworkspaces\fR module displays the currently used workspaces in wayland compositor.\&
.P
.SH CONFIGURATION
.P
Addressed by \fBwlr/workspaces\fR
.P
\fBformat\fR: 
.br
	typeof: string 
.br
	default: {name} 
.br
	The format, how information should be displayed.\&
.P
\fBformat-icons\fR: 
.br
	typeof: array 
.br
	Based on the workspace name and state, the corresponding icon gets selected.\& See \fBicons\fR.\&
.P
\fBsort-by-name\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Should workspaces be sorted by name.\&
.P
\fBsort-by-coordinates\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Should workspaces be sorted by coordinates.\&
.RS 4
Note that if both  \fBsort-by-name\fR and \fBsort-by-coordinates\fR are true sort by name will be first.\&
If both are false - sort by id will be performed.\&
.P
.RE
\fBsort-by-number\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	If set to true, workspace names will be sorted numerically.\& Takes presedence over any other sort-by option.\&
.P
\fBall-outputs\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	If set to false workspaces group will be shown only in assigned output.\& Otherwise all workspace groups are shown.\&
.P
\fBactive-only\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	If set to true only active or urgent workspaces will be shown.\&
.P
.SH FORMAT REPLACEMENTS
.P
\fB{name}\fR: Name of workspace assigned by compositor
.P
\fB{icon}\fR: Icon, as defined in \fBformat-icons\fR.\&
.P
.SH CLICK ACTIONS
.P
\fBactivate\fR: Switch to workspace.\&
.P
\fBclose\fR: Close the workspace.\&
.P
.SH ICONS
.P
Additional to workspace name matching, the following \fBformat-icons\fR can be set.\&
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBdefault\fR: Will be shown, when no string match is found.\&
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBfocused\fR: Will be shown, when workspace is focused

.RE
.P
.SH EXAMPLES
.P
.nf
.RS 4
"wlr/workspaces": {
	"format": "{name}: {icon}",
	"format-icons": {
		"1": "",
		"2": "",
		"3": "",
		"4": "",
		"5": "",
		"focused": "",
		"default": ""
	},
	"sort-by-number": true
}
.fi
.RE
.P
.SH Style
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#workspaces\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#workspaces button\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#workspaces button.\&active\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#workspaces button.\&urgent\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#workspaces button.\&hidden\fR
.RE