X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=doc%2Fbspwm.1;h=b1a69a5a8809c0513b0ccc7961538e5e77c33398;hb=196610445cf33a49fb7353b645bef5f723a5dbc5;hp=b28085999190e6f95d7e300d26f81f6424366a3f;hpb=319566e4af405488a6e3ae668a5a5b82b474b649;p=bspwm.git

diff --git a/doc/bspwm.1 b/doc/bspwm.1
index b280859..b1a69a5 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: 05/20/2016
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\"      Date: 07/24/2017
 .\"    Manual: Bspwm Manual
-.\"    Source: Bspwm 0.9.1-75-g666af89
+.\"    Source: Bspwm 0.9.3-10-g9ea4b01
 .\"  Language: English
 .\"
-.TH "BSPWM" "1" "05/20/2016" "Bspwm 0\&.9\&.1\-75\-g666af89" "Bspwm Manual"
+.TH "BSPWM" "1" "07/24/2017" "Bspwm 0\&.9\&.3\-10\-g9ea4b01" "Bspwm Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -96,7 +96,7 @@ Select a node\&.
 .RS 4
 .\}
 .nf
-NODE_SEL := [NODE_SEL#](DIR|CYCLE_DIR|PATH|last|older|newer|focused|pointed|biggest|<node_id>)[\&.[!]focused][\&.[!]automatic][\&.[!]local][\&.[!]leaf][\&.[!]window][\&.[!]STATE][\&.[!]FLAG][\&.[!]LAYER][\&.[!]same_class][\&.[!]descendant_of][\&.[!]ancestor_of]
+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
 
@@ -222,7 +222,13 @@ 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
@@ -230,6 +236,11 @@ Only consider nodes in automatic or manual insertion mode\&.
 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
 .RS 4
 Only consider leaves or internal nodes\&.
@@ -358,7 +369,7 @@ Only consider urgent or non urgent desktops\&.
 .PP
 [!]local
 .RS 4
-Only consider inside or outside of the reference monitor\&.
+Only consider desktops inside or outside of the reference monitor\&.
 .RE
 .RE
 .SS "Monitor"
@@ -568,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
@@ -594,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
@@ -814,12 +825,12 @@ List the IDs of the matching nodes\&.
 .PP
 \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 [\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
@@ -844,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
@@ -917,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] [(hidden|sticky|private|locked|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
@@ -942,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"
@@ -957,11 +973,34 @@ Get or set the value of <key>\&.
 \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"
@@ -1023,7 +1062,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
@@ -1037,6 +1076,15 @@ On which child should a new window be attached when adding a window on a single
 \fBsecond_child\fR\&.
 .RE
 .PP
+\fIdirectional_focus_tightness\fR
+.RS 4
+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
 .RS 4
 Remove borders of tiled windows for the
@@ -1065,6 +1113,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:
@@ -1087,12 +1140,26 @@ Action performed when pressing
 \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
@@ -1160,11 +1227,10 @@ Window border width\&.
 .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
@@ -1260,14 +1326,14 @@ A desktop is activated\&.
 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
@@ -1319,6 +1385,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"