X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=doc%2Fbspwm.1;h=068fba5ce97f008598ee151ee55ff87908fd7e3e;hb=3e7f820afe86623c758165972b7651d19903860b;hp=52034c2b6e0c361c249c40e53cefcf399d3393b0;hpb=51e09ea11e57458a64b004ca3a127df972bb7f0d;p=bspwm.git

diff --git a/doc/bspwm.1 b/doc/bspwm.1
index 52034c2..068fba5 100644
--- a/doc/bspwm.1
+++ b/doc/bspwm.1
@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: bspwm
 .\"    Author: [see the "Author" section]
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 08/05/2015
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\"      Date: 01/06/2019
 .\"    Manual: Bspwm Manual
-.\"    Source: Bspwm 0.9
+.\"    Source: Bspwm 0.9.5-27-g2c2faeb
 .\"  Language: English
 .\"
-.TH "BSPWM" "1" "08/05/2015" "Bspwm 0\&.9" "Bspwm Manual"
+.TH "BSPWM" "1" "01/06/2019" "Bspwm 0\&.9\&.5\-27\-g2c2faeb" "Bspwm Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -33,7 +33,9 @@ bspwm \- Binary space partitioning window manager
 .sp
 \fBbspwm\fR [\fB\-h\fR|\fB\-v\fR|\fB\-c\fR \fICONFIG_PATH\fR]
 .sp
-\fBbspc\fR \fICOMMAND\fR [\fIARGUMENTS\fR]
+\fBbspc\fR \fIDOMAIN\fR [\fISELECTOR\fR] \fICOMMANDS\fR
+.sp
+\fBbspc\fR \fICOMMAND\fR [\fIOPTIONS\fR] [\fIARGUMENTS\fR]
 .SH "DESCRIPTION"
 .sp
 \fBbspwm\fR is a tiling window manager that represents windows as the leaves of a full binary tree\&.
@@ -55,87 +57,13 @@ Print the version and exit\&.
 .RS 4
 Use the given configuration file\&.
 .RE
-.SH "CONFIGURATION"
-.sp
-\fBbspwm\fR has only two sources of informations: the X events it receives and the messages it reads on a dedicated socket\&.
-.sp
-The default configuration file is \fI$XDG_CONFIG_HOME/bspwm/bspwmrc\fR\&.
-.sp
-Keyboard and pointer bindings are defined with sxhkd\&.
-.sp
-Example configuration files can be found in the \fBexamples\fR directory\&.
-.SH "SPLITTING MODES"
-.sp
-New windows are inserted in the tree as close as possible to the focused window\&.
-.sp
-There are only two splitting modes: \fIautomatic\fR and \fImanual\fR\&.
-.sp
-The default mode is \fIautomatic\fR\&. The \fImanual\fR mode is entered by sending a \fBpreselection\fR message\&.
-.sp
-Example: insertion of a new node (number 4) into the given tree in \fIautomatic\fR mode:
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-              b                                   c
-             / \e                                 / \e
-            3   a              \-\->              4   b
-            ^  / \e                              ^  / \e
-              2   1                               3   a
-                                                     / \e
-                                                    2   1
- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+         +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
- |            |            |         |            |            |
- |            |     2      |         |            |     3      |
- |            |            |         |            |            |
- |     3      |\-\-\-\-\-\-\-\-\-\-\-\-|   \-\->   |     4      |\-\-\-\-\-\-\-\-\-\-\-\-|
- |     ^      |            |         |     ^      |     |      |
- |            |     1      |         |            |  1  |  2   |
- |            |            |         |            |     |      |
- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+         +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
-.fi
-.if n \{\
-.RE
-.\}
-.sp
-Same action, but the mode is \fImanual\fR, and a \fBwindow \-\-presel up\fR message was sent beforehand:
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-             b                                   b
-            / \e                                 / \e
-           3   a              \-\->              c   a
-           ^  / \e                             / \e / \e
-             2   1                           4  3 2  1
-                                             ^
-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+         +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
-|            |            |         |            |            |
-|            |     2      |         |     4      |     2      |
-|            |            |         |     ^      |            |
-|     3      |\-\-\-\-\-\-\-\-\-\-\-\-|   \-\->   |\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-|
-|     ^      |            |         |            |            |
-|            |     1      |         |     3      |     1      |
-|            |            |         |            |            |
-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+         +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
-.fi
-.if n \{\
-.RE
-.\}
-.SH "CONTAINERS"
-.sp
-Each monitor contains at least one desktop\&.
-.sp
-Each desktop contains at most one tree\&.
 .SH "COMMON DEFINITIONS"
 .sp
 .if n \{\
 .RS 4
 .\}
 .nf
-DIR         := left | right | up | down
+DIR         := north | west | south | east
 CYCLE_DIR   := next | prev
 .fi
 .if n \{\
@@ -143,31 +71,50 @@ CYCLE_DIR   := next | prev
 .\}
 .SH "SELECTORS"
 .sp
-Selectors are used to select a target window, desktop, or monitor\&. A selector can either describe the target relatively or name it globally\&.
+Selectors are used to select a target node, desktop, or monitor\&. A selector can either describe the target relatively or name it globally\&.
 .sp
-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:
 .sp
 .if n \{\
 .RS 4
 .\}
 .nf
