.\" 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-sway-workspaces" "5" "2023-02-28"
.P
.SH NAME
.P
waybar - sway workspaces module
.P
.SH DESCRIPTION
.P
The \fBworkspaces\fR module displays the currently used workspaces in Sway.\&
.P
.SH CONFIGURATION
.P
Addressed by \fBsway/workspaces\fR
.P
\fBall-outputs\fR: 
.br
    typeof: bool 
.br
    default: false 
.br
    If set to false, workspaces will only be shown on the output they are on.\& If set to true all workspaces will be shown on every output.\&
.P
\fBformat\fR: 
.br
    typeof: string 
.br
    default: {value} 
.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
\fBdisable-scroll\fR: 
.br
    typeof: bool 
.br
    default: false 
.br
    If set to false, you can scroll to cycle through workspaces.\& If set to true this behaviour is disabled.\&
.P
\fBdisable-click\fR: 
.br
    typeof: bool 
.br
    default: false 
.br
    If set to false, you can click to change workspace.\& If set to true this behaviour is disabled.\&
.P
\fBsmooth-scrolling-threshold\fR: 
.br
    typeof: double 
.br
    Threshold to be used when scrolling.\&
.P
\fBdisable-scroll-wraparound\fR: 
.br
    typeof: bool 
.br
    default: false 
.br
    If set to false, scrolling on the workspace indicator will wrap around to the first workspace when reading the end, and vice versa.\& If set to true this behavior is disabled.\&
.P
\fBenable-bar-scroll\fR: 
.br
    typeof: bool 
.br
    default: false 
.br
    If set to false, you can'\&t scroll to cycle throughout workspaces from the entire bar.\& If set to true this behaviour is enabled.\&
.P
\fBdisable-markup\fR: 
.br
    typeof: bool 
.br
    default: false 
.br
    If set to true, button label will escape pango markup.\&
.P
\fBcurrent-only\fR: 
.br
    typeof: bool 
.br
    default: false 
.br
    If set to true.\& Only focused workspaces will be shown.\&
.P
\fBpersistent_workspaces\fR: 
.br
    typeof: json (see below) 
.br
    default: empty 
.br
    Lists workspaces that should always be shown, even when non existent
.P
\fBon-update\fR: 
.br
    typeof: string 
.br
    Command to execute when the module is updated.\&
.P
\fBdisable-auto-back-and-forth\fR: 
.br
    typeof: bool 
.br
    Whether to disable \fBworkspace_auto_back_and_forth\fR when clicking on workspaces.\& If this is set to \fBtrue\fR, clicking on a workspace you are already on won'\&t do anything, even if \fBworkspace_auto_back_and_forth\fR is enabled in the Sway configuration.\&
.P
\fBalphabetical_sort\fR: 
.br
    typeof: bool 
.br
    Whether to sort workspaces alphabetically.\& Please note this can make "swaymsg workspace prev/next" move to workspaces inconsistent with the ordering shown in Waybar.\&
.P
.SH FORMAT REPLACEMENTS
.P
\fB{value}\fR: Name of the workspace, as defined by sway.\&
.P
\fB{name}\fR: Number stripped from workspace value.\&
.P
\fB{icon}\fR: Icon, as defined in \fBformat-icons\fR.\&
.P
\fB{index}\fR: Index of 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 matches is found.\&
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBurgent\fR: Will be shown, when workspace is flagged as urgent
.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
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBpersistent\fR: Will be shown, when workspace is persistent one.\&

.RE
.P
.SH PERSISTENT WORKSPACES
.P
Each entry of \fBpersistent_workspace\fR names a workspace that should always be shown.\&
Associated with that value is a list of outputs indicating \fBwhere\fR the workspace should be shown,
an empty list denoting all outputs.\&
.P
.nf
.RS 4
"sway/workspaces": {
    "persistent_workspaces": {
        "3": [], // Always show a workspace with name \&'3\&', on all outputs if it does not exists
        "4": ["eDP-1"], // Always show a workspace with name \&'4\&', on output \&'eDP-1\&' if it does not exists
        "5": ["eDP-1", "DP-2"] // Always show a workspace with name \&'5\&', on outputs \&'eDP-1\&' and \&'DP-2\&' if it does not exists
    }
}
.fi
.RE
.P
n.\&b.\&: the list of outputs can be obtained from command line using \fBswaymsg -t get_outputs\fR
.P
.SH EXAMPLES
.P
.nf
.RS 4
"sway/workspaces": {
    "disable-scroll": true,
    "all-outputs": true,
    "format": "{name}: {icon}",
    "format-icons": {
        "1": "",
        "2": "",
        "3": "",
        "4": "",
        "5": "",
        "urgent": "",
        "focused": "",
        "default": ""
    }
}
.fi
.RE
.P
.SH Style
.P
.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.\&visible\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#workspaces button.\&focused\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.\&persistent\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#workspaces button.\&current_output\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#workspaces button#sway-workspace-${name}\fR
.RE