*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.
+
+Node
+~~~~
-Select a window.
+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|last|older|newer|focused|pointed|biggest|<node_id>)[.[!]focused][.[!]automatic][.[!]local][.[!]active][.[!]leaf][.[!]window][.[!]STATE][.[!]FLAG][.[!]LAYER][.[!]same_class][.[!]descendant_of][.[!]ancestor_of]
+
+STATE := tiled|pseudo_tiled|floating|fullscreen
+
+FLAG := hidden|sticky|private|locked|urgent
+
+LAYER := below|normal|above
+
+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 window in the given (cyclic) direction relative to the reference node.
-biggest::
- Selects the biggest window on the current desktop.
+'PATH'::
+ Selects the node at the given path.
last::
- Selects the previously focused window.
-
-focused::
- Selects the currently focused window.
+ Selects the previously focused node relative to the reference 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
-^^^^^^^^^
-
-tiled::
- Only consider tiled windows.
+ Selects the node newer than the reference node in the history.
-nontiled::
- Only consider non tiled windows.
+focused::
+ Selects the currently focused node.
-pseudotiled::
- Only consider pseudo-tiled windows.
+pointed::
+ Selects the window under the pointer.
-nonpseudotiled::
- Only consider non pseudo-tiled windows.
+biggest::
+ Selects the biggest window.
-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 focused or unfocused nodes.
-above::
- Only consider windows of the ABOVE layer.
+[!]automatic::
+ Only consider nodes in automatic or manual insertion mode. See also *--presel-dir* under *Node* in the *DOMAINS* section below.
-like::
- Only consider windows that have the same class as the current window.
+[!]local::
+ Only consider nodes in or not in the reference desktop.
-unlike::
- Only consider windows that have a different class than the current window.
+[!]active::
+ Only consider nodes in or not in the active desktop of their monitor.
-local::
- Only consider windows of the current desktop.
+[!]leaf::
+ Only consider leaves or internal nodes.
-foreign::
- Only consider windows outside of the current desktop.
+[!]window::
+ Only consider nodes that hold or don't hold a window.
-private::
- Only consider private windows.
+[!](tiled|pseudo_tiled|floating|fullscreen)::
+ Only consider windows in or not in the given state.
-public::
- Only consider non private windows.
+[!]same_class::
+ Only consider windows that have or don't have the same class as the reference window.
-urgent::
- Only consider urgent windows.
+[!]descendant_of::
+ Only consider nodes that are or aren't descendants of the reference node.
-nonurgent::
- Only consider non urgent windows.
+[!]ancestor_of::
+ Only consider nodes that are or aren't ancestors of the reference node.
-sticky::
- Only consider sticky windows.
+[!](hidden|sticky|private|locked|urgent)::
+ Only consider windows that have or don't have the given flag set.
-nonsticky::
- Only consider non sticky windows.
-
-locked::
- Only consider locked windows.
-
-unlocked::
- Only consider non locked windows.
+[!](below|normal|above)::
+ Only consider windows in or not in the given layer.
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|last|older|newer|[MONITOR_SEL:](focused|^<n>)|<desktop_id>|<desktop_name>)[.[!]occupied][.[!]focused][.[!]urgent][.[!]local]
----
-Primary Selectors
-^^^^^^^^^^^^^^^^^
-
-<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.
last::
- Selects the previously focused desktop.
+ Selects the previously focused desktop relative to the reference desktop.
+
+older::
+ Selects the desktop older than the reference desktop in the history.
+
+newer::
+ Selects the desktop newer than the reference desktop in the history.
focused::
Selects the currently focused desktop.
-older::
- Selects the desktop older than the focused desktop in the history.
+^<n>::
+ Selects the nth desktop.
-newer::
- Selects the desktop newer than the focused desktop in the history.
+<desktop_id>::
+ Selects the desktop with the given ID.
+
+<desktop_name>::
+ Selects the desktop with the given name.
Modifiers
^^^^^^^^^
-occupied::
- Only consider occupied desktops.
+[!]occupied::
+ Only consider occupied or free desktops.
-free::
- Only consider free desktops.
+[!]focused::
+ Only consider focused or unfocused desktops.
-urgent::
- Only consider urgent desktops.
+[!]urgent::
+ Only consider urgent or non urgent desktops.
-nonurgent::
- Only consider non urgent desktops.
-
-local::
- Only consider desktops of the current monitor.
-
-foreign::
- Only consider desktops outside of the current monitor.
+[!]local::
+ Only consider desktops inside or outside of the reference monitor.
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|last|older|newer|focused|primary|^<n>|<monitor_id>|<monitor_name>)[.[!]occupied][.[!]focused]
----
-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.
-
-primary::
- Selects the primary monitor.
+ Selects the monitor in the given (cyclic) direction relative to the reference monitor.
last::
- Selects the previously focused monitor.
+ Selects the previously focused monitor relative to the reference monitor.
+
+older::
+ Selects the monitor older than the reference monitor in the history.
+
+newer::
+ Selects the monitor newer than the reference monitor in the history.
focused::
Selects the currently focused monitor.
-older::
- Selects the monitor older than the focused monitor in the history.
+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.
-newer::
- Selects the monitor newer than the focused monitor in the history.
Modifiers
^^^^^^^^^
-occupied::
- Only consider monitors where the focused desktop is occupied.
+[!]occupied::
+ Only consider monitors where the focused desktop is occupied or free.
-free::
- Only consider monitors where the focused desktop is free.
+[!]focused::
+ Only consider focused or unfocused monitors.
Window States
Fills its monitor rectangle and has no borders. It is send in the ABOVE layer by default.
-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.
+
urgent::
Has its urgency hint set. This flag is set externally.
In each layer, the window are orderered as follow: tiled & pseudo-tiled < fullscreen < floating.
-Commands
---------
+Domains
+-------
-Window
-~~~~~~
+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.
+ Send the selected node to the given desktop.
*-m*, *--to-monitor* 'MONITOR_SEL'::
- Send the selected window to the given monitor.
+ Send the selected node to the given monitor.
-*-w*, *--to-window* 'WINDOW_SEL'::
- Transplant the selected window to the given window.
+*-n*, *--to-node* 'NODE_SEL'::
+ Transplant the selected node to the given node.
-*-s*, *--swap* 'WINDOW_SEL'::
- Swap the selected window with the given window.
+*-s*, *--swap* 'NODE_SEL'::
+ Swap the selected node with the given node.
-*-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 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* [~](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.
+
+*-g*, *--flag* hidden|sticky|private|locked[=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.
+*-a*, *--activate* ['DESKTOP_SEL']::
+ Activate the selected or given desktop.
+
*-m*, *--to-monitor* 'MONITOR_SEL'::
Send the selected desktop to the given monitor.
*-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.
+Commands
+^^^^^^^^
-*-H*, *--history*::
- Print the history as it relates to the query.
+The optional selectors are references.
-*-S*, *--stack*::
- Print the window stacking order.
+*-N*, *--nodes* ['NODE_SEL']::
+ List the IDs of the matching nodes.
-[*-m*,*--monitor* ['MONITOR_SEL']] | [*-d*,*--desktop* ['DESKTOP_SEL']] | [*-w*, *--window* ['WINDOW_SEL']]::
- Constrain matches to the selected monitor, desktop or window.
+*-D*, *--desktops* ['DESKTOP_SEL']::
+ List the IDs (or names) of the matching desktops.
-Restore
-~~~~~~~
+*-M*, *--monitors* ['MONITOR_SEL']::
+ List the IDs (or names) of the matching monitors.
-General Syntax
-^^^^^^^^^^^^^^
-
-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']::
+*-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'.
-*-H*, *--history* <file_path>::
- Load the focus history from the given file.
+*--names*::
+ Print names instead of IDs.
-*-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.
+wm 'COMMANDS'
-*--toggle-visibility*::
- Toggle the visibility of all the windows.
-
-*--record-history* on|off::
- Enable or disable the recording of window focus history.
-
-*--subscribe* (all|report|monitor|desktop|window|...)*::
- Continuously print status information. See the *EVENTS* section for the detailed description of each event.
+Commands
+^^^^^^^^
-*--get-status*::
- Print the current status information.
+*-d*, *--dump-state*::
+ Dump the current world state on standard output.
-Pointer
-~~~~~~~
+*-l*, *--load-state* <file_path>::
+ Load a world state from the given file.
-General Syntax
-^^^^^^^^^^^^^^
-
-pointer 'OPTIONS'
+*-a*, *--add-monitor* <name> WxH+X+Y::
+ Add a monitor for the given name and rectangle.
-Options
-^^^^^^^
-
-*-g*, *--grab* focus|move|resize_side|resize_corner::
- Initiate the given pointer action.
+*-o*, *--adopt-orphans*::
+ Manage all the unmanaged windows remaining from a previous session.
-*-t*, *--track* <x> <y>::
- Pass the pointer root coordinates for the current pointer action.
+*-h*, *--record-history* on|off::
+ Enable or disable the recording of node focus history.
-*-u*, *--ungrab*::
- Terminate the current pointer action.
+*-g*, *--get-status*::
+ Print the current status information.
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>|\*)] [*-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|center|follow|manage|focus|border)=(on|off)]::
Create a new rule.
-*-r*, *--remove* ^<n>|head|tail|<class_name>|<instance_name>|*...::
+*-r*, *--remove* ^<n>|head|tail|(<class_name>|\*)[:(<instance_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 (all|report|monitor|desktop|node|...)*::
+ Continuously print status information. See the *EVENTS* section for the detailed description of each event.
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).
+ External command used to retrieve rule consequences. The command will receive the following arguments: window ID, class and instance names, monitor, desktop and node selectors. 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).
'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.
-
-'focus_by_distance'::
- Base focusing on distances between windows.
-
'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'::
+'paddingless_monocle'::
+ Remove padding space for the *monocle* desktop layout.
+
+'single_monocle'::
Set the desktop layout to *monocle* if there's only one tiled window in the tree.
+'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'::
+ Focus a window (or a monitor) by clicking it.
+
+'swallow_first_click'::
+ Don't replay the click that makes a window focused when 'click_to_focus' is set.
+
'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.
-
'ignore_ewmh_focus'::
Ignore EWMH focus requests coming from applications.
'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.
+'button1'::
+ Focus the window under the pointer if 'click_to_focus' is set.
+
+'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>'::
+'node_manage <monitor_id> <desktop_id> <node_id> <ip_id>'::
A window is managed.
-'window_unmanage <monitor_name> <desktop_name> <window_id>'::
+'node_unmanage <monitor_id> <desktop_id> <node_id>'::
A window is unmanaged.
-'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_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_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>'::
+ A node is transferred.
+
+'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|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 occured.
+
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?)'::
+ Active flags of the focused node of a focused desktop.
+
Environment Variables
---------------------
projects / bspwm.git / blobdiff