*bspwm* [*-h*|*-v*|*-c* 'CONFIG_PATH']
-*bspc* 'COMMAND' ['ARGUMENTS']
+*bspc* 'DOMAIN' ['SELECTOR'] 'COMMANDS'
+
+*bspc* 'COMMAND' ['OPTIONS'] ['ARGUMENTS']
Description
-----------
------------------
----
-DIR := left | right | up | down
+DIR := north | west | south | east
CYCLE_DIR := next | prev
----
Selectors
---------
-Selectors are used to select a target window, desktop, or monitor. A selector
+Selectors are used to select a target node, desktop, or monitor. A selector
can either describe the target relatively or name it globally.
-Descriptive (relative) selectors consist of a primary selector and any number
-of non-conflicting modifiers as follows:
+Selectors consist of an optional reference, a descriptor and any number of
+non-conflicting modifiers as follows:
- PRIMARY_SELECTOR[.MODIFIER]*
+ [REFERENCE#]DESCRIPTOR(.MODIFIER)*
-For obvious reasons, neither desktop nor monitor names may be valid descriptive
-selectors.
+The relative targets are computed in relation to the given reference (the
+default reference value is *focused*).
-Window
-~~~~~~
+An exclamation mark can be prepended to any modifier in order to reverse its
+meaning.
+
+The following characters cannot be used in monitor or desktop names: *#*, *:*, *.*.
+
+The special selector *%<name>* can be used to select a monitor or a desktop with an invalid name.
-Select a window.
+Node
+~~~~
+
+Select a node.
----
-WINDOW_SEL := <window_id>
- | (DIR|CYCLE_DIR|biggest|last|focused|older|newer)[.manual|.automatic][.tiled|nontiled][.pseudotiled|.nonpseudotiled][.floating|.nonfloating][.fullscreen|.nonfullscreen][.below|.normal|.above][.local|.foreign][.like|.unlike][.focused|.unfocused][.urgent|.nonurgent][.sticky|.nonsticky][.public|.private][.locked|.unlocked]
+NODE_SEL := [NODE_SEL#](DIR|CYCLE_DIR|PATH|any|first_ancestor|last|newest|
+ older|newer|focused|pointed|biggest|smallest|
+ <node_id>)[.[!]focused][.[!]active][.[!]automatic][.[!]local]
+ [.[!]leaf][.[!]window][.[!]STATE][.[!]FLAG][.[!]LAYER][.[!]SPLIT_TYPE]
+ [.[!]same_class][.[!]descendant_of][.[!]ancestor_of]
+
+STATE := tiled|pseudo_tiled|floating|fullscreen
+
+FLAG := hidden|sticky|private|locked|marked|urgent
+
+LAYER := below|normal|above
+
+SPLIT_TYPE := horizontal|vertical
+
+PATH := @[DESKTOP_SEL:][[/]JUMP](/JUMP)*
+
+JUMP := first|1|second|2|brother|parent|DIR
----
-Primary Selectors
-^^^^^^^^^^^^^^^^^
+Descriptors
+^^^^^^^^^^^
'DIR'::
- Selects the window in the given (spacial) direction relative to the active window.
+ Selects the window in the given (spacial) direction relative to the reference node.
'CYCLE_DIR'::
- Selects the window in the given (cyclic) direction.
+ Selects the node in the given (cyclic) direction relative to the reference node within a depth-first in-order traversal of the tree.
-biggest::
- Selects the biggest window on the current desktop.
+'PATH'::
+ Selects the node at the given path.
+
+any::
+ Selects the first node that matches the given selectors.
+
+first_ancestor::
+ Selects the first ancestor of the reference node that matches the given selectors.
last::
- Selects the previously focused window.
+ Selects the previously focused node relative to the reference node.
-focused::
- Selects the currently focused window.
+newest::
+ Selects the newest node in the history of the focused node.
older::
- Selects the window older than the focused window in the history.
+ Selects the node older than the reference node in the history.
newer::
- Selects the window newer than the focused window in the history.
-
-Modifiers
-^^^^^^^^^
+ Selects the node newer than the reference node in the history.
-tiled::
- Only consider tiled windows.
+focused::
+ Selects the currently focused node.
-nontiled::
- Only consider non tiled windows.
+pointed::
+ Selects the leaf under the pointer.
-pseudotiled::
- Only consider pseudo-tiled windows.
+biggest::
+ Selects the biggest leaf.
-nonpseudotiled::
- Only consider non pseudo-tiled windows.
+smallest::
+ Selects the smallest leaf.
-floating::
- Only consider floating windows.
+<node_id>::
+ Selects the node with the given ID.
-nonfloating::
- Only consider non floating windows.
+Path Jumps
+^^^^^^^^^^
-fullscreen::
- Only consider fullscreen windows.
+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).
-nonfullscreen::
- Only consider non fullscreen windows.
+1|first::
+ Jumps to the first child.
-manual::
- Only consider windows in manual splitting mode.
+2|second::
+ Jumps to the second child.
-automatic::
- Only consider windows in automatic splitting mode.
+brother::
+ Jumps to the brother node.
-focused::
- Only consider focused windows.
+parent::
+ Jumps to the parent node.
-unfocused::
- Only consider unfocused windows.
+'DIR'::
+ Jumps to the node holding the edge in the given direction.
-below::
- Only consider windows of the BELOW layer.
+Modifiers
+^^^^^^^^^
-normal::
- Only consider windows of the NORMAL layer.
+[!]focused::
+ Only consider the focused node.
-above::
- Only consider windows of the ABOVE layer.
+[!]active::
+ Only consider nodes that are the focused node of their desktop.
-like::
- Only consider windows that have the same class as the current window.
+[!]automatic::
+ Only consider nodes in automatic insertion mode. See also *--presel-dir* under *Node* in the *DOMAINS* section below.
-unlike::
- Only consider windows that have a different class than the current window.
+[!]local::
+ Only consider nodes in the reference desktop.
-local::
- Only consider windows of the current desktop.
+[!]leaf::
+ Only consider leaf nodes.
-foreign::
- Only consider windows outside of the current desktop.
+[!]window::
+ Only consider nodes that hold a window.
-private::
- Only consider private windows.
+[!](tiled|pseudo_tiled|floating|fullscreen)::
+ Only consider windows in the given state.
-public::
- Only consider non private windows.
+[!]same_class::
+ Only consider windows that have the same class as the reference window.
-urgent::
- Only consider urgent windows.
+[!]descendant_of::
+ Only consider nodes that are descendants of the reference node.
-nonurgent::
- Only consider non urgent windows.
+[!]ancestor_of::
+ Only consider nodes that are ancestors of the reference node.
-sticky::
- Only consider sticky windows.
+[!](hidden|sticky|private|locked|marked|urgent)::
+ Only consider windows that have the given flag set.
-nonsticky::
- Only consider non sticky windows.
+[!](below|normal|above)::
+ Only consider windows in the given layer.
-locked::
- Only consider locked windows.
+[!](horizontal|vertical)::
+ Only consider nodes with the given split type.
-unlocked::
- Only consider non locked windows.
Desktop
~~~~~~~
Select a desktop.
----
-DESKTOP_SEL := <desktop_name>
- | [MONITOR_SEL:]^<n>
- | (CYCLE_DIR|last|[MONITOR_SEL:]focused|older|newer)[.occupied|.free][.urgent|.nonurgent][.local|.foreign]
-----
+DESKTOP_SEL := [DESKTOP_SEL#](CYCLE_DIR|any|last|newest|older|newer|
+ [MONITOR_SEL:](focused|^<n>)|
+ <desktop_id>|<desktop_name>)[.[!]focused][.[!]active]
+ [.[!]occupied][.[!]urgent][.[!]local]
+ [.[!]LAYOUT][.[!]user_LAYOUT]
-Primary Selectors
-^^^^^^^^^^^^^^^^^
+LAYOUT := tiled|monocle
+----
-<desktop_name>::
- Selects the desktop with the given name.
-
-^<n>::
- Selects the nth desktop.
+Descriptors
+^^^^^^^^^^^
'CYCLE_DIR'::
- Selects the desktop in the given direction relative to the active desktop.
+ Selects the desktop in the given direction relative to the reference desktop.
+
+any::
+ Selects the first desktop that matches the given selectors.
last::
- Selects the previously focused desktop.
+ Selects the previously focused desktop relative to the reference desktop.
-focused::
- Selects the currently focused desktop.
+newest::
+ Selects the newest desktop in the history of the focused desktops.
older::
- Selects the desktop older than the focused desktop in the history.
+ Selects the desktop older than the reference desktop in the history.
newer::
- Selects the desktop newer than the focused desktop in the history.
+ Selects the desktop newer than the reference desktop in the history.
+
+focused::
+ Selects the currently focused desktop.
+
+^<n>::
+ Selects the nth desktop. If *MONITOR_SEL* is given, selects the nth desktop on the selected monitor.
+
+<desktop_id>::
+ Selects the desktop with the given ID.
+
+<desktop_name>::
+ Selects the desktop with the given name.
Modifiers
^^^^^^^^^
-occupied::
- Only consider occupied desktops.
+[!]focused::
+ Only consider the focused desktop.
-free::
- Only consider free desktops.
+[!]active::
+ Only consider desktops that are the focused desktop of their monitor.
-urgent::
+[!]occupied::
+ Only consider occupied desktops.
+
+[!]urgent::
Only consider urgent desktops.
-nonurgent::
- Only consider non urgent desktops.
+[!]local::
+ Only consider desktops inside the reference monitor.
-local::
- Only consider desktops of the current monitor.
+[!](tiled|monocle)::
+ Only consider desktops with the given layout.
-foreign::
- Only consider desktops outside of the current monitor.
+[!](user_tiled|user_monocle)::
+ Only consider desktops which have the given layout as userLayout.
Monitor
~~~~~~~
Select a monitor.
----
-MONITOR_SEL := <monitor_name>
- | ^<n>
- | (DIR|CYCLE_DIR|last|primary|focused|older|newer)[.occupied|.free]
+MONITOR_SEL := [MONITOR_SEL#](DIR|CYCLE_DIR|any|last|newest|older|newer|
+ focused|pointed|primary|^<n>|
+ <monitor_id>|<monitor_name>)[.[!]focused][.[!]occupied]
----
-Primary Selectors
-^^^^^^^^^^^^^^^^^
-
-<monitor_name>::
- Selects the monitor with the given name.
-
-^<n>::
- Selects the nth monitor.
+Descriptors
+^^^^^^^^^^^
'DIR'::
- Selects the monitor in the given (spacial) direction relative to the active monitor.
+ Selects the monitor in the given (spacial) direction relative to the reference monitor.
'CYCLE_DIR'::
- Selects the monitor in the given (cyclic) direction relative to the active monitor.
+ Selects the monitor in the given (cyclic) direction relative to the reference monitor.
-primary::
- Selects the primary monitor.
+any::
+ Selects the first monitor that matches the given selectors.
last::
- Selects the previously focused monitor.
+ Selects the previously focused monitor relative to the reference monitor.
-focused::
- Selects the currently focused monitor.
+newest::
+ Selects the newest monitor in the history of the focused monitors.
older::
- Selects the monitor older than the focused monitor in the history.
+ Selects the monitor older than the reference monitor in the history.
newer::
- Selects the monitor newer than the focused monitor in the history.
+ Selects the monitor newer than the reference monitor in the history.
+
+focused::
+ Selects the currently focused monitor.
+
+pointed::
+ Selects the monitor under the pointer.
+
+primary::
+ Selects the primary monitor.
+
+^<n>::
+ Selects the nth monitor.
+
+<monitor_id>::
+ Selects the monitor with the given ID.
+
+<monitor_name>::
+ Selects the monitor with the given name.
+
Modifiers
^^^^^^^^^
-occupied::
+[!]focused::
+ Only consider the focused monitor.
+
+[!]occupied::
Only consider monitors where the focused desktop is occupied.
-free::
- Only consider monitors where the focused desktop is free.
Window States
-------------
tiled::
- Its size and position are determined by the splitting type and ratio of each node of its path in the window tree.
+ Its size and position are determined by the window tree.
pseudo_tiled::
- Has an unrestricted size while being centered in its tiling space.
+ A tiled window that automatically shrinks but doesn't stretch beyond its floating size.
floating::
- Can be moved/resized freely. Although it doesn't occupy any tiling space, it is still part of the window tree.
+ Can be moved/resized freely. Although it doesn't use any tiling space, it is still part of the window tree.
fullscreen::
- Fills its monitor rectangle and has no borders. It is send in the ABOVE layer by default.
+ Fills its monitor rectangle and has no borders.
-Window Flags
--------------
+Node Flags
+----------
-locked::
- Ignores the *window --close* message.
+hidden::
+ Is hidden and doesn't occupy any tiling space.
sticky::
Stays in the focused desktop of its monitor.
private::
Tries to keep the same tiling position/size.
+locked::
+ Ignores the *node --close* message.
+
+marked::
+ Is marked (useful for deferred actions). A marked node becomes unmarked after being sent on a preselected node.
+
urgent::
Has its urgency hint set. This flag is set externally.
There's three stacking layers: BELOW, NORMAL and ABOVE.
-In each layer, the window are orderered as follow: tiled & pseudo-tiled < fullscreen < floating.
+In each layer, the window are orderered as follow: tiled & pseudo-tiled < floating < fullscreen.
+
+Receptacles
+-----------
+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.
-Commands
---------
-Window
-~~~~~~
+Domains
+-------
+
+Node
+~~~~
General Syntax
^^^^^^^^^^^^^^
-window ['WINDOW_SEL'] 'OPTIONS'
+node ['NODE_SEL'] 'COMMANDS'
-Options
-^^^^^^^
-*-f*, *--focus* ['WINDOW_SEL']::
- Focus the selected or given window.
+If 'NODE_SEL' is omitted, *focused* is assumed.
+
+Commands
+^^^^^^^^
+*-f*, *--focus* ['NODE_SEL']::
+ Focus the selected or given node.
-*-a*, *--activate* ['WINDOW_SEL']::
- Activate the selected or given window.
+*-a*, *--activate* ['NODE_SEL']::
+ Activate the selected or given node.
-*-d*, *--to-desktop* 'DESKTOP_SEL'::
- Send the selected window to the given desktop.
+*-d*, *--to-desktop* 'DESKTOP_SEL' [*--follow*]::
+ Send the selected node to the given desktop. If *--follow* is passed, the focused node will stay focused.
-*-m*, *--to-monitor* 'MONITOR_SEL'::
- Send the selected window to the given monitor.
+*-m*, *--to-monitor* 'MONITOR_SEL' [*--follow*]::
+ Send the selected node to the given monitor. If *--follow* is passed, the focused node will stay focused.
-*-w*, *--to-window* 'WINDOW_SEL'::
- Transplant the selected window to the given window.
+*-n*, *--to-node* 'NODE_SEL' [*--follow*]::
+ Send the selected node on the given node. If *--follow* is passed, the focused node will stay focused.
-*-s*, *--swap* 'WINDOW_SEL'::
- Swap the selected window with the given window.
+*-s*, *--swap* 'NODE_SEL' [*--follow*]::
+ Swap the selected node with the given node. If *--follow* is passed, the focused node will stay focused.
-*-p*, *--presel* 'DIR'|cancel::
- Preselect the splitting area of the selected window (or cancel the preselection).
+*-p*, *--presel-dir* \[~]'DIR'|cancel::
+ 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".
-*-r*, *--ratio* 'RATIO'::
- Set the splitting ratio of the selected window (0 < 'RATIO' < 1).
+*-o*, *--presel-ratio* 'RATIO'::
+ Set the splitting ratio of the preselection area.
-*-e*, *--edge* 'DIR' 'RATIO'|±'PIXELS'::
- Set or change the splitting ratio of the edge located in the given direction in relation to the selected window.
+*-v*, *--move* 'dx' 'dy'::
+ Move the selected window by 'dx' pixels horizontally and 'dy' pixels vertically.
-*-R*, *--rotate* 'DIR' '90|270|180'::
- Rotate the tree holding the edge located in the given direction in relation to the selected window.
+*-z*, *--resize* top|left|bottom|right|top_left|top_right|bottom_right|bottom_left 'dx' 'dy'::
+ Resize the selected window by moving the given handle by 'dx' pixels horizontally and 'dy' pixels vertically.
-*-t*, *--state* tiled|pseudo_tiled|floating|fullscreen::
- Set the state of the selected window.
+*-r*, *--ratio* 'RATIO'|(+|-)('PIXELS'|'FRACTION')::
+ Set the splitting ratio of the selected node (0 < 'RATIO' < 1).
-*-g*, *--flag* locked|sticky|private[=on|off]::
- Set or toggle the given flag for the selected window.
+*-R*, *--rotate* '90|270|180'::
+ Rotate the tree rooted at the selected node.
+
+*-F*, *--flip* 'horizontal|vertical'::
+ Flip the tree rooted at selected node.
+
+*-E*, *--equalize*::
+ Reset the split ratios of the tree rooted at the selected node to their default value.
+
+*-B*, *--balance*::
+ Adjust the split ratios of the tree rooted at the selected node so that all windows occupy the same area.
+
+*-C*, *--circulate* forward|backward::
+ Circulate the windows of the tree rooted at the selected node.
+
+*-t*, *--state* \~|\[~]'STATE'::
+ Set the state of the selected window. If *\~* is present and the current state matches 'STATE', then the argument is interpreted as its last state. If the argument is just *~* with 'STATE' omitted, then the state of the selected window is set to its last state.
+
+*-g*, *--flag* hidden|sticky|private|locked|marked[=on|off]::
+ Set or toggle the given flag for the selected node.
*-l*, *--layer* below|normal|above::
Set the stacking layer of the selected window.
+*-i*, *--insert-receptacle*::
+ Insert a receptacle node at the selected node.
+
*-c*, *--close*::
- Close the selected window.
+ Close the windows rooted at the selected node.
*-k*, *--kill*::
- Kill the selected window.
+ Kill the windows rooted at the selected node.
Desktop
~~~~~~~
General Syntax
^^^^^^^^^^^^^^
-desktop ['DESKTOP_SEL'] 'OPTIONS'
+desktop ['DESKTOP_SEL'] 'COMMANDS'
-Options
-^^^^^^^
+If 'DESKTOP_SEL' is omitted, *focused* is assumed.
+
+COMMANDS
+^^^^^^^^
*-f*, *--focus* ['DESKTOP_SEL']::
Focus the selected or given desktop.
-*-m*, *--to-monitor* 'MONITOR_SEL'::
- Send the selected desktop to the given monitor.
+*-a*, *--activate* ['DESKTOP_SEL']::
+ Activate the selected or given desktop.
+
+*-m*, *--to-monitor* 'MONITOR_SEL' [*--follow*]::
+ Send the selected desktop to the given monitor. If *--follow* is passed, the focused desktop will stay focused.
+
+*-s*, *--swap* 'DESKTOP_SEL' [*--follow*]::
+ Swap the selected desktop with the given desktop. If *--follow* is passed, the focused desktop will stay focused.
*-l*, *--layout* 'CYCLE_DIR'|monocle|tiled::
Set or cycle the layout of the selected desktop.
*-n*, *--rename* <new_name>::
Rename the selected desktop.
-*-s*, *--swap* 'DESKTOP_SEL'::
- Swap the selected desktop with the given desktop.
-
*-b*, *--bubble* 'CYCLE_DIR'::
Bubble the selected desktop in the given direction.
*-r*, *--remove*::
Remove the selected desktop.
-*-c*, *--cancel-presel*::
- Cancel the preselection of all the windows of the selected desktop.
-
-*-F*, *--flip* 'horizontal|vertical'::
- Flip the tree of the selected desktop.
-
-*-R*, *--rotate* '90|270|180'::
- Rotate the tree of the selected desktop.
-
-*-E*, *--equalize*::
- Reset the split ratios of the tree of the selected desktop.
-
-*-B*, *--balance*::
- Adjust the split ratios of the tree of the selected desktop so that all windows occupy the same area.
-
-*-C*, *--circulate* forward|backward::
- Circulate the leaves of the tree of the selected desktop.
-
-
Monitor
~~~~~~~
General Syntax
^^^^^^^^^^^^^^
-monitor ['MONITOR_SEL'] 'OPTIONS'
+monitor ['MONITOR_SEL'] 'COMMANDS'
-Options
-^^^^^^^
+If 'MONITOR_SEL' is omitted, *focused* is assumed.
+
+Commands
+^^^^^^^^
*-f*, *--focus* ['MONITOR_SEL']::
Focus the selected or given monitor.
+*-s*, *--swap* 'MONITOR_SEL'::
+ Swap the selected monitor with the given monitor.
+
*-a*, *--add-desktops* <name>...::
Create desktops with the given names in the selected monitor.
-*-r*, *--remove-desktops* <name>...::
- Remove desktops with the given names.
-
*-o*, *--reorder-desktops* <name>...::
Reorder the desktops of the selected monitor to match the given order.
*-d*, *--reset-desktops* <name>...::
- Rename, add or remove desktops depending on whether the number of given names is equal, superior or inferior to the number of existing desktops. Incidentally reset the settings of the existing desktops.
+ Rename, add or remove desktops depending on whether the number of given names is equal, superior or inferior to the number of existing desktops.
+
+*-g*, *--rectangle* WxH+X+Y::
+ Set the rectangle of the selected monitor.
*-n*, *--rename* <new_name>::
Rename the selected monitor.
-*-s*, *--swap* 'MONITOR_SEL'::
- Swap the selected monitor with the given monitor.
+*-r*, *--remove*::
+ Remove the selected monitor.
Query
~~~~~
General Syntax
^^^^^^^^^^^^^^
-query 'OPTIONS'
-
-Options
-^^^^^^^
-*-W*, *--windows*::
- List matching windows.
-
-*-D*, *--desktops*::
- List matching desktops.
-
-*-M*, *--monitors*::
- List matching monitors.
+query 'COMMANDS' ['OPTIONS']
-*-T*, *--tree*::
- Print tree rooted at query.
-
-*-H*, *--history*::
- Print the history as it relates to the query.
+Commands
+^^^^^^^^
-*-S*, *--stack*::
- Print the window stacking order.
+The optional selectors are references.
-[*-m*,*--monitor* ['MONITOR_SEL']] | [*-d*,*--desktop* ['DESKTOP_SEL']] | [*-w*, *--window* ['WINDOW_SEL']]::
- Constrain matches to the selected monitor, desktop or window.
+*-N*, *--nodes* ['NODE_SEL']::
+ List the IDs of the matching nodes.
-Restore
-~~~~~~~
+*-D*, *--desktops* ['DESKTOP_SEL']::
+ List the IDs (or names) of the matching desktops.
-General Syntax
-^^^^^^^^^^^^^^
+*-M*, *--monitors* ['MONITOR_SEL']::
+ List the IDs (or names) of the matching monitors.
-restore 'OPTIONS'
+*-T*, *--tree*::
+ Print a JSON representation of the matching item.
Options
^^^^^^^
-*-T*, *--tree* <file_path>::
- Load the desktop trees from the given file.
+*-m*,*--monitor* ['MONITOR_SEL'|'MONITOR_MODIFIERS']::
+*-d*,*--desktop* ['DESKTOP_SEL'|'DESKTOP_MODIFIERS']::
+*-n*, *--node* ['NODE_SEL'|'NODE_MODIFIERS']::
+ Constrain matches to the selected monitors, desktops or nodes.
-*-H*, *--history* <file_path>::
- Load the focus history from the given file.
+*--names*::
+ Print names instead of IDs. Can only be used with '-M' and '-D'.
-*-S*, *--stack* <file_path>::
- Load the window stacking order from the given file.
-
-Control
-~~~~~~~
+Wm
+~~
General Syntax
^^^^^^^^^^^^^^
-control 'OPTIONS'
-
-Options
-^^^^^^^
-
-*--adopt-orphans*::
- Manage all the unmanaged windows remaining from a previous session.
-
-*--toggle-visibility*::
- Toggle the visibility of all the windows.
+wm 'COMMANDS'
-*--record-history* on|off::
- Enable or disable the recording of window focus history.
+Commands
+^^^^^^^^
-*--subscribe* (all|report|monitor|desktop|window|...)*::
- Continuously print status information. See the *EVENTS* section for the detailed description of each event.
+*-d*, *--dump-state*::
+ Dump the current world state on standard output.
-*--get-status*::
- Print the current status information.
+*-l*, *--load-state* <file_path>::
+ Load a world state from the given file. The path must be absolute.
-Pointer
-~~~~~~~
+*-a*, *--add-monitor* <name> WxH+X+Y::
+ Add a monitor for the given name and rectangle.
-General Syntax
-^^^^^^^^^^^^^^
-
-pointer 'OPTIONS'
+*-O*, *--reorder-monitors* <name>...::
+ Reorder the list of monitors to match the given order.
-Options
-^^^^^^^
+*-o*, *--adopt-orphans*::
+ Manage all the unmanaged windows remaining from a previous session.
-*-g*, *--grab* focus|move|resize_side|resize_corner::
- Initiate the given pointer action.
+*-h*, *--record-history* on|off::
+ Enable or disable the recording of node focus history.
-*-t*, *--track* <x> <y>::
- Pass the pointer root coordinates for the current pointer action.
+*-g*, *--get-status*::
+ Print the current status information.
-*-u*, *--ungrab*::
- Terminate the current pointer action.
+*-r*, *--restart*::
+ Restart the window manager
Rule
~~~~
General Syntax
^^^^^^^^^^^^^^
-rule 'OPTIONS'
+rule 'COMMANDS'
-Options
-^^^^^^^
+Commands
+^^^^^^^^
-*-a*, *--add* <class_name>|<instance_name>|* [*-o*|*--one-shot*] [monitor=MONITOR_SEL|desktop=DESKTOP_SEL|window=WINDOW_SEL] [state=STATE] [layer=LAYER] [split_dir=DIR] [split_ratio=RATIO] [(locked|sticky|private|center|follow|manage|focus|border)=(on|off)]::
+*-a*, *--add* (<class_name>|\*)[:(<instance_name>|\*)[:(<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]::
Create a new rule.
-*-r*, *--remove* ^<n>|head|tail|<class_name>|<instance_name>|*...::
+*-r*, *--remove* ^<n>|head|tail|(<class_name>|\*)[:(<instance_name>|\*)[:(<name>|*)]]...::
Remove the given rules.
-*-l*, *--list* [<class_name>|<instance_name>|*]::
+*-l*, *--list*::
List the rules.
Config
General Syntax
^^^^^^^^^^^^^^
-config [-m 'MONITOR_SEL'|-d 'DESKTOP_SEL'|-w 'WINDOW_SEL'] <key> [<value>]::
- Get or set the value of <key>.
+config [-m 'MONITOR_SEL'|-d 'DESKTOP_SEL'|-n 'NODE_SEL'] <setting> [<value>]::
+ Get or set the value of <setting>.
+
+Subscribe
+~~~~~~~~~
+
+General Syntax
+^^^^^^^^^^^^^^
+subscribe ['OPTIONS'] (all|report|monitor|desktop|node|...)*::
+ Continuously print events. See the *EVENTS* section for the description of each event.
+
+Options
+^^^^^^^
+
+*-f*, *--fifo*::
+ Print a path to a FIFO from which events can be read and return.
+
+*-c*, *--count* 'COUNT'::
+ Stop the corresponding *bspc* process after having received 'COUNT' events.
Quit
~~~~
Exit Codes
----------
-If the server can't handle a message, *bspc* will return with one of the following exit codes:
-
-1::
- Failure.
-2::
- Syntax error.
-3::
- Unknown command.
-
+If the server can't handle a message, *bspc* will return with a non-zero exit code.
Settings
--------
-Colors are either '#RRGGBB' or http://en.wikipedia.org/wiki/X11_color_names[X color names], booleans are 'true', 'on', 'false' or 'off'.
+Colors are in the form '#RRGGBB', booleans are 'true', 'on', 'false' or 'off'.
All the boolean settings are 'false' by default unless stated otherwise.
Global Settings
~~~~~~~~~~~~~~~
-'focused_border_color'::
- Color of the border of a focused window of a focused monitor.
-
-'active_border_color'::
- Color of the border of a focused window of an unfocused monitor.
-
'normal_border_color'::
Color of the border of an unfocused window.
-'presel_border_color'::
- Color of the *window --presel* message feedback.
-
-'focused_locked_border_color'::
- Color of the border of a focused locked window of a focused monitor.
-
-'active_locked_border_color'::
- Color of the border of a focused locked window of an unfocused monitor.
-
-'normal_locked_border_color'::
- Color of the border of an unfocused locked window.
-
-'focused_sticky_border_color'::
- Color of the border of a focused sticky window of a focused monitor.
-
-'active_sticky_border_color'::
- Color of the border of a focused sticky window of an unfocused monitor.
-
-'normal_sticky_border_color'::
- Color of the border of an unfocused sticky window.
-
-'focused_private_border_color'::
- Color of the border of a focused private window of a focused monitor.
-
-'active_private_border_color'::
- Color of the border of a focused private window of an unfocused monitor.
+'active_border_color'::
+ Color of the border of a focused window of an unfocused monitor.
-'normal_private_border_color'::
- Color of the border of an unfocused private window.
+'focused_border_color'::
+ Color of the border of a focused window of a focused monitor.
-'urgent_border_color'::
- Color of the border of an urgent window.
+'presel_feedback_color'::
+ Color of the *node --presel-{dir,ratio}* message feedback area.
'split_ratio'::
Default split ratio.
Prefix prepended to each of the status lines.
'external_rules_command'::
- External command used to retrieve rule consequences. The command will receive the the ID of the window being processed as its first argument and the class and instance names as second and third arguments. 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).
+ Absolute path to the 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).
+
+'automatic_scheme'::
+ The insertion scheme used when the insertion point is in automatic mode. Accept the following values: *longest_side*, *alternate*, *spiral*.
'initial_polarity'::
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*.
-'history_aware_focus'::
- Give priority to the focus history when focusing nodes.
+'directional_focus_tightness'::
+ 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*.
-'focus_by_distance'::
- Base focusing on distances between windows.
+'removal_adjustment'::
+ Adjust the brother when unlinking a node from the tree in accordance with the automatic insertion scheme.
+
+'presel_feedback'::
+ Draw the preselection feedback area. Defaults to 'true'.
'borderless_monocle'::
Remove borders of tiled windows for the *monocle* desktop layout.
'gapless_monocle'::
Remove gaps of tiled windows for the *monocle* desktop layout.
-'leaf_monocle'::
+'top_monocle_padding'::
+'right_monocle_padding'::
+'bottom_monocle_padding'::
+'left_monocle_padding'::
+ Padding space added at the sides of the screen for the *monocle* desktop layout.
+
+'single_monocle'::
Set the desktop layout to *monocle* if there's only one tiled window in the tree.
+'borderless_singleton'::
+ Remove borders of the only window on the only monitor regardless its layout.
+
+'pointer_motion_interval'::
+ The minimum interval, in milliseconds, between two motion notify events.
+
+'pointer_modifier'::
+ Keyboard modifier used for moving or resizing windows. Accept the following values: *shift*, *control*, *lock*, *mod1*, *mod2*, *mod3*, *mod4*, *mod5*.
+
+'pointer_action1'::
+'pointer_action2'::
+'pointer_action3'::
+ Action performed when pressing 'pointer_modifier' + 'button<n>'. Accept the following values: *move*, *resize_side*, *resize_corner*, *focus*, *none*.
+
+'click_to_focus'::
+ Button used for focusing a window (or a monitor). The possible values are: *button1*, *button2*, *button3*, *any*, *none*. Defaults to *button1*.
+
+'swallow_first_click'::
+ Don't replay the click that makes a window focused if 'click_to_focus' isn't *none*.
+
'focus_follows_pointer'::
Focus the window under the pointer.
'pointer_follows_monitor'::
When focusing a monitor, put the pointer at its center.
-'auto_alternate'::
- Interpret consecutive identical *--focus* arguments as the *last* selector for the *monitor* and *desktop* commands.
-
-'auto_cancel'::
- Interpret consecutive identical *--presel* arguments as *--cancel-presel* option.
+'mapping_events_count'::
+ Handle the next *mapping_events_count* mapping notify events. A negative value implies that every event needs to be handled.
'ignore_ewmh_focus'::
Ignore EWMH focus requests coming from applications.
+'ignore_ewmh_fullscreen'::
+ 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*.
+
+'ignore_ewmh_struts'::
+ Ignore strut hinting from clients requesting to reserve space (i.e. task bars).
+
'center_pseudo_tiled'::
Center pseudo tiled windows into their tiling rectangles. Defaults to 'true'.
+'honor_size_hints'::
+ Apply ICCCM window size hints.
+
'remove_disabled_monitors'::
Consider disabled monitors as disconnected.
'left_padding'::
Padding space added at the sides of the monitor or desktop.
-Default, Desktop Default and Window Settings
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Desktop Settings
+~~~~~~~~~~~~~~~~
+
+'window_gap'::
+ Size of the gap that separates windows.
+
+Node Settings
+~~~~~~~~~~~~~
'border_width'::
Window border width.
-Default and Desktop Settings
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Pointer Bindings
+----------------
-'window_gap'::
- Size of the gap that separates windows.
+'click_to_focus'::
+ Focus the window (or the monitor) under the pointer if the value isn't *none*.
+
+'pointer_modifier' + 'button1'::
+ Move the window under the pointer.
+
+'pointer_modifier' + 'button2'::
+ Resize the window under the pointer by dragging the nearest side.
+
+'pointer_modifier' + 'button3'::
+ Resize the window under the pointer by dragging the nearest corner.
+The behavior of 'pointer_modifier' + 'button<n>' can be modified through the 'pointer_action<n>' setting.
Events
------
'report'::
See the next section for the description of the format.
-'monitor_add <monitor_name> <monitor_id> <monitor_geometry>'::
+'monitor_add <monitor_id> <monitor_name> <monitor_geometry>'::
A monitor is added.
-'monitor_rename <old_name> <new_name>'::
+'monitor_rename <monitor_id> <old_name> <new_name>'::
A monitor is renamed.
-'monitor_remove <monitor_name>'::
+'monitor_remove <monitor_id>'::
A monitor is removed.
-'monitor_focus <monitor_name>'::
+'monitor_swap <src_monitor_id> <dst_monitor_id>'::
+ A monitor is swapped.
+
+'monitor_focus <monitor_id>'::
A monitor is focused.
-'monitor_geometry <monitor_name> <monitor_geometry>'::
+'monitor_geometry <monitor_id> <monitor_geometry>'::
The geometry of a monitor changed.
-'desktop_add <monitor_name> <desktop_name>'::
+'desktop_add <monitor_id> <desktop_id> <desktop_name>'::
A desktop is added.
-'desktop_rename <monitor_
name> <old_name> <new_name>'::
+'desktop_rename <monitor_
id> <desktop_id> <old_name> <new_name>'::
A desktop is renamed.
-'desktop_remove <monitor_name> <desktop_name>'::
+'desktop_remove <monitor_id> <desktop_id>'::
A desktop is removed.
-'desktop_swap <src_monitor_name> <src_desktop_name> <dst_monitor_name> <dst_desktop_name>'::
+'desktop_swap <src_monitor_id> <src_desktop_id> <dst_monitor_id> <dst_desktop_id>'::
A desktop is swapped.
-'desktop_transfer <src_monitor_name> <src_desktop_name> <dst_monitor_name>'::
+'desktop_transfer <src_monitor_id> <src_desktop_id> <dst_monitor_id>'::
A desktop is transferred.
-'desktop_focus <monitor_name> <desktop_name>'::
+'desktop_focus <monitor_id> <desktop_id>'::
A desktop is focused.
-'desktop_layout <monitor_name> <desktop_name> tiled|monocle'::
+'desktop_activate <monitor_id> <desktop_id>'::
+ A desktop is activated.
+
+'desktop_layout <monitor_id> <desktop_id> tiled|monocle'::
The layout of a desktop changed.
-'window_manage <monitor_name> <desktop_name> <window_id> <ip_id>'::
- A window is managed.
+'node_add <monitor_id> <desktop_id> <ip_id> <node_id>'::
+ A node is added.
+
+'node_remove <monitor_id> <desktop_id> <node_id>'::
+ A node is removed.
+
+'node_swap <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>'::
+ A node is swapped.
-'window_unmanage <monitor_name> <desktop_name> <window_id>'::
- A window is unmanaged.
+'node_transfer <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>'::
+ A node is transferred.
-'window_swap <src_monitor_name> <src_desktop_name> <src_window_id> <dst_monitor_name> <dst_desktop_name> <dst_window_id>'::
- A window is swapped.
+'node_focus <monitor_id> <desktop_id> <node_id>'::
+ A node is focused.
-'window_transfer <src_monitor_name> <src_desktop_name> <src_window_id> <dst_monitor_name> <dst_desktop_name> <dst_window_id>'::
- A window is transferred.
+'node_activate <monitor_id> <desktop_id> <node_id>'::
+ A node is activated.
-'window_focus <monitor_name> <desktop_name> <window_id>'::
- A window is focused.
+'node_presel <monitor_id> <desktop_id> <node_id> (dir DIR|ratio RATIO|cancel)'::
+ A node is preselected.
-'window_activate <monitor_name> <desktop_name> <window_id>'::
- A window is activated.
+'node_stack <node_id_1> below|above <node_id_2>'::
+ A node is stacked below or above another node.
-'window_geometry <monitor_name> <desktop_name> <window_id> <window_geometry>'::
+'node_geometry <monitor_id> <desktop_id> <node_id> <node_geometry>'::
The geometry of a window changed.
-'window_state <monitor_name> <desktop_name> <window_id> tiled|pseudo_tiled|floating|fullscreen on|off'::
+'node_state <monitor_id> <desktop_id> <node_id> tiled|pseudo_tiled|floating|fullscreen on|off'::
The state of a window changed.
-'window_flag <monitor_name> <desktop_name> <window_id> sticky|private|locked|urgent on|off'::
- One of the flags of a window changed.
+'node_flag <monitor_id> <desktop_id> <node_id> hidden|sticky|private|locked|marked|urgent on|off'::
+ One of the flags of a node changed.
-'window_layer <monitor_name> <desktop_name> <window_id> below|normal|above'::
+'node_layer <monitor_id> <desktop_id> <node_id> below|normal|above'::
The layer of a window changed.
+'pointer_action <monitor_id> <desktop_id> <node_id> move|resize_corner|resize_side begin|end'::
+ A pointer action occurred.
+
Please note that *bspwm* initializes monitors before it reads messages on its socket, therefore the initial monitor events can't be received.
Report Format
'L(T|M)'::
Layout of the focused desktop of a monitor.
+'T(T|P|F|=|@)'::
+ State of the focused node of a focused desktop.
+
+'G(S?P?L?M?)'::
+ Active flags of the focused node of a focused desktop.
+
Environment Variables
---------------------
projects / bspwm.git / blobdiff