-
-
## Description
-`bspwm` is a tiling window manager based on binary space partitioning.
-
-The windows are represented as the leaves of a binary tree.
-
-## Configuration
-
-`bspwm` have only two sources of informations: the X events it receives and the messages it reads on a dedicated socket.
-
-Those messages are sent via `bspc`.
-
-If the `BSPWM_SOCKET` environment variable is defined, it will be used as the socket path, otherwise `/tmp/bspwm-socket` is used.
-
-The recommended way of defining keyboard shortcuts is to use [sxhkd](https://github.com/baskerville/sxhkd).
-
-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/`.
-
-Example configurations: [autostart](https://github.com/baskerville/bin/blob/master/bspwm_autostart) and [sxhkdrc](https://github.com/baskerville/dotfiles/blob/master/sxhkdrc).
-
-## Splitting Modes
-
-There is only two splitting modes: *automatic* and *manual*.
-
-The default mode is *automatic*. The *manual* mode is entered by sending a *presel* message.
-
-Example: insertion of a new node (number 4) into the given tree in
-*automatic* mode:
-
- b c
- / \ / \
- 3 a --> 4 b
- ^ / \ ^ / \
- 2 1 3 a
- / \
- 2 1
- +-------------------------+ +-------------------------+
- | | | | | |
- | | 2 | | | 3 |
- | | | | | |
- | 3 |------------| --> | 4 |------------|
- | ^ | | | ^ | | |
- | | 1 | | | 1 | 2 |
- | | | | | | |
- +-------------------------+ +-------------------------+
-
-Same departure, but the mode is *manual*, and a `presel up` message
-was sent beforehand:
-
- b b
- / \ / \
- 3 a --> c a
- ^ / \ / \ / \
- 2 1 4 3 2 1
- ^
- +-------------------------+ +-------------------------+
- | | | | | |
- | | 2 | | 4 | 2 |
- | | | | ^ | |
- | 3 |------------| --> |------------|------------|
- | ^ | | | | |
- | | 1 | | 3 | 1 |
- | | | | | |
- +-------------------------+ +-------------------------+
-
-## Synopsis
-
- bspwm [-v|-s STATUS_FIFO]
-
- bspc MESSAGE [ARGUMENTS] [OPTIONS]
-
-## Messages
-
-The syntax for the client is `bspc MESSAGE [ARGUMENTS ...]`.
-
-The following messages are handled:
-
-- `get SETTING` — Return the value of the given setting.
-
-- `set SETTING VALUE` — Set the value of the given setting.
-
-- `list [DESKTOP_NAME]` — Output the internal representation of the window tree.
-
-- `list_desktops [--quiet]` — Perform a dump of each desktop for the current monitor.
-
-- `list_monitors [--quiet]` — Perform a dump of each monitor.
-
-- `list_windows` — Return the list of managed windows (i.e. their identifiers).
-
-- `list_rules` — Return the list of rules.
+*bspwm* is a tiling window manager that represents windows as the leaves of a full binary tree.
-- `presel left|right|up|down [SPLIT_RATIO]` — Switch to manual mode and select the splitting direction.
+It only responds to X events, and the messages it receives on a dedicated socket.
-- `cancel` — Switch to automatic mode.
+*bspc* is a program that writes messages on *bspwm*'s socket.
-- `ratio VALUE` — Set the splitting ratio of the focused window.
+*bspwm* doesn't handle any keyboard or pointer inputs: a third party program (e.g. *sxhkd*) is needed in order to translate keyboard and pointer events to *bspc* invocations.
-- `pad MONITOR_NAME [TOP_PADDING [RIGHT_PADDING [BOTTOM_PADDING [LEFT_PADDING]]]]` — Set the padding of the given monitor.
+The outlined architecture is the following:
-- `focus left|right|up|down` — Focus the neighbor window situated in the given direction.
+```
+ PROCESS SOCKET
+sxhkd --------> bspc <------> bspwm
+```
-- `shift left|right|up|down` — Exchange the current window with the given neighbor.
-
-- `swap` — Swap the focused window with the last focused window.
-
-- `push left|right|up|down` — Push the fence located in the given direction.
-
-- `pull left|right|up|down` — Pull the fence located in the given direction.
-
-- `cycle next|prev [--skip-floating|--skip-tiled|--skip-class-equal|--skip-class-differ]` — Focus the next or previous window matching the given constraints.
-
-- `nearest older|newer [--skip-floating|--skip-tiled|--skip-class-equal|--skip-class-differ]` — Focus the nearest window matching the given constraints.
-
-- `circulate forward|backward` — Circulate the leaves in the given direction.
-
-- `grab_pointer move|resize|focus|move_tiled|resize_tiled` — Begin the specified pointer action.
-
-- `track_pointer ROOT_X ROOT_Y` — Pass the pointer root coordinates for the current pointer action.
-
-- `ungrab_pointer` — End the current pointer action.
-
-- `toggle_fullscreen` — Toggle the fullscreen state of the current window.
-
-- `toggle_floating` — Toggle the floating state of the current window.
-
-- `toggle_locked` — Toggle the locked state of the current window (locked windows will not respond to the `close` message).
-
-- `toggle_visibility` — Toggle the visibility of all the managed windows.
-
-- `close` — Close the focused window.
-
-- `kill` — Kill the focused window.
-
-- `send_to DESKTOP_NAME [--follow]` — Send the focused window to the given desktop.
-
-- `drop_to next|prev [--follow]` — Send the focused window to the next or previous desktop.
-
-- `send_to_monitor MONITOR_NAME [--follow]` — Send the focused window to the given monitor.
-
-- `drop_to_monitor next|prev [--follow]` — Send the focused window to the next or previous monitor.
-
-- `use DESKTOP_NAME` — Select the given desktop.
-
-- `use_monitor MONITOR_NAME` — Select the given monitor.
-
-- `alternate` — Alternate between the current and the last focused window.
-
-- `alternate_desktop` — Alternate between the current and the last focused desktop.
-
-- `alternate_monitor` — Alternate between the current and the last focused monitor.
-
-- `add DESKTOP_NAME ...` — Make new desktops with the given names.
-
-- `add_in MONITOR_NAME DESKTOP_NAME ...` — Make new desktops with the given names in the given monitor.
-
-- `rename_monitor CURRENT_NAME NEW_NAME` — Rename the monitor named `CURRENT_NAME` to `NEW_NAME`.
-
-- `rename CURRENT_NAME NEW_NAME` — Rename the desktop named `CURRENT_NAME` to `NEW_NAME`.
-
-- `cycle_monitor next|prev` — Select the next or previous monitor.
+## Configuration
-- `cycle_desktop next|prev [--skip-free|--skip-occupied]` — Select the next or previous desktop.
+The default configuration file is `$XDG_CONFIG_HOME/bspwm/bspwmrc`: this is simply a shell script that calls *bspc*.
-- `layout monocle|tiled [DESKTOP_NAME ...]` — Set the layout of the given desktops (current if none given).
+Keyboard and pointer bindings are defined with [sxhkd](https://github.com/baskerville/sxhkd).
-- `cycle_layout` — Cycle the layout of the current desktop.
+Example configuration files can be found in the [examples](examples) directory.
-- `rotate clockwise|counter_clockwise|full_cycle` — Rotate the tree of the current desktop.
+## Monitors, desktops and windows
-- `rule PATTERN [DESKTOP_NAME] [floating]` — Create a new rule (`PATTERN` must match the class or instance name).
+*bspwm* holds a list of monitors.
-- `remove_rule UID ...` — Remove the rules with the given UIDs.
+A monitor is just a rectangle that contains desktops.
-- `adopt_orphans` — Manage all the unmanaged windows remaining from a previous session.
+A desktop is just a pointer to a tree.
-- `reload_autostart` — Reload the autostart file.
+Monitors only show the tree of one desktop at a time (their focused desktop).
-- `reload_settings` — Reload the default settings.
+The tree is a partition of a monitor's rectangle into smaller rectangular regions.
-- `restore FILE_PATH` — Restore the layout of each desktop from the content of `FILE_PATH`.
+Each node in a tree either has zero or two children.
-- `quit [EXIT_STATUS]` — Quit.
+Each internal node is responsible for splitting a rectangle in half.
-## Settings
+A split is defined by two parameters: the type (horizontal or vertical) and the ratio (a real number *r* such that *0 < r < 1*).
-Colors are either [X color names](http://en.wikipedia.org/wiki/X11_color_names) or *#RRGGBB*, booleans are *true* or *false*.
+Each leaf node holds exactly one window.
-- `focused_border_color` — Color of the main border of a focused window of a focused monitor.
+## Insertion Modes
-- `active_border_color` — Color of the main border of a focused window of an unfocused monitor.
+### Prelude
-- `normal_border_color` — Color of the main border of an unfocused window.
+When *bspwm* receives a new window, it inserts it into a window tree at the specified insertion point (a leaf) using the insertion mode specified for that insertion point.
-- `inner_border_color` — Color of the inner border of a window.
+The insertion mode tells *bspwm* how it should alter the tree in order to insert new windows on a given insertion point.
-- `outer_border_color` — Color of the outer border of a window.
+By default the insertion point is the focused window and its default insertion mode is *automatic*.
-- `presel_border_color` — Color of the `presel` message feedback.
+### Automatic Mode
-- `focused_locked_border_color` — Color of the main border of a focused locked window of a focused monitor.
+The *automatic* mode, as opposed to the *manual* mode, doesn't require any user choice: the new window will *take the space* of the insertion point.
-- `active_locked_border_color` — Color of the main border of a focused locked window of an unfocused monitor.
+For example, let's consider the following scenario:
-- `normal_locked_border_color` — Color of the main border of an unfocused locked window.
+```
+ a a a
+ / \ / \ / \
+ 1 b ---> 1 c ---> 1 d
+ / \ / \ / \
+ 2 3 4 b 5 c
+ ^ ^ / \ ^ / \
+ 3 2 b 4
+ / \
+ 3 2
-- `urgent_border_color` — Color of the border of an urgent window.
+ +-----------------------+ +-----------------------+ +-----------------------+
+ | | | | | | | | |
+ | | 2 | | | 4 | | | 5 |
+ | | ^ | | | ^ | | | ^ |
+ | 1 |-----------| | 1 |-----------| | 1 |-----------|
+ | | | | | | | | | 3 | |
+ | | 3 | | | 3 | 2 | | |-----| 4 |
+ | | | | | | | | | 2 | |
+ +-----------------------+ +-----------------------+ +-----------------------+
-- `{inner,main,outer}_border_width` — Width of the inner, main and outer borders.
+ X Y Z
+```
-- `window_gap` — Value of the gap that separates windows.
+In state *X*, the insertion point, *2* is in automatic mode.
-- `{top,right,bottom,left}_padding` — Padding space added at the sides of the current monitor.
+When we add a new window, *4*, the whole tree rooted at *b* is reattached, as the second child of a new internal node, *c*.
-- `wm_name` — The value that shall be used for the `_NET_WM_NAME` property of the root window.
+The splitting parameters of *b* (type: *horizontal*, ratio: *½*) are copied to *c* and *b* is rotated by 90° clockwise.
-- `borderless_monocle` — Whether to remove borders for tiled windows in monocle mode.
+The tiling rectangle of *4* in state *Y* is equal to the tiling rectangle of *2* in state *X*.
-- `gapless_monocle` — Whether to remove gaps for tiled windows in monocle mode.
+Then the insertion of *5*, with *4* as insertion point, leads to *Z*.
-- `focus_follows_pointer` — Wether to focus the window under the pointer.
+The automatic mode generates window spirals that rotate clockwise (resp. anti-clockwise) if the insertion point is the first (resp. second) child of its parent.
-- `adaptative_raise` — Prevent floating windows from being raised when they might cover other floating windows.
+### Manual Mode
-- `apply_shadow_property` — Enable shadows for floating windows via the `_COMPTON_SHADOW` property.
+The user can specify a region in the insertion point where the next new window should appear by sending a *node -p|--presel-dir DIR* message to *bspwm*.
-- `fence_grip` — If the distance to the nearest fence is greater than `fence_grip`, the `resize_tiled` action will not be engaged.
+The *DIR* argument allows to specify how the insertion point should be split (horizontally or vertically) and if the new window should be the first or the second child of the new internal node (the insertion point will become its *brother*).
-## Key Features
+After doing so the insertion point goes into *manual* mode.
-- Configured and controlled through messages
-- Multiple monitors support (via *Xinerama*)
-- EWMH support (`tint2` works)
-- Automatic and manual modes
-- Triple window borders
+For example, let's consider the following scenario:
-## Panel
+```
+ a a a
+ / \ / \ / \
+ 1 b ---> c b ---> c b
+ ^ / \ / \ / \ / \ / \
+ 2 3 4 1 2 3 d 1 2 3
+ ^ / \
+ 5 4
+ ^
-Multiple choices:
-- `dzen2` fed with the output of `ewmhstatus`. Example: [launchpanel](https://github.com/baskerville/bin/blob/master/launchpanel).
-- A custom panel if the `-s` flag is used (have a look at the files in `examples/`).
-- Any EWMH compliant panel (e.g. `tint2`, `bmpanel2`, etc.).
++-----------------------+ +-----------------------+ +-----------------------+
+| | | | | | | | | |
+| | 2 | | 4 | 2 | | 5 | 4 | 2 |
+| | | | ^ | | | ^ | | |
+| 1 |-----------| |-----------|-----------| |-----------|-----------|
+| ^ | | | | | | | |
+| | 3 | | 1 | 3 | | 1 | 3 |
+| | | | | | | | |
++-----------------------+ +-----------------------+ +-----------------------+
-## Required Libraries:
+ X Y Z
+```
-- libxcb
-- xcb-util
-- xcb-util-wm
+In state *X*, the insertion point is *1*.
-## Installation
+We send the following message to *bspwm*: *node -p north*.
- make
- make install
+Then add a new window: *4*, this leads to state *Y*: the new internal node, *c* becomes *a*'s first child.
-## Contributors
+Finally we send another message: *node -p west* and add window *5*.
-- [Ivan Kanakarakis](https://github.com/c00kiemon5ter)
+The ratio of the preselection (that ends up being the ratio of the split of the new internal node) can be changed with the *node -o|--presel-ratio* message.
-## Mailing List
+## Supported protocols and standards
-bspwm *at* librelist *dot* com.
+- The RandR and Xinerama protocols.
+- A subset of the EWMH and ICCCM standards.
projects / bspwm.git / blobdiff