2 :man version: {revnumber}
3 :man manual: Bspwm Manual
11 bspwm - Binary space partitioning window manager
16 *bspwm* [*-h*|*-v*|*-c* 'CONFIG_PATH']
18 *bspc* 'DOMAIN' ['SELECTOR'] 'COMMANDS'
20 *bspc* 'COMMAND' ['OPTIONS'] ['ARGUMENTS']
25 *bspwm* is a tiling window manager that represents windows as the leaves of a full binary tree.
27 It is controlled and configured via *bspc*.
34 Print the synopsis and exit.
37 Print the version and exit.
40 Use the given configuration file.
46 DIR := north | west | south | east
47 CYCLE_DIR := next | prev
53 Selectors are used to select a target node, desktop, or monitor. A selector
54 can either describe the target relatively or name it globally.
56 Selectors consist of an optional reference, a descriptor and any number of
57 non-conflicting modifiers as follows:
59 [REFERENCE#]DESCRIPTOR(.MODIFIER)*
61 The relative targets are computed in relation to the given reference (the
62 default reference value is *focused*).
64 An exclamation mark can be prepended to any modifier in order to reverse its
67 The following characters cannot be used in monitor or desktop names: *#*, *:*, *.*.
69 The special selector *%<name>* can be used to select a monitor or a desktop with an invalid name.
77 NODE_SEL := [NODE_SEL#](DIR|CYCLE_DIR|PATH|any|last|newest|
78 older|newer|focused|pointed|biggest|smallest|
79 <node_id>)[.[!]focused][.[!]automatic][.[!]local][.[!]active]
80 [.[!]leaf][.[!]window][.[!]STATE][.[!]FLAG][.[!]LAYER]
81 [.[!]same_class][.[!]descendant_of][.[!]ancestor_of]
83 STATE := tiled|pseudo_tiled|floating|fullscreen
85 FLAG := hidden|sticky|private|locked|marked|urgent
87 LAYER := below|normal|above
89 PATH := @[DESKTOP_SEL:][[/]JUMP](/JUMP)*
91 JUMP := first|1|second|2|brother|parent|DIR
98 Selects the window in the given (spacial) direction relative to the reference node.
101 Selects the window in the given (cyclic) direction relative to the reference node.
104 Selects the node at the given path.
107 Selects the first node that matches the given selectors.
110 Selects the previously focused node relative to the reference node.
113 Selects the newest node in the history of the focused node.
116 Selects the node older than the reference node in the history.
119 Selects the node newer than the reference node in the history.
122 Selects the currently focused node.
125 Selects the window under the pointer.
128 Selects the biggest window.
131 Selects the smallest window.
134 Selects the node with the given ID.
139 The initial node is the focused node (or the root if the path starts with '/') of the reference desktop (or the selected desktop if the path has a 'DESKTOP_SEL' prefix).
142 Jumps to the first child.
145 Jumps to the second child.
148 Jumps to the brother node.
151 Jumps to the parent node.
154 Jumps to the node holding the edge in the given direction.
160 Only consider focused or unfocused nodes.
163 Only consider nodes in automatic or manual insertion mode. See also *--presel-dir* under *Node* in the *DOMAINS* section below.
166 Only consider nodes in or not in the reference desktop.
169 Only consider nodes in or not in the active desktop of their monitor.
172 Only consider leaves or internal nodes.
175 Only consider nodes that hold or don't hold a window.
177 [!](tiled|pseudo_tiled|floating|fullscreen)::
178 Only consider windows in or not in the given state.
181 Only consider windows that have or don't have the same class as the reference window.
184 Only consider nodes that are or aren't descendants of the reference node.
187 Only consider nodes that are or aren't ancestors of the reference node.
189 [!](hidden|sticky|private|locked|marked|urgent)::
190 Only consider windows that have or don't have the given flag set.
192 [!](below|normal|above)::
193 Only consider windows in or not in the given layer.
201 DESKTOP_SEL := [DESKTOP_SEL#](CYCLE_DIR|any|last|newest|older|newer|
202 [MONITOR_SEL:](focused|^<n>)|
203 <desktop_id>|<desktop_name>)[.[!]occupied][.[!]focused][.[!]urgent][.[!]local]
210 Selects the desktop in the given direction relative to the reference desktop.
213 Selects the first desktop that matches the given selectors.
216 Selects the previously focused desktop relative to the reference desktop.
219 Selects the newest desktop in the history of the focused desktops.
222 Selects the desktop older than the reference desktop in the history.
225 Selects the desktop newer than the reference desktop in the history.
228 Selects the currently focused desktop.
231 Selects the nth desktop. If *MONITOR_SEL* is given, selects the nth desktop on the selected monitor.
234 Selects the desktop with the given ID.
237 Selects the desktop with the given name.
243 Only consider occupied or free desktops.
246 Only consider focused or unfocused desktops.
249 Only consider urgent or non urgent desktops.
252 Only consider desktops inside or outside of the reference monitor.
260 MONITOR_SEL := [MONITOR_SEL#](DIR|CYCLE_DIR|any|last|newest|older|newer|
261 focused|pointed|primary|^<n>|
262 <monitor_id>|<monitor_name>)[.[!]occupied][.[!]focused]
269 Selects the monitor in the given (spacial) direction relative to the reference monitor.
272 Selects the monitor in the given (cyclic) direction relative to the reference monitor.
275 Selects the first monitor that matches the given selectors.
278 Selects the previously focused monitor relative to the reference monitor.
281 Selects the newest monitor in the history of the focused monitors.
284 Selects the monitor older than the reference monitor in the history.
287 Selects the monitor newer than the reference monitor in the history.
290 Selects the currently focused monitor.
293 Selects the monitor under the pointer.
296 Selects the primary monitor.
299 Selects the nth monitor.
302 Selects the monitor with the given ID.
305 Selects the monitor with the given name.
312 Only consider monitors where the focused desktop is occupied or free.
315 Only consider focused or unfocused monitors.
322 Its size and position are determined by the splitting type and ratio of each node of its path in the window tree.
325 Has an unrestricted size while being centered in its tiling space.
328 Can be moved/resized freely. Although it doesn't occupy any tiling space, it is still part of the window tree.
331 Fills its monitor rectangle and has no borders. It is send in the ABOVE layer by default.
338 Is hidden and doesn't occupy any tiling space.
341 Stays in the focused desktop of its monitor.
344 Tries to keep the same tiling position/size.
347 Ignores the *node --close* message.
350 Is marked (useful for deferred actions). A marked node becomes unmarked after being sent on a preselected node.
353 Has its urgency hint set. This flag is set externally.
359 There's three stacking layers: BELOW, NORMAL and ABOVE.
361 In each layer, the window are orderered as follow: tiled & pseudo-tiled < fullscreen < floating.
366 A leaf node that doesn't hold any window is called a receptacle. When a node is inserted on a receptacle in automatic mode, it will replace the receptacle. A receptacle can be inserted on a node, preselected and killed. Receptacles can therefore be used to build a tree whose leaves are receptacles. Using the appropriate rules, one can then send windows on the leaves of this tree. This feature is used in 'examples/receptacles' to store and recreate layouts.
378 node ['NODE_SEL'] 'COMMANDS'
380 If 'NODE_SEL' is omitted, *focused* is assumed.
384 *-f*, *--focus* ['NODE_SEL']::
385 Focus the selected or given node.
387 *-a*, *--activate* ['NODE_SEL']::
388 Activate the selected or given node.
390 *-d*, *--to-desktop* 'DESKTOP_SEL' [*--follow*]::
391 Send the selected node to the given desktop. If *--follow* is passed, the focused node will stay focused.
393 *-m*, *--to-monitor* 'MONITOR_SEL' [*--follow*]::
394 Send the selected node to the given monitor. If *--follow* is passed, the focused node will stay focused.
396 *-n*, *--to-node* 'NODE_SEL' [*--follow*]::
397 Send the selected node on the given node. If *--follow* is passed, the focused node will stay focused.
399 *-s*, *--swap* 'NODE_SEL' [*--follow*]::
400 Swap the selected node with the given node. If *--follow* is passed, the focused node will stay focused.
402 *-p*, *--presel-dir* \[~]'DIR'|cancel::
403 Preselect the splitting area of the selected node (or cancel the preselection). If *~* is prepended to 'DIR' and the current preselection direction matches 'DIR', then the argument is interpreted as *cancel*. A node with a preselected area is said to be in "manual insertion mode".
405 *-o*, *--presel-ratio* 'RATIO'::
406 Set the splitting ratio of the preselection area.
408 *-v*, *--move* 'dx' 'dy'::
409 Move the selected window by 'dx' pixels horizontally and 'dy' pixels vertically.
411 *-z*, *--resize* top|left|bottom|right|top_left|top_right|bottom_right|bottom_left 'dx' 'dy'::
412 Resize the selected window by moving the given handle by 'dx' pixels horizontally and 'dy' pixels vertically.
414 *-r*, *--ratio* 'RATIO'|(+|-)('PIXELS'|'FRACTION')::
415 Set the splitting ratio of the selected node (0 < 'RATIO' < 1).
417 *-R*, *--rotate* '90|270|180'::
418 Rotate the tree rooted at the selected node.
420 *-F*, *--flip* 'horizontal|vertical'::
421 Flip the the tree rooted at selected node.
424 Reset the split ratios of the tree rooted at the selected node to their default value.
427 Adjust the split ratios of the tree rooted at the selected node so that all windows occupy the same area.
429 *-C*, *--circulate* forward|backward::
430 Circulate the windows of the tree rooted at the selected node.
432 *-t*, *--state* [~](tiled|pseudo_tiled|floating|fullscreen)::
433 Set the state of the selected window. If *~* is present and the current state matches the given state, then the argument is interpreted as the last state.
435 *-g*, *--flag* hidden|sticky|private|locked|marked[=on|off]::
436 Set or toggle the given flag for the selected node.
438 *-l*, *--layer* below|normal|above::
439 Set the stacking layer of the selected window.
441 *-i*, *--insert-receptacle*::
442 Insert a receptacle node at the selected node.
445 Close the windows rooted at the selected node.
448 Kill the windows rooted at the selected node.
456 desktop ['DESKTOP_SEL'] 'COMMANDS'
458 If 'DESKTOP_SEL' is omitted, *focused* is assumed.
462 *-f*, *--focus* ['DESKTOP_SEL']::
463 Focus the selected or given desktop.
465 *-a*, *--activate* ['DESKTOP_SEL']::
466 Activate the selected or given desktop.
468 *-m*, *--to-monitor* 'MONITOR_SEL' [*--follow*]::
469 Send the selected desktop to the given monitor. If *--follow* is passed, the focused desktop will stay focused.
471 *-s*, *--swap* 'DESKTOP_SEL' [*--follow*]::
472 Swap the selected desktop with the given desktop. If *--follow* is passed, the focused desktop will stay focused.
474 *-l*, *--layout* 'CYCLE_DIR'|monocle|tiled::
475 Set or cycle the layout of the selected desktop.
477 *-n*, *--rename* <new_name>::
478 Rename the selected desktop.
480 *-b*, *--bubble* 'CYCLE_DIR'::
481 Bubble the selected desktop in the given direction.
484 Remove the selected desktop.
492 monitor ['MONITOR_SEL'] 'COMMANDS'
494 If 'MONITOR_SEL' is omitted, *focused* is assumed.
498 *-f*, *--focus* ['MONITOR_SEL']::
499 Focus the selected or given monitor.
501 *-s*, *--swap* 'MONITOR_SEL'::
502 Swap the selected monitor with the given monitor.
504 *-a*, *--add-desktops* <name>...::
505 Create desktops with the given names in the selected monitor.
507 *-o*, *--reorder-desktops* <name>...::
508 Reorder the desktops of the selected monitor to match the given order.
510 *-d*, *--reset-desktops* <name>...::
511 Rename, add or remove desktops depending on whether the number of given names is equal, superior or inferior to the number of existing desktops.
513 *-g*, *--rectangle* WxH+X+Y::
514 Set the rectangle of the selected monitor.
516 *-n*, *--rename* <new_name>::
517 Rename the selected monitor.
520 Remove the selected monitor.
528 query 'COMMANDS' ['OPTIONS']
533 The optional selectors are references.
535 *-N*, *--nodes* ['NODE_SEL']::
536 List the IDs of the matching nodes.
538 *-D*, *--desktops* ['DESKTOP_SEL']::
539 List the IDs (or names) of the matching desktops.
541 *-M*, *--monitors* ['MONITOR_SEL']::
542 List the IDs (or names) of the matching monitors.
545 Print a JSON representation of the matching item.
550 *-m*,*--monitor* ['MONITOR_SEL']::
551 *-d*,*--desktop* ['DESKTOP_SEL']::
552 *-n*, *--node* ['NODE_SEL']::
553 Constrain matches to the selected monitor, desktop or node. The descriptor can be omitted for '-M', '-D' and '-N'.
556 Print names instead of IDs. Can only be used with '-M' and '-D'.
569 *-d*, *--dump-state*::
570 Dump the current world state on standard output.
572 *-l*, *--load-state* <file_path>::
573 Load a world state from the given file.
575 *-a*, *--add-monitor* <name> WxH+X+Y::
576 Add a monitor for the given name and rectangle.
578 *-O*, *--reorder-monitors* <name>...::
579 Reorder the list of monitors to match the given order.
581 *-o*, *--adopt-orphans*::
582 Manage all the unmanaged windows remaining from a previous session.
584 *-h*, *--record-history* on|off::
585 Enable or disable the recording of node focus history.
587 *-g*, *--get-status*::
588 Print the current status information.
601 *-a*, *--add* (<class_name>|\*)[:(<instance_name>|\*)] [*-o*|*--one-shot*] [monitor=MONITOR_SEL|desktop=DESKTOP_SEL|node=NODE_SEL] [state=STATE] [layer=LAYER] [split_dir=DIR] [split_ratio=RATIO] [(hidden|sticky|private|locked|marked|center|follow|manage|focus|border)=(on|off)] [rectangle=WxH+X+Y]::
604 *-r*, *--remove* ^<n>|head|tail|(<class_name>|\*)[:(<instance_name>|*)]...::
605 Remove the given rules.
616 config [-m 'MONITOR_SEL'|-d 'DESKTOP_SEL'|-n 'NODE_SEL'] <setting> [<value>]::
617 Get or set the value of <setting>.
624 subscribe ['OPTIONS'] (all|report|monitor|desktop|node|...)*::
625 Continuously print events. See the *EVENTS* section for the description of each event.
631 Print a path to a FIFO from which events can be read and return.
633 *-c*, *--count* 'COUNT'::
634 Stop the corresponding *bspc* process after having received 'COUNT' events.
643 Quit with an optional exit status.
648 If the server can't handle a message, *bspc* will return with a non-zero exit code.
652 Colors are in the form '#RRGGBB', booleans are 'true', 'on', 'false' or 'off'.
654 All the boolean settings are 'false' by default unless stated otherwise.
659 'normal_border_color'::
660 Color of the border of an unfocused window.
662 'active_border_color'::
663 Color of the border of a focused window of an unfocused monitor.
665 'focused_border_color'::
666 Color of the border of a focused window of a focused monitor.
668 'presel_feedback_color'::
669 Color of the *node --presel-{dir,ratio}* message feedback area.
675 Prefix prepended to each of the status lines.
677 'external_rules_command'::
678 External command used to retrieve rule consequences. The command will receive the following arguments: window ID, class name, instance name, and intermediate consequences. The output of that command must have the following format: *key1=value1 key2=value2 ...* (the valid key/value pairs are given in the description of the 'rule' command).
681 On which child should a new window be attached when adding a window on a single window tree in automatic mode. Accept the following values: *first_child*, *second_child*.
683 'directional_focus_tightness'::
684 The tightness of the algorithm used to decide whether a window is on the 'DIR' side of another window. Accept the following values: *high*, *low*.
686 'borderless_monocle'::
687 Remove borders of tiled windows for the *monocle* desktop layout.
690 Remove gaps of tiled windows for the *monocle* desktop layout.
692 'paddingless_monocle'::
693 Remove padding space for the *monocle* desktop layout.
696 Set the desktop layout to *monocle* if there's only one tiled window in the tree.
698 'pointer_motion_interval'::
699 The minimum interval, in milliseconds, between two motion notify events.
702 Keyboard modifier used for moving or resizing windows. Accept the following values: *shift*, *control*, *lock*, *mod1*, *mod2*, *mod3*, *mod4*, *mod5*.
707 Action performed when pressing 'pointer_modifier' + 'button<n>'. Accept the following values: *move*, *resize_side*, *resize_corner*, *focus*, *none*.
710 Button used for focusing a window (or a monitor). The possible values are: *button1*, *button2*, *button3*, *any*, *none*. Defaults to *button1*.
712 'swallow_first_click'::
713 Don't replay the click that makes a window focused if 'click_to_focus' isn't *none*.
715 'focus_follows_pointer'::
716 Focus the window under the pointer.
718 'pointer_follows_focus'::
719 When focusing a window, put the pointer at its center.
721 'pointer_follows_monitor'::
722 When focusing a monitor, put the pointer at its center.
724 'mapping_events_count'::
725 Handle the next *mapping_events_count* mapping notify events. A negative value implies that every event needs to be handled.
727 'ignore_ewmh_focus'::
728 Ignore EWMH focus requests coming from applications.
730 'ignore_ewmh_fullscreen'::
731 Block the fullscreen state transitions that originate from an EWMH request. The possible values are: *none*, *all*, or a comma separated list of the following values: *enter*, *exit*.
733 'center_pseudo_tiled'::
734 Center pseudo tiled windows into their tiling rectangles. Defaults to 'true'.
737 Apply ICCCM window size hints.
739 'remove_disabled_monitors'::
740 Consider disabled monitors as disconnected.
742 'remove_unplugged_monitors'::
743 Remove unplugged monitors.
745 'merge_overlapping_monitors'::
746 Merge overlapping monitors (the bigger remains).
748 Monitor and Desktop Settings
749 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
755 Padding space added at the sides of the monitor or desktop.
761 Size of the gap that separates windows.
773 Focus the window (or the monitor) under the pointer if the value isn't *none*.
775 'pointer_modifier' + 'button1'::
776 Move the window under the pointer.
778 'pointer_modifier' + 'button2'::
779 Resize the window under the pointer by dragging the nearest side.
781 'pointer_modifier' + 'button3'::
782 Resize the window under the pointer by dragging the nearest corner.
784 The behavior of 'pointer_modifier' + 'button<n>' can be modified through the 'pointer_action<n>' setting.
790 See the next section for the description of the format.
792 'monitor_add <monitor_id> <monitor_name> <monitor_geometry>'::
795 'monitor_rename <monitor_id> <old_name> <new_name>'::
796 A monitor is renamed.
798 'monitor_remove <monitor_id>'::
799 A monitor is removed.
801 'monitor_swap <src_monitor_id> <dst_monitor_id>'::
802 A monitor is swapped.
804 'monitor_focus <monitor_id>'::
805 A monitor is focused.
807 'monitor_geometry <monitor_id> <monitor_geometry>'::
808 The geometry of a monitor changed.
810 'desktop_add <monitor_id> <desktop_id> <desktop_name>'::
813 'desktop_rename <monitor_id> <desktop_id> <old_name> <new_name>'::
814 A desktop is renamed.
816 'desktop_remove <monitor_id> <desktop_id>'::
817 A desktop is removed.
819 'desktop_swap <src_monitor_id> <src_desktop_id> <dst_monitor_id> <dst_desktop_id>'::
820 A desktop is swapped.
822 'desktop_transfer <src_monitor_id> <src_desktop_id> <dst_monitor_id>'::
823 A desktop is transferred.
825 'desktop_focus <monitor_id> <desktop_id>'::
826 A desktop is focused.
828 'desktop_activate <monitor_id> <desktop_id>'::
829 A desktop is activated.
831 'desktop_layout <monitor_id> <desktop_id> tiled|monocle'::
832 The layout of a desktop changed.
834 'node_add <monitor_id> <desktop_id> <ip_id> <node_id>'::
837 'node_remove <monitor_id> <desktop_id> <node_id>'::
840 'node_swap <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>'::
843 'node_transfer <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>'::
844 A node is transferred.
846 'node_focus <monitor_id> <desktop_id> <node_id>'::
849 'node_activate <monitor_id> <desktop_id> <node_id>'::
852 'node_presel <monitor_id> <desktop_id> <node_id> (dir DIR|ratio RATIO|cancel)'::
853 A node is preselected.
855 'node_stack <node_id_1> below|above <node_id_2>'::
856 A node is stacked below or above another node.
858 'node_geometry <monitor_id> <desktop_id> <node_id> <node_geometry>'::
859 The geometry of a window changed.
861 'node_state <monitor_id> <desktop_id> <node_id> tiled|pseudo_tiled|floating|fullscreen on|off'::
862 The state of a window changed.
864 'node_flag <monitor_id> <desktop_id> <node_id> hidden|sticky|private|locked|marked|urgent on|off'::
865 One of the flags of a node changed.
867 'node_layer <monitor_id> <desktop_id> <node_id> below|normal|above'::
868 The layer of a window changed.
870 'pointer_action <monitor_id> <desktop_id> <node_id> move|resize_corner|resize_side begin|end'::
871 A pointer action occured.
873 Please note that *bspwm* initializes monitors before it reads messages on its socket, therefore the initial monitor events can't be received.
878 Each report event message is composed of items separated by colons.
880 Each item has the form '<type><value>' where '<type>' is the first character of the item.
889 Occupied focused desktop.
892 Occupied unfocused desktop.
895 Free focused desktop.
898 Free unfocused desktop.
901 Urgent focused desktop.
904 Urgent unfocused desktop.
907 Layout of the focused desktop of a monitor.
910 State of the focused node of a focused desktop.
913 Active flags of the focused node of a focused desktop.
915 Environment Variables
916 ---------------------
919 The path of the socket used for the communication between *bspc* and *bspwm*. If it isn't defined, then the following path is used: '/tmp/bspwm<host_name>_<display_number>_<screen_number>-socket'.
924 * Steven Allen <steven at stebalien.com>
925 * Thomas Adam <thomas at xteddy.org>
926 * Ivan Kanakarakis <ivan.kanak at gmail.com>
931 Bastien Dejean <nihilhill at gmail.com>