1 ![logo](https://github.com/baskerville/bspwm/raw/master/logo/bspwm-logo.png)
5 `bspwm` is a tiling window manager based on binary space partitioning.
7 The windows are represented as the leaves of a binary tree.
11 `bspwm` have only two sources of informations: the X events it receives and the messages it reads on a dedicated socket.
13 Those messages are sent via `bspc`.
15 If the `BSPWM_SOCKET` environment variable is defined, it will be used as the socket path, otherwise `/tmp/bspwm-socket` is used.
17 The recommended way of defining keyboard shortcuts is to use [sxhkd](https://github.com/baskerville/sxhkd).
19 The only way to configure `bspwm` is by sending *set* messages via the client, hence `bspwm`'s configuration file is an executable called `autostart` which lives in `$XDG_CONFIG_HOME/bspwm/`.
21 Example configurations: [autostart](https://github.com/baskerville/bin/blob/master/bspwm_autostart) and [sxhkdrc](https://github.com/baskerville/dotfiles/blob/master/sxhkdrc).
25 There is only two splitting modes: *automatic* and *manual*.
27 The default mode is *automatic*. The *manual* mode is entered by sending a *presel* message.
29 Example: insertion of a new node (number 4) into the given tree in
39 +-------------------------+ +-------------------------+
43 | 3 |------------| --> | 4 |------------|
47 +-------------------------+ +-------------------------+
49 Same departure, but the mode is *manual*, and a `presel up` message
58 +-------------------------+ +-------------------------+
62 | 3 |------------| --> |------------|------------|
66 +-------------------------+ +-------------------------+
70 bspwm [-v|-s STATUS_FIFO]
72 bspc MESSAGE [ARGUMENTS] [OPTIONS]
76 The syntax for the client is `bspc MESSAGE [ARGUMENTS ...]`.
78 The following messages are handled:
81 Return the value of the given setting.
84 Set the value of the given setting.
87 Output the internal representation of the window tree.
89 list_desktops [--quiet]
90 Perform a dump of each desktop for the current monitor.
92 list_monitors [--quiet]
93 Perform a dump of each monitor.
96 Return the list of managed windows (i.e. their identifiers).
99 Return the list of rules.
101 presel left|right|up|down [SPLIT_RATIO]
102 Switch to manual mode and select the splitting direction.
105 Switch to automatic mode.
108 Set the splitting ratio of the focused window.
110 pad MONITOR_NAME [TOP_PADDING [RIGHT_PADDING [BOTTOM_PADDING [LEFT_PADDING]]]]
111 Set the padding of the given monitor.
113 focus left|right|up|down
114 Focus the neighbor window situated in the given direction.
116 shift left|right|up|down
117 Exchange the current window with the given neighbor.
120 Swap the focused window with the last focused window.
122 push left|right|up|down
123 Push the fence located in the given direction.
125 pull left|right|up|down
126 Pull the fence located in the given direction.
128 cycle next|prev [--skip-floating|--skip-tiled|--skip-class-equal|--skip-class-differ]
129 Focus the next or previous window matching the given constraints.
131 nearest older|newer [--skip-floating|--skip-tiled|--skip-class-equal|--skip-class-differ]
132 Focus the nearest window matching the given constraints.
134 circulate forward|backward
135 Circulate the leaves in the given direction.
137 grab_pointer move|resize|focus
138 Begin the specified pointer action.
140 track_pointer ROOT_X ROOT_Y
141 Pass the pointer root coordinates for the current pointer action.
144 End the current pointer action.
147 Toggle the fullscreen state of the current window.
150 Toggle the floating state of the current window.
153 Toggle the locked state of the current window (locked windows will not respond to the 'close' message).
156 Toggle the visibility of all the managed windows.
159 Close the focused window.
162 Kill the focused window.
164 send_to DESKTOP_NAME [--follow]
165 Send the focused window to the given desktop.
167 send_to_monitor MONITOR_NAME [--follow]
168 Send the focused window to the given monitor.
171 Select the given desktop.
173 use_monitor MONITOR_NAME
174 Select the given monitor.
177 Alternate between the current and the last focused window.
180 Alternate between the current and the last focused desktop.
183 Alternate between the current and the last focused monitor.
186 Make new desktops with the given names.
188 add_in MONITOR_NAME DESKTOP_NAME ...
189 Make new desktops with the given names in the given monitor.
191 rename_monitor CURRENT_NAME NEW_NAME
192 Rename the monitor named CURRENT_NAME to NEW_NAME.
194 rename CURRENT_NAME NEW_NAME
195 Rename the desktop named CURRENT_NAME to NEW_NAME.
197 cycle_monitor next|prev
198 Select the next or previous monitor.
200 cycle_desktop next|prev [--skip-free|--skip-occupied]
201 Select the next or previous desktop.
203 layout monocle|tiled [DESKTOP_NAME ...]
204 Set the layout of the given desktops (current if none given).
207 Cycle the layout of the current desktop.
209 rotate clockwise|counter_clockwise|full_cycle
210 Rotate the tree of the current desktop.
212 rule PATTERN [DESKTOP_NAME] [floating]
213 Create a new rule (PATTERN must match the class or instance name).
216 Remove the rules with the given UIDs.
219 Manage all the unmanaged windows remaining from a previous session.
222 Reload the autostart file.
225 Reload the default settings.
228 Restore the layout of each desktop from the content of FILE_PATH.
235 Colors are either [X color names](http://en.wikipedia.org/wiki/X11_color_names) or *#RRGGBB*, booleans are *true* or *false*.
238 Color of the main border of a focused window of a focused monitor.
241 Color of the main border of a focused window of an unfocused monitor.
244 Color of the main border of an unfocused window.
247 Color of the inner border of a window.
250 Color of the outer border of a window.
253 Color of the *presel* message feedback.
255 focused_locked_border_color
256 Color of the main border of a focused locked window of a focused monitor.
258 active_locked_border_color
259 Color of the main border of a focused locked window of an unfocused monitor.
261 normal_locked_border_color
262 Color of the main border of an unfocused locked window.
265 Color of the border of an urgent window.
270 Width of the inner, main and outer borders.
273 Value of the gap that separates windows.
275 {top,right,bottom,left}_padding
276 Padding space added at the sides of the current monitor.
279 The value that shall be used for the _NET_WM_NAME property of the root window.
282 Whether to remove borders for tiled windows in monocle mode.
285 Whether to remove gaps for tiled windows in monocle mode.
287 focus_follows_pointer
288 Wether to focus the window under the pointer.
291 Prevent floating windows from being raised when they might cover other floating windows.
295 - Configured and controlled through messages
296 - Multiple monitors support (via *Xinerama*)
297 - EWMH support (`tint2` works)
298 - Automatic and manual modes
299 - Triple window borders
304 - `dzen2` fed with the output of `ewmhstatus`. Example: [launchpanel](https://github.com/baskerville/bin/blob/master/launchpanel).
305 - A custom panel if the `-s` flag is used (have a look at the files in `examples/`).
306 - Any EWMH compliant panel (e.g. `tint2`, `bmpanel2`, etc.).
308 ## Required Libraries:
321 - [Ivan Kanakarakis](https://github.com/c00kiemon5ter)
325 bspwm *at* librelist *dot* com.