-PRIMARY_SELECTOR[\&.MODIFIER]*
+[REFERENCE#]DESCRIPTOR(\&.MODIFIER)*
 .fi
 .if n \{\
 .RE
 .\}
 .sp
-For obvious reasons, neither desktop nor monitor names may be valid descriptive selectors\&.
-.SS "Window"
+The relative targets are computed in relation to the given reference (the default reference value is \fBfocused\fR)\&.
+.sp
+An exclamation mark can be prepended to any modifier in order to reverse its meaning\&.
+.sp
+The following characters cannot be used in monitor or desktop names: \fB#\fR, \fB:\fR, \fB\&.\fR\&.
 .sp
-Select a window\&.
+The special selector \fB%<name>\fR can be used to select a monitor or a desktop with an invalid name\&.
+.SS "Node"
+.sp
+Select a node\&.
 .sp
 .if n \{\
 .RS 4
 .\}
 .nf
-WINDOW_SEL := <window_id>
-            | (DIR|CYCLE_DIR|biggest|last|focused|older|newer)[\&.floating|\&.tiled][\&.like|\&.unlike][\&.manual|\&.automatic][\&.urgent][\&.local][\&.unfocused]
+NODE_SEL := [NODE_SEL#](DIR|CYCLE_DIR|PATH|any|last|newest|
+                        older|newer|focused|pointed|biggest|smallest|
+                        <node_id>)[\&.[!]focused][\&.[!]active][\&.[!]automatic][\&.[!]local]
+                                  [\&.[!]leaf][\&.[!]window][\&.[!]STATE][\&.[!]FLAG][\&.[!]LAYER]
+                                  [\&.[!]same_class][\&.[!]descendant_of][\&.[!]ancestor_of]
+
+STATE := tiled|pseudo_tiled|floating|fullscreen
+
+FLAG := hidden|sticky|private|locked|marked|urgent
+
+LAYER := below|normal|above
+
+PATH := @[DESKTOP_SEL:][[/]JUMP](/JUMP)*
+
+JUMP := first|1|second|2|brother|parent|DIR
 .fi
 .if n \{\
 .RE
@@ -178,42 +125,108 @@ WINDOW_SEL := <window_id>
 .nr an-break-flag 1
 .br
 .ps +1
-\fBPrimary Selectors\fR
+\fBDescriptors\fR
 .RS 4
 .PP
 \fIDIR\fR
 .RS 4
-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\&.
 .RE
 .PP
 \fICYCLE_DIR\fR
 .RS 4
-Selects the window in the given (cyclic) direction\&.
+Selects the window in the given (cyclic) direction relative to the reference node\&.
 .RE
 .PP
-biggest
+\fIPATH\fR
+.RS 4
+Selects the node at the given path\&.
+.RE
+.PP
+any
 .RS 4
-Selects the biggest window on the current desktop\&.
+Selects the first node that matches the given selectors\&.
 .RE
 .PP
 last
 .RS 4
-Selects the previously focused window\&.
+Selects the previously focused node relative to the reference node\&.
 .RE
 .PP
-focused
+newest
 .RS 4
-Selects the currently focused window\&.
+Selects the newest node in the history of the focused node\&.
 .RE
 .PP
 older
 .RS 4
-Selects the window older than the focused window in the history\&.
+Selects the node older than the reference node in the history\&.
 .RE
 .PP
 newer
 .RS 4
-Selects the window newer than the focused window in the history\&.
+Selects the node newer than the reference node in the history\&.
+.RE
+.PP
+focused
+.RS 4
+Selects the currently focused node\&.
+.RE
+.PP
+pointed
+.RS 4
+Selects the window under the pointer\&.
+.RE
+.PP
+biggest
+.RS 4
+Selects the biggest window\&.
+.RE
+.PP
+smallest
+.RS 4
+Selects the smallest window\&.
+.RE
+.PP
+<node_id>
+.RS 4
+Selects the node with the given ID\&.
+.RE
+.RE
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBPath Jumps\fR
+.RS 4
+.sp
+The initial node is the focused node (or the root if the path starts with \fI/\fR) of the reference desktop (or the selected desktop if the path has a \fIDESKTOP_SEL\fR prefix)\&.
+.PP
+1|first
+.RS 4
+Jumps to the first child\&.
+.RE
+.PP
+2|second
+.RS 4
+Jumps to the second child\&.
+.RE
+.PP
+brother
+.RS 4
+Jumps to the brother node\&.
+.RE
+.PP
+parent
+.RS 4
+Jumps to the parent node\&.
+.RE
+.PP
+\fIDIR\fR
+.RS 4
+Jumps to the node holding the edge in the given direction\&.
 .RE
 .RE
 .sp
@@ -225,49 +238,70 @@ Selects the window newer than the focused window in the history\&.
 \fBModifiers\fR
 .RS 4
 .PP
-floating
+[!]focused
 .RS 4
-Only consider floating windows\&.
+Only consider the focused node\&.
 .RE
 .PP
-tiled
+[!]active
 .RS 4
-Only consider tiled windows\&.
+Only consider nodes that are the focused node of their desktop\&.
 .RE
 .PP
-like
+[!]automatic
 .RS 4
-Only consider windows that have the same class as the current window\&.
+Only consider nodes in automatic insertion mode\&. See also
+\fB\-\-presel\-dir\fR
+under
+\fBNode\fR
+in the
+\fBDOMAINS\fR
+section below\&.
 .RE
 .PP
-unlike
+[!]local
 .RS 4
-Only consider windows that have a different class than the current window\&.
+Only consider nodes in the reference desktop\&.
 .RE
 .PP
-manual
+[!]leaf
 .RS 4
-Only consider windows in manual splitting mode\&.
+Only consider leaf nodes\&.
 .RE
 .PP
-automatic
+[!]window
 .RS 4
-Only consider windows in automatic splitting mode\&.
+Only consider nodes that hold a window\&.
 .RE
 .PP
-local
+[!](tiled|pseudo_tiled|floating|fullscreen)
 .RS 4
-Only consider windows of the current desktop\&.
+Only consider windows in the given state\&.
 .RE
 .PP
-urgent
+[!]same_class
+.RS 4
+Only consider windows that have the same class as the reference window\&.
+.RE
+.PP
+[!]descendant_of
+.RS 4
+Only consider nodes that are descendants of the reference node\&.
+.RE
+.PP
+[!]ancestor_of
+.RS 4
+Only consider nodes that are ancestors of the reference node\&.
+.RE
+.PP
+[!](hidden|sticky|private|locked|marked|urgent)
 .RS 4
-Only consider urgent windows\&.
+Only consider windows that have the given flag set\&.
 .RE
 .PP
-unfocused
+[!](below|normal|above)
 .RS 4
-Only consider windows other than the focused window\&.
+Only consider windows in the given layer\&.
 .RE
 .RE
 .SS "Desktop"
@@ -278,9 +312,10 @@ Select a desktop\&.
 .RS 4
 .\}
 .nf
-DESKTOP_SEL := <desktop_name>
-             | [MONITOR_SEL:]^<n>
-             | (CYCLE_DIR|last|[MONITOR_SEL:]focused|older|newer)[\&.occupied|\&.free][\&.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]
 .fi
 .if n \{\
 .RE
@@ -291,27 +326,37 @@ DESKTOP_SEL := <desktop_name>
 .nr an-break-flag 1
 .br
 .ps +1
-\fBPrimary Selectors\fR
+\fBDescriptors\fR
 .RS 4
 .PP
-<desktop_name>
+\fICYCLE_DIR\fR
 .RS 4
-Selects the desktop with the given name\&.
+Selects the desktop in the given direction relative to the reference desktop\&.
 .RE
 .PP
-^<n>
+any
 .RS 4
-Selects the nth desktop\&.
+Selects the first desktop that matches the given selectors\&.
 .RE
 .PP
-\fICYCLE_DIR\fR
+last
 .RS 4
-Selects the desktop in the given direction relative to the active desktop\&.
+Selects the previously focused desktop relative to the reference desktop\&.
 .RE
 .PP
-last
+newest
+.RS 4
+Selects the newest desktop in the history of the focused desktops\&.
+.RE
+.PP
+older
+.RS 4
+Selects the desktop older than the reference desktop in the history\&.
+.RE
+.PP
+newer
 .RS 4
-Selects the previously focused desktop\&.
+Selects the desktop newer than the reference desktop in the history\&.
 .RE
 .PP
 focused
@@ -319,14 +364,21 @@ focused
 Selects the currently focused desktop\&.
 .RE
 .PP
-older
+^<n>
 .RS 4
-Selects the desktop older than the focused desktop in the history\&.
+Selects the nth desktop\&. If
+\fBMONITOR_SEL\fR
+is given, selects the nth desktop on the selected monitor\&.
 .RE
 .PP
-newer
+<desktop_id>
+.RS 4
+Selects the desktop with the given ID\&.
+.RE
+.PP
+<desktop_name>
 .RS 4
-Selects the desktop newer than the focused desktop in the history\&.
+Selects the desktop with the given name\&.
 .RE
 .RE
 .sp
@@ -338,24 +390,29 @@ Selects the desktop newer than the focused desktop in the history\&.
 \fBModifiers\fR
 .RS 4
 .PP
-occupied
+[!]focused
 .RS 4
-Only consider occupied desktops\&.
+Only consider the focused desktop\&.
 .RE
 .PP
-free
+[!]active
 .RS 4
-Only consider free desktops\&.
+Only consider desktops that are the focused desktop of their monitor\&.
 .RE
 .PP
-urgent
+[!]occupied
+.RS 4
+Only consider occupied desktops\&.
+.RE
+.PP
+[!]urgent
 .RS 4
 Only consider urgent desktops\&.
 .RE
 .PP
-local
+[!]local
 .RS 4
-Only consider desktops of the current monitor\&.
+Only consider desktops inside the reference monitor\&.
 .RE
 .RE
 .SS "Monitor"
@@ -366,9 +423,9 @@ Select a monitor\&.
 .RS 4
 .\}
 .nf
-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]
 .fi
 .if n \{\
 .RE
@@ -379,37 +436,42 @@ MONITOR_SEL := <monitor_name>
 .nr an-break-flag 1
 .br
 .ps +1
-\fBPrimary Selectors\fR
+\fBDescriptors\fR
 .RS 4
 .PP
-<monitor_name>
+\fIDIR\fR
 .RS 4
-Selects the monitor with the given name\&.
+Selects the monitor in the given (spacial) direction relative to the reference monitor\&.
 .RE
 .PP
-^<n>
+\fICYCLE_DIR\fR
 .RS 4
-Selects the nth monitor\&.
+Selects the monitor in the given (cyclic) direction relative to the reference monitor\&.
 .RE
 .PP
-\fIDIR\fR
+any
 .RS 4
-Selects the monitor in the given (spacial) direction relative to the active monitor\&.
+Selects the first monitor that matches the given selectors\&.
 .RE
 .PP
-\fICYCLE_DIR\fR
+last
 .RS 4
-Selects the monitor in the given (cyclic) direction relative to the active monitor\&.
+Selects the previously focused monitor relative to the reference monitor\&.
 .RE
 .PP
-primary
+newest
 .RS 4
-Selects the primary monitor\&.
+Selects the newest monitor in the history of the focused monitors\&.
 .RE
 .PP
-last
+older
+.RS 4
+Selects the monitor older than the reference monitor in the history\&.
+.RE
+.PP
+newer
 .RS 4
-Selects the previously focused monitor\&.
+Selects the monitor newer than the reference monitor in the history\&.
 .RE
 .PP
 focused
@@ -417,14 +479,29 @@ focused
 Selects the currently focused monitor\&.
 .RE
 .PP
-older
+pointed
 .RS 4
-Selects the monitor older than the focused monitor in the history\&.
+Selects the monitor under the pointer\&.
 .RE
 .PP
-newer
+primary
+.RS 4
+Selects the primary monitor\&.
+.RE
+.PP
+^<n>
+.RS 4
+Selects the nth monitor\&.
+.RE
+.PP
+<monitor_id>
+.RS 4
+Selects the monitor with the given ID\&.
+.RE
+.PP
+<monitor_name>
 .RS 4
-Selects the monitor newer than the focused monitor in the history\&.
+Selects the monitor with the given name\&.
 .RE
 .RE
 .sp
@@ -436,21 +513,21 @@ Selects the monitor newer than the focused monitor in the history\&.
 \fBModifiers\fR
 .RS 4
 .PP
-occupied
+[!]focused
 .RS 4
-Only consider monitors where the focused desktop is occupied\&.
+Only consider the focused monitor\&.
 .RE
 .PP
-free
+[!]occupied
 .RS 4
-Only consider monitors where the focused desktop is free\&.
+Only consider monitors where the focused desktop is occupied\&.
 .RE
 .RE
 .SH "WINDOW STATES"
 .PP
-floating
+tiled
 .RS 4
-Is above any tiled window and can be moved/resized freely\&. Although it doesn\(cqt occupy any tiling space, it is still part of the window tree\&.
+Its size and position are determined by the splitting type and ratio of each node of its path in the window tree\&.
 .RE
 .PP
 pseudo_tiled
@@ -458,16 +535,20 @@ pseudo_tiled
 Has an unrestricted size while being centered in its tiling space\&.
 .RE
 .PP
+floating
+.RS 4
+Can be moved/resized freely\&. Although it doesn\(cqt occupy any tiling space, it is still part of the window tree\&.
+.RE
+.PP
 fullscreen
 .RS 4
-Fills its monitor rectangle, is above all the other windows and has no borders\&.
+Fills its monitor rectangle and has no borders\&. It is send in the ABOVE layer by default\&.
 .RE
+.SH "NODE FLAGS"
 .PP
-locked
+hidden
 .RS 4
-Ignores the
-\fBclose\fR
-message\&.
+Is hidden and doesn\(cqt occupy any tiling space\&.
 .RE
 .PP
 sticky
@@ -479,8 +560,33 @@ private
 .RS 4
 Tries to keep the same tiling position/size\&.
 .RE
-.SH "COMMANDS"
-.SS "Window"
+.PP
+locked
+.RS 4
+Ignores the
+\fBnode \-\-close\fR
+message\&.
+.RE
+.PP
+marked
+.RS 4
+Is marked (useful for deferred actions)\&. A marked node becomes unmarked after being sent on a preselected node\&.
+.RE
+.PP
+urgent
+.RS 4
+Has its urgency hint set\&. This flag is set externally\&.
+.RE
+.SH "STACKING LAYERS"
+.sp
+There\(cqs three stacking layers: BELOW, NORMAL and ABOVE\&.
+.sp
+In each layer, the window are orderered as follow: tiled & pseudo\-tiled < floating < fullscreen\&.
+.SH "RECEPTACLES"
+.sp
+A leaf node that doesn\(cqt 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 \fIexamples/receptacles\fR to store and recreate layouts\&.
+.SH "DOMAINS"
+.SS "Node"
 .sp
 .it 1 an-trap
 .nr an-no-space-flag 1
@@ -490,7 +596,9 @@ Tries to keep the same tiling position/size\&.
 \fBGeneral Syntax\fR
 .RS 4
 .sp
-window [\fIWINDOW_SEL\fR] \fIOPTIONS\fR
+node [\fINODE_SEL\fR] \fICOMMANDS\fR
+.sp
+If \fINODE_SEL\fR is omitted, \fBfocused\fR is assumed\&.
 .RE
 .sp
 .it 1 an-trap
@@ -498,69 +606,143 @@ window [\fIWINDOW_SEL\fR] \fIOPTIONS\fR
 .nr an-break-flag 1
 .br
 .ps +1
-\fBOptions\fR
+\fBCommands\fR
+.RS 4
+.PP
+\fB\-f\fR, \fB\-\-focus\fR [\fINODE_SEL\fR]
+.RS 4
+Focus the selected or given node\&.
+.RE
+.PP
+\fB\-a\fR, \fB\-\-activate\fR [\fINODE_SEL\fR]
+.RS 4
+Activate the selected or given node\&.
+.RE
+.PP
+\fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR [\fB\-\-follow\fR]
 .RS 4
+Send the selected node to the given desktop\&. If
+\fB\-\-follow\fR
+is passed, the focused node will stay focused\&.
+.RE
+.PP
+\fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR [\fB\-\-follow\fR]
+.RS 4
+Send the selected node to the given monitor\&. If
+\fB\-\-follow\fR
+is passed, the focused node will stay focused\&.
+.RE
 .PP
-\fB\-f\fR, \fB\-\-focus\fR [\fIWINDOW_SEL\fR]
+\fB\-n\fR, \fB\-\-to\-node\fR \fINODE_SEL\fR [\fB\-\-follow\fR]
 .RS 4
-Focus the selected or given window\&.
+Send the selected node on the given node\&. If
+\fB\-\-follow\fR
+is passed, the focused node will stay focused\&.
 .RE
 .PP
-\fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR
+\fB\-s\fR, \fB\-\-swap\fR \fINODE_SEL\fR [\fB\-\-follow\fR]
 .RS 4
-Send the selected window to the given desktop\&.
+Swap the selected node with the given node\&. If
+\fB\-\-follow\fR
+is passed, the focused node will stay focused\&.
 .RE
 .PP
-\fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR
+\fB\-p\fR, \fB\-\-presel\-dir\fR [~]\fIDIR\fR|cancel
 .RS 4
-Send the selected window to the given monitor\&.
+Preselect the splitting area of the selected node (or cancel the preselection)\&. If
+\fB~\fR
+is prepended to
+\fIDIR\fR
+and the current preselection direction matches
+\fIDIR\fR, then the argument is interpreted as
+\fBcancel\fR\&. A node with a preselected area is said to be in "manual insertion mode"\&.
 .RE
 .PP
-\fB\-w\fR, \fB\-\-to\-window\fR \fIWINDOW_SEL\fR
+\fB\-o\fR, \fB\-\-presel\-ratio\fR \fIRATIO\fR
 .RS 4
-Transplant the selected window to the given window\&.
+Set the splitting ratio of the preselection area\&.
 .RE
 .PP
-\fB\-s\fR, \fB\-\-swap\fR \fIWINDOW_SEL\fR
+\fB\-v\fR, \fB\-\-move\fR \fIdx\fR \fIdy\fR
 .RS 4
-Swap the selected window with the given window\&.
+Move the selected window by
+\fIdx\fR
+pixels horizontally and
+\fIdy\fR
+pixels vertically\&.
 .RE
 .PP
-\fB\-p\fR, \fB\-\-presel\fR \fIDIR\fR|cancel
+\fB\-z\fR, \fB\-\-resize\fR top|left|bottom|right|top_left|top_right|bottom_right|bottom_left \fIdx\fR \fIdy\fR
 .RS 4
-Preselect the splitting area of the selected window (or cancel the preselection)\&.
+Resize the selected window by moving the given handle by
+\fIdx\fR
+pixels horizontally and
+\fIdy\fR
+pixels vertically\&.
 .RE
 .PP
-\fB\-r\fR, \fB\-\-ratio\fR \fIRATIO\fR
+\fB\-r\fR, \fB\-\-ratio\fR \fIRATIO\fR|(+|\-)(\fIPIXELS\fR|\fIFRACTION\fR)
 .RS 4
-Set the splitting ratio of the selected window (0 <
+Set the splitting ratio of the selected node (0 <
 \fIRATIO\fR
 < 1)\&.
 .RE
 .PP
-\fB\-e\fR, \fB\-\-edge\fR \fIDIR\fR \fIRATIO\fR|\(+-\fIPIXELS\fR
+\fB\-R\fR, \fB\-\-rotate\fR \fI90|270|180\fR
+.RS 4
+Rotate the tree rooted at the selected node\&.
+.RE
+.PP
+\fB\-F\fR, \fB\-\-flip\fR \fIhorizontal|vertical\fR
+.RS 4
+Flip the the tree rooted at selected node\&.
+.RE
+.PP
+\fB\-E\fR, \fB\-\-equalize\fR
+.RS 4
+Reset the split ratios of the tree rooted at the selected node to their default value\&.
+.RE
+.PP
+\fB\-B\fR, \fB\-\-balance\fR
+.RS 4
+Adjust the split ratios of the tree rooted at the selected node so that all windows occupy the same area\&.
+.RE
+.PP
+\fB\-C\fR, \fB\-\-circulate\fR forward|backward
+.RS 4
+Circulate the windows of the tree rooted at the selected node\&.
+.RE
+.PP
+\fB\-t\fR, \fB\-\-state\fR [~](tiled|pseudo_tiled|floating|fullscreen)
+.RS 4
+Set the state of the selected window\&. If
+\fB~\fR
+is present and the current state matches the given state, then the argument is interpreted as the last state\&.
+.RE
+.PP
+\fB\-g\fR, \fB\-\-flag\fR hidden|sticky|private|locked|marked[=on|off]
 .RS 4
-Set or change the splitting ratio of the edge located in the given direction in relation to the selected window\&.
+Set or toggle the given flag for the selected node\&.
 .RE
 .PP
-\fB\-R\fR, \fB\-\-rotate\fR \fIDIR\fR \fI90|270|180\fR
+\fB\-l\fR, \fB\-\-layer\fR below|normal|above
 .RS 4
-Rotate the tree holding the edge located in the given direction in relation to the selected window\&.
+Set the stacking layer of the selected window\&.
 .RE
 .PP
-\fB\-t\fR, \fB\-\-toggle\fR floating|fullscreen|pseudo_tiled|locked|sticky|private[=on|off]
+\fB\-i\fR, \fB\-\-insert\-receptacle\fR
 .RS 4
-Set or toggle the given state for the selected window\&.
+Insert a receptacle node at the selected node\&.
 .RE
 .PP
 \fB\-c\fR, \fB\-\-close\fR
 .RS 4
-Close the selected window\&.
+Close the windows rooted at the selected node\&.
 .RE
 .PP
 \fB\-k\fR, \fB\-\-kill\fR
 .RS 4
-Kill the selected window\&.
+Kill the windows rooted at the selected node\&.
 .RE
 .RE
 .SS "Desktop"
@@ -573,7 +755,9 @@ Kill the selected window\&.
 \fBGeneral Syntax\fR
 .RS 4
 .sp
-desktop [\fIDESKTOP_SEL\fR] \fIOPTIONS\fR
+desktop [\fIDESKTOP_SEL\fR] \fICOMMANDS\fR
+.sp
+If \fIDESKTOP_SEL\fR is omitted, \fBfocused\fR is assumed\&.
 .RE
 .sp
 .it 1 an-trap
@@ -581,7 +765,7 @@ desktop [\fIDESKTOP_SEL\fR] \fIOPTIONS\fR
 .nr an-break-flag 1
 .br
 .ps +1
-\fBOptions\fR
+\fBCOMMANDS\fR
 .RS 4
 .PP
 \fB\-f\fR, \fB\-\-focus\fR [\fIDESKTOP_SEL\fR]
@@ -589,9 +773,23 @@ desktop [\fIDESKTOP_SEL\fR] \fIOPTIONS\fR
 Focus the selected or given desktop\&.
 .RE
 .PP
-\fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR
+\fB\-a\fR, \fB\-\-activate\fR [\fIDESKTOP_SEL\fR]
+.RS 4
+Activate the selected or given desktop\&.
+.RE
+.PP
+\fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR [\fB\-\-follow\fR]
+.RS 4
+Send the selected desktop to the given monitor\&. If
+\fB\-\-follow\fR
+is passed, the focused desktop will stay focused\&.
+.RE
+.PP
+\fB\-s\fR, \fB\-\-swap\fR \fIDESKTOP_SEL\fR [\fB\-\-follow\fR]
 .RS 4
-Send the selected desktop to the given monitor\&.
+Swap the selected desktop with the given desktop\&. If
+\fB\-\-follow\fR
+is passed, the focused desktop will stay focused\&.
 .RE
 .PP
 \fB\-l\fR, \fB\-\-layout\fR \fICYCLE_DIR\fR|monocle|tiled
@@ -604,11 +802,6 @@ Set or cycle the layout of the selected desktop\&.
 Rename the selected desktop\&.
 .RE
 .PP
-\fB\-s\fR, \fB\-\-swap\fR \fIDESKTOP_SEL\fR
-.RS 4
-Swap the selected desktop with the given desktop\&.
-.RE
-.PP
 \fB\-b\fR, \fB\-\-bubble\fR \fICYCLE_DIR\fR
 .RS 4
 Bubble the selected desktop in the given direction\&.
@@ -618,43 +811,71 @@ Bubble the selected desktop in the given direction\&.
 .RS 4
 Remove the selected desktop\&.
 .RE
-.PP
-\fB\-c\fR, \fB\-\-cancel\-presel\fR
+.RE
+.SS "Monitor"
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBGeneral Syntax\fR
 .RS 4
-Cancel the preselection of all the windows of the selected desktop\&.
+.sp
+monitor [\fIMONITOR_SEL\fR] \fICOMMANDS\fR
+.sp
+If \fIMONITOR_SEL\fR is omitted, \fBfocused\fR is assumed\&.
 .RE
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBCommands\fR
+.RS 4
 .PP
-\fB\-F\fR, \fB\-\-flip\fR \fIhorizontal|vertical\fR
+\fB\-f\fR, \fB\-\-focus\fR [\fIMONITOR_SEL\fR]
 .RS 4
-Flip the tree of the selected desktop\&.
+Focus the selected or given monitor\&.
 .RE
 .PP
-\fB\-R\fR, \fB\-\-rotate\fR \fI90|270|180\fR
+\fB\-s\fR, \fB\-\-swap\fR \fIMONITOR_SEL\fR
 .RS 4
-Rotate the tree of the selected desktop\&.
+Swap the selected monitor with the given monitor\&.
 .RE
 .PP
-\fB\-E\fR, \fB\-\-equalize\fR
+\fB\-a\fR, \fB\-\-add\-desktops\fR <name>\&...
 .RS 4
-Reset the split ratios of the tree of the selected desktop\&.
+Create desktops with the given names in the selected monitor\&.
 .RE
 .PP
-\fB\-B\fR, \fB\-\-balance\fR
+\fB\-o\fR, \fB\-\-reorder\-desktops\fR <name>\&...
 .RS 4
-Adjust the split ratios of the tree of the selected desktop so that all windows occupy the same area\&.
+Reorder the desktops of the selected monitor to match the given order\&.
 .RE
 .PP
-\fB\-C\fR, \fB\-\-circulate\fR forward|backward
+\fB\-d\fR, \fB\-\-reset\-desktops\fR <name>\&...
+.RS 4
+Rename, add or remove desktops depending on whether the number of given names is equal, superior or inferior to the number of existing desktops\&.
+.RE
+.PP
+\fB\-g\fR, \fB\-\-rectangle\fR WxH+X+Y
 .RS 4
-Circulate the leaves of the tree of the selected desktop\&.
+Set the rectangle of the selected monitor\&.
 .RE
 .PP
-\fB\-t\fR, \fB\-\-toggle\fR floating[=on|off]
+\fB\-n\fR, \fB\-\-rename\fR <new_name>
 .RS 4
-Set or toggle the given state for the selected desktop\&.
+Rename the selected monitor\&.
 .RE
+.PP
+\fB\-r\fR, \fB\-\-remove\fR
+.RS 4
+Remove the selected monitor\&.
 .RE
-.SS "Monitor"
+.RE
+.SS "Query"
 .sp
 .it 1 an-trap
 .nr an-no-space-flag 1
@@ -664,7 +885,7 @@ Set or toggle the given state for the selected desktop\&.
 \fBGeneral Syntax\fR
 .RS 4
 .sp
-monitor [\fIMONITOR_SEL\fR] \fIOPTIONS\fR
+query \fICOMMANDS\fR [\fIOPTIONS\fR]
 .RE
 .sp
 .it 1 an-trap
@@ -672,45 +893,58 @@ monitor [\fIMONITOR_SEL\fR] \fIOPTIONS\fR
 .nr an-break-flag 1
 .br
 .ps +1
-\fBOptions\fR
+\fBCommands\fR
 .RS 4
+.sp
+The optional selectors are references\&.
 .PP
-\fB\-f\fR, \fB\-\-focus\fR [\fIMONITOR_SEL\fR]
+\fB\-N\fR, \fB\-\-nodes\fR [\fINODE_SEL\fR]
 .RS 4
-Focus the selected or given monitor\&.
+List the IDs of the matching nodes\&.
 .RE
 .PP
-\fB\-a\fR, \fB\-\-add\-desktops\fR <name>\&...
+\fB\-D\fR, \fB\-\-desktops\fR [\fIDESKTOP_SEL\fR]
 .RS 4
-Create desktops with the given names in the selected monitor\&.
+List the IDs (or names) of the matching desktops\&.
 .RE
 .PP
-\fB\-r\fR, \fB\-\-remove\-desktops\fR <name>\&...
+\fB\-M\fR, \fB\-\-monitors\fR [\fIMONITOR_SEL\fR]
 .RS 4
-Remove desktops with the given names\&.
+List the IDs (or names) of the matching monitors\&.
 .RE
 .PP
-\fB\-o\fR, \fB\-\-reorder\-desktops\fR <name>\&...
+\fB\-T\fR, \fB\-\-tree\fR
 .RS 4
-Reorder the desktops of the selected monitor to match the given order\&.
+Print a JSON representation of the matching item\&.
 .RE
-.PP
-\fB\-d\fR, \fB\-\-reset\-desktops\fR <name>\&...
-.RS 4
-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\&.
 .RE
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBOptions\fR
+.RS 4
 .PP
-\fB\-n\fR, \fB\-\-rename\fR <new_name>
+\fB\-m\fR,\fB\-\-monitor\fR [\fIMONITOR_SEL\fR], \fB\-d\fR,\fB\-\-desktop\fR [\fIDESKTOP_SEL\fR], \fB\-n\fR, \fB\-\-node\fR [\fINODE_SEL\fR]
 .RS 4
-Rename the selected monitor\&.
+Constrain matches to the selected monitor, desktop or node\&. The descriptor can be omitted for
+\fI\-M\fR,
+\fI\-D\fR
+and
+\fI\-N\fR\&.
 .RE
 .PP
-\fB\-s\fR, \fB\-\-swap\fR \fIMONITOR_SEL\fR
+\fB\-\-names\fR
 .RS 4
-Swap the selected monitor with the given monitor\&.
+Print names instead of IDs\&. Can only be used with
+\fI\-M\fR
+and
+\fI\-D\fR\&.
 .RE
 .RE
-.SS "Query"
+.SS "Wm"
 .sp
 .it 1 an-trap
 .nr an-no-space-flag 1
@@ -720,7 +954,7 @@ Swap the selected monitor with the given monitor\&.
 \fBGeneral Syntax\fR
 .RS 4
 .sp
-query \fIOPTIONS\fR
+wm \fICOMMANDS\fR
 .RE
 .sp
 .it 1 an-trap
@@ -728,45 +962,45 @@ query \fIOPTIONS\fR
 .nr an-break-flag 1
 .br
 .ps +1
-\fBOptions\fR
+\fBCommands\fR
 .RS 4
 .PP
-\fB\-W\fR, \fB\-\-windows\fR
+\fB\-d\fR, \fB\-\-dump\-state\fR
 .RS 4
-List matching windows\&.
+Dump the current world state on standard output\&.
 .RE
 .PP
-\fB\-D\fR, \fB\-\-desktops\fR
+\fB\-l\fR, \fB\-\-load\-state\fR <file_path>
 .RS 4
-List matching desktops\&.
+Load a world state from the given file\&.
 .RE
 .PP
-\fB\-M\fR, \fB\-\-monitors\fR
+\fB\-a\fR, \fB\-\-add\-monitor\fR <name> WxH+X+Y
 .RS 4
-List matching monitors\&.
+Add a monitor for the given name and rectangle\&.
 .RE
 .PP
-\fB\-T\fR, \fB\-\-tree\fR
+\fB\-O\fR, \fB\-\-reorder\-monitors\fR <name>\&...
 .RS 4
-Print tree rooted at query\&.
+Reorder the list of monitors to match the given order\&.
 .RE
 .PP
-\fB\-H\fR, \fB\-\-history\fR
+\fB\-o\fR, \fB\-\-adopt\-orphans\fR
 .RS 4
-Print the history as it relates to the query\&.
+Manage all the unmanaged windows remaining from a previous session\&.
 .RE
 .PP
-\fB\-S\fR, \fB\-\-stack\fR
+\fB\-h\fR, \fB\-\-record\-history\fR on|off
 .RS 4
-Print the window stacking order\&.
+Enable or disable the recording of node focus history\&.
 .RE
 .PP
-[\fB\-m\fR,\fB\-\-monitor\fR [\fIMONITOR_SEL\fR]] | [\fB\-d\fR,\fB\-\-desktop\fR [\fIDESKTOP_SEL\fR]] | [\fB\-w\fR, \fB\-\-window\fR [\fIWINDOW_SEL\fR]]
+\fB\-g\fR, \fB\-\-get\-status\fR
 .RS 4
-Constrain matches to the selected monitor, desktop or window\&.
+Print the current status information\&.
 .RE
 .RE
-.SS "Restore"
+.SS "Rule"
 .sp
 .it 1 an-trap
 .nr an-no-space-flag 1
@@ -776,7 +1010,7 @@ Constrain matches to the selected monitor, desktop or window\&.
 \fBGeneral Syntax\fR
 .RS 4
 .sp
-restore \fIOPTIONS\fR
+rule \fICOMMANDS\fR
 .RE
 .sp
 .it 1 an-trap
@@ -784,25 +1018,25 @@ restore \fIOPTIONS\fR
 .nr an-break-flag 1
 .br
 .ps +1
-\fBOptions\fR
+\fBCommands\fR
 .RS 4
 .PP
-\fB\-T\fR, \fB\-\-tree\fR <file_path>
+\fB\-a\fR, \fB\-\-add\fR (<class_name>|*)[:(<instance_name>|*)] [\fB\-o\fR|\fB\-\-one\-shot\fR] [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]
 .RS 4
-Load the desktop trees from the given file\&.
+Create a new rule\&.
 .RE
 .PP
-\fB\-H\fR, \fB\-\-history\fR <file_path>
+\fB\-r\fR, \fB\-\-remove\fR ^<n>|head|tail|(<class_name>|*)[:(<instance_name>|*)]\&...
 .RS 4
-Load the focus history from the given file\&.
+Remove the given rules\&.
 .RE
 .PP
-\fB\-S\fR, \fB\-\-stack\fR <file_path>
+\fB\-l\fR, \fB\-\-list\fR
 .RS 4
-Load the window stacking order from the given file\&.
+List the rules\&.
 .RE
 .RE
-.SS "Control"
+.SS "Config"
 .sp
 .it 1 an-trap
 .nr an-no-space-flag 1
@@ -811,44 +1045,53 @@ Load the window stacking order from the given file\&.
 .ps +1
 \fBGeneral Syntax\fR
 .RS 4
-.sp
-control \fIOPTIONS\fR
+.PP
+config [\-m \fIMONITOR_SEL\fR|\-d \fIDESKTOP_SEL\fR|\-n \fINODE_SEL\fR] <setting> [<value>]
+.RS 4
+Get or set the value of <setting>\&.
+.RE
 .RE
+.SS "Subscribe"
 .sp
 .it 1 an-trap
 .nr an-no-space-flag 1
 .nr an-break-flag 1
 .br
 .ps +1
-\fBOptions\fR
+\fBGeneral Syntax\fR
 .RS 4
 .PP
-\fB\-\-adopt\-orphans\fR
+subscribe [\fIOPTIONS\fR] (all|report|monitor|desktop|node|\&...)*
 .RS 4
-Manage all the unmanaged windows remaining from a previous session\&.
+Continuously print events\&. See the
+\fBEVENTS\fR
+section for the description of each event\&.
 .RE
-.PP
-\fB\-\-toggle\-visibility\fR
-.RS 4
-Toggle the visibility of all the windows\&.
 .RE
-.PP
-\fB\-\-record\-history\fR on|off
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBOptions\fR
 .RS 4
-Enable or disable the recording of window focus history\&.
-.RE
 .PP
-\fB\-\-subscribe\fR (all|report|monitor|desktop|window|\&...)*
+\fB\-f\fR, \fB\-\-fifo\fR
 .RS 4
-Continuously print status information\&.
+Print a path to a FIFO from which events can be read and return\&.
 .RE
 .PP
-\fB\-\-get\-status\fR
+\fB\-c\fR, \fB\-\-count\fR \fICOUNT\fR
 .RS 4
-Print the current status information\&.
+Stop the corresponding
+\fBbspc\fR
+process after having received
+\fICOUNT\fR
+events\&.
 .RE
 .RE
-.SS "Pointer"
+.SS "Quit"
 .sp
 .it 1 an-trap
 .nr an-no-space-flag 1
@@ -857,333 +1100,419 @@ Print the current status information\&.
 .ps +1
 \fBGeneral Syntax\fR
 .RS 4
-.sp
-pointer \fIOPTIONS\fR
+.PP
+quit [<status>]
+.RS 4
+Quit with an optional exit status\&.
 .RE
+.RE
+.SH "EXIT CODES"
 .sp
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBOptions\fR
+If the server can\(cqt handle a message, \fBbspc\fR will return with a non\-zero exit code\&.
+.SH "SETTINGS"
+.sp
+Colors are in the form \fI#RRGGBB\fR, booleans are \fItrue\fR, \fIon\fR, \fIfalse\fR or \fIoff\fR\&.
+.sp
+All the boolean settings are \fIfalse\fR by default unless stated otherwise\&.
+.SS "Global Settings"
+.PP
+\fInormal_border_color\fR
 .RS 4
+Color of the border of an unfocused window\&.
+.RE
 .PP
-\fB\-g\fR, \fB\-\-grab\fR focus|move|resize_side|resize_corner
+\fIactive_border_color\fR
 .RS 4
-Initiate the given pointer action\&.
+Color of the border of a focused window of an unfocused monitor\&.
 .RE
 .PP
-\fB\-t\fR, \fB\-\-track\fR <x> <y>
+\fIfocused_border_color\fR
 .RS 4
-Pass the pointer root coordinates for the current pointer action\&.
+Color of the border of a focused window of a focused monitor\&.
 .RE
 .PP
-\fB\-u\fR, \fB\-\-ungrab\fR
+\fIpresel_feedback_color\fR
 .RS 4
-Terminate the current pointer action\&.
+Color of the
+\fBnode \-\-presel\-{dir,ratio}\fR
+message feedback area\&.
 .RE
+.PP
+\fIsplit_ratio\fR
+.RS 4
+Default split ratio\&.
 .RE
-.SS "Rule"
-.sp
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBGeneral Syntax\fR
+.PP
+\fIstatus_prefix\fR
 .RS 4
-.sp
-rule \fIOPTIONS\fR
+Prefix prepended to each of the status lines\&.
 .RE
-.sp
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBOptions\fR
+.PP
+\fIexternal_rules_command\fR
 .RS 4
+External command used to retrieve rule consequences\&. The command will receive the following arguments: window ID, class name, instance name, and intermediate consequences\&. The output of that command must have the following format:
+\fBkey1=value1 key2=value2 \&...\fR
+(the valid key/value pairs are given in the description of the
+\fIrule\fR
+command)\&.
+.RE
 .PP
-\fB\-a\fR, \fB\-\-add\fR <class_name>|<instance_name>|* [\fB\-o\fR|\fB\-\-one\-shot\fR] [monitor=MONITOR_SEL|desktop=DESKTOP_SEL|window=WINDOW_SEL] [(floating|fullscreen|pseudo_tiled|locked|sticky|private|center|follow|manage|focus|border)=(on|off)] [split_dir=DIR] [split_ratio=RATIO]
+\fIautomatic_scheme\fR
 .RS 4
-Create a new rule\&.
+The insertion scheme used when the insertion point is in automatic mode\&. Accept the following values:
+\fBlongest_side\fR,
+\fBalternate\fR,
+\fBspiral\fR\&.
 .RE
 .PP
-\fB\-r\fR, \fB\-\-remove\fR ^<n>|head|tail|<class_name>|<instance_name>|*\&...
+\fIinitial_polarity\fR
 .RS 4
-Remove the given rules\&.
+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:
+\fBfirst_child\fR,
+\fBsecond_child\fR\&.
 .RE
 .PP
-\fB\-l\fR, \fB\-\-list\fR [<class_name>|<instance_name>|*]
+\fIdirectional_focus_tightness\fR
 .RS 4
-List the rules\&.
+The tightness of the algorithm used to decide whether a window is on the
+\fIDIR\fR
+side of another window\&. Accept the following values:
+\fBhigh\fR,
+\fBlow\fR\&.
 .RE
+.PP
+\fIremoval_adjustment\fR
+.RS 4
+Adjust the brother when unlinking a node from the tree in accordance with the automatic insertion scheme\&.
 .RE
-.SS "Config"
-.sp
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBGeneral Syntax\fR
+.PP
+\fIborderless_monocle\fR
 .RS 4
+Remove borders of tiled windows for the
+\fBmonocle\fR
+desktop layout\&.
+.RE
 .PP
-config [\-m \fIMONITOR_SEL\fR|\-d \fIDESKTOP_SEL\fR|\-w \fIWINDOW_SEL\fR] <key> [<value>]
+\fIgapless_monocle\fR
 .RS 4
-Get or set the value of <key>\&.
+Remove gaps of tiled windows for the
+\fBmonocle\fR
+desktop layout\&.
 .RE
+.PP
+\fItop_monocle_padding\fR, \fIright_monocle_padding\fR, \fIbottom_monocle_padding\fR, \fIleft_monocle_padding\fR
+.RS 4
+Padding space added at the sides of the screen for the
+\fBmonocle\fR
+desktop layout\&.
 .RE
-.SS "Quit"
-.sp
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBGeneral Syntax\fR
+.PP
+\fIsingle_monocle\fR
 .RS 4
+Set the desktop layout to
+\fBmonocle\fR
+if there\(cqs only one tiled window in the tree\&.
+.RE
 .PP
-quit [<status>]
+\fIpointer_motion_interval\fR
 .RS 4
-Quit with an optional exit status\&.
+The minimum interval, in milliseconds, between two motion notify events\&.
 .RE
+.PP
+\fIpointer_modifier\fR
+.RS 4
+Keyboard modifier used for moving or resizing windows\&. Accept the following values:
+\fBshift\fR,
+\fBcontrol\fR,
+\fBlock\fR,
+\fBmod1\fR,
+\fBmod2\fR,
+\fBmod3\fR,
+\fBmod4\fR,
+\fBmod5\fR\&.
 .RE
-.SH "EXIT CODES"
-.sp
-If the server can\(cqt handle a message, \fBbspc\fR will return with one of the following exit codes:
 .PP
-1
+\fIpointer_action1\fR, \fIpointer_action2\fR, \fIpointer_action3\fR
 .RS 4
-Failure\&.
+Action performed when pressing
+\fIpointer_modifier\fR
++
+\fIbutton<n>\fR\&. Accept the following values:
+\fBmove\fR,
+\fBresize_side\fR,
+\fBresize_corner\fR,
+\fBfocus\fR,
+\fBnone\fR\&.
 .RE
 .PP
-2
+\fIclick_to_focus\fR
 .RS 4
-Syntax error\&.
+Button used for focusing a window (or a monitor)\&. The possible values are:
+\fBbutton1\fR,
+\fBbutton2\fR,
+\fBbutton3\fR,
+\fBany\fR,
+\fBnone\fR\&. Defaults to
+\fBbutton1\fR\&.
 .RE
 .PP
-3
+\fIswallow_first_click\fR
 .RS 4
-Unknown command\&.
+Don\(cqt replay the click that makes a window focused if
+\fIclick_to_focus\fR
+isn\(cqt
+\fBnone\fR\&.
 .RE
-.SH "SETTINGS"
-.sp
-Colors are either \fI#RRGGBB\fR or X color names, booleans are \fItrue\fR, \fIon\fR, \fIfalse\fR or \fIoff\fR\&.
-.sp
-All the boolean settings are \fIfalse\fR by default unless stated otherwise\&.
-.SS "Global Settings"
 .PP
-\fIfocused_border_color\fR
+\fIfocus_follows_pointer\fR
 .RS 4
-Color of the border of a focused window of a focused monitor\&.
+Focus the window under the pointer\&.
 .RE
 .PP
-\fIactive_border_color\fR
+\fIpointer_follows_focus\fR
 .RS 4
-Color of the border of a focused window of an unfocused monitor\&.
+When focusing a window, put the pointer at its center\&.
 .RE
 .PP
-\fInormal_border_color\fR
+\fIpointer_follows_monitor\fR
 .RS 4
-Color of the border of an unfocused window\&.
+When focusing a monitor, put the pointer at its center\&.
 .RE
 .PP
-\fIpresel_border_color\fR
+\fImapping_events_count\fR
 .RS 4
-Color of the
-\fBpresel\fR
-message feedback\&.
+Handle the next
+\fBmapping_events_count\fR
+mapping notify events\&. A negative value implies that every event needs to be handled\&.
 .RE
 .PP
-\fIfocused_locked_border_color\fR
+\fIignore_ewmh_focus\fR
 .RS 4
-Color of the border of a focused locked window of a focused monitor\&.
+Ignore EWMH focus requests coming from applications\&.
 .RE
 .PP
-\fIactive_locked_border_color\fR
+\fIignore_ewmh_fullscreen\fR
 .RS 4
-Color of the border of a focused locked window of an unfocused monitor\&.
+Block the fullscreen state transitions that originate from an EWMH request\&. The possible values are:
+\fBnone\fR,
+\fBall\fR, or a comma separated list of the following values:
+\fBenter\fR,
+\fBexit\fR\&.
 .RE
 .PP
-\fInormal_locked_border_color\fR
+\fIcenter_pseudo_tiled\fR
 .RS 4
-Color of the border of an unfocused locked window\&.
+Center pseudo tiled windows into their tiling rectangles\&. Defaults to
+\fItrue\fR\&.
 .RE
 .PP
-\fIfocused_sticky_border_color\fR
+\fIhonor_size_hints\fR
 .RS 4
-Color of the border of a focused sticky window of a focused monitor\&.
+Apply ICCCM window size hints\&.
 .RE
 .PP
-\fIactive_sticky_border_color\fR
+\fIremove_disabled_monitors\fR
 .RS 4
-Color of the border of a focused sticky window of an unfocused monitor\&.
+Consider disabled monitors as disconnected\&.
 .RE
 .PP
-\fInormal_sticky_border_color\fR
+\fIremove_unplugged_monitors\fR
 .RS 4
-Color of the border of an unfocused sticky window\&.
+Remove unplugged monitors\&.
 .RE
 .PP
-\fIfocused_private_border_color\fR
+\fImerge_overlapping_monitors\fR
 .RS 4
-Color of the border of a focused private window of a focused monitor\&.
+Merge overlapping monitors (the bigger remains)\&.
 .RE
+.SS "Monitor and Desktop Settings"
 .PP
-\fIactive_private_border_color\fR
+\fItop_padding\fR, \fIright_padding\fR, \fIbottom_padding\fR, \fIleft_padding\fR
 .RS 4
-Color of the border of a focused private window of an unfocused monitor\&.
+Padding space added at the sides of the monitor or desktop\&.
 .RE
+.SS "Desktop Settings"
 .PP
-\fInormal_private_border_color\fR
+\fIwindow_gap\fR
 .RS 4
-Color of the border of an unfocused private window\&.
+Size of the gap that separates windows\&.
 .RE
+.SS "Node Settings"
 .PP
-\fIurgent_border_color\fR
+\fIborder_width\fR
 .RS 4
-Color of the border of an urgent window\&.
+Window border width\&.
 .RE
+.SH "POINTER BINDINGS"
 .PP
-\fIsplit_ratio\fR
+\fIclick_to_focus\fR
 .RS 4
-Default split ratio\&.
+Focus the window (or the monitor) under the pointer if the value isn\(cqt
+\fBnone\fR\&.
 .RE
 .PP
-\fIstatus_prefix\fR
+\fIpointer_modifier\fR + \fIbutton1\fR
 .RS 4
-Prefix prepended to each of the status lines\&.
+Move the window under the pointer\&.
 .RE
 .PP
-\fIexternal_rules_command\fR
+\fIpointer_modifier\fR + \fIbutton2\fR
 .RS 4
-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:
-\fBkey1=value1 key2=value2 \&...\fR
-(the valid key/value pairs are given in the description of the
-\fIrule\fR
-command)\&.
+Resize the window under the pointer by dragging the nearest side\&.
 .RE
 .PP
-\fIinitial_polarity\fR
+\fIpointer_modifier\fR + \fIbutton3\fR
 .RS 4
-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:
-\fBfirst_child\fR,
-\fBsecond_child\fR\&.
+Resize the window under the pointer by dragging the nearest corner\&.
 .RE
+.sp
+The behavior of \fIpointer_modifier\fR + \fIbutton<n>\fR can be modified through the \fIpointer_action<n>\fR setting\&.
+.SH "EVENTS"
 .PP
-\fIhistory_aware_focus\fR
+\fIreport\fR
 .RS 4
-Give priority to the focus history when focusing nodes\&.
+See the next section for the description of the format\&.
 .RE
 .PP
-\fIfocus_by_distance\fR
+\fImonitor_add <monitor_id> <monitor_name> <monitor_geometry>\fR
 .RS 4
-Base focusing on distances between windows\&.
+A monitor is added\&.
 .RE
 .PP
-\fIborderless_monocle\fR
+\fImonitor_rename <monitor_id> <old_name> <new_name>\fR
 .RS 4
-Remove borders for tiled windows in monocle mode\&.
+A monitor is renamed\&.
 .RE
 .PP
-\fIgapless_monocle\fR
+\fImonitor_remove <monitor_id>\fR
 .RS 4
-Remove gaps for tiled windows in monocle mode\&.
+A monitor is removed\&.
 .RE
 .PP
-\fIleaf_monocle\fR
+\fImonitor_swap <src_monitor_id> <dst_monitor_id>\fR
 .RS 4
-Use monocle layout if there is a single node\&.
+A monitor is swapped\&.
 .RE
 .PP
-\fIfocus_follows_pointer\fR
+\fImonitor_focus <monitor_id>\fR
 .RS 4
-Focus the window under the pointer\&.
+A monitor is focused\&.
 .RE
 .PP
-\fIpointer_follows_focus\fR
+\fImonitor_geometry <monitor_id> <monitor_geometry>\fR
 .RS 4
-When focusing a window, put the pointer at its center\&.
+The geometry of a monitor changed\&.
 .RE
 .PP
-\fIpointer_follows_monitor\fR
+\fIdesktop_add <monitor_id> <desktop_id> <desktop_name>\fR
 .RS 4
-When focusing a monitor, put the pointer at its center\&.
+A desktop is added\&.
 .RE
 .PP
-\fIauto_alternate\fR
+\fIdesktop_rename <monitor_id> <desktop_id> <old_name> <new_name>\fR
 .RS 4
-Interpret two consecutive identical
-\fBuse\fR
-messages as an
-\fBalternate\fR
-message\&.
+A desktop is renamed\&.
 .RE
 .PP
-\fIauto_cancel\fR
+\fIdesktop_remove <monitor_id> <desktop_id>\fR
 .RS 4
-Interpret two consecutive identical
-\fBpresel\fR
-messages as a
-\fBcancel\fR
-message\&.
+A desktop is removed\&.
 .RE
 .PP
-\fIapply_floating_atom\fR
+\fIdesktop_swap <src_monitor_id> <src_desktop_id> <dst_monitor_id> <dst_desktop_id>\fR
 .RS 4
-Set the value of the
-\fI_BSPWM_FLOATING_WINDOW\fR
-atom of each window according to its floating state\&.
+A desktop is swapped\&.
 .RE
 .PP
-\fIignore_ewmh_focus\fR
+\fIdesktop_transfer <src_monitor_id> <src_desktop_id> <dst_monitor_id>\fR
 .RS 4
-Ignore EWMH focus requests coming from applications\&.
+A desktop is transferred\&.
 .RE
 .PP
-\fIcenter_pseudo_tiled\fR
+\fIdesktop_focus <monitor_id> <desktop_id>\fR
 .RS 4
-Center pseudo tiled windows into their tiling rectangles\&. Defaults to
-\fItrue\fR\&.
+A desktop is focused\&.
 .RE
 .PP
-\fIremove_disabled_monitors\fR
+\fIdesktop_activate <monitor_id> <desktop_id>\fR
 .RS 4
-Consider disabled monitors as disconnected\&.
+A desktop is activated\&.
 .RE
 .PP
-\fIremove_unplugged_monitors\fR
+\fIdesktop_layout <monitor_id> <desktop_id> tiled|monocle\fR
 .RS 4
-Remove unplugged monitors\&.
+The layout of a desktop changed\&.
 .RE
 .PP
-\fImerge_overlapping_monitors\fR
+\fInode_add <monitor_id> <desktop_id> <ip_id> <node_id>\fR
 .RS 4
-Merge overlapping monitors (the bigger remains)\&.
+A node is added\&.
 .RE
-.SS "Monitor and Desktop Settings"
 .PP
-\fItop_padding\fR, \fIright_padding\fR, \fIbottom_padding\fR, \fIleft_padding\fR
+\fInode_remove <monitor_id> <desktop_id> <node_id>\fR
 .RS 4
-Padding space added at the sides of the monitor or desktop\&.
+A node is removed\&.
 .RE
-.SS "Default, Desktop Default and Window Settings"
 .PP
-\fIborder_width\fR
+\fInode_swap <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>\fR
 .RS 4
-Window border width\&.
+A node is swapped\&.
 .RE
-.SS "Default and Desktop Settings"
 .PP
-\fIwindow_gap\fR
+\fInode_transfer <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>\fR
 .RS 4
-Size of the gap that separates windows\&.
+A node is transferred\&.
+.RE
+.PP
+\fInode_focus <monitor_id> <desktop_id> <node_id>\fR
+.RS 4
+A node is focused\&.
+.RE
+.PP
+\fInode_activate <monitor_id> <desktop_id> <node_id>\fR
+.RS 4
+A node is activated\&.
+.RE
+.PP
+\fInode_presel <monitor_id> <desktop_id> <node_id> (dir DIR|ratio RATIO|cancel)\fR
+.RS 4
+A node is preselected\&.
 .RE
-.SH "STATUS FORMAT"
+.PP
+\fInode_stack <node_id_1> below|above <node_id_2>\fR
+.RS 4
+A node is stacked below or above another node\&.
+.RE
+.PP
+\fInode_geometry <monitor_id> <desktop_id> <node_id> <node_geometry>\fR
+.RS 4
+The geometry of a window changed\&.
+.RE
+.PP
+\fInode_state <monitor_id> <desktop_id> <node_id> tiled|pseudo_tiled|floating|fullscreen on|off\fR
+.RS 4
+The state of a window changed\&.
+.RE
+.PP
+\fInode_flag <monitor_id> <desktop_id> <node_id> hidden|sticky|private|locked|marked|urgent on|off\fR
+.RS 4
+One of the flags of a node changed\&.
+.RE
+.PP
+\fInode_layer <monitor_id> <desktop_id> <node_id> below|normal|above\fR
+.RS 4
+The layer of a window changed\&.
+.RE
+.PP
+\fIpointer_action <monitor_id> <desktop_id> <node_id> move|resize_corner|resize_side begin|end\fR
+.RS 4
+A pointer action occured\&.
+.RE
+.sp
+Please note that \fBbspwm\fR initializes monitors before it reads messages on its socket, therefore the initial monitor events can\(cqt be received\&.
+.SH "REPORT FORMAT"
 .sp
-Status information is composed of items separated by colons\&.
+Each report event message is composed of items separated by colons\&.
 .sp
 Each item has the form \fI<type><value>\fR where \fI<type>\fR is the first character of the item\&.
 .PP
@@ -1231,6 +1560,16 @@ Urgent unfocused desktop\&.
 .RS 4
 Layout of the focused desktop of a monitor\&.
 .RE
+.PP
+\fIT(T|P|F|=|@)\fR
+.RS 4
+State of the focused node of a focused desktop\&.
+.RE
+.PP
+\fIG(S?P?L?)\fR
+.RS 4
+Active flags of the focused node of a focused desktop\&.
+.RE
 .SH "ENVIRONMENT VARIABLES"
 .PP
 \fIBSPWM_SOCKET\fR
@@ -1241,77 +1580,6 @@ and
 \fBbspwm\fR\&. If it isn\(cqt defined, then the following path is used:
 \fI/tmp/bspwm<host_name>_<display_number>_<screen_number>\-socket\fR\&.
 .RE
-.SH "PANELS"
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Any EWMH compliant panel (e\&.g\&.:
-\fItint2\fR,
-\fIbmpanel2\fR, etc\&.)\&.
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-A custom panel (have a look at the files in
-\fIexamples/panel\fR)\&.
-.RE
-.SH "KEY FEATURES"
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Configured and controlled through messages\&.
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Multiple monitors support\&.
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-EWMH support\&.
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Hybrid tiling\&.
-.RE
 .SH "CONTRIBUTORS"
 .sp
 .RS 4
@@ -1349,6 +1617,3 @@ Ivan Kanakarakis <ivan\&.kanak at gmail\&.com>
 .SH "AUTHOR"
 .sp
 Bastien Dejean <nihilhill at gmail\&.com>
-.SH "MAILING LIST"
-.sp
-bspwm at librelist\&.com