.\" 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 "sway-bar" "5" "2024-10-28" .PP .SH NAME .PP sway-bar - bar configuration file and commands .PP .SH DESCRIPTION .PP Sway allows configuring swaybar in the sway configuration file.\& .PP .SH COMMANDS .PP The following commands may only be used in the configuration file.\& .PP \fBid\fR .RS 4 Sets the ID of the bar.\& .PP .RE \fBswaybar_command\fR .RS 4 Executes custom bar command.\& Default is \fIswaybar\fR.\& .PP .RE The following commands may be used either in the configuration file or at runtime.\& .PP \fBbindcode\fR [--release] .RS 4 Executes \fIcommand\fR when the mouse button has been pressed (or if \fIreleased\fR is given, when the button has been released).\& The buttons can be given as an event code, which can be obtaining from \fBlibinput debug-events\fR.\& To disable the default behavior for a button, use the command \fInop\fR.\& .PP .RE \fBbindsym\fR [--release] button[1-9]| .RS 4 Executes \fIcommand\fR when the mouse button has been pressed (or if \fIreleased\fR is given, when the button has been released).\& The buttons can be given as a x11 button number or an event name, which can be obtained from \fBlibinput debug-events\fR.\& To disable the default behavior for a button, use the command \fInop\fR.\& .PP .RE \fBbinding_mode_indicator\fR yes|no .RS 4 Enable or disable binding mode indicator.\& Default is \fIyes\fR.\& .PP .RE \fBfont\fR .RS 4 Specifies the font to be used in the bar.\& \fIfont\fR should be specified as a pango font description.\& For more information on pango font descriptions, see https://docs.\>k.\&org/Pango/type_func.\&FontDescription.\&from_string.\&html#description .PP .RE \fBgaps\fR | | .RS 4 Sets the gaps from the edge of the screen for the bar.\& Gaps can either be set all at once, per direction, or per side.\& Note that only sides that touch an edge of the screen can have gaps.\& For the side that does not touch an edge of the screen, per-side outer gaps for workspaces may be of use.\& .PP .RE \fBheight\fR .RS 4 Sets the height of the bar.\& Default height (0) will match the font size.\& .PP .RE \fBhidden_state\fR hide|show [] .RS 4 Specifies the behaviour of the bar when it is in \fIhide\fR mode.\& When the hidden state is \fIhide\fR, then it is normally hidden, and only unhidden by pressing the modifier key or in case of urgency hints.\& When the hidden state is \fIshow\fR, then it is permanently visible, drawn on top of the currently visible workspace.\& Default is \fIhide\fR.\& .PP For compatibility with i3, \fIbar hidden_state hide|show []\fR is supported along with the sway only \fIbar hidden_state hide|show\fR syntax.\& When using the i3 syntax, if \fIbar-id\fR is omitted, the hidden_state will be changed for all bars.\& Attempting to use \fIbar hidden_state hide|show \fR will result in an error due to conflicting bar ids.\& .PP .RE \fBmode\fR dock|hide|invisible|overlay [] .RS 4 Specifies the visibility of the bar.\& In \fIdock\fR mode, it is permanently visible at one edge of the screen.\& In \fIhide\fR mode, it is hidden unless the modifier key is pressed, though this behaviour depends on the hidden state.\& In \fIinvisible\fR mode, it is permanently hidden.\& In \fIoverlay\fR mode, it is permanently visible on top of other windows.\& (In \fIoverlay\fR mode the bar is transparent to input events.\&) Default is \fIdock\fR.\& .PP For compatibility with i3, \fIbar mode []\fR syntax is supported along with the sway only \fIbar mode \fR syntax.\& When using the i3 syntax, if \fIbar-id\fR is omitted, the mode will be changed for all bars.\& Attempting to use \fIbar mode \fR will result in an error due to conflicting bar ids.\& .PP .RE \fBmodifier\fR |none .RS 4 Specifies the modifier key that shows a hidden bar.\& Default is \fIMod4\fR.\& .PP .RE \fBoutput\fR |* .RS 4 Restrict the bar to a certain output, can be specified multiple times.\& If the output command is omitted, the bar will be displayed on all outputs.\& \fI*\fR can be given at any point to reset it back to all outputs.\& .PP .RE \fBpango_markup\fR enabled|disabled .RS 4 Enables or disables pango markup for status lines.\& This has no effect on status lines using the i3bar JSON protocol.\& .PP .RE \fBposition\fR top|bottom .RS 4 Sets position of the bar.\& Default is \fIbottom\fR.\& .PP .RE \fBseparator_symbol\fR .RS 4 Specifies the separator symbol to separate blocks on the bar.\& .PP .RE \fBstatus_command\fR .RS 4 Executes the bar \fIstatus command\fR with \fIsh -c\fR.\& Each line of text printed to stdout from this command will be displayed in the status area of the bar.\& You may also use swaybar'\&s JSON status line protocol.\& See \fBswaybar-protocol\fR(7) for more information on the protocol .PP If running this command via IPC, you can disable a running status command by setting the command to a single dash: \fIswaybar bar bar-0 status_command -\fR .PP .RE \fBstatus_edge_padding\fR .RS 4 Sets the padding that is used when the status line is at the right edge of the bar.\& This value will be multiplied by the output scale.\& The default is \fI3\fR.\& .PP .RE \fBstatus_padding\fR .RS 4 Sets the vertical padding that is used for the status line.\& The default is \fI1\fR.\& If \fIpadding\fR is \fI0\fR, blocks will be able to take up the full height of the bar.\& This value will be multiplied by the output scale.\& .PP .RE \fBstrip_workspace_name\fR yes|no .RS 4 If set to \fIyes\fR, then workspace names will be omitted from the workspace button and only the custom number will be shown.\& Default is \fIno\fR.\& .PP .RE \fBstrip_workspace_numbers\fR yes|no .RS 4 If set to \fIyes\fR, then workspace numbers will be omitted from the workspace button and only the custom name will be shown.\& Default is \fIno\fR.\& .PP .RE \fBunbindcode\fR [--release] .RS 4 Removes the binding with the given .\& .PP .RE \fBunbindsym\fR [--release] button[1-9]| .RS 4 Removes the binding with the given