*bspc* 'DOMAIN' ['SELECTOR'] 'COMMANDS'
+*bspc* 'COMMAND' ['OPTIONS'] ['ARGUMENTS']
+
Description
-----------
Selectors are used to select a target node, desktop, or monitor. A selector
can either describe the target relatively or name it globally.
-Selectors consist of a descriptor 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:
+
+ [REFERENCE#]DESCRIPTOR(.MODIFIER)*
+
+The relative targets are computed in relation to the given reference (the
+default reference value is *focused*).
- DESCRIPTOR(.MODIFIER)*
+An exclamation mark can be prepended to any modifier in order to reverse its
+meaning.
-An exclamation mark can be prepended to certain modifiers in order to reverse their 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.
Node
~~~~
Select a node.
----
-NODE_SEL := (<node_id>|PATH|DIR|CYCLE_DIR|last|older|newer|biggest|focused)[.[!]focused][.[!]automatic][.[!]local][.[!]leaf][.[!]STATE][.[!]FLAG][.[!]LAYER][.[!]same_class]
+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 := urgent|sticky|private|locked
+FLAG := hidden|sticky|private|locked|marked|urgent
LAYER := below|normal|above
-PATH := @[DESK_SEL:][[/]JUMP](/JUMP)*
+SPLIT_TYPE := horizontal|vertical
+
+PATH := @[DESKTOP_SEL:][[/]JUMP](/JUMP)*
JUMP := first|1|second|2|brother|parent|DIR
----
Descriptors
^^^^^^^^^^^
-<node_id>::
- Selects the node with the given ID.
+'DIR'::
+ Selects the window in the given (spacial) direction relative to the reference node.
+
+'CYCLE_DIR'::
+ Selects the node in the given (cyclic) direction relative to the reference node within a depth-first in-order traversal of the tree.
'PATH'::
Selects the node at the given path.
-'DIR'::
- Selects the window in the given (spacial) direction relative to the active node.
+any::
+ Selects the first node that matches the given selectors.
-'CYCLE_DIR'::
- Selects the window in the given (cyclic) direction.
-
-biggest::
- Selects the biggest window on the current desktop.
+first_ancestor::
+ Selects the first ancestor of the reference node that matches the given selectors.
last::
- Selects the previously focused node.
+ Selects the previously focused node relative to the reference node.
-focused::
- Selects the currently focused node.
+newest::
+ Selects the newest node in the history of the focused node.
older::
- Selects the node older than the focused node in the history.
+ Selects the node older than the reference node in the history.
newer::
- Selects the node newer than the focused node in the history.
+ Selects the node newer than the reference node in the history.
+
+focused::
+ Selects the currently focused node.
+
+pointed::
+ Selects the leaf under the pointer.
+
+biggest::
+ Selects the biggest leaf.
+
+smallest::
+ Selects the smallest leaf.
+
+<node_id>::
+ Selects the node with the given ID.
Path Jumps
^^^^^^^^^^
-The initial node is the focused node (or the root if the path starts with '/') of the focused desktop (or the selected desktop if the path has a 'DESK_SEL' prefix).
+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).
1|first::
Jumps to the first child.
^^^^^^^^^
[!]focused::
- Only consider focused or unfocused nodes.
+ Only consider the focused node.
+
+[!]active::
+ Only consider nodes that are the focused node of their desktop.
[!]automatic::
- Only consider nodes in automatic or manual insertion mode.
+ Only consider nodes in automatic insertion mode. See also *--presel-dir* under *Node* in the *DOMAINS* section below.
[!]local::
- Only consider nodes in or not in the current desktop.
+ Only consider nodes in the reference desktop.
[!]leaf::
- Only consider leaves or internal nodes.
+ Only consider leaf nodes.
+
+[!]window::
+ Only consider nodes that hold a window.
[!](tiled|pseudo_tiled|floating|fullscreen)::
- Only consider windows in or not in the given state.
+ Only consider windows in the given state.
[!]same_class::
- Only consider windows that have or don't have the same class as the current window.
+ Only consider windows that have the same class as the reference window.
+
+[!]descendant_of::
+ Only consider nodes that are descendants of the reference node.
+
+[!]ancestor_of::
+ Only consider nodes that are ancestors of the reference node.
-[!](private|urgent|sticky|locked)::
- Only consider windows that have or don't have the given flag set.
+[!](hidden|sticky|private|locked|marked|urgent)::
+ Only consider windows that have the given flag set.
[!](below|normal|above)::
- Only consider windows in or not in the given layer.
+ Only consider windows in the given layer.
+
+[!](horizontal|vertical)::
+ Only consider nodes with the given split type.
+
Desktop
~~~~~~~
Select a desktop.
----
-DESKTOP_SEL := (<desktop_name>|[MONITOR_SEL:](focused|^<n>)CYCLE_DIR|last|older|newer)[.[!]occupied][.[!]focused][.[!]urgent][.[!]local]
+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]
+
+LAYOUT := tiled|monocle
----
Descriptors
^^^^^^^^^^^
-<desktop_name>::
- Selects the desktop with the given name.
-
-^<n>::
- Selects the nth desktop.
-
'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 or free desktops.
-
[!]focused::
- Only consider focused or unfocused desktops.
+ Only consider the focused desktop.
+
+[!]active::
+ Only consider desktops that are the focused desktop of their monitor.
+
+[!]occupied::
+ Only consider occupied desktops.
[!]urgent::
- Only consider urgent or non urgent desktops.
+ Only consider urgent desktops.
[!]local::
- Only consider inside or outside of the current monitor.
+ Only consider desktops inside the reference monitor.
+
+[!](tiled|monocle)::
+ Only consider desktops with the given layout.
+
+[!](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][.[!]focused]
+MONITOR_SEL := [MONITOR_SEL#](DIR|CYCLE_DIR|any|last|newest|older|newer|
+ focused|pointed|primary|^<n>|
+ <monitor_id>|<monitor_name>)[.[!]focused][.[!]occupied]
----
Descriptors
^^^^^^^^^^^
-<monitor_name>::
- Selects the monitor with the given name.
-
-^<n>::
- Selects the nth monitor.
-
'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
^^^^^^^^^
+[!]focused::
+ Only consider the focused monitor.
+
[!]occupied::
- Only consider monitors where the focused desktop is occupied or free.
+ Only consider monitors where the focused desktop is occupied.
-[!]focused::
- Only consider focused or unfocused monitors.
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.
Node Flags
----------
-locked::
- Ignores the *node --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.
Domains
node ['NODE_SEL'] 'COMMANDS'
+If 'NODE_SEL' is omitted, *focused* is assumed.
+
Commands
^^^^^^^^
*-f*, *--focus* ['NODE_SEL']::
*-a*, *--activate* ['NODE_SEL']::
Activate the selected or given node.
-*-d*, *--to-desktop* 'DESKTOP_SEL'::
- Send the selected node 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 node 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.
-*-n*, *--to-node* 'NODE_SEL'::
- Transplant the selected node to the given node.
+*-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* 'NODE_SEL'::
- Swap the selected node with the given node.
+*-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* \[~]'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*.
+ 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".
*-o*, *--presel-ratio* 'RATIO'::
Set the splitting ratio of the preselection area.
-*-r*, *--ratio* 'RATIO'|(+|-)'PIXELS'::
+*-v*, *--move* 'dx' 'dy'::
+ Move the selected window by 'dx' pixels horizontally and 'dy' pixels vertically.
+
+*-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.
+
+*-r*, *--ratio* 'RATIO'|(+|-)('PIXELS'|'FRACTION')::
Set the splitting ratio of the selected node (0 < 'RATIO' < 1).
*-R*, *--rotate* '90|270|180'::
Rotate the tree rooted at the selected node.
*-F*, *--flip* 'horizontal|vertical'::
- Flip the the tree rooted at selected node.
+ 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.
*-C*, *--circulate* forward|backward::
Circulate the windows of the tree rooted at the selected node.
-*-t*, *--state* [~](tiled|pseudo_tiled|floating|fullscreen)::
- 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.
+*-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* locked|sticky|private[=on|off]::
+*-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 windows rooted at the selected node.
desktop ['DESKTOP_SEL'] 'COMMANDS'
+If 'DESKTOP_SEL' is omitted, *focused* is assumed.
+
COMMANDS
^^^^^^^^
*-f*, *--focus* ['DESKTOP_SEL']::
*-a*, *--activate* ['DESKTOP_SEL']::
Activate the selected or given desktop.
-*-m*, *--to-monitor* 'MONITOR_SEL'::
- Send the selected desktop to the given monitor.
+*-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.
monitor ['MONITOR_SEL'] 'COMMANDS'
+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
~~~~~
Commands
^^^^^^^^
-*-N*, *--nodes*::
+The optional selectors are references.
+
+*-N*, *--nodes* ['NODE_SEL']::
List the IDs of the matching nodes.
-*-D*, *--desktops*::
- List the names of the matching desktops.
+*-D*, *--desktops* ['DESKTOP_SEL']::
+ List the IDs (or names) of the matching desktops.
-*-M*, *--monitors*::
- List the names of the matching monitors.
+*-M*, *--monitors* ['MONITOR_SEL']::
+ List the IDs (or names) of the matching monitors.
*-T*, *--tree*::
Print a JSON representation of the matching item.
Options
^^^^^^^
-[*-m*,*--monitor* ['MONITOR_SEL']] | [*-d*,*--desktop* ['DESKTOP_SEL']] | [*-n*, *--node* ['NODE_SEL']]::
- Constrain matches to the selected monitor, desktop or node. The descriptor can be omitted for '-M', '-D' and '-N'.
+*-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.
+
+*--names*::
+ Print names instead of IDs. Can only be used with '-M' and '-D'.
Wm
~~
Dump the current world state on standard output.
*-l*, *--load-state* <file_path>::
- Load a world state from the given file.
+ Load a world state from the given file. The path must be absolute.
*-a*, *--add-monitor* <name> WxH+X+Y::
Add a monitor for the given name and rectangle.
-*-r*, *--remove-monitor* <name>::
- Remove the monitor with the given name.
+*-O*, *--reorder-monitors* <name>...::
+ Reorder the list of monitors to match the given order.
*-o*, *--adopt-orphans*::
Manage all the unmanaged windows remaining from a previous session.
*-g*, *--get-status*::
Print the current status information.
-Pointer
-~~~~~~~
-
-General Syntax
-^^^^^^^^^^^^^^
-
-pointer 'COMMANDS'
-
-Commands
-^^^^^^^^
-
-*-g*, *--grab* focus|move|resize_side|resize_corner::
- Initiate the given pointer action.
-
-*-t*, *--track* <x> <y>::
- Pass the pointer root coordinates for the current pointer action.
-
-*-u*, *--ungrab*::
- Terminate the current pointer action.
+*-r*, *--restart*::
+ Restart the window manager
Rule
~~~~
Commands
^^^^^^^^
-*-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] [(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*::
General Syntax
^^^^^^^^^^^^^^
-config [-m 'MONITOR_SEL'|-d 'DESKTOP_SEL'|-n 'NODE_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 (all|report|monitor|desktop|window|...)*::
- Continuously print status information. See the *EVENTS* section for the detailed description of each event.
+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
--------
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*.
+
+'removal_adjustment'::
+ Adjust the brother when unlinking a node from the tree in accordance with the automatic insertion scheme.
-'focus_by_distance'::
- Base focusing on distances between windows.
+'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.
+'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.
+'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_activate <monitor_name> <desktop_name>'::
+'desktop_activate <monitor_id> <desktop_id>'::
A desktop is activated.
-'desktop_layout <monitor_name> <desktop_name> tiled|monocle'::
+'desktop_layout <monitor_id> <desktop_id> tiled|monocle'::
The layout of a desktop changed.
-'node_manage <monitor_name> <desktop_name> <node_id> <ip_id>'::
- A window is managed.
+'node_add <monitor_id> <desktop_id> <ip_id> <node_id>'::
+ A node is added.
-'node_unmanage <monitor_name> <desktop_name> <node_id>'::
- A window is unmanaged.
+'node_remove <monitor_id> <desktop_id> <node_id>'::
+ A node is removed.
-'node_swap <src_monitor_name> <src_desktop_name> <src_node_id> <dst_monitor_name> <dst_desktop_name> <dst_node_id>'::
+'node_swap <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>'::
A node is swapped.
-'node_transfer <src_monitor_name> <src_desktop_name> <src_node_id> <dst_monitor_name> <dst_desktop_name> <dst_node_id>'::
+'node_transfer <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>'::
A node is transferred.
-'node_focus <monitor_name> <desktop_name> <node_id>'::
+'node_focus <monitor_id> <desktop_id> <node_id>'::
A node is focused.
-'node_activate <monitor_name> <desktop_name> <node_id>'::
+'node_activate <monitor_id> <desktop_id> <node_id>'::
A node is activated.
-'node_presel <monitor_name> <desktop_name> <node_id> (dir DIR|ratio RATIO|cancel)'::
+'node_presel <monitor_id> <desktop_id> <node_id> (dir DIR|ratio RATIO|cancel)'::
A node is preselected.
'node_stack <node_id_1> below|above <node_id_2>'::
A node is stacked below or above another node.
-'node_geometry <monitor_name> <desktop_name> <node_id> <node_geometry>'::
+'node_geometry <monitor_id> <desktop_id> <node_id> <node_geometry>'::
The geometry of a window changed.
-'node_state <monitor_name> <desktop_name> <node_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.
-'node_flag <monitor_name> <desktop_name> <node_id> sticky|private|locked|urgent on|off'::
+'node_flag <monitor_id> <desktop_id> <node_id> hidden|sticky|private|locked|marked|urgent on|off'::
One of the flags of a node changed.
-'node_layer <monitor_name> <desktop_name> <node_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
'T(T|P|F|=|@)'::
State of the focused node of a focused desktop.
-'G(S?P?L?)'::
+'G(S?P?L?M?)'::
Active flags of the focused node of a focused desktop.
Environment Variables
projects / bspwm.git / blobdiff