X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=doc%2Fbspwm.1;h=4a0681cc15aeeb87f76c5f4ebf9389daaf6abbd9;hb=40cd53a9ad87f13d403a47408423c60b17b05c9e;hp=b4f9fd1e90f10c9fc809237166b6cb05237f974e;hpb=12edac86fa3be32f799bedca4c8f5c0287a735b0;p=bspwm.git

diff --git a/doc/bspwm.1 b/doc/bspwm.1
index b4f9fd1..4a0681c 100644
--- a/doc/bspwm.1
+++ b/doc/bspwm.1
@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: bspwm
 .\"    Author: [see the "Author" section]
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 04/07/2016
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\"      Date: 01/30/2017
 .\"    Manual: Bspwm Manual
-.\"    Source: Bspwm 0.9.1-11-ge1b5f77
+.\"    Source: Bspwm 0.9.2-25-g048230e
 .\"  Language: English
 .\"
-.TH "BSPWM" "1" "04/07/2016" "Bspwm 0\&.9\&.1\-11\-ge1b5f77" "Bspwm Manual"
+.TH "BSPWM" "1" "01/30/2017" "Bspwm 0\&.9\&.2\-25\-g048230e" "Bspwm Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -73,19 +73,21 @@ CYCLE_DIR   := next | prev
 .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\&.
@@ -94,11 +96,11 @@ 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
 
@@ -120,12 +122,12 @@ JUMP := first|1|second|2|brother|parent|DIR
 .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
@@ -135,17 +137,17 @@ Selects the node at the given path\&.
 .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
@@ -153,9 +155,14 @@ 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>
@@ -172,7 +179,7 @@ Selects the node with the given 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
@@ -215,12 +222,23 @@ Only consider focused or unfocused nodes\&.
 .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
@@ -240,10 +258,20 @@ Only consider windows in or not in the given state\&.
 .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
+[!]ancestor_of
+.RS 4
+Only consider nodes that are or aren\(cqt ancestors of the reference node\&.
 .RE
 .PP
-[!](private|urgent|sticky|locked)
+[!](hidden|sticky|private|locked|urgent)
 .RS 4
 Only consider windows that have or don\(cqt have the given flag set\&.
 .RE
@@ -261,7 +289,7 @@ Select a desktop\&.
 .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
@@ -277,22 +305,22 @@ DESKTOP_SEL := (CYCLE_DIR|last|older|newer|[MONITOR_SEL:](focused|^<n>)|<desktop
 .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
@@ -341,7 +369,7 @@ Only consider urgent or non urgent desktops\&.
 .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"
@@ -352,7 +380,7 @@ Select a 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
@@ -368,27 +396,27 @@ MONITOR_SEL := (DIR|CYCLE_DIR|last|older|newer|focused|primary|^<n>|<monitor_id>
 .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
@@ -458,11 +486,9 @@ Fills its monitor rectangle and has no borders\&. It is send in the ABOVE layer
 .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
@@ -475,6 +501,13 @@ private
 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\&.
@@ -496,6 +529,8 @@ In each layer, the window are orderered as follow: tiled & pseudo\-tiled < fulls
 .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
@@ -544,7 +579,7 @@ is prepended to
 \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
@@ -570,7 +605,7 @@ pixels horizontally and
 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
@@ -609,7 +644,7 @@ Set the state of the selected window\&. If
 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
@@ -645,6 +680,8 @@ Kill 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
@@ -706,6 +743,8 @@ Remove the selected desktop\&.
 .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
@@ -721,6 +760,11 @@ monitor [\fIMONITOR_SEL\fR] \fICOMMANDS\fR
 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\&.
@@ -746,11 +790,6 @@ Set the rectangle of 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\&.
@@ -776,20 +815,22 @@ query \fICOMMANDS\fR [\fIOPTIONS\fR]
 .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
@@ -806,7 +847,7 @@ Print a JSON representation of the matching item\&.
 \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], \fB\-d\fR,\fB\-\-desktop\fR [\fIDESKTOP_SEL\fR], \fB\-n\fR, \fB\-\-node\fR [\fINODE_SEL\fR]
 .RS 4
 Constrain matches to the selected monitor, desktop or node\&. The descriptor can be omitted for
 \fI\-M\fR,
@@ -814,6 +855,11 @@ Constrain matches to the selected monitor, desktop or node\&. The descriptor can
 and
 \fI\-N\fR\&.
 .RE
+.PP
+\fB\-\-names\fR
+.RS 4
+Print names instead of IDs\&.
+.RE
 .RE
 .SS "Wm"
 .sp
@@ -887,7 +933,7 @@ rule \fICOMMANDS\fR
 \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)]
 .RS 4
 Create a new rule\&.
 .RE
@@ -912,9 +958,9 @@ List the rules\&.
 \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"
@@ -993,7 +1039,7 @@ Prefix prepended to each of the status lines\&.
 .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
@@ -1007,16 +1053,6 @@ On which child should a new window be attached when adding a window on a single
 \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
-.RS 4
-Base focusing on distances between windows\&.
-.RE
-.PP
 \fIborderless_monocle\fR
 .RS 4
 Remove borders of tiled windows for the
@@ -1045,6 +1081,11 @@ Set the desktop layout to
 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:
@@ -1058,11 +1099,31 @@ Keyboard modifier used for moving or resizing windows\&. Accept the following va
 \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
 Focus a window (or a monitor) by clicking it\&.
 .RE
 .PP
+\fIswallow_first_click\fR
+.RS 4
+Don\(cqt replay the click that makes a window focused when
+\fIclick_to_focus\fR
+is set\&.
+.RE
+.PP
 \fIfocus_follows_pointer\fR
 .RS 4
 Focus the window under the pointer\&.
@@ -1149,6 +1210,8 @@ Resize the window under the pointer by dragging the nearest side\&.
 .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
@@ -1276,7 +1339,7 @@ The geometry of a window changed\&.
 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
@@ -1285,6 +1348,11 @@ One of the flags of a node changed\&.
 .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"