diff options
Diffstat (limited to 'sway/sway-bar.5.scd')
-rw-r--r-- | sway/sway-bar.5.scd | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/sway/sway-bar.5.scd b/sway/sway-bar.5.scd index 9a6397e3..5c8b9417 100644 --- a/sway/sway-bar.5.scd +++ b/sway/sway-bar.5.scd | |||
@@ -10,7 +10,7 @@ Sway allows configuring swaybar in the sway configuration file. | |||
10 | 10 | ||
11 | # COMMANDS | 11 | # COMMANDS |
12 | 12 | ||
13 | *status\_command* <status command> | 13 | *status_command* <status command> |
14 | Executes the bar _status command_ with _sh -c_. Each line of text printed | 14 | Executes the bar _status command_ with _sh -c_. Each line of text printed |
15 | to stdout from this command will be displayed in the status area of the | 15 | to stdout from this command will be displayed in the status area of the |
16 | bar. You may also use the i3bar JSON protocol: | 16 | bar. You may also use the i3bar JSON protocol: |
@@ -18,13 +18,13 @@ Sway allows configuring swaybar in the sway configuration file. | |||
18 | https://i3wm.org/docs/i3bar-protocol.html | 18 | https://i3wm.org/docs/i3bar-protocol.html |
19 | 19 | ||
20 | If running this command via IPC, you can disable a running status command by | 20 | If running this command via IPC, you can disable a running status command by |
21 | setting the command to a single dash: _swaybar bar bar-0 status\_command -_ | 21 | setting the command to a single dash: _swaybar bar bar-0 status_command -_ |
22 | 22 | ||
23 | *pango\_markup* enabled|disabled | 23 | *pango_markup* enabled|disabled |
24 | Enables or disables pango markup for status lines. This has no effect on | 24 | Enables or disables pango markup for status lines. This has no effect on |
25 | status lines using the i3bar JSON protocol. | 25 | status lines using the i3bar JSON protocol. |
26 | 26 | ||
27 | *id* <bar\_id> | 27 | *id* <bar_id> |
28 | Sets the ID of the bar. | 28 | Sets the ID of the bar. |
29 | 29 | ||
30 | *position* top|bottom | 30 | *position* top|bottom |
@@ -34,31 +34,31 @@ Sway allows configuring swaybar in the sway configuration file. | |||
34 | Restrict the bar to a certain output, can be specified multiple times. If | 34 | Restrict the bar to a certain output, can be specified multiple times. If |
35 | the output command is omitted, the bar will be displayed on all outputs. | 35 | the output command is omitted, the bar will be displayed on all outputs. |
36 | 36 | ||
37 | *swaybar\_command* <command> | 37 | *swaybar_command* <command> |
38 | Executes custom bar command. Default is _swaybar_. | 38 | Executes custom bar command. Default is _swaybar_. |
39 | 39 | ||
40 | *font* <font> | 40 | *font* <font> |
41 | Specifies the font to be used in the bar. | 41 | Specifies the font to be used in the bar. |
42 | 42 | ||
43 | *separator\_symbol* <symbol> | 43 | *separator_symbol* <symbol> |
44 | Specifies the separator symbol to separate blocks on the bar. | 44 | Specifies the separator symbol to separate blocks on the bar. |
45 | 45 | ||
46 | *wrap\_scroll* yes|no | 46 | *wrap_scroll* yes|no |
47 | Enables or disables wrapping when scrolling through workspaces with the | 47 | Enables or disables wrapping when scrolling through workspaces with the |
48 | scroll wheel. Default is _no_. | 48 | scroll wheel. Default is _no_. |
49 | 49 | ||
50 | *workspace\_buttons* yes|no | 50 | *workspace_buttons* yes|no |
51 | Enables or disables workspace buttons on the bar. Default is _yes_. | 51 | Enables or disables workspace buttons on the bar. Default is _yes_. |
52 | 52 | ||
53 | *strip\_workspace\_name* yes|no | 53 | *strip_workspace_name* yes|no |
54 | If set to _yes_, then workspace names will be omitted from the workspace | 54 | If set to _yes_, then workspace names will be omitted from the workspace |
55 | button and only the custom number will be shown. Default is _no_. | 55 | button and only the custom number will be shown. Default is _no_. |
56 | 56 | ||
57 | *strip\_workspace\_numbers* yes|no | 57 | *strip_workspace_numbers* yes|no |
58 | If set to _yes_, then workspace numbers will be omitted from the workspace | 58 | If set to _yes_, then workspace numbers will be omitted from the workspace |
59 | button and only the custom name will be shown. Default is _no_. | 59 | button and only the custom name will be shown. Default is _no_. |
60 | 60 | ||
61 | *binding\_mode\_indicator* yes|no | 61 | *binding_mode_indicator* yes|no |
62 | Enable or disable binding mode indicator. Default is _yes_. | 62 | Enable or disable binding mode indicator. Default is _yes_. |
63 | 63 | ||
64 | *gaps* <all> | <horizontal> <vertical> | <top> <right> <bottom> <left> | 64 | *gaps* <all> | <horizontal> <vertical> | <top> <right> <bottom> <left> |
@@ -90,7 +90,7 @@ Sway allows configuring swaybar in the sway configuration file. | |||
90 | modifier key is pressed, though this behaviour depends on the hidden state. | 90 | modifier key is pressed, though this behaviour depends on the hidden state. |
91 | In _invisible_ mode, it is permanently hidden. Default is _dock_. | 91 | In _invisible_ mode, it is permanently hidden. Default is _dock_. |
92 | 92 | ||
93 | *hidden\_state* hide|show | 93 | *hidden_state* hide|show |
94 | Specifies the behaviour of the bar when it is in _hide_ mode. When the | 94 | Specifies the behaviour of the bar when it is in _hide_ mode. When the |
95 | hidden state is _hide_, then it is normally hidden, and only unhidden by | 95 | hidden state is _hide_, then it is normally hidden, and only unhidden by |
96 | pressing the modifier key or in case of urgency hints. When the hidden | 96 | pressing the modifier key or in case of urgency hints. When the hidden |
@@ -100,12 +100,12 @@ Sway allows configuring swaybar in the sway configuration file. | |||
100 | *modifier* <Modifier>|none | 100 | *modifier* <Modifier>|none |
101 | Specifies the modifier key that shows a hidden bar. Default is _Mod4_. | 101 | Specifies the modifier key that shows a hidden bar. Default is _Mod4_. |
102 | 102 | ||
103 | *status\_padding* <padding> | 103 | *status_padding* <padding> |
104 | Sets the vertical padding that is used for the status line. The default is | 104 | Sets the vertical padding that is used for the status line. The default is |
105 | _1_. If _padding_ is _0_, blocks will be able to take up the full height of | 105 | _1_. If _padding_ is _0_, blocks will be able to take up the full height of |
106 | the bar. This value will be multiplied by the output scale. | 106 | the bar. This value will be multiplied by the output scale. |
107 | 107 | ||
108 | *status\_edge\_padding* <padding> | 108 | *status_edge_padding* <padding> |
109 | Sets the padding that is used when the status line is at the right edge of | 109 | Sets the padding that is used when the status line is at the right edge of |
110 | the bar. This value will be multiplied by the output scale. The default is | 110 | the bar. This value will be multiplied by the output scale. The default is |
111 | _3_. | 111 | _3_. |
@@ -115,13 +115,13 @@ Sway allows configuring swaybar in the sway configuration file. | |||
115 | Swaybar provides a system tray where third-party applications may place icons. | 115 | Swaybar provides a system tray where third-party applications may place icons. |
116 | The following commands configure the tray. | 116 | The following commands configure the tray. |
117 | 117 | ||
118 | *tray\_bindcode* <event-code> | 118 | *tray_bindcode* <event-code> |
119 | ContextMenu|Activate|SecondaryActivate|ScrollDown|ScrollLeft|ScrollRight|ScrollUp|nop | 119 | ContextMenu|Activate|SecondaryActivate|ScrollDown|ScrollLeft|ScrollRight|ScrollUp|nop |
120 | Executes the action when the mouse button has been pressed. The buttons can | 120 | Executes the action when the mouse button has been pressed. The buttons can |
121 | be given as an event code, which can be obtained from `libinput debug-events`. | 121 | be given as an event code, which can be obtained from `libinput debug-events`. |
122 | To disable the default behavior for a button, use the command _nop_. | 122 | To disable the default behavior for a button, use the command _nop_. |
123 | 123 | ||
124 | *tray\_bindsym* button[1-9]|<event-name> | 124 | *tray_bindsym* button[1-9]|<event-name> |
125 | ContextMenu|Activate|SecondaryActivate|ScrollDown|ScrollLeft|ScrollRight|ScrollUp|nop | 125 | ContextMenu|Activate|SecondaryActivate|ScrollDown|ScrollLeft|ScrollRight|ScrollUp|nop |
126 | Executes the action when the mouse button has been pressed. The buttons can | 126 | Executes the action when the mouse button has been pressed. The buttons can |
127 | be given as a x11 button number or an event name, which can be obtained | 127 | be given as a x11 button number or an event name, which can be obtained |
@@ -129,16 +129,16 @@ ContextMenu|Activate|SecondaryActivate|ScrollDown|ScrollLeft|ScrollRight|ScrollU | |||
129 | action (Activate for button1, ContextMenu for button2 and SecondaryActivate | 129 | action (Activate for button1, ContextMenu for button2 and SecondaryActivate |
130 | for button3). | 130 | for button3). |
131 | 131 | ||
132 | *tray\_padding* <px> [px] | 132 | *tray_padding* <px> [px] |
133 | Sets the pixel padding of the system tray. This padding will surround the | 133 | Sets the pixel padding of the system tray. This padding will surround the |
134 | tray on all sides and between each item. The default value for _px_ is 2. | 134 | tray on all sides and between each item. The default value for _px_ is 2. |
135 | 135 | ||
136 | *tray\_output* none|<output> | 136 | *tray_output* none|<output> |
137 | Restrict the tray to a certain output, can be specified multiple times. If | 137 | Restrict the tray to a certain output, can be specified multiple times. If |
138 | omitted, the tray will be displayed on all outputs. Unlike i3bar, swaybar | 138 | omitted, the tray will be displayed on all outputs. Unlike i3bar, swaybar |
139 | can show icons on any number of bars and outputs without races. | 139 | can show icons on any number of bars and outputs without races. |
140 | 140 | ||
141 | *icon\_theme* <name> | 141 | *icon_theme* <name> |
142 | Sets the icon theme that sway will look for item icons in. This option has | 142 | Sets the icon theme that sway will look for item icons in. This option has |
143 | no default value, because sway will always default to the fallback theme, | 143 | no default value, because sway will always default to the fallback theme, |
144 | hicolor. | 144 | hicolor. |
@@ -157,40 +157,40 @@ must be defined in hex: _#RRGGBB_ or _#RRGGBBAA_. | |||
157 | *separator* <color> | 157 | *separator* <color> |
158 | Text color to be used for the separator. | 158 | Text color to be used for the separator. |
159 | 159 | ||
160 | *focused\_background* <color> | 160 | *focused_background* <color> |
161 | Background color of the bar on the currently focused monitor output. If not | 161 | Background color of the bar on the currently focused monitor output. If not |
162 | used, the color will be taken from _background_. | 162 | used, the color will be taken from _background_. |
163 | 163 | ||
164 | *focused\_statusline* <color> | 164 | *focused_statusline* <color> |
165 | Text color to be used for the statusline on the currently focused monitor | 165 | Text color to be used for the statusline on the currently focused monitor |
166 | output. If not used, the color will be taken from _statusline_. | 166 | output. If not used, the color will be taken from _statusline_. |
167 | 167 | ||
168 | *focused\_separator* <color> | 168 | *focused_separator* <color> |
169 | Text color to be used for the separator on the currently focused monitor | 169 | Text color to be used for the separator on the currently focused monitor |
170 | output. If not used, the color will be taken from _separator_. | 170 | output. If not used, the color will be taken from _separator_. |
171 | 171 | ||
172 | *focused\_workspace* <border> <background> <text> | 172 | *focused_workspace* <border> <background> <text> |
173 | Border, background and text color for a workspace button when the workspace | 173 | Border, background and text color for a workspace button when the workspace |
174 | has focus. | 174 | has focus. |
175 | 175 | ||
176 | *active\_workspace* <border> <background> <text> | 176 | *active_workspace* <border> <background> <text> |
177 | Border, background and text color for a workspace button when the workspace | 177 | Border, background and text color for a workspace button when the workspace |
178 | is active (visible) on some output, but the focus is on another one. You | 178 | is active (visible) on some output, but the focus is on another one. You |
179 | can only tell this apart from the focused workspace when you are using | 179 | can only tell this apart from the focused workspace when you are using |
180 | multiple monitors. | 180 | multiple monitors. |
181 | 181 | ||
182 | *inactive\_workspace* <border> <background> <text> | 182 | *inactive_workspace* <border> <background> <text> |
183 | Border, background and text color for a workspace button when the workspace | 183 | Border, background and text color for a workspace button when the workspace |
184 | does not have focus and is not active (visible) on any output. This will be | 184 | does not have focus and is not active (visible) on any output. This will be |
185 | the case for most workspaces. | 185 | the case for most workspaces. |
186 | 186 | ||
187 | *urgent\_workspace* <border> <background> <text> | 187 | *urgent_workspace* <border> <background> <text> |
188 | Border, background and text color for a workspace button when the workspace | 188 | Border, background and text color for a workspace button when the workspace |
189 | contains a window with the urgency hint set. | 189 | contains a window with the urgency hint set. |
190 | 190 | ||
191 | *binding\_mode* <border> <background> <text> | 191 | *binding_mode* <border> <background> <text> |
192 | Border, background and text color for the binding mode indicator. If not used, | 192 | Border, background and text color for the binding mode indicator. If not used, |
193 | the colors will be taken from _urgent\_workspace_. | 193 | the colors will be taken from _urgent_workspace_. |
194 | 194 | ||
195 | # SEE ALSO | 195 | # SEE ALSO |
196 | 196 | ||