'\" t
.\" Title: bspwm
.\" Author: [see the "Author" section]
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 04/14/2016
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\" Date: 07/24/2017
.\" Manual: Bspwm Manual
-.\" Source: Bspwm 0.9.1-26-g789cb8a
+.\" Source: Bspwm 0.9.3-10-g9ea4b01
.\" Language: English
.\"
-.TH "BSPWM" "1" "04/14/2016" "Bspwm 0\&.9\&.1\-26\-g789cb8a" "Bspwm Manual"
+.TH "BSPWM" "1" "07/24/2017" "Bspwm 0\&.9\&.3\-10\-g9ea4b01" "Bspwm Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.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\&.
.SS "Node"
.sp
Select a node\&.
.RS 4
.\}
.nf
-NODE_SEL := (DIR|CYCLE_DIR|PATH|last|older|newer|focused|biggest|<node_id>)[\&.[!]focused][\&.[!]automatic][\&.[!]local][\&.[!]leaf][\&.[!]window][\&.[!]STATE][\&.[!]FLAG][\&.[!]LAYER][\&.[!]same_class]
+NODE_SEL := [NODE_SEL#](DIR|CYCLE_DIR|PATH|last|older|newer|focused|pointed|biggest|<node_id>)[\&.[!]focused][\&.[!]automatic][\&.[!]local][\&.[!]active][\&.[!]leaf][\&.[!]window][\&.[!]STATE][\&.[!]FLAG][\&.[!]LAYER][\&.[!]same_class][\&.[!]descendant_of][\&.[!]ancestor_of]
STATE := tiled|pseudo_tiled|floating|fullscreen
-FLAG := urgent|sticky|private|locked
+FLAG := hidden|sticky|private|locked|urgent
LAYER := below|normal|above
.PP
\fIDIR\fR
.RS 4
-Selects the window in the given (spacial) direction relative to the active node\&.
+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
\fIPATH\fR
.PP
last
.RS 4
-Selects the previously focused node\&.
+Selects the previously focused node relative to the reference node\&.
.RE
.PP
older
.RS 4
-Selects the node older than the focused node in the history\&.
+Selects the node older than the reference node in the history\&.
.RE
.PP
newer
.RS 4
-Selects the node newer than the focused node in the history\&.
+Selects the node newer than the reference node in the history\&.
.RE
.PP
focused
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\&.
+Selects the biggest window\&.
.RE
.PP
<node_id>
\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
[!]automatic
.RS 4
-Only consider nodes in automatic or manual insertion mode\&.
+Only consider nodes in automatic or manual 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 or not in the reference desktop\&.
+.RE
+.PP
+[!]active
+.RS 4
+Only consider nodes in or not in the active desktop of their monitor\&.
.RE
.PP
[!]leaf
.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 or don\(cqt have the same class as the reference window\&.
+.RE
+.PP
+[!]descendant_of
+.RS 4
+Only consider nodes that are or aren\(cqt descendants of the reference node\&.
.RE
.PP
-[!](private|urgent|sticky|locked)
+[!]ancestor_of
+.RS 4
+Only consider nodes that are or aren\(cqt ancestors of the reference node\&.
+.RE
+.PP
+[!](hidden|sticky|private|locked|urgent)
.RS 4
Only consider windows that have or don\(cqt have the given flag set\&.
.RE
.RS 4
.\}
.nf
-DESKTOP_SEL := (CYCLE_DIR|last|older|newer|[MONITOR_SEL:](focused|^<n>)|<desktop_id>|<desktop_name>)[\&.[!]occupied][\&.[!]focused][\&.[!]urgent][\&.[!]local]
+DESKTOP_SEL := [DESKTOP_SEL#](CYCLE_DIR|last|older|newer|[MONITOR_SEL:](focused|^<n>)|<desktop_id>|<desktop_name>)[\&.[!]occupied][\&.[!]focused][\&.[!]urgent][\&.[!]local]
.fi
.if n \{\
.RE
.PP
\fICYCLE_DIR\fR
.RS 4
-Selects the desktop in the given direction relative to the active desktop\&.
+Selects the desktop in the given direction relative to the reference desktop\&.
.RE
.PP
last
.RS 4
-Selects the previously focused desktop\&.
+Selects the previously focused desktop relative to the reference desktop\&.
.RE
.PP
older
.RS 4
-Selects the desktop older than the focused desktop in the history\&.
+Selects the desktop older than the reference desktop in the history\&.
.RE
.PP
newer
.RS 4
-Selects the desktop newer than the focused desktop in the history\&.
+Selects the desktop newer than the reference desktop in the history\&.
.RE
.PP
focused
.PP
[!]local
.RS 4
-Only consider inside or outside of the current monitor\&.
+Only consider desktops inside or outside of the reference monitor\&.
.RE
.RE
.SS "Monitor"
.RS 4
.\}
.nf
-MONITOR_SEL := (DIR|CYCLE_DIR|last|older|newer|focused|primary|^<n>|<monitor_id>|<monitor_name>)[\&.[!]occupied][\&.[!]focused]
+MONITOR_SEL := [MONITOR_SEL#](DIR|CYCLE_DIR|last|older|newer|focused|primary|^<n>|<monitor_id>|<monitor_name>)[\&.[!]occupied][\&.[!]focused]
.fi
.if n \{\
.RE
.PP
\fIDIR\fR
.RS 4
-Selects the monitor in the given (spacial) direction relative to the active monitor\&.
+Selects the monitor in the given (spacial) direction relative to the reference monitor\&.
.RE
.PP
\fICYCLE_DIR\fR
.RS 4
-Selects the monitor in the given (cyclic) direction relative to the active monitor\&.
+Selects the monitor in the given (cyclic) direction relative to the reference monitor\&.
.RE
.PP
last
.RS 4
-Selects the previously focused monitor\&.
+Selects the previously focused monitor relative to the reference monitor\&.
.RE
.PP
older
.RS 4
-Selects the monitor older than the focused monitor in the history\&.
+Selects the monitor older than the reference monitor in the history\&.
.RE
.PP
newer
.RS 4
-Selects the monitor newer than the focused monitor in the history\&.
+Selects the monitor newer than the reference monitor in the history\&.
.RE
.PP
focused
.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
urgent
.RS 4
Has its urgency hint set\&. This flag is set externally\&.
.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
\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
pixels vertically\&.
.RE
.PP
-\fB\-r\fR, \fB\-\-ratio\fR \fIRATIO\fR|(+|\-)\fIPIXELS\fR
+\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
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 locked|sticky|private[=on|off]
+\fB\-g\fR, \fB\-\-flag\fR hidden|sticky|private|locked[=on|off]
.RS 4
Set or toggle the given flag for the selected node\&.
.RE
.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
.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\&.
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
and
\fI\-N\fR\&.
.RE
+.PP
+\fB\-\-names\fR
+.RS 4
+Print names instead of IDs\&.
+.RE
.RE
.SS "Wm"
.sp
\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>|*)] [\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)] [rectangle=WxH+X+Y]
.RS 4
Create a new rule\&.
.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
+.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\-f\fR, \fB\-\-fifo\fR
+.RS 4
+Print a path to a FIFO from which events can be read and return\&.
+.RE
+.PP
+\fB\-c\fR, \fB\-\-count\fR \fICOUNT\fR
+.RS 4
+Stop the corresponding
+\fBbspc\fR
+process after having received
+\fICOUNT\fR
+events\&.
.RE
.RE
.SS "Quit"
.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:
+External command used to retrieve rule consequences\&. The command will receive the following arguments: window ID, class and instance names, monitor, desktop and node selectors\&. The output of that command must have the following format:
\fBkey1=value1 key2=value2 \&...\fR
(the valid key/value pairs are given in the description of the
\fIrule\fR
\fBsecond_child\fR\&.
.RE
.PP
-\fIhistory_aware_focus\fR
-.RS 4
-Give priority to the focus history when focusing nodes\&.
-.RE
-.PP
-\fIfocus_by_distance\fR
+\fIdirectional_focus_tightness\fR
.RS 4
-Base focusing on distances between windows\&.
+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
\fIborderless_monocle\fR
if there\(cqs only one tiled window in the tree\&.
.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:
\fBmove\fR,
\fBresize_side\fR,
\fBresize_corner\fR,
-\fBfocus\fR\&.
+\fBfocus\fR,
+\fBnone\fR\&.
.RE
.PP
\fIclick_to_focus\fR
.RS 4
-Focus a window (or a monitor) by clicking it\&.
+Button used for focusing a window (or a monitor)\&. The possible values are:
+\fBbutton1\fR,
+\fBbutton2\fR,
+\fBbutton3\fR,
+\fBany\fR,
+\fBnone\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
.RE
.SH "POINTER BINDINGS"
.PP
-\fIbutton1\fR
-.RS 4
-Focus the window under the pointer if
\fIclick_to_focus\fR
-is set\&.
+.RS 4
+Focus the window (or the monitor) under the pointer if the value isn\(cqt
+\fBnone\fR\&.
.RE
.PP
\fIpointer_modifier\fR + \fIbutton1\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|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 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"
projects / bspwm.git / blobdiff