.\" Generated by scdoc 1.10.0 .ie \n(.g .ds Aq \(aq .el .ds Aq ' .nh .ad l .\" Begin generated content: .TH "waybar" "5" "2019-12-31" .P .SH NAME .P waybar - configuration file .P .SH DESCRIPTION .P The configuration uses the JSON file format and is named \fBconfig\fR. .P Valid locations for this file are: .P .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fB$XDG_CONFIG_HOME/waybar/config\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fB~/.config/waybar/config\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fB~/waybar/config\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fB/etc/xdg/waybar/config\fR .RE .P A good starting point is the default configuration found at https://github.com/Alexays/Waybar/blob/master/resources/config. Also a minimal example configuration can be found on the at the bottom of this man page. .P .SH BAR CONFIGURATION .P \fBlayer\fR .br typeof: string .br default: bottom .br Decide if the bar is displayed in front of the windows or behind them. .P \fBoutput\fR .br typeof: string|array .br Specifies on which screen this bar will be displayed. .P \fBposition\fR .br typeof: string .br default: top .br Bar position, can be \fBtop\fR, \fBbottom\fR, \fBleft\fR, \fBright\fR. .P \fBheight\fR .br typeof: integer .br Height to be used by the bar if possible. Leave blank for a dynamic value. .P \fBwidth\fR .br typeof: integer .br Width to be used by the bar if possible. Leave blank for a dynamic value. .P \fBmodules-left\fR .br typeof: array .br Modules that will be displayed on the left. .P \fBmodules-center\fR .br typeof: array .br Modules that will be displayed in the center. .P \fBmodules-right\fR .br typeof: array .RS 4 Modules that will be displayed on the right. .P .RE \fBmargin\fR .br typeof: string .br Margins value using the CSS format without units. .P \fBmargin-\fR .br typeof: integer .br Margins value without units. .P \fBname\fR .br typeof: string .br Optional name added as a CSS class, for styling multiple waybars. .P .SH MODULE FORMAT .P You can use PangoMarkupFormat (See https://developer.gnome.org/pango/stable/PangoMarkupFormat.html#PangoMarkupFormat). .P e.g. .P .nf .RS 4 "format": "{}" .fi .RE .SH MULTIPLE INSTANCES OF A MODULE .P If you want to have a second instance of a module, you can suffix it by a '#' and a custom name. For example if you want a second battery module, you can add \fB"battery#bat2"\fR to your modules. To configure the newly added module, you then also add a module configuration with the same name. .P This could then look something like this \fB(this is an incomplete example)\fR: .P .nf .RS 4 "modules-right": ["battery", "battery#bat2"], "battery": { "bat": "BAT1" }, "battery#bat2": { "bat": "BAT2" } .fi .RE .P .SH MINIMAL CONFIGURATION .P A minimal \fBconfig\fR file could look like this: .P .nf .RS 4 { "layer": "top", "modules-left": ["sway/workspaces", "sway/mode"], "modules-center": ["sway/window"], "modules-right": ["battery", "clock"], "sway/window": { "max-length": 50 }, "battery": { "format": "{capacity}% {icon}", "format-icons": ["", "", "", "", ""] }, "clock": { "format-alt": "{:%a, %d\&. %b %H:%M}" } } .fi .RE .P .SH MULTI OUTPUT CONFIGURATION .P .SS Limit a configuration to some outputs .P .nf .RS 4 { "layer": "top", "output": "eDP-1", "modules-left": ["sway/workspaces", "sway/mode"], \&.\&.\&. } .fi .RE .P .nf .RS 4 { "layer": "top", "output": ["eDP-1", "VGA"], "modules-left": ["sway/workspaces", "sway/mode"], \&.\&.\&. } .fi .RE .P .SS Configuration of multiple outputs .P Don't specify an output to create multiple bars on the same screen. .P .nf .RS 4 [{ "layer": "top", "output": "eDP-1", "modules-left": ["sway/workspaces", "sway/mode"], \&.\&.\&. }, { "layer": "top", "output": "VGA", "modules-right": ["clock"], \&.\&.\&. }] .fi .RE .P .SS Rotating modules .P When positioning Waybar on the left or right side of the screen, sometimes it's useful to be able to rotate the contents of a module so the text runs vertically. This can be done using the "rotate" property of the module. Example: .P .nf .RS 4 { "clock": { "rotate": 90 } } .fi .RE .P Valid options for the "rotate" property are: 0, 90, 180 and 270. .P .SH SUPPORTED MODULES .P .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fBwaybar-backlight(5)\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fBwaybar-battery(5)\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fBwaybar-clock(5)\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fBwaybar-cpu(5)\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fBwaybar-custom(5)\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fBwaybar-idle-inhibitor(5)\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fBwaybar-memory(5)\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fBwaybar-mdp(5)\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fBwaybar-network(5)\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fBwaybar-pulseaudio(5)\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fBwaybar-sway-mode(5)\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fBwaybar-sway-window(5)\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fBwaybar-sway-workspaces(5)\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fBwaybar-temperature(5)\fR .RE .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .IP \(bu 4 .\} \fBwaybar-tray(5)\fR .RE