.\" Title: bspwm
.\" Author: [see the "Author" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 09/08/2017
+.\" Date: 01/29/2019
.\" Manual: Bspwm Manual
-.\" Source: Bspwm 0.9.3-26-g412da35
+.\" Source: Bspwm 0.9.5-35-g32ff624
.\" Language: English
.\"
-.TH "BSPWM" "1" "09/08/2017" "Bspwm 0\&.9\&.3\-26\-g412da35" "Bspwm Manual"
+.TH "BSPWM" "1" "01/29/2019" "Bspwm 0\&.9\&.5\-35\-g32ff624" "Bspwm Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.RS 4
.\}
.nf
-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]
+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|urgent
+FLAG := hidden|sticky|private|locked|marked|urgent
LAYER := below|normal|above
Selects the node at the given path\&.
.RE
.PP
+any
+.RS 4
+Selects the first node that matches the given selectors\&.
+.RE
+.PP
last
.RS 4
Selects the previously focused node relative to the reference node\&.
.RE
.PP
+newest
+.RS 4
+Selects the newest node in the history of the focused node\&.
+.RE
+.PP
older
.RS 4
Selects the node older than the reference node in the history\&.
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\&.
.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\&. See also
+Only consider nodes in automatic insertion mode\&. See also
\fB\-\-presel\-dir\fR
under
\fBNode\fR
.PP
[!]local
.RS 4
-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\&.
+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 or don\(cqt hold a window\&.
+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 reference window\&.
+Only consider windows that 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\&.
+Only consider nodes that are descendants of the reference node\&.
.RE
.PP
[!]ancestor_of
.RS 4
-Only consider nodes that are or aren\(cqt ancestors of the reference node\&.
+Only consider nodes that are ancestors of the reference node\&.
.RE
.PP
-[!](hidden|sticky|private|locked|urgent)
+[!](hidden|sticky|private|locked|marked|urgent)
.RS 4
-Only consider windows that have or don\(cqt have the given flag set\&.
+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
.RE
.SS "Desktop"
.RS 4
.\}
.nf
-DESKTOP_SEL := [DESKTOP_SEL#](CYCLE_DIR|last|older|newer|
+DESKTOP_SEL := [DESKTOP_SEL#](CYCLE_DIR|any|last|newest|older|newer|
[MONITOR_SEL:](focused|^<n>)|
- <desktop_id>|<desktop_name>)[\&.[!]occupied][\&.[!]focused][\&.[!]urgent][\&.[!]local]
+ <desktop_id>|<desktop_name>)[\&.[!]focused][\&.[!]active]
+ [\&.[!]occupied][\&.[!]urgent][\&.[!]local]
.fi
.if n \{\
.RE
Selects the desktop in the given direction relative to the reference desktop\&.
.RE
.PP
+any
+.RS 4
+Selects the first desktop that matches the given selectors\&.
+.RE
+.PP
last
.RS 4
Selects the previously focused desktop relative to the reference desktop\&.
.RE
.PP
+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\&.
\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 focused or unfocused desktops\&.
+Only consider desktops that are the focused desktop of their monitor\&.
+.RE
+.PP
+[!]occupied
+.RS 4
+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 desktops inside or outside of the reference monitor\&.
+Only consider desktops inside the reference monitor\&.
.RE
.RE
.SS "Monitor"
.RS 4
.\}
.nf
-MONITOR_SEL := [MONITOR_SEL#](DIR|CYCLE_DIR|last|older|newer|
+MONITOR_SEL := [MONITOR_SEL#](DIR|CYCLE_DIR|any|last|newest|older|newer|
focused|pointed|primary|^<n>|
- <monitor_id>|<monitor_name>)[\&.[!]occupied][\&.[!]focused]
+ <monitor_id>|<monitor_name>)[\&.[!]focused][\&.[!]occupied]
.fi
.if n \{\
.RE
Selects the monitor in the given (cyclic) direction relative to the reference monitor\&.
.RE
.PP
+any
+.RS 4
+Selects the first monitor that matches the given selectors\&.
+.RE
+.PP
last
.RS 4
Selects the previously focused monitor relative to the reference monitor\&.
.RE
.PP
+newest
+.RS 4
+Selects the newest monitor in the history of the focused monitors\&.
+.RE
+.PP
older
.RS 4
Selects the monitor older than the reference monitor in the history\&.
\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
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
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
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[=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
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\&.
+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
+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\&.
.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
\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)] [rectangle=WxH+X+Y]
+\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
Create a new rule\&.
.RE
.PP
\fIexternal_rules_command\fR
.RS 4
-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:
+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:
\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
+.PP
+\fIpresel_feedback\fR
+.RS 4
+Draw the preselection feedback area\&. Defaults to
+\fItrue\fR\&.
+.RE
+.PP
\fIborderless_monocle\fR
.RS 4
Remove borders of tiled windows for the
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
\fBbutton2\fR,
\fBbutton3\fR,
\fBany\fR,
-\fBnone\fR\&.
+\fBnone\fR\&. Defaults to
+\fBbutton1\fR\&.
.RE
.PP
\fIswallow_first_click\fR
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
+BIgnore 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
The state of a window changed\&.
.RE
.PP
-\fInode_flag <monitor_id> <desktop_id> <node_id> hidden|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
projects / bspwm.git / blobdiff