]> git.lizzy.rs Git - bspwm.git/blobdiff - doc/bspwm.1
Don't change the client's layer in set_fullscreen
[bspwm.git] / doc / bspwm.1
index 8dbaf75053994b111de9507948e32f6b62de97f2..068fba5ce97f008598ee151ee55ff87908fd7e3e 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: bspwm
 .\"    Author: [see the "Author" section]
 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 04/08/2018
+.\"      Date: 01/06/2019
 .\"    Manual: Bspwm Manual
-.\"    Source: Bspwm 0.9.5
+.\"    Source: Bspwm 0.9.5-27-g2c2faeb
 .\"  Language: English
 .\"
-.TH "BSPWM" "1" "04/08/2018" "Bspwm 0\&.9\&.5" "Bspwm Manual"
+.TH "BSPWM" "1" "01/06/2019" "Bspwm 0\&.9\&.5\-27\-g2c2faeb" "Bspwm Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -101,10 +101,10 @@ Select a node\&.
 .\}
 .nf
 NODE_SEL := [NODE_SEL#](DIR|CYCLE_DIR|PATH|any|last|newest|
-                        older|newer|focused|pointed|
-                        biggest|<node_id>)[\&.[!]focused][\&.[!]automatic][\&.[!]local][\&.[!]active]
-                                          [\&.[!]leaf][\&.[!]window][\&.[!]STATE][\&.[!]FLAG][\&.[!]LAYER]
-                                          [\&.[!]same_class][\&.[!]descendant_of][\&.[!]ancestor_of]
+                        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
 
@@ -183,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\&.
@@ -235,12 +240,17 @@ Jumps to the node holding the edge in the given direction\&.
 .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
@@ -251,52 +261,47 @@ section below\&.
 .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|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"
@@ -309,7 +314,8 @@ Select a desktop\&.
 .nf
 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
@@ -384,24 +390,29 @@ Selects the desktop with the given name\&.
 \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"
@@ -414,7 +425,7 @@ Select a monitor\&.
 .nf
 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
@@ -502,14 +513,14 @@ Selects the monitor with the given name\&.
 \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"
@@ -570,10 +581,10 @@ 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 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
@@ -1146,6 +1157,14 @@ External command used to retrieve rule consequences\&. The command will receive
 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:
@@ -1162,6 +1181,11 @@ side of another window\&. 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
 \fIborderless_monocle\fR
 .RS 4
 Remove borders of tiled windows for the
@@ -1176,9 +1200,9 @@ Remove gaps 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