Rename node_{manage,unmanage} to node_{add,remove}

[bspwm.git] / doc / bspwm.1

diff --git a/doc/bspwm.1 b/doc/bspwm.1
index 1c36f70d3e363aca2967265a7e717063ce7ec4b0..b1a69a5a8809c0513b0ccc7961538e5e77c33398 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: 11/17/2016
+.\"      Date: 07/24/2017
 .\"    Manual: Bspwm Manual
-.\"    Source: Bspwm 0.9.2-9-g201f6e6
+.\"    Source: Bspwm 0.9.3-10-g9ea4b01
 .\"  Language: English
 .\"
-.TH "BSPWM" "1" "11/17/2016" "Bspwm 0\&.9\&.2\-9\-g201f6e6" "Bspwm Manual"
+.TH "BSPWM" "1" "07/24/2017" "Bspwm 0\&.9\&.3\-10\-g9ea4b01" "Bspwm Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -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
@@ -573,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
@@ -599,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
@@ -927,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
@@ -967,11 +973,34 @@ Get or set the value of <setting>\&.
 \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"
@@ -1047,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
@@ -1108,14 +1146,20 @@ Action performed when pressing
 .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 when
+Don\(cqt replay the click that makes a window focused if
 \fIclick_to_focus\fR
-is set\&.
+isn\(cqt
+\fBnone\fR\&.
 .RE
 .PP
 \fIfocus_follows_pointer\fR
@@ -1183,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
@@ -1283,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