3 bspwm \- Tiling window manager based on binary space partitioning
13 is a tiling window manager where each window is represented as the leaf of a binary tree. It is controlled and configured via
17 have only two sources of informations: the
19 events it receives and the messages it reads on a dedicated socket.
21 Those messages are sent via
26 environment variable is defined, it will be used as the socket path, otherwise
30 The recommended way of defining keyboard shortcuts is to use
33 The only way to configure
37 messages via the client, hence
39 configuration file is an executable called
42 .IR $XDG_CONFIG_HOME/bspwm/ .
44 There is only two splitting modes:
45 .IR automatic " and " manual .
51 mode is entered by sending a
55 Example: insertion of a new node (number 4) into the given tree in
66 +-------------------------+ +-------------------------+
70 | 3 |------------| --> | 4 |------------|
74 +-------------------------+ +-------------------------+
77 Same departure, but the mode is
81 message was sent beforehand:
89 +-------------------------+ +-------------------------+
93 | 3 |------------| --> |------------|------------|
97 +-------------------------+ +-------------------------+
102 Return the value of the given setting.
104 .BI set " SETTING VALUE"
105 Set the value of the given setting.
108 Output the internal representation of the window tree.
110 .BI list_desktops " [--quiet]"
111 Perform a dump of each desktop for the current monitor.
113 .BI list_monitors " [--quiet]"
114 Perform a dump of each monitor.
117 Return the list of managed windows (i.e. their identifiers).
119 .BI presel " left|right|up|down"
120 Switch to manual mode and select the splitting direction.
123 Switch to automatic mode.
126 Set the splitting ratio of the focused window.
128 .BI focus " left|right|up|down"
129 Focus the neighbor window situated in the given direction.
131 .BI shift " left|right|up|down"
132 Exchange the current window with the given neighbor.
134 .BI push " left|right|up|down"
135 Push the fence located in the given direction.
137 .BI pull " left|right|up|down"
138 Pull the fence located in the given direction.
140 .BI cycle " next|prev [--skip-floating|--skip-tiled|--skip-class-equal|--skip-class-differ]"
141 Focus the next or previous window matching the given constraints.
143 .BI nearest " older|newer [--skip-floating|--skip-tiled|--skip-class-equal|--skip-class-differ]"
144 Focus the nearest window matching the given constraints.
146 .BI circulate " forward|backward"
147 Circulate the leaves in the given direction.
149 .BI toggle_fullscreen
150 Toggle the fullscreen state of the current window.
153 Toggle the floating state of the current window.
156 Toggle the locked state of the current window (locked windows will not respond to the
161 Close the focused window.
164 Kill the focused window.
166 .BI send_to " DESKTOP_NAME"
167 Send the focused window to the given desktop.
169 .BI send_to_monitor " MONITOR_NAME"
170 Send the focused window to the given monitor.
172 .BI use " DESKTOP_NAME"
173 Select the given desktop.
175 .BI use_monitor " MONITOR_NAME"
176 Select the given monitor.
179 Alternate between the current and the last focused window.
181 .BI alternate_desktop
182 Alternate between the current and the last focused desktop.
184 .BI alternate_monitor
185 Alternate between the current and the last focused monitor.
187 .BI add " DESKTOP_NAME ..."
188 Make new desktops with the given names.
190 .BI add_in " MONITOR_NAME DESKTOP_NAME ..."
191 Make new desktops with the given names in the given monitor.
193 .BI rename_monitor " CURRENT_NAME NEW_NAME"
194 Rename the monitor named CURRENT_NAME to NEW_NAME.
196 .BI rename " CURRENT_NAME NEW_NAME"
197 Rename the desktop named CURRENT_NAME to NEW_NAME.
199 .BI cycle_monitor " next|prev"
200 Select the next or previous monitor.
202 .BI cycle_desktop " next|prev [--skip-free|--skip-occupied]"
203 Select the next or previous desktop.
205 .BI layout " monocle|tiled [DESKTOP_NAME ...]"
206 Set the layout of the given desktops (current if none given).
209 Cycle the layout of the current desktop.
211 .BI rotate " clockwise|counter_clockwise|full_cycle"
212 Rotate the tree of the current desktop.
214 .BI rule " PATTERN [DESKTOP_NAME] [floating] "
215 Create a new rule (PATTERN must match the class or instance name).
218 Manage all the unmanaged windows remaining from a previous session.
221 Reload the autostart file.
224 Reload the default settings.
227 Reload the autostart file and the default settings.
241 .IR "true " "or " false .
243 .I focused_border_color
244 Color of the main border of a focused window of a focused monitor.
246 .I active_border_color
247 Color of the main border of a focused window of an unfocused monitor.
249 .I normal_border_color
250 Color of the main border of an unfocused window.
252 .I inner_border_color
253 Color of the inner border of a window.
255 .I outer_border_color
256 Color of the outer border of a window.
258 .I presel_border_color
263 .I focused_locked_border_color
264 Color of the main border of a focused locked window of a focused monitor.
266 .I active_locked_border_color
267 Color of the main border of a focused locked window of an unfocused monitor.
269 .I normal_locked_border_color
270 Color of the main border of an unfocused locked window.
272 .I urgent_border_color
273 Color of the border of an urgent window.
275 .I {inner,main,outer}_border_width
276 Width of the inner, main and outer borders.
279 Value of the gap that separates windows.
281 .I {top,bottom,left,right}_padding
282 Padding space added at the sides of the screen.
285 The value that shall be used for the
287 property of the root window.
290 The modifier mask used for mouse bindings (possible values:
291 .BR mod1 " ... " mod5 ).
293 .I borderless_monocle
294 Whether to remove borders for tiled windows in monocle mode.
297 Whether to remove gaps for tiled windows in monocle mode.
299 .I focus_follows_mouse
300 Wether to focus the window under the mouse pointer.
303 .I button_modifier + left mouse button
304 Move the window under the pointer.
306 .I button_modifier + middle mouse button
307 Focus the window under the pointer.
309 .I button_modifier + right mouse button
310 Resize the window under the pointer (by moving one of its four corners).
313 Bastien Dejean <baskerville at lavabit.com>
316 Ivan Kanakarakis <ivan.kanak at gmail.com>
320 https://github.com/baskerville/bspwm