Add node descriptor: `smallest`

[bspwm.git] / doc / bspwm.1

diff --git a/doc/bspwm.1 b/doc/bspwm.1
index ba2db7dfcde0d6fc26a4ffa43bdf48dd6fbc0f12..ca04ae63089d9caa4270c8c79761255eea2df7ba 100644 (file)
--- a/doc/bspwm.1
+++ b/doc/bspwm.1
@@ -2,12 +2,12 @@
 .\"     Title: bspwm
 .\"    Author: [see the "Author" section]
 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 03/07/2018
+.\"      Date: 06/19/2018
 .\"    Manual: Bspwm Manual
-.\"    Source: Bspwm 0.9.3-52-gf83f7ef
+.\"    Source: Bspwm 0.9.5-3-gdb5b0cd
 .\"  Language: English
 .\"
-.TH "BSPWM" "1" "03/07/2018" "Bspwm 0\&.9\&.3\-52\-gf83f7ef" "Bspwm Manual"
+.TH "BSPWM" "1" "06/19/2018" "Bspwm 0\&.9\&.5\-3\-gdb5b0cd" "Bspwm Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -100,11 +100,11 @@ Select a node\&.
 .RS 4
 .\}
 .nf
-NODE_SEL := [NODE_SEL#](DIR|CYCLE_DIR|PATH|last|newest|
-                        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][\&.[!]automatic][\&.[!]local][\&.[!]active]
+                                  [\&.[!]leaf][\&.[!]window][\&.[!]STATE][\&.[!]FLAG][\&.[!]LAYER]
+                                  [\&.[!]same_class][\&.[!]descendant_of][\&.[!]ancestor_of]
 
 STATE := tiled|pseudo_tiled|floating|fullscreen
 
@@ -143,6 +143,11 @@ Selects the window in the given (cyclic) direction relative to the reference nod
 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\&.
@@ -178,6 +183,11 @@ biggest
 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\&.
@@ -302,7 +312,7 @@ Select a desktop\&.
 .RS 4
 .\}
 .nf
-DESKTOP_SEL := [DESKTOP_SEL#](CYCLE_DIR|last|newest|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]
 .fi
@@ -323,6 +333,11 @@ DESKTOP_SEL := [DESKTOP_SEL#](CYCLE_DIR|last|newest|older|newer|
 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\&.
@@ -402,7 +417,7 @@ Select a monitor\&.
 .RS 4
 .\}
 .nf
-MONITOR_SEL := [MONITOR_SEL#](DIR|CYCLE_DIR|last|newest|older|newer|
+MONITOR_SEL := [MONITOR_SEL#](DIR|CYCLE_DIR|any|last|newest|older|newer|
                               focused|pointed|primary|^<n>|
                               <monitor_id>|<monitor_name>)[\&.[!]occupied][\&.[!]focused]
 .fi
@@ -428,6 +443,11 @@ Selects the monitor in the given (spacial) direction relative to the reference m
 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\&.
@@ -544,7 +564,7 @@ message\&.
 .PP
 marked
 .RS 4
-Is marked (useful for deferred operations)\&.
+Is marked (useful for deferred actions)\&. A marked node becomes unmarked after being sent on a preselected node\&.
 .RE
 .PP
 urgent
@@ -558,7 +578,7 @@ There\(cqs three stacking layers: BELOW, NORMAL and ABOVE\&.
 In each layer, the window are orderered as follow: tiled & pseudo\-tiled < fullscreen < floating\&.
 .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 and preselected\&. 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\&.
+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
@@ -1213,7 +1233,8 @@ Button used for focusing a window (or a monitor)\&. The possible values are:
 \fBbutton2\fR,
 \fBbutton3\fR,
 \fBany\fR,
-\fBnone\fR\&.
+\fBnone\fR\&. Defaults to
+\fBbutton1\fR\&.
 .RE
 .PP
 \fIswallow_first_click\fR
@@ -1239,11 +1260,27 @@ When focusing a window, put the pointer at its center\&.
 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
 \fIcenter_pseudo_tiled\fR
 .RS 4
 Center pseudo tiled windows into their tiling rectangles\&. Defaults to