.\" Generated by scdoc 1.11.3
.\" 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-taskbar" "5" "2024-09-15"
.PP
.SH NAME
.PP
waybar - wlr taskbar module
.PP
.SH DESCRIPTION
.PP
The \fBtaskbar\fR module displays the currently open applications.\& This module requires
a compositor that implements the foreign-toplevel-manager interface.\&
.PP
.SH CONFIGURATION
.PP
Addressed by \fBwlr/taskbar\fR
.PP
\fBall-outputs\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	If set to false applications on the waybar'\&s current output will be shown.\& Otherwise, all applications are shown.\&
.PP
\fBformat\fR: 
.br
	typeof: string 
.br
	default: {icon} 
.br
	The format, how information should be displayed.\&
.PP
\fBicon-theme\fR: 
.br
	typeof: array|string 
.br
	The names of the icon-themes that should be used to find an icon.\& The list will be traversed from left to right.\& If omitted, the system default will be used.\&
.PP
\fBicon-size\fR: 
.br
	typeof: integer 
.br
	default: 16 
.br
	The size of the icon.\&
.PP
\fBmarkup\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	If set to true, pango markup will be accepted in format and tooltip-format.\&
.PP
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	If set to false no tooltip will be shown.\&
.PP
\fBtooltip-format\fR: 
.br
	typeof: string 
.br
	default: {title} 
.br
	The format, how information in the tooltip should be displayed.\&
.PP
\fBactive-first\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	If set to true, always reorder the tasks in the taskbar so that the currently active one is first.\& Otherwise don'\&t reorder.\&
.PP
\fBsort-by-app-id\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	If set to true, group tasks by their app_id.\& Cannot be used with '\&active-first'\&.\&
.PP
\fBon-click\fR: 
.br
	typeof: string 
.br
	The action which should be triggered when clicking on the application button with the left mouse button.\&
.PP
\fBon-click-middle\fR: 
.br
	typeof: string 
.br
	The action which should be triggered when clicking on the application button with the middle mouse button.\&
.PP
\fBon-click-right\fR: 
.br
	typeof: string 
.br
	The action which should be triggered when clicking on the application button with the right mouse button.\&
.PP
\fBon-update\fR: 
.br
	typeof: string 
.br
	Command to execute when the module is updated.\&
.PP
\fBignore-list\fR: 
.br
	typeof: array 
.br
	List of app_id/titles to be invisible.\&
.PP
\fBapp_ids-mapping\fR: 
.br
	typeof: object 
.br
	Dictionary of app_id to be replaced with
.PP
\fBrewrite\fR: 
.br
	typeof: object 
.br
	Rules to rewrite the module format output.\& See \fBrewrite rules\fR.\&
.PP
.SH FORMAT REPLACEMENTS
.PP
\fB{icon}\fR: The icon of the application.\&
.PP
\fB{name}\fR: The application name as in desktop file if appropriate desktop files are found, otherwise same as {app_id}
.PP
\fB{title}\fR: The title of the application.\&
.PP
\fB{app_id}\fR: The app_id (== application name) of the application.\&
.PP
\fB{state}\fR: The state (minimized, maximized, active, fullscreen) of the application.\&
.PP
\fB{short_state}\fR: The state (minimize == m, maximized == M, active == A, fullscreen == F) represented as one character of the application.\&
.PP
.SH CLICK ACTIONS
.PP
\fBactivate\fR: Bring the application into foreground.\&
.PP
\fBminimize\fR: Toggle application'\&s minimized state.\&
.PP
\fBminimize-raise\fR: Bring the application into foreground or toggle its minimized state.\&
.PP
\fBmaximize\fR: Toggle application'\&s maximized state.\&
.PP
\fBfullscreen\fR: Toggle application'\&s fullscreen state.\&
.PP
\fBclose\fR: Close the application.\&
.PP
.SH REWRITE RULES
.PP
\fBrewrite\fR is an object where keys are regular expressions and values are
rewrite rules if the expression matches.\& Rules may contain references to
captures of the expression.\&
.PP
Regular expression and replacement follow ECMA-script rules.\&
.PP
If no expression matches, the format output is left unchanged.\&
.PP
Invalid expressions (e.\&g.\&, mismatched parentheses) are skipped.\&
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"wlr/taskbar": {
	"format": "{icon}",
	"icon-size": 14,
	"icon-theme": "Numix-Circle",
	"tooltip-format": "{title}",
	"on-click": "activate",
	"on-click-middle": "close",
	"ignore-list": [
	    "Alacritty"
	],
	"app_ids-mapping": {
		"firefoxdeveloperedition": "firefox-developer-edition"
	},
	"rewrite": {
		"Firefox Web Browser": "Firefox",
		"Foot Server": "Terminal"
	}
}
.fi
.RE
.PP
.SH Style
.PP
.PD 0
.IP \(bu 4
\fB#taskbar\fR
.IP \(bu 4
\fB#taskbar button\fR
.IP \(bu 4
\fB#taskbar button.\&maximized\fR
.IP \(bu 4
\fB#taskbar button.\&minimized\fR
.IP \(bu 4
\fB#taskbar button.\&active\fR
.IP \(bu 4
\fB#taskbar button.\&fullscreen\fR