.\" Title: bspwm
.\" Author: [see the "Author" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 07/05/2013
+.\" Date: 05/09/2016
.\" Manual: Bspwm Manual
-.\" Source: Bspwm 0.7
+.\" Source: Bspwm 0.9.1-54-gcdc20bb
.\" Language: English
.\"
-.TH "BSPWM" "1" "07/05/2013" "Bspwm 0\&.7" "Bspwm Manual"
+.TH "BSPWM" "1" "05/09/2016" "Bspwm 0\&.9\&.1\-54\-gcdc20bb" "Bspwm Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-bspwm \- Tiling window manager based on binary space partitioning
+bspwm \- Binary space partitioning window manager
.SH "SYNOPSIS"
.sp
-\fBbspwm\fR [\fB\-h\fR|\fB\-v\fR|\fB\-s\fR \fIPANEL_FIFO\fR|\fB\-p\fR \fIPANEL_PREFIX\fR]
+\fBbspwm\fR [\fB\-h\fR|\fB\-v\fR|\fB\-c\fR \fICONFIG_PATH\fR]
.sp
-\fBbspc\fR \fIMESSAGE\fR [\fIARGUMENTS\fR] [\fIOPTIONS\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\&.
.sp
It is controlled and configured via \fBbspc\fR\&.
-.SH "CONFIGURATION"
+.SH "OPTIONS"
+.PP
+\fB\-h\fR
+.RS 4
+Print the synopsis and exit\&.
+.RE
+.PP
+\fB\-v\fR
+.RS 4
+Print the version and exit\&.
+.RE
+.PP
+\fB\-c\fR \fICONFIG_PATH\fR
+.RS 4
+Use the given configuration file\&.
+.RE
+.SH "COMMON DEFINITIONS"
.sp
-\fBbspwm\fR have only two sources of informations: the X events it receives and the messages it reads on a dedicated socket\&.
+.if n \{\
+.RS 4
+.\}
+.nf
+DIR := north | west | south | east
+CYCLE_DIR := next | prev
+.fi
+.if n \{\
+.RE
+.\}
+.SH "SELECTORS"
.sp
-Its configuration file is \fI$XDG_CONFIG_HOME/bspwm/autostart\fR\&.
+Selectors are used to select a target node, desktop, or monitor\&. A selector can either describe the target relatively or name it globally\&.
.sp
-Keyboard and pointer bindings are defined with sxhkd\&.
+Selectors consist of a descriptor and any number of non\-conflicting modifiers as follows:
.sp
-Example configuration files can be found in the \fBexamples\fR directory\&.
-.SH "SPLITTING MODES"
+.if n \{\
+.RS 4
+.\}
+.nf
+DESCRIPTOR(\&.MODIFIER)*
+.fi
+.if n \{\
+.RE
+.\}
.sp
-There is only two splitting modes: \fIautomatic\fR and \fImanual\fR\&.
+An exclamation mark can be prepended to certain modifiers in order to reverse their meaning\&.
+.SS "Node"
.sp
-The default mode is \fIautomatic\fR\&. The \fImanual\fR mode is entered by sending a \fBpresel\fR message\&.
+Select a node\&.
.sp
-Example: insertion of a new node (number 4) into the given tree in \fIautomatic\fR mode:
+.if n \{\
+.RS 4
+.\}
+.nf
+NODE_SEL := (DIR|CYCLE_DIR|PATH|last|older|newer|focused|pointed|biggest|<node_id>)[\&.[!]focused][\&.[!]automatic][\&.[!]local][\&.[!]leaf][\&.[!]window][\&.[!]STATE][\&.[!]FLAG][\&.[!]LAYER][\&.[!]same_class]
+
+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
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBDescriptors\fR
+.RS 4
+.PP
+\fIDIR\fR
+.RS 4
+Selects the window in the given (spacial) direction relative to the active node\&.
+.RE
+.PP
+\fICYCLE_DIR\fR
+.RS 4
+Selects the window in the given (cyclic) direction\&.
+.RE
+.PP
+\fIPATH\fR
+.RS 4
+Selects the node at the given path\&.
+.RE
+.PP
+last
+.RS 4
+Selects the previously focused node\&.
+.RE
+.PP
+older
+.RS 4
+Selects the node older than the focused node in the history\&.
+.RE
+.PP
+newer
+.RS 4
+Selects the node newer than the focused 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 on the current desktop\&.
+.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 focused 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
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBModifiers\fR
+.RS 4
+.PP
+[!]focused
+.RS 4
+Only consider focused or unfocused nodes\&.
+.RE
+.PP
+[!]automatic
+.RS 4
+Only consider nodes in automatic or manual insertion mode\&.
+.RE
+.PP
+[!]local
+.RS 4
+Only consider nodes in or not in the current desktop\&.
+.RE
+.PP
+[!]leaf
+.RS 4
+Only consider leaves or internal nodes\&.
+.RE
+.PP
+[!]window
+.RS 4
+Only consider nodes that hold or don\(cqt hold a window\&.
+.RE
+.PP
+[!](tiled|pseudo_tiled|floating|fullscreen)
+.RS 4
+Only consider windows in or not in the given state\&.
+.RE
+.PP
+[!]same_class
+.RS 4
+Only consider windows that have or don\(cqt have the same class as the current window\&.
+.RE
+.PP
+[!](hidden|sticky|private|locked|urgent)
+.RS 4
+Only consider windows that have or don\(cqt have the given flag set\&.
+.RE
+.PP
+[!](below|normal|above)
+.RS 4
+Only consider windows in or not in the given layer\&.
+.RE
+.RE
+.SS "Desktop"
+.sp
+Select a desktop\&.
.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 |
- | | | | | | |
- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+DESKTOP_SEL := (CYCLE_DIR|last|older|newer|[MONITOR_SEL:](focused|^<n>)|<desktop_id>|<desktop_name>)[\&.[!]occupied][\&.[!]focused][\&.[!]urgent][\&.[!]local]
.fi
.if n \{\
.RE
.\}
.sp
-Same departure, but the mode is \fImanual\fR, and a \fBpresel\fR \fIup\fR message was sent beforehand:
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBDescriptors\fR
+.RS 4
+.PP
+\fICYCLE_DIR\fR
+.RS 4
+Selects the desktop in the given direction relative to the active desktop\&.
+.RE
+.PP
+last
+.RS 4
+Selects the previously focused desktop\&.
+.RE
+.PP
+older
+.RS 4
+Selects the desktop older than the focused desktop in the history\&.
+.RE
+.PP
+newer
+.RS 4
+Selects the desktop newer than the focused desktop in the history\&.
+.RE
+.PP
+focused
+.RS 4
+Selects the currently focused desktop\&.
+.RE
+.PP
+^<n>
+.RS 4
+Selects the nth desktop\&.
+.RE
+.PP
+<desktop_id>
+.RS 4
+Selects the desktop with the given ID\&.
+.RE
+.PP
+<desktop_name>
+.RS 4
+Selects the desktop with the given name\&.
+.RE
+.RE
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBModifiers\fR
+.RS 4
+.PP
+[!]occupied
+.RS 4
+Only consider occupied or free desktops\&.
+.RE
+.PP
+[!]focused
+.RS 4
+Only consider focused or unfocused desktops\&.
+.RE
+.PP
+[!]urgent
+.RS 4
+Only consider urgent or non urgent desktops\&.
+.RE
+.PP
+[!]local
+.RS 4
+Only consider inside or outside of the current monitor\&.
+.RE
+.RE
+.SS "Monitor"
+.sp
+Select a monitor\&.
.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 |
-| | | | | |
-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
+MONITOR_SEL := (DIR|CYCLE_DIR|last|older|newer|focused|primary|^<n>|<monitor_id>|<monitor_name>)[\&.[!]occupied][\&.[!]focused]
.fi
.if n \{\
.RE
.\}
-.SH "CONTAINERS"
.sp
-Each monitor contains at least one desktop\&.
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBDescriptors\fR
+.RS 4
+.PP
+\fIDIR\fR
+.RS 4
+Selects the monitor in the given (spacial) direction relative to the active monitor\&.
+.RE
+.PP
+\fICYCLE_DIR\fR
+.RS 4
+Selects the monitor in the given (cyclic) direction relative to the active monitor\&.
+.RE
+.PP
+last
+.RS 4
+Selects the previously focused monitor\&.
+.RE
+.PP
+older
+.RS 4
+Selects the monitor older than the focused monitor in the history\&.
+.RE
+.PP
+newer
+.RS 4
+Selects the monitor newer than the focused monitor in the history\&.
+.RE
+.PP
+focused
+.RS 4
+Selects the currently focused monitor\&.
+.RE
+.PP
+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 with the given name\&.
+.RE
+.RE
.sp
-Each desktop contains at most one tree\&.
-.SH "MESSAGES"
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBModifiers\fR
+.RS 4
.PP
-\fBget\fR \fISETTING\fR
+[!]occupied
.RS 4
-Return the value of the given setting\&.
+Only consider monitors where the focused desktop is occupied or free\&.
+.RE
+.PP
+[!]focused
+.RS 4
+Only consider focused or unfocused monitors\&.
+.RE
.RE
+.SH "WINDOW STATES"
.PP
-\fBset\fR \fISETTING\fR \fIVALUE\fR
+tiled
.RS 4
-Set the value of the given setting\&.
+Its size and position are determined by the splitting type and ratio of each node of its path in the window tree\&.
.RE
.PP
-\fBlist\fR [\fIDESKTOP_NAME\fR]
+pseudo_tiled
.RS 4
-Output the internal representation of the window tree\&.
+Has an unrestricted size while being centered in its tiling space\&.
.RE
.PP
-\fBlist_desktops\fR [\fB\-\-quiet\fR]
+floating
.RS 4
-Perform a dump of each desktop for the current monitor\&.
+Can be moved/resized freely\&. Although it doesn\(cqt occupy any tiling space, it is still part of the window tree\&.
.RE
.PP
-\fBlist_monitors\fR [\fB\-\-quiet\fR]
+fullscreen
.RS 4
-Perform a dump of each monitor\&.
+Fills its monitor rectangle and has no borders\&. It is send in the ABOVE layer by default\&.
.RE
+.SH "NODE FLAGS"
.PP
-\fBlist_history\fR
+hidden
.RS 4
-Return the node focus history of each desktop\&.
+Is hidden and doesn\(cqt occupy any tiling space\&.
.RE
.PP
-\fBlist_windows\fR
+sticky
.RS 4
-Return the list of managed windows (i\&.e\&. their identifiers)\&.
+Stays in the focused desktop of its monitor\&.
.RE
.PP
-\fBlist_rules\fR
+private
.RS 4
-Return the list of rules\&.
+Tries to keep the same tiling position/size\&.
.RE
.PP
-\fBpresel\fR \fIleft\fR|\fIright\fR|\fIup\fR|\fIdown\fR [\fISPLIT_RATIO\fR]
+locked
.RS 4
-Switch to manual mode and select the splitting direction\&.
+Ignores the
+\fBnode \-\-close\fR
+message\&.
.RE
.PP
-\fBcancel\fR [\fB\-\-all\fR]
+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 < fullscreen < floating\&.
+.SH "DOMAINS"
+.SS "Node"
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBGeneral Syntax\fR
.RS 4
-Switch to automatic mode\&.
+.sp
+node [\fINODE_SEL\fR] \fICOMMANDS\fR
+.sp
+If \fINODE_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
-\fBratio\fR \fIVALUE\fR
+\fB\-f\fR, \fB\-\-focus\fR [\fINODE_SEL\fR]
.RS 4
-Set the splitting ratio of the focused window\&.
+Focus the selected or given node\&.
.RE
.PP
-\fBpad\fR \fIMONITOR_NAME\fR [\fITOP_PADDING\fR [\fIRIGHT_PADDING\fR [\fIBOTTOM_PADDING\fR [\fILEFT_PADDING\fR]]]]
+\fB\-a\fR, \fB\-\-activate\fR [\fINODE_SEL\fR]
.RS 4
-Set the padding of the given monitor\&.
+Activate the selected or given node\&.
.RE
.PP
-\fBfocus\fR \fIleft\fR|\fIright\fR|\fIup\fR|\fIdown\fR
+\fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR
.RS 4
-Focus the neighbor window situated in the given direction\&.
+Send the selected node to the given desktop\&.
.RE
.PP
-\fBshift\fR \fIleft\fR|\fIright\fR|\fIup\fR|\fIdown\fR
+\fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR
.RS 4
-Exchange the current window with the given neighbor\&.
+Send the selected node to the given monitor\&.
.RE
.PP
-\fBswap\fR [\fB\-\-keep\-focus\fR]
+\fB\-n\fR, \fB\-\-to\-node\fR \fINODE_SEL\fR
.RS 4
-Swap the focused window with the last focused window\&.
+Transplant the selected node to the given node\&.
.RE
.PP
-\fBpush\fR \fIleft\fR|\fIright\fR|\fIup\fR|\fIdown\fR
+\fB\-s\fR, \fB\-\-swap\fR \fINODE_SEL\fR
.RS 4
-Push the fence located in the given direction\&.
+Swap the selected node with the given node\&.
.RE
.PP
-\fBpull\fR \fIleft\fR|\fIright\fR|\fIup\fR|\fIdown\fR
+\fB\-p\fR, \fB\-\-presel\-dir\fR [~]\fIDIR\fR|cancel
.RS 4
-Pull the fence located in the given direction\&.
+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\&.
.RE
.PP
-\fBfence_ratio\fR \fIleft\fR|\fIright\fR|\fIup\fR|\fIdown\fR \fIRATIO\fR
+\fB\-o\fR, \fB\-\-presel\-ratio\fR \fIRATIO\fR
.RS 4
-Set the splitting ratio of the fence located in the given direction\&.
+Set the splitting ratio of the preselection area\&.
.RE
.PP
-\fBcycle\fR \fInext\fR|\fIprev\fR [\fB\-\-skip\-floating\fR|\fB\-\-skip\-tiled\fR|\fB\-\-skip\-class\-equal\fR|\fB\-\-skip\-class\-differ\fR]
+\fB\-v\fR, \fB\-\-move\fR \fIdx\fR \fIdy\fR
.RS 4
-Focus the next or previous window matching the given constraints\&.
+Move the selected window by
+\fIdx\fR
+pixels horizontally and
+\fIdy\fR
+pixels vertically\&.
.RE
.PP
-\fBnearest\fR \fIolder\fR|\fInewer\fR [\fB\-\-skip\-floating\fR|\fB\-\-skip\-tiled\fR|\fB\-\-skip\-class\-equal\fR|\fB\-\-skip\-class\-differ\fR]
+\fB\-z\fR, \fB\-\-resize\fR top|left|bottom|right|top_left|top_right|bottom_right|bottom_left \fIdx\fR \fIdy\fR
.RS 4
-Focus the nearest window matching the given constraints\&.
+Resize the selected window by moving the given handle by
+\fIdx\fR
+pixels horizontally and
+\fIdy\fR
+pixels vertically\&.
.RE
.PP
-\fBbiggest\fR
+\fB\-r\fR, \fB\-\-ratio\fR \fIRATIO\fR|(+|\-)\fIPIXELS\fR
.RS 4
-Return the ID of the biggest tiled window\&.
+Set the splitting ratio of the selected node (0 <
+\fIRATIO\fR
+< 1)\&.
.RE
.PP
-\fBcirculate\fR \fIforward\fR|\fIbackward\fR
+\fB\-R\fR, \fB\-\-rotate\fR \fI90|270|180\fR
.RS 4
-Circulate the leaves in the given direction\&.
+Rotate the tree rooted at the selected node\&.
.RE
.PP
-\fBgrab_pointer\fR \fIfocus\fR|\fImove\fR|\fIresize_side\fR|\fIresize_corner\fR
+\fB\-F\fR, \fB\-\-flip\fR \fIhorizontal|vertical\fR
.RS 4
-Begin the specified pointer action\&.
+Flip the the tree rooted at selected node\&.
.RE
.PP
-\fBtrack_pointer\fR \fIROOT_X\fR \fIROOT_Y\fR
+\fB\-E\fR, \fB\-\-equalize\fR
.RS 4
-Pass the pointer root coordinates for the current pointer action\&.
+Reset the split ratios of the tree rooted at the selected node to their default value\&.
.RE
.PP
-\fBtoggle_fullscreen\fR
+\fB\-B\fR, \fB\-\-balance\fR
.RS 4
-Toggle the fullscreen state of the current window\&.
+Adjust the split ratios of the tree rooted at the selected node so that all windows occupy the same area\&.
.RE
.PP
-\fBtoggle_floating\fR
+\fB\-C\fR, \fB\-\-circulate\fR forward|backward
.RS 4
-Toggle the floating state of the current window\&.
+Circulate the windows of the tree rooted at the selected node\&.
.RE
.PP
-\fBtoggle_locked\fR
+\fB\-t\fR, \fB\-\-state\fR [~](tiled|pseudo_tiled|floating|fullscreen)
.RS 4
-Toggle the locked state of the current window (locked windows will not respond to the
-\fBclose\fR
-message)\&.
+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
-\fBtoggle_visibility\fR
+\fB\-g\fR, \fB\-\-flag\fR hidden|sticky|private|locked[=on|off]
.RS 4
-Toggle the visibility of all the managed windows\&.
+Set or toggle the given flag for the selected node\&.
.RE
.PP
-\fBclose\fR
+\fB\-l\fR, \fB\-\-layer\fR below|normal|above
.RS 4
-Close the focused window\&.
+Set the stacking layer of the selected window\&.
.RE
.PP
-\fBkill\fR
+\fB\-i\fR, \fB\-\-insert\-receptacle\fR
.RS 4
-Kill the focused window\&.
+Insert a receptacle node at the selected node\&.
.RE
.PP
-\fBsend_to\fR \fIDESKTOP_NAME\fR [\fB\-\-follow\fR]
+\fB\-c\fR, \fB\-\-close\fR
.RS 4
-Send the focused window to the given desktop\&.
+Close the windows rooted at the selected node\&.
.RE
.PP
-\fBdrop_to\fR \fInext\fR|\fIprev\fR [\fB\-\-follow\fR]
+\fB\-k\fR, \fB\-\-kill\fR
.RS 4
-Send the focused window to the next or previous desktop\&.
+Kill the windows rooted at the selected node\&.
+.RE
+.RE
+.SS "Desktop"
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBGeneral Syntax\fR
+.RS 4
+.sp
+desktop [\fIDESKTOP_SEL\fR] \fICOMMANDS\fR
+.sp
+If \fIDESKTOP_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
-\fBsend_to_monitor\fR \fIMONITOR_NAME\fR [\fB\-\-follow\fR]
+\fB\-f\fR, \fB\-\-focus\fR [\fIDESKTOP_SEL\fR]
.RS 4
-Send the focused window to the given monitor\&.
+Focus the selected or given desktop\&.
.RE
.PP
-\fBdrop_to_monitor\fR \fInext\fR|\fIprev\fR [\fB\-\-follow\fR]
+\fB\-a\fR, \fB\-\-activate\fR [\fIDESKTOP_SEL\fR]
.RS 4
-Send the focused window to the next or previous monitor\&.
+Activate the selected or given desktop\&.
.RE
.PP
-\fBuse\fR \fIDESKTOP_NAME\fR
+\fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR
.RS 4
-Select the given desktop\&.
+Send the selected desktop to the given monitor\&.
.RE
.PP
-\fBuse_monitor\fR \fIMONITOR_NAME\fR
+\fB\-l\fR, \fB\-\-layout\fR \fICYCLE_DIR\fR|monocle|tiled
.RS 4
-Select the given monitor\&.
+Set or cycle the layout of the selected desktop\&.
.RE
.PP
-\fBfocus_monitor\fR \fIleft\fR|\fIright\fR|\fIup\fR|\fIdown\fR
+\fB\-n\fR, \fB\-\-rename\fR <new_name>
.RS 4
-Focus the nearest monitor in the given direction\&.
+Rename the selected desktop\&.
.RE
.PP
-\fBalternate\fR
+\fB\-s\fR, \fB\-\-swap\fR \fIDESKTOP_SEL\fR
.RS 4
-Alternate between the current and the last focused window\&.
+Swap the selected desktop with the given desktop\&.
.RE
.PP
-\fBalternate_desktop\fR
+\fB\-b\fR, \fB\-\-bubble\fR \fICYCLE_DIR\fR
.RS 4
-Alternate between the current and the last focused desktop\&.
+Bubble the selected desktop in the given direction\&.
.RE
.PP
-\fBalternate_monitor\fR
+\fB\-r\fR, \fB\-\-remove\fR
.RS 4
-Alternate between the current and the last focused monitor\&.
+Remove the selected desktop\&.
+.RE
.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
+.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
-\fBadd\fR \fIDESKTOP_NAME\fR \&...
+\fB\-f\fR, \fB\-\-focus\fR [\fIMONITOR_SEL\fR]
.RS 4
-Make new desktops with the given names\&.
+Focus the selected or given monitor\&.
.RE
.PP
-\fBadd_in\fR \fIMONITOR_NAME\fR \fIDESKTOP_NAME\fR \&...
+\fB\-a\fR, \fB\-\-add\-desktops\fR <name>\&...
.RS 4
-Make new desktops with the given names in the given monitor\&.
+Create desktops with the given names in the selected monitor\&.
.RE
.PP
-\fBrename_monitor\fR \fICURRENT_NAME\fR \fINEW_NAME\fR
+\fB\-o\fR, \fB\-\-reorder\-desktops\fR <name>\&...
.RS 4
-Rename the monitor named
-\fICURRENT_NAME\fR
-to
-\fINEW_NAME\fR\&.
+Reorder the desktops of the selected monitor to match the given order\&.
.RE
.PP
-\fBrename\fR \fICURRENT_NAME\fR \fINEW_NAME\fR
+\fB\-d\fR, \fB\-\-reset\-desktops\fR <name>\&...
.RS 4
-Rename the desktop named
-\fICURRENT_NAME\fR
-to
-\fINEW_NAME\fR\&.
+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
-\fBremove_desktop\fR \fIDESKTOP_NAME\fR \&...
+\fB\-g\fR, \fB\-\-rectangle\fR WxH+X+Y
.RS 4
-Remove the given desktops\&.
+Set the rectangle of the selected monitor\&.
.RE
.PP
-\fBsend_desktop_to\fR \fIMONITOR_NAME\fR [\fB\-\-follow\fR]
+\fB\-n\fR, \fB\-\-rename\fR <new_name>
.RS 4
-Send the current desktop to the given monitor\&.
+Rename the selected monitor\&.
.RE
.PP
-\fBcycle_monitor\fR \fInext\fR|\fIprev\fR
+\fB\-s\fR, \fB\-\-swap\fR \fIMONITOR_SEL\fR
.RS 4
-Select the next or previous monitor\&.
+Swap the selected monitor with the given monitor\&.
.RE
.PP
-\fBcycle_desktop\fR \fInext\fR|\fIprev\fR [\fB\-\-skip\-free\fR|\fB\-\-skip\-occupied\fR]
+\fB\-r\fR, \fB\-\-remove\fR
+.RS 4
+Remove the selected monitor\&.
+.RE
+.RE
+.SS "Query"
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBGeneral Syntax\fR
.RS 4
-Select the next or previous desktop\&.
+.sp
+query \fICOMMANDS\fR [\fIOPTIONS\fR]
.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
-\fBlayout\fR \fImonocle\fR|\fItiled\fR [\fIDESKTOP_NAME\fR \&...]
+\fB\-N\fR, \fB\-\-nodes\fR
.RS 4
-Set the layout of the given desktops (current if none given)\&.
+List the IDs of the matching nodes\&.
.RE
.PP
-\fBcycle_layout\fR
+\fB\-D\fR, \fB\-\-desktops\fR
.RS 4
-Cycle the layout of the current desktop\&.
+List the IDs of the matching desktops\&.
.RE
.PP
-\fBrotate\fR \fIclockwise\fR|\fIcounter_clockwise\fR|\fIfull_cycle\fR
+\fB\-M\fR, \fB\-\-monitors\fR
.RS 4
-Rotate the window tree\&.
+List the IDs of the matching monitors\&.
.RE
.PP
-\fBflip\fR \fIhorizontal\fR|\fIvertical\fR
+\fB\-T\fR, \fB\-\-tree\fR
.RS 4
-Flip the window tree\&.
+Print a JSON representation of the matching item\&.
+.RE
.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
-\fBbalance\fR
+\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
-Adjust the split ratios so that all windows occupy the same area\&.
+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
.RE
+.SS "Wm"
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBGeneral Syntax\fR
+.RS 4
+.sp
+wm \fICOMMANDS\fR
+.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
-\fBrule\fR \fIPATTERN\fR [\fIDESKTOP_NAME\fR] [\fIfloating\fR] [\fIfollow\fR]
+\fB\-d\fR, \fB\-\-dump\-state\fR
.RS 4
-Create a new rule (\fIPATTERN\fR
-must match the class or instance name)\&.
+Dump the current world state on standard output\&.
.RE
.PP
-\fBremove_rule\fR \fIUID\fR \&...
+\fB\-l\fR, \fB\-\-load\-state\fR <file_path>
.RS 4
-Remove the rules with the given
-\fIUIDs\fR\&.
+Load a world state from the given file\&.
.RE
.PP
-\fBput_status\fR
+\fB\-a\fR, \fB\-\-add\-monitor\fR <name> WxH+X+Y
.RS 4
-Output the current state to the panel fifo\&.
+Add a monitor for the given name and rectangle\&.
.RE
.PP
-\fBadopt_orphans\fR
+\fB\-o\fR, \fB\-\-adopt\-orphans\fR
.RS 4
Manage all the unmanaged windows remaining from a previous session\&.
.RE
.PP
-\fBrestore_layout\fR \fIFILE_PATH\fR
+\fB\-h\fR, \fB\-\-record\-history\fR on|off
.RS 4
-Restore the layout of each desktop from the content of
-\fIFILE_PATH\fR\&.
+Enable or disable the recording of node focus history\&.
.RE
.PP
-\fBrestore_history\fR \fIFILE_PATH\fR
+\fB\-g\fR, \fB\-\-get\-status\fR
.RS 4
-Restore the history of each desktop from the content of
-\fIFILE_PATH\fR\&.
+Print the current status information\&.
+.RE
.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
+.RS 4
+.sp
+rule \fICOMMANDS\fR
+.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\-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|center|follow|manage|focus|border)=(on|off)]
+.RS 4
+Create a new rule\&.
+.RE
+.PP
+\fB\-r\fR, \fB\-\-remove\fR ^<n>|head|tail|(<class_name>|*)[:(<instance_name>|*)]\&...
+.RS 4
+Remove the given rules\&.
+.RE
+.PP
+\fB\-l\fR, \fB\-\-list\fR
+.RS 4
+List the rules\&.
+.RE
+.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
+.RS 4
+.PP
+config [\-m \fIMONITOR_SEL\fR|\-d \fIDESKTOP_SEL\fR|\-n \fINODE_SEL\fR] <key> [<value>]
+.RS 4
+Get or set the value of <key>\&.
+.RE
+.RE
+.SS "Subscribe"
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBGeneral Syntax\fR
+.RS 4
+.PP
+subscribe (all|report|monitor|desktop|node|\&...)*
+.RS 4
+Continuously print status information\&. See the
+\fBEVENTS\fR
+section for the detailed description of each event\&.
+.RE
+.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
+.RS 4
.PP
-\fBquit\fR [\fIEXIT_STATUS\fR]
+quit [<status>]
.RS 4
-Quit\&.
+Quit with an optional exit status\&.
.RE
+.RE
+.SH "EXIT CODES"
+.sp
+If the server can\(cqt handle a message, \fBbspc\fR will return with a non\-zero exit code\&.
.SH "SETTINGS"
.sp
-Colors are either X color names or \fI#RRGGBB\fR, booleans are \fItrue\fR or \fIfalse\fR\&.
+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\&.
+All the boolean settings are \fIfalse\fR by default unless stated otherwise\&.
+.SS "Global Settings"
.PP
-\fIfocused_border_color\fR
+\fInormal_border_color\fR
.RS 4
-Color of the border of a focused window of a focused monitor\&.
+Color of the border of an unfocused window\&.
.RE
.PP
\fIactive_border_color\fR
Color of the border of a focused window of an unfocused monitor\&.
.RE
.PP
-\fInormal_border_color\fR
+\fIfocused_border_color\fR
.RS 4
-Color of the border of an unfocused window\&.
+Color of the border of a focused window of a focused monitor\&.
.RE
.PP
-\fIpresel_border_color\fR
+\fIpresel_feedback_color\fR
.RS 4
Color of the
-\fBpresel\fR
-message feedback\&.
+\fBnode \-\-presel\-{dir,ratio}\fR
+message feedback area\&.
.RE
.PP
-\fIfocused_locked_border_color\fR
+\fIsplit_ratio\fR
.RS 4
-Color of the border of a focused locked window of a focused monitor\&.
+Default split ratio\&.
.RE
.PP
-\fIactive_locked_border_color\fR
+\fIstatus_prefix\fR
.RS 4
-Color of the border of a focused locked window of an unfocused monitor\&.
+Prefix prepended to each of the status lines\&.
.RE
.PP
-\fInormal_locked_border_color\fR
+\fIexternal_rules_command\fR
.RS 4
-Color of the border of an unfocused locked window\&.
+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)\&.
.RE
.PP
-\fIurgent_border_color\fR
+\fIinitial_polarity\fR
.RS 4
-Color of the border of an urgent window\&.
+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
-\fIborder_width\fR
+\fIborderless_monocle\fR
.RS 4
-Window border width\&.
+Remove borders of tiled windows for the
+\fBmonocle\fR
+desktop layout\&.
.RE
.PP
-\fIwindow_gap\fR
+\fIgapless_monocle\fR
.RS 4
-Value of the gap that separates windows\&.
+Remove gaps of tiled windows for the
+\fBmonocle\fR
+desktop layout\&.
.RE
.PP
-\fIsplit_ratio\fR
+\fIpaddingless_monocle\fR
.RS 4
-Default split ratio\&.
+Remove padding space for the
+\fBmonocle\fR
+desktop layout\&.
.RE
.PP
-\fItop_padding\fR, \fIright_padding\fR, \fIbottom_padding\fR, \fIleft_padding\fR
+\fIsingle_monocle\fR
.RS 4
-Padding space added at the sides of the current monitor\&.
+Set the desktop layout to
+\fBmonocle\fR
+if there\(cqs only one tiled window in the tree\&.
.RE
.PP
-\fIwm_name\fR
+\fIpointer_modifier\fR
.RS 4
-The value that shall be used for the
-\fI_NET_WM_NAME\fR
-property of the root window\&.
+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
.PP
-\fIborderless_monocle\fR
+\fIpointer_action1\fR, \fIpointer_action2\fR, \fIpointer_action3\fR
.RS 4
-Remove borders for tiled windows in monocle mode\&.
+Action performed when pressing
+\fIpointer_modifier\fR
++
+\fIbutton<n>\fR\&. Accept the following values:
+\fBmove\fR,
+\fBresize_side\fR,
+\fBresize_corner\fR,
+\fBfocus\fR\&.
.RE
.PP
-\fIgapless_monocle\fR
+\fIclick_to_focus\fR
.RS 4
-Remove gaps for tiled windows in monocle mode\&.
+Focus a window (or a monitor) by clicking it\&.
.RE
.PP
\fIfocus_follows_pointer\fR
Focus the window under the pointer\&.
.RE
.PP
+\fIpointer_follows_focus\fR
+.RS 4
+When focusing a window, put the pointer at its center\&.
+.RE
+.PP
\fIpointer_follows_monitor\fR
.RS 4
When focusing a monitor, put the pointer at its center\&.
.RE
.PP
-\fImonitor_focus_fallback\fR
+\fIignore_ewmh_focus\fR
.RS 4
-If the focus message fails, try to focus the nearest monitor in the same direction\&.
+Ignore EWMH focus requests coming from applications\&.
.RE
.PP
-\fIadaptative_raise\fR
+\fIcenter_pseudo_tiled\fR
.RS 4
-Prevent floating windows from being raised when they might cover other floating windows\&.
+Center pseudo tiled windows into their tiling rectangles\&. Defaults to
+\fItrue\fR\&.
.RE
.PP
-\fIapply_shadow_property\fR
+\fIhonor_size_hints\fR
.RS 4
-Enable shadows for floating windows via the
-\fI_COMPTON_SHADOW\fR
-property\&.
+Apply ICCCM window size hints\&.
.RE
.PP
-\fIauto_alternate\fR
+\fIremove_disabled_monitors\fR
.RS 4
-Interpret two consecutive identical
-\fBuse\fR
-messages as an
-\fBalternate\fR
-message\&.
+Consider disabled monitors as disconnected\&.
.RE
.PP
-\fIauto_cancel\fR
+\fIremove_unplugged_monitors\fR
.RS 4
-Interpret two consecutive identical
-\fBpresel\fR
-messages as a
-\fBcancel\fR
-message\&.
+Remove unplugged monitors\&.
.RE
.PP
-\fIfocus_by_distance\fR
+\fImerge_overlapping_monitors\fR
.RS 4
-Use window or leaf distance for focus movement\&.
+Merge overlapping monitors (the bigger remains)\&.
.RE
+.SS "Monitor and Desktop Settings"
.PP
-\fIhistory_aware_focus\fR
+\fItop_padding\fR, \fIright_padding\fR, \fIbottom_padding\fR, \fIleft_padding\fR
.RS 4
-Give priority to the focus history when focusing nodes\&.
+Padding space added at the sides of the monitor or desktop\&.
.RE
-.SH "ENVIRONMENT VARIABLES"
+.SS "Desktop Settings"
.PP
-\fIBSPWM_SOCKET\fR
+\fIwindow_gap\fR
.RS 4
-The path of the socket used for the communication between
-\fBbspc\fR
-and
-\fBbspwm\fR\&.
+Size of the gap that separates windows\&.
.RE
-.SH "PANELS"
-.sp
+.SS "Node Settings"
+.PP
+\fIborder_width\fR
.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\&.)\&.
+Window border width\&.
.RE
-.sp
+.SH "POINTER BINDINGS"
+.PP
+\fIbutton1\fR
.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-A custom panel if the
-\fI\-s\fR
-flag is used (have a look at the files in
-\fIexamples/panel\fR)\&.
+Focus the window under the pointer if
+\fIclick_to_focus\fR
+is set\&.
.RE
-.SH "KEY FEATURES"
-.sp
+.PP
+\fIpointer_modifier\fR + \fIbutton1\fR
.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Configured and controlled through messages\&.
+Move the window under the pointer\&.
.RE
-.sp
+.PP
+\fIpointer_modifier\fR + \fIbutton2\fR
.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Multiple monitors support (via
-\fIRandR\fR)\&.
+Resize the window under the pointer by dragging the nearest side\&.
+.RE
+.PP
+\fIpointer_modifier\fR + \fIbutton3\fR
+.RS 4
+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
+\fIreport\fR
.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-EWMH support (\fBtint2\fR
-works)\&.
+See the next section for the description of the format\&.
+.RE
+.PP
+\fImonitor_add <monitor_id> <monitor_name> <monitor_geometry>\fR
+.RS 4
+A monitor is added\&.
+.RE
+.PP
+\fImonitor_rename <monitor_id> <old_name> <new_name>\fR
+.RS 4
+A monitor is renamed\&.
+.RE
+.PP
+\fImonitor_remove <monitor_id>\fR
+.RS 4
+A monitor is removed\&.
+.RE
+.PP
+\fImonitor_swap <src_monitor_id> <dst_monitor_id>\fR
+.RS 4
+A monitor is swapped\&.
+.RE
+.PP
+\fImonitor_focus <monitor_id>\fR
+.RS 4
+A monitor is focused\&.
+.RE
+.PP
+\fImonitor_geometry <monitor_id> <monitor_geometry>\fR
+.RS 4
+The geometry of a monitor changed\&.
+.RE
+.PP
+\fIdesktop_add <monitor_id> <desktop_id> <desktop_name>\fR
+.RS 4
+A desktop is added\&.
+.RE
+.PP
+\fIdesktop_rename <monitor_id> <desktop_id> <old_name> <new_name>\fR
+.RS 4
+A desktop is renamed\&.
+.RE
+.PP
+\fIdesktop_remove <monitor_id> <desktop_id>\fR
+.RS 4
+A desktop is removed\&.
+.RE
+.PP
+\fIdesktop_swap <src_monitor_id> <src_desktop_id> <dst_monitor_id> <dst_desktop_id>\fR
+.RS 4
+A desktop is swapped\&.
+.RE
+.PP
+\fIdesktop_transfer <src_monitor_id> <src_desktop_id> <dst_monitor_id>\fR
+.RS 4
+A desktop is transferred\&.
+.RE
+.PP
+\fIdesktop_focus <monitor_id> <desktop_id>\fR
+.RS 4
+A desktop is focused\&.
+.RE
+.PP
+\fIdesktop_activate <monitor_id> <desktop_id>\fR
+.RS 4
+A desktop is activated\&.
+.RE
+.PP
+\fIdesktop_layout <monitor_id> <desktop_id> tiled|monocle\fR
+.RS 4
+The layout of a desktop changed\&.
+.RE
+.PP
+\fInode_manage <monitor_id> <desktop_id> <node_id> <ip_id>\fR
+.RS 4
+A window is managed\&.
+.RE
+.PP
+\fInode_unmanage <monitor_id> <desktop_id> <node_id>\fR
+.RS 4
+A window is unmanaged\&.
+.RE
+.PP
+\fInode_swap <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>\fR
+.RS 4
+A node is swapped\&.
+.RE
+.PP
+\fInode_transfer <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>\fR
+.RS 4
+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
+.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|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
+.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
+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
+\fIM<monitor_name>\fR
.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Automatic and manual modes\&.
+Focused monitor\&.
+.RE
+.PP
+\fIm<monitor_name>\fR
+.RS 4
+Unfocused monitor\&.
+.RE
+.PP
+\fIO<desktop_name>\fR
+.RS 4
+Occupied focused desktop\&.
+.RE
+.PP
+\fIo<desktop_name>\fR
+.RS 4
+Occupied unfocused desktop\&.
+.RE
+.PP
+\fIF<desktop_name>\fR
+.RS 4
+Free focused desktop\&.
+.RE
+.PP
+\fIf<desktop_name>\fR
+.RS 4
+Free unfocused desktop\&.
+.RE
+.PP
+\fIU<desktop_name>\fR
+.RS 4
+Urgent focused desktop\&.
+.RE
+.PP
+\fIu<desktop_name>\fR
+.RS 4
+Urgent unfocused desktop\&.
+.RE
+.PP
+\fIL(T|M)\fR
+.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
+.RS 4
+The path of the socket used for the communication between
+\fBbspc\fR
+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 "CONTRIBUTORS"
.sp
.RE
.SH "AUTHOR"
.sp
-Bastien Dejean <baskerville at lavabit\&.com>
-.SH "MAILING LIST"
-.sp
-bspwm at librelist\&.com
+Bastien Dejean <nihilhill at gmail\&.com>
projects / bspwm.git / blobdiff