'\" t
.\" Title: bspwm
.\" Author: [see the "Author" section]
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 03/16/2016
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 05/28/2021
.\" Manual: Bspwm Manual
-.\" Source: Bspwm 0.9.1-2-g212442e
+.\" Source: Bspwm 0.9.10-26-gbadfd6c
.\" Language: English
.\"
-.TH "BSPWM" "1" "03/16/2016" "Bspwm 0\&.9\&.1\-2\-g212442e" "Bspwm Manual"
+.TH "BSPWM" "1" "05/28/2021" "Bspwm 0\&.9\&.10\-26\-gbadfd6c" "Bspwm Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
\fBbspwm\fR [\fB\-h\fR|\fB\-v\fR|\fB\-c\fR \fICONFIG_PATH\fR]
.sp
\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
Selectors are used to select a target node, desktop, or monitor\&. A selector can either describe the target relatively or name it globally\&.
.sp
-Selectors consist of a descriptor and any number of non\-conflicting modifiers as follows:
+Selectors consist of an optional reference, a descriptor and any number of non\-conflicting modifiers as follows:
.sp
.if n \{\
.RS 4
.\}
.nf
-DESCRIPTOR(\&.MODIFIER)*
+[REFERENCE#]DESCRIPTOR(\&.MODIFIER)*
.fi
.if n \{\
.RE
.\}
.sp
-An exclamation mark can be prepended to certain modifiers in order to reverse their meaning\&.
+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
+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\&.
.RS 4
.\}
.nf
-NODE_SEL := (<node_id>|PATH|DIR|CYCLE_DIR|last|older|newer|biggest|focused)[\&.[!]focused][\&.[!]automatic][\&.[!]local][\&.[!]leaf][\&.[!]STATE][\&.[!]FLAG][\&.[!]LAYER][\&.[!]same_class]
+NODE_SEL := [NODE_SEL#](DIR|CYCLE_DIR|PATH|any|first_ancestor|last|newest|
+ older|newer|focused|pointed|biggest|smallest|
+ <node_id>)[\&.[!]focused][\&.[!]active][\&.[!]automatic][\&.[!]local]
+ [\&.[!]leaf][\&.[!]window][\&.[!]STATE][\&.[!]FLAG][\&.[!]LAYER][\&.[!]SPLIT_TYPE]
+ [\&.[!]same_class][\&.[!]descendant_of][\&.[!]ancestor_of]
STATE := tiled|pseudo_tiled|floating|fullscreen
-FLAG := urgent|sticky|private|locked
+FLAG := hidden|sticky|private|locked|marked|urgent
LAYER := below|normal|above
+SPLIT_TYPE := horizontal|vertical
+
PATH := @[DESKTOP_SEL:][[/]JUMP](/JUMP)*
JUMP := first|1|second|2|brother|parent|DIR
\fBDescriptors\fR
.RS 4
.PP
-<node_id>
+\fIDIR\fR
.RS 4
-Selects the node with the given ID\&.
+Selects the window in the given (spacial) direction relative to the reference node\&.
+.RE
+.PP
+\fICYCLE_DIR\fR
+.RS 4
+Selects the node in the given (cyclic) direction relative to the reference node within a depth\-first in\-order traversal of the tree\&.
.RE
.PP
\fIPATH\fR
Selects the node at the given path\&.
.RE
.PP
-\fIDIR\fR
+any
.RS 4
-Selects the window in the given (spacial) direction relative to the active node\&.
+Selects the first node that matches the given selectors\&.
.RE
.PP
-\fICYCLE_DIR\fR
+first_ancestor
.RS 4
-Selects the window in the given (cyclic) direction\&.
+Selects the first ancestor of the reference node that matches the given selectors\&.
.RE
.PP
-biggest
+last
.RS 4
-Selects the biggest window on the current desktop\&.
+Selects the previously focused node relative to the reference node\&.
.RE
.PP
-last
+newest
+.RS 4
+Selects the newest node in the history of the focused node\&.
+.RE
+.PP
+older
.RS 4
-Selects the previously focused node\&.
+Selects the node older than the reference node in the history\&.
+.RE
+.PP
+newer
+.RS 4
+Selects the node newer than the reference node in the history\&.
.RE
.PP
focused
Selects the currently focused node\&.
.RE
.PP
-older
+pointed
.RS 4
-Selects the node older than the focused node in the history\&.
+Selects the leaf under the pointer\&.
.RE
.PP
-newer
+biggest
.RS 4
-Selects the node newer than the focused node in the history\&.
+Selects the biggest leaf\&.
+.RE
+.PP
+smallest
+.RS 4
+Selects the smallest leaf\&.
+.RE
+.PP
+<node_id>
+.RS 4
+Selects the node with the given ID\&.
.RE
.RE
.sp
\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)\&.
+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
.PP
[!]focused
.RS 4
-Only consider focused or unfocused nodes\&.
+Only consider the focused node\&.
+.RE
+.PP
+[!]active
+.RS 4
+Only consider nodes that are the focused node of their desktop\&.
.RE
.PP
[!]automatic
.RS 4
-Only consider nodes in automatic or manual insertion mode\&.
+Only consider nodes in automatic insertion mode\&. See also
+\fB\-\-presel\-dir\fR
+under
+\fBNode\fR
+in the
+\fBDOMAINS\fR
+section below\&.
.RE
.PP
[!]local
.RS 4
-Only consider nodes in or not in the current desktop\&.
+Only consider nodes in the reference desktop\&.
.RE
.PP
[!]leaf
.RS 4
-Only consider leaves or internal nodes\&.
+Only consider leaf nodes\&.
+.RE
+.PP
+[!]window
+.RS 4
+Only consider nodes that hold a window\&.
.RE
.PP
[!](tiled|pseudo_tiled|floating|fullscreen)
.RS 4
-Only consider windows in or not in the given state\&.
+Only consider windows 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\&.
+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
-[!](private|urgent|sticky|locked)
+[!]ancestor_of
.RS 4
-Only consider windows that have or don\(cqt have the given flag set\&.
+Only consider nodes that are ancestors of the reference node\&.
+.RE
+.PP
+[!](hidden|sticky|private|locked|marked|urgent)
+.RS 4
+Only consider windows that have the given flag set\&.
.RE
.PP
[!](below|normal|above)
.RS 4
-Only consider windows in or not in the given layer\&.
+Only consider windows in the given layer\&.
+.RE
+.PP
+[!](horizontal|vertical)
+.RS 4
+Only consider nodes with the given split type\&.
.RE
.RE
.SS "Desktop"
.RS 4
.\}
.nf
-DESKTOP_SEL := (<desktop_id>|<desktop_name>|[MONITOR_SEL:](focused|^<n>)|CYCLE_DIR|last|older|newer)[\&.[!]occupied][\&.[!]focused][\&.[!]urgent][\&.[!]local]
+DESKTOP_SEL := [DESKTOP_SEL#](CYCLE_DIR|any|last|newest|older|newer|
+ [MONITOR_SEL:](focused|^<n>)|
+ <desktop_id>|<desktop_name>)[\&.[!]focused][\&.[!]active]
+ [\&.[!]occupied][\&.[!]urgent][\&.[!]local]
+ [\&.[!]LAYOUT][\&.[!]user_LAYOUT]
+
+LAYOUT := tiled|monocle
.fi
.if n \{\
.RE
\fBDescriptors\fR
.RS 4
.PP
-<desktop_id>
+\fICYCLE_DIR\fR
.RS 4
-Selects the desktop with the given ID\&.
+Selects the desktop in the given direction relative to the reference desktop\&.
.RE
.PP
-<desktop_name>
+any
.RS 4
-Selects the desktop with the given name\&.
+Selects the first desktop that matches the given selectors\&.
.RE
.PP
-^<n>
+last
.RS 4
-Selects the nth desktop\&.
+Selects the previously focused desktop relative to the reference desktop\&.
.RE
.PP
-\fICYCLE_DIR\fR
+newest
.RS 4
-Selects the desktop in the given direction relative to the active desktop\&.
+Selects the newest desktop in the history of the focused desktops\&.
.RE
.PP
-last
+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
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
\fBModifiers\fR
.RS 4
.PP
-[!]occupied
+[!]focused
.RS 4
-Only consider occupied or free desktops\&.
+Only consider the focused desktop\&.
.RE
.PP
-[!]focused
+[!]active
+.RS 4
+Only consider desktops that are the focused desktop of their monitor\&.
+.RE
+.PP
+[!]occupied
.RS 4
-Only consider focused or unfocused desktops\&.
+Only consider occupied desktops\&.
.RE
.PP
[!]urgent
.RS 4
-Only consider urgent or non urgent desktops\&.
+Only consider urgent desktops\&.
.RE
.PP
[!]local
.RS 4
-Only consider inside or outside of the current monitor\&.
+Only consider desktops inside the reference monitor\&.
+.RE
+.PP
+[!](tiled|monocle)
+.RS 4
+Only consider desktops with the given layout\&.
+.RE
+.PP
+[!](user_tiled|user_monocle)
+.RS 4
+Only consider desktops which have the given layout as userLayout\&.
.RE
.RE
.SS "Monitor"
.RS 4
.\}
.nf
-MONITOR_SEL := (<monitor_id>|<monitor_name>|^<n>|DIR|CYCLE_DIR|last|primary|focused|older|newer)[\&.[!]occupied][\&.[!]focused]
+MONITOR_SEL := [MONITOR_SEL#](DIR|CYCLE_DIR|any|last|newest|older|newer|
+ focused|pointed|primary|^<n>|
+ <monitor_id>|<monitor_name>)[\&.[!]focused][\&.[!]occupied]
.fi
.if n \{\
.RE
\fBDescriptors\fR
.RS 4
.PP
-<monitor_id>
+\fIDIR\fR
.RS 4
-Selects the monitor with the given ID\&.
+Selects the monitor in the given (spacial) direction relative to the reference monitor\&.
.RE
.PP
-<monitor_name>
+\fICYCLE_DIR\fR
.RS 4
-Selects the monitor with the given name\&.
+Selects the monitor in the given (cyclic) direction relative to the reference monitor\&.
.RE
.PP
-^<n>
+any
.RS 4
-Selects the nth monitor\&.
+Selects the first monitor that matches the given selectors\&.
.RE
.PP
-\fIDIR\fR
+last
.RS 4
-Selects the monitor in the given (spacial) direction relative to the active monitor\&.
+Selects the previously focused monitor relative to the reference monitor\&.
.RE
.PP
-\fICYCLE_DIR\fR
+newest
.RS 4
-Selects the monitor in the given (cyclic) direction relative to the active monitor\&.
+Selects the newest monitor in the history of the focused monitors\&.
.RE
.PP
-primary
+older
.RS 4
-Selects the primary monitor\&.
+Selects the monitor older than the reference monitor in the history\&.
.RE
.PP
-last
+newer
.RS 4
-Selects the previously focused monitor\&.
+Selects the monitor newer than the reference monitor in the history\&.
.RE
.PP
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 monitor newer than the focused monitor in the history\&.
+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
\fBModifiers\fR
.RS 4
.PP
-[!]occupied
+[!]focused
.RS 4
-Only consider monitors where the focused desktop is occupied or free\&.
+Only consider the focused monitor\&.
.RE
.PP
-[!]focused
+[!]occupied
.RS 4
-Only consider focused or unfocused monitors\&.
+Only consider monitors where the focused desktop is occupied\&.
.RE
.RE
.SH "WINDOW STATES"
.PP
tiled
.RS 4
-Its size and position are determined by the splitting type and ratio of each node of its path in the window tree\&.
+Its size and position are determined by the window tree\&.
.RE
.PP
pseudo_tiled
.RS 4
-Has an unrestricted size while being centered in its tiling space\&.
+A tiled window that automatically shrinks but doesn\(cqt stretch beyond its floating size\&.
.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\&.
+Can be moved/resized freely\&. Although it doesn\(cqt use any tiling space, it is still part of the window tree\&.
.RE
.PP
fullscreen
.RS 4
-Fills its monitor rectangle and has no borders\&. It is send in the ABOVE layer by default\&.
+Fills its monitor rectangle and has no borders\&.
.RE
.SH "NODE FLAGS"
.PP
-locked
+hidden
.RS 4
-Ignores the
-\fBnode \-\-close\fR
-message\&.
+Is hidden and doesn\(cqt occupy any tiling space\&.
.RE
.PP
sticky
Tries to keep the same tiling position/size\&.
.RE
.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\&.
.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\&.
+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
.RS 4
.sp
node [\fINODE_SEL\fR] \fICOMMANDS\fR
+.sp
+If \fINODE_SEL\fR is omitted, \fBfocused\fR is assumed\&.
.RE
.sp
.it 1 an-trap
Activate the selected or given node\&.
.RE
.PP
-\fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR
+\fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR [\fB\-\-follow\fR]
.RS 4
-Send the selected node to the given desktop\&.
+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\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR [\fB\-\-follow\fR]
.RS 4
-Send the selected node to the given monitor\&.
+Send the selected node to the given monitor\&. If
+\fB\-\-follow\fR
+is passed, the focused node will stay focused\&.
.RE
.PP
-\fB\-n\fR, \fB\-\-to\-node\fR \fINODE_SEL\fR
+\fB\-n\fR, \fB\-\-to\-node\fR \fINODE_SEL\fR [\fB\-\-follow\fR]
.RS 4
-Transplant the selected node to the given node\&.
+Send the selected node on the given node\&. If
+\fB\-\-follow\fR
+is passed, the focused node will stay focused\&.
.RE
.PP
-\fB\-s\fR, \fB\-\-swap\fR \fINODE_SEL\fR
+\fB\-s\fR, \fB\-\-swap\fR \fINODE_SEL\fR [\fB\-\-follow\fR]
.RS 4
-Swap the selected node with the given node\&.
+Swap the selected node with the given node\&. If
+\fB\-\-follow\fR
+is passed, the focused node will stay focused\&.
.RE
.PP
\fB\-p\fR, \fB\-\-presel\-dir\fR [~]\fIDIR\fR|cancel
\fIDIR\fR
and the current preselection direction matches
\fIDIR\fR, then the argument is interpreted as
-\fBcancel\fR\&.
+\fBcancel\fR\&. A node with a preselected area is said to be in "manual insertion mode"\&.
.RE
.PP
\fB\-o\fR, \fB\-\-presel\-ratio\fR \fIRATIO\fR
Set the splitting ratio of the preselection area\&.
.RE
.PP
-\fB\-r\fR, \fB\-\-ratio\fR \fIRATIO\fR|(+|\-)\fIPIXELS\fR
+\fB\-v\fR, \fB\-\-move\fR \fIdx\fR \fIdy\fR
+.RS 4
+Move the selected window by
+\fIdx\fR
+pixels horizontally and
+\fIdy\fR
+pixels vertically\&.
+.RE
+.PP
+\fB\-z\fR, \fB\-\-resize\fR top|left|bottom|right|top_left|top_right|bottom_right|bottom_left \fIdx\fR \fIdy\fR
+.RS 4
+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|(+|\-)(\fIPIXELS\fR|\fIFRACTION\fR)
.RS 4
Set the splitting ratio of the selected node (0 <
\fIRATIO\fR
.PP
\fB\-F\fR, \fB\-\-flip\fR \fIhorizontal|vertical\fR
.RS 4
-Flip the the tree rooted at selected node\&.
+Flip the tree rooted at selected node\&.
.RE
.PP
\fB\-E\fR, \fB\-\-equalize\fR
Circulate the windows of the tree rooted at the selected node\&.
.RE
.PP
-\fB\-t\fR, \fB\-\-state\fR [~](tiled|pseudo_tiled|floating|fullscreen)
+\fB\-t\fR, \fB\-\-state\fR ~|[~]\fISTATE\fR
.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\&.
+is present and the current state matches
+\fISTATE\fR, then the argument is interpreted as its last state\&. If the argument is just
+\fB~\fR
+with
+\fISTATE\fR
+omitted, then the state of the selected window is set to its last state\&.
.RE
.PP
-\fB\-g\fR, \fB\-\-flag\fR locked|sticky|private[=on|off]
+\fB\-g\fR, \fB\-\-flag\fR hidden|sticky|private|locked|marked[=on|off]
.RS 4
Set or toggle the given flag for the selected node\&.
.RE
Set the stacking layer of the selected window\&.
.RE
.PP
+\fB\-i\fR, \fB\-\-insert\-receptacle\fR
+.RS 4
+Insert a receptacle node at the selected node\&.
+.RE
+.PP
\fB\-c\fR, \fB\-\-close\fR
.RS 4
Close the windows rooted at the selected node\&.
.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
Activate the selected or given desktop\&.
.RE
.PP
-\fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR
+\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
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\&.
.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
Focus the selected or given monitor\&.
.RE
.PP
+\fB\-s\fR, \fB\-\-swap\fR \fIMONITOR_SEL\fR
+.RS 4
+Swap the selected monitor with the given monitor\&.
+.RE
+.PP
\fB\-a\fR, \fB\-\-add\-desktops\fR <name>\&...
.RS 4
Create desktops with the given names in the selected monitor\&.
.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\&.
+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
Rename the selected monitor\&.
.RE
.PP
-\fB\-s\fR, \fB\-\-swap\fR \fIMONITOR_SEL\fR
-.RS 4
-Swap the selected monitor with the given monitor\&.
-.RE
-.PP
\fB\-r\fR, \fB\-\-remove\fR
.RS 4
Remove the selected monitor\&.
.ps +1
\fBCommands\fR
.RS 4
+.sp
+The optional selectors are references\&.
.PP
-\fB\-N\fR, \fB\-\-nodes\fR
+\fB\-N\fR, \fB\-\-nodes\fR [\fINODE_SEL\fR]
.RS 4
List the IDs of the matching nodes\&.
.RE
.PP
-\fB\-D\fR, \fB\-\-desktops\fR
+\fB\-D\fR, \fB\-\-desktops\fR [\fIDESKTOP_SEL\fR]
.RS 4
-List the IDs of the matching desktops\&.
+List the IDs (or names) of the matching desktops\&.
.RE
.PP
-\fB\-M\fR, \fB\-\-monitors\fR
+\fB\-M\fR, \fB\-\-monitors\fR [\fIMONITOR_SEL\fR]
.RS 4
-List the IDs of the matching monitors\&.
+List the IDs (or names) of the matching monitors\&.
.RE
.PP
\fB\-T\fR, \fB\-\-tree\fR
\fBOptions\fR
.RS 4
.PP
-[\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]]
+\fB\-m\fR,\fB\-\-monitor\fR [\fIMONITOR_SEL\fR|\fIMONITOR_MODIFIERS\fR], \fB\-d\fR,\fB\-\-desktop\fR [\fIDESKTOP_SEL\fR|\fIDESKTOP_MODIFIERS\fR], \fB\-n\fR, \fB\-\-node\fR [\fINODE_SEL\fR|\fINODE_MODIFIERS\fR]
+.RS 4
+Constrain matches to the selected monitors, desktops or nodes\&.
+.RE
+.PP
+\fB\-\-names\fR
.RS 4
-Constrain matches to the selected monitor, desktop or node\&. The descriptor can be omitted for
-\fI\-M\fR,
-\fI\-D\fR
+Print names instead of IDs\&. Can only be used with
+\fI\-M\fR
and
-\fI\-N\fR\&.
+\fI\-D\fR\&.
.RE
.RE
.SS "Wm"
.PP
\fB\-l\fR, \fB\-\-load\-state\fR <file_path>
.RS 4
-Load a world state from the given file\&.
+Load a world state from the given file\&. The path must be absolute\&.
.RE
.PP
\fB\-a\fR, \fB\-\-add\-monitor\fR <name> WxH+X+Y
Add a monitor for the given name and rectangle\&.
.RE
.PP
+\fB\-O\fR, \fB\-\-reorder\-monitors\fR <name>\&...
+.RS 4
+Reorder the list of monitors to match the given order\&.
+.RE
+.PP
\fB\-o\fR, \fB\-\-adopt\-orphans\fR
.RS 4
Manage all the unmanaged windows remaining from a previous session\&.
.RS 4
Print the current status information\&.
.RE
-.RE
-.SS "Pointer"
-.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
-pointer \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\-g\fR, \fB\-\-grab\fR focus|move|resize_side|resize_corner
+\fB\-r\fR, \fB\-\-restart\fR
.RS 4
-Initiate the given pointer action\&.
-.RE
-.PP
-\fB\-t\fR, \fB\-\-track\fR <x> <y>
-.RS 4
-Pass the pointer root coordinates for the current pointer action\&.
-.RE
-.PP
-\fB\-u\fR, \fB\-\-ungrab\fR
-.RS 4
-Terminate the current pointer action\&.
+Restart the window manager
.RE
.RE
.SS "Rule"
\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] [(locked|sticky|private|center|follow|manage|focus|border)=(on|off)]
+\fB\-a\fR, \fB\-\-add\fR (<class_name>|*)[:(<instance_name>|*)[:(<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
Create a new rule\&.
.RE
.PP
-\fB\-r\fR, \fB\-\-remove\fR ^<n>|head|tail|(<class_name>|*)[:(<instance_name>|*)]\&...
+\fB\-r\fR, \fB\-\-remove\fR ^<n>|head|tail|(<class_name>|*)[:(<instance_name>|*)[:(<name>|*)]]\&...
.RS 4
Remove the given rules\&.
.RE
\fBGeneral Syntax\fR
.RS 4
.PP
-config [\-m \fIMONITOR_SEL\fR|\-d \fIDESKTOP_SEL\fR|\-n \fINODE_SEL\fR] <key> [<value>]
+config [\-m \fIMONITOR_SEL\fR|\-d \fIDESKTOP_SEL\fR|\-n \fINODE_SEL\fR] <setting> [<value>]
.RS 4
-Get or set the value of <key>\&.
+Get or set the value of <setting>\&.
.RE
.RE
.SS "Subscribe"
\fBGeneral Syntax\fR
.RS 4
.PP
-subscribe (all|report|monitor|desktop|node|\&...)*
+subscribe [\fIOPTIONS\fR] (all|report|monitor|desktop|node|\&...)*
.RS 4
-Continuously print status information\&. See the
+Continuously print events\&. See the
\fBEVENTS\fR
-section for the detailed description of each event\&.
+section for the 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
+\fBOptions\fR
.RS 4
.PP
-quit [<status>]
+\fB\-f\fR, \fB\-\-fifo\fR
.RS 4
-Quit with an optional exit status\&.
-.RE
+Print a path to a FIFO from which events can be read and return\&.
.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
+\fB\-c\fR, \fB\-\-count\fR \fICOUNT\fR
.RS 4
-Failure\&.
+Stop the corresponding
+\fBbspc\fR
+process after having received
+\fICOUNT\fR
+events\&.
.RE
-.PP
-2
-.RS 4
-Syntax error\&.
.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
-3
+quit [<status>]
.RS 4
-Unknown command\&.
+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 in the form \fI#RRGGBB\fR, booleans are \fItrue\fR, \fIon\fR, \fIfalse\fR or \fIoff\fR\&.
.PP
\fIexternal_rules_command\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:
+Absolute path to the command used to retrieve rule consequences\&. The command will receive the following arguments: window ID, class name, instance name, and intermediate consequences\&. The output of that command must have the following format:
\fBkey1=value1 key2=value2 \&...\fR
(the valid key/value pairs are given in the description of the
\fIrule\fR
command)\&.
.RE
.PP
+\fIautomatic_scheme\fR
+.RS 4
+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
\fIinitial_polarity\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:
\fBsecond_child\fR\&.
.RE
.PP
-\fIhistory_aware_focus\fR
+\fIdirectional_focus_tightness\fR
+.RS 4
+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
-Give priority to the focus history when focusing nodes\&.
+Adjust the brother when unlinking a node from the tree in accordance with the automatic insertion scheme\&.
.RE
.PP
-\fIfocus_by_distance\fR
+\fIpresel_feedback\fR
.RS 4
-Base focusing on distances between windows\&.
+Draw the preselection feedback area\&. Defaults to
+\fItrue\fR\&.
.RE
.PP
\fIborderless_monocle\fR
desktop layout\&.
.RE
.PP
-\fIpaddingless_monocle\fR
+\fItop_monocle_padding\fR, \fIright_monocle_padding\fR, \fIbottom_monocle_padding\fR, \fIleft_monocle_padding\fR
.RS 4
-Remove padding space for the
+Padding space added at the sides of the screen for the
\fBmonocle\fR
desktop layout\&.
.RE
if there\(cqs only one tiled window in the tree\&.
.RE
.PP
+\fIborderless_singleton\fR
+.RS 4
+Remove borders of the only window on the only monitor regardless its layout\&.
+.RE
+.PP
+\fIpointer_motion_interval\fR
+.RS 4
+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
+.PP
+\fIpointer_action1\fR, \fIpointer_action2\fR, \fIpointer_action3\fR
+.RS 4
+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
+\fIclick_to_focus\fR
+.RS 4
+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
+\fIswallow_first_click\fR
+.RS 4
+Don\(cqt replay the click that makes a window focused if
+\fIclick_to_focus\fR
+isn\(cqt
+\fBnone\fR\&.
+.RE
+.PP
\fIfocus_follows_pointer\fR
.RS 4
Focus the window under the pointer\&.
When focusing a monitor, put the pointer at its center\&.
.RE
.PP
+\fImapping_events_count\fR
+.RS 4
+Handle the next
+\fBmapping_events_count\fR
+mapping notify events\&. A negative value implies that every event needs to be handled\&.
+.RE
+.PP
\fIignore_ewmh_focus\fR
.RS 4
Ignore EWMH focus requests coming from applications\&.
.RE
.PP
+\fIignore_ewmh_fullscreen\fR
+.RS 4
+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
+\fIignore_ewmh_struts\fR
+.RS 4
+Ignore strut hinting from clients requesting to reserve space (i\&.e\&. task bars)\&.
+.RE
+.PP
\fIcenter_pseudo_tiled\fR
.RS 4
Center pseudo tiled windows into their tiling rectangles\&. Defaults to
\fItrue\fR\&.
.RE
.PP
+\fIhonor_size_hints\fR
+.RS 4
+Apply ICCCM window size hints\&.
+.RE
+.PP
\fIremove_disabled_monitors\fR
.RS 4
Consider disabled monitors as disconnected\&.
.RS 4
Padding space added at the sides of the monitor or desktop\&.
.RE
-.SS "Default, Desktop Default and Window Settings"
+.SS "Desktop Settings"
+.PP
+\fIwindow_gap\fR
+.RS 4
+Size of the gap that separates windows\&.
+.RE
+.SS "Node Settings"
.PP
\fIborder_width\fR
.RS 4
Window border width\&.
.RE
-.SS "Default and Desktop Settings"
+.SH "POINTER BINDINGS"
.PP
-\fIwindow_gap\fR
+\fIclick_to_focus\fR
.RS 4
-Size of the gap that separates windows\&.
+Focus the window (or the monitor) under the pointer if the value isn\(cqt
+\fBnone\fR\&.
.RE
+.PP
+\fIpointer_modifier\fR + \fIbutton1\fR
+.RS 4
+Move the window under the pointer\&.
+.RE
+.PP
+\fIpointer_modifier\fR + \fIbutton2\fR
+.RS 4
+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
The layout of a desktop changed\&.
.RE
.PP
-\fInode_manage <monitor_id> <desktop_id> <node_id> <ip_id>\fR
+\fInode_add <monitor_id> <desktop_id> <ip_id> <node_id>\fR
.RS 4
-A window is managed\&.
+A node is added\&.
.RE
.PP
-\fInode_unmanage <monitor_id> <desktop_id> <node_id>\fR
+\fInode_remove <monitor_id> <desktop_id> <node_id>\fR
.RS 4
-A window is unmanaged\&.
+A node is removed\&.
.RE
.PP
\fInode_swap <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>\fR
The state of a window changed\&.
.RE
.PP
-\fInode_flag <monitor_id> <desktop_id> <node_id> sticky|private|locked|urgent on|off\fR
+\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
.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 occurred\&.
+.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"
State of the focused node of a focused desktop\&.
.RE
.PP
-\fIG(S?P?L?)\fR
+\fIG(S?P?L?M?)\fR
.RS 4
Active flags of the focused node of a focused desktop\&.
.RE
projects / bspwm.git / blobdiff