X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=doc%2Fbspwm.1;h=ca04ae63089d9caa4270c8c79761255eea2df7ba;hb=336095739e2de94109e55e544c806770316c822c;hp=e63a7ffde102c688dc6f22e3e8f62b807a4d511c;hpb=ed76b1f8a7c557f3b17dc128116e3a9e604362f7;p=bspwm.git diff --git a/doc/bspwm.1 b/doc/bspwm.1 index e63a7ff..ca04ae6 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 -.\" Date: 02/22/2016 +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 06/19/2018 .\" Manual: Bspwm Manual -.\" Source: Bspwm 0.9-130-g21f92ab +.\" Source: Bspwm 0.9.5-3-gdb5b0cd .\" Language: English .\" -.TH "BSPWM" "1" "02/22/2016" "Bspwm 0\&.9\-130\-g21f92ab" "Bspwm Manual" +.TH "BSPWM" "1" "06/19/2018" "Bspwm 0\&.9\&.5\-3\-gdb5b0cd" "Bspwm Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -34,6 +34,8 @@ bspwm \- Binary space partitioning window manager \fBbspwm\fR [\fB\-h\fR|\fB\-v\fR|\fB\-c\fR \fICONFIG_PATH\fR] .sp \fBbspc\fR \fIDOMAIN\fR [\fISELECTOR\fR] \fICOMMANDS\fR +.sp +\fBbspc\fR \fICOMMAND\fR [\fIOPTIONS\fR] [\fIARGUMENTS\fR] .SH "DESCRIPTION" .sp \fBbspwm\fR is a tiling window manager that represents windows as the leaves of a full binary tree\&. @@ -71,19 +73,25 @@ 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\&. +.sp +The following characters cannot be used in monitor or desktop names: \fB#\fR, \fB:\fR, \fB\&.\fR\&. +.sp +The special selector \fB%\fR can be used to select a monitor or a desktop with an invalid name\&. .SS "Node" .sp Select a node\&. @@ -92,11 +100,15 @@ Select a node\&. .RS 4 .\} .nf -NODE_SEL := (|PATH|DIR|CYCLE_DIR|last|older|newer|biggest|focused)[\&.[!]focused][\&.[!]automatic][\&.[!]local][\&.[!]leaf][\&.[!]STATE][\&.[!]FLAG][\&.[!]LAYER][\&.[!]same_class] +NODE_SEL := [NODE_SEL#](DIR|CYCLE_DIR|PATH|any|last|newest| + older|newer|focused|pointed|biggest|smallest + )[\&.[!]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|marked|urgent LAYER := below|normal|above @@ -116,9 +128,14 @@ JUMP := first|1|second|2|brother|parent|DIR \fBDescriptors\fR .RS 4 .PP - +\fIDIR\fR .RS 4 -Selects the node with the given ID\&. +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 relative to the reference node\&. .RE .PP \fIPATH\fR @@ -126,24 +143,29 @@ Selects the node with the given ID\&. Selects the node at the given path\&. .RE .PP -\fIDIR\fR +any .RS 4 -Selects the window in the given (spacial) direction relative to the active node\&. +Selects the first node that matches the given selectors\&. .RE .PP -\fICYCLE_DIR\fR +last .RS 4 -Selects the window in the given (cyclic) direction\&. +Selects the previously focused node relative to the reference node\&. .RE .PP -biggest +newest .RS 4 -Selects the biggest window on the current desktop\&. +Selects the newest node in the history of the focused node\&. .RE .PP -last +older +.RS 4 +Selects the node older than the reference node in the history\&. +.RE +.PP +newer .RS 4 -Selects the previously focused node\&. +Selects the node newer than the reference node in the history\&. .RE .PP focused @@ -151,14 +173,24 @@ focused Selects the currently focused node\&. .RE .PP -older +pointed .RS 4 -Selects the node older than the focused node in the history\&. +Selects the window under the pointer\&. .RE .PP -newer +biggest +.RS 4 +Selects the biggest window\&. +.RE +.PP +smallest +.RS 4 +Selects the smallest window\&. +.RE +.PP + .RS 4 -Selects the node newer than the focused node in the history\&. +Selects the node with the given ID\&. .RE .RE .sp @@ -170,7 +202,7 @@ Selects the node newer than the focused node in the history\&. \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 @@ -213,12 +245,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 @@ -226,6 +269,11 @@ Only consider nodes in or not in the current desktop\&. Only consider leaves or internal nodes\&. .RE .PP +[!]window +.RS 4 +Only consider nodes that hold or don\(cqt hold a window\&. +.RE +.PP [!](tiled|pseudo_tiled|floating|fullscreen) .RS 4 Only consider windows in or not in the given state\&. @@ -233,10 +281,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|marked|urgent) .RS 4 Only consider windows that have or don\(cqt have the given flag set\&. .RE @@ -254,7 +312,9 @@ Select a desktop\&. .RS 4 .\} .nf -DESKTOP_SEL := (|[MONITOR_SEL:](focused|^)CYCLE_DIR|last|older|newer)[\&.[!]occupied][\&.[!]focused][\&.[!]urgent][\&.[!]local] +DESKTOP_SEL := [DESKTOP_SEL#](CYCLE_DIR|any|last|newest|older|newer| + [MONITOR_SEL:](focused|^)| + |)[\&.[!]occupied][\&.[!]focused][\&.[!]urgent][\&.[!]local] .fi .if n \{\ .RE @@ -268,24 +328,34 @@ DESKTOP_SEL := (|[MONITOR_SEL:](focused|^)CYCLE_DIR|last|older| \fBDescriptors\fR .RS 4 .PP - +\fICYCLE_DIR\fR .RS 4 -Selects the desktop with the given name\&. +Selects the desktop in the given direction relative to the reference desktop\&. .RE .PP -^ +any .RS 4 -Selects the nth desktop\&. +Selects the first desktop that matches the given selectors\&. .RE .PP -\fICYCLE_DIR\fR +last .RS 4 -Selects the desktop in the given direction relative to the active desktop\&. +Selects the previously focused desktop relative to the reference desktop\&. .RE .PP -last +newest +.RS 4 +Selects the newest desktop in the history of the focused desktops\&. +.RE +.PP +older .RS 4 -Selects the previously focused desktop\&. +Selects the desktop older than the reference desktop in the history\&. +.RE +.PP +newer +.RS 4 +Selects the desktop newer than the reference desktop in the history\&. .RE .PP focused @@ -293,14 +363,21 @@ focused Selects the currently focused desktop\&. .RE .PP -older +^ .RS 4 -Selects the desktop older than the focused desktop in the history\&. +Selects the nth desktop\&. If +\fBMONITOR_SEL\fR +is given, selects the nth desktop on the selected monitor\&. .RE .PP -newer + .RS 4 -Selects the desktop newer than the focused desktop in the history\&. +Selects the desktop with the given ID\&. +.RE +.PP + +.RS 4 +Selects the desktop with the given name\&. .RE .RE .sp @@ -329,7 +406,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" @@ -340,7 +417,9 @@ Select a monitor\&. .RS 4 .\} .nf -MONITOR_SEL := (|^|DIR|CYCLE_DIR|last|primary|focused|older|newer)[\&.[!]occupied][\&.[!]focused] +MONITOR_SEL := [MONITOR_SEL#](DIR|CYCLE_DIR|any|last|newest|older|newer| + focused|pointed|primary|^| + |)[\&.[!]occupied][\&.[!]focused] .fi .if n \{\ .RE @@ -354,34 +433,39 @@ MONITOR_SEL := (|^|DIR|CYCLE_DIR|last|primary|focused|older|new \fBDescriptors\fR .RS 4 .PP - +\fIDIR\fR .RS 4 -Selects the monitor with the given name\&. +Selects the monitor in the given (spacial) direction relative to the reference monitor\&. .RE .PP -^ +\fICYCLE_DIR\fR .RS 4 -Selects the nth monitor\&. +Selects the monitor in the given (cyclic) direction relative to the reference monitor\&. .RE .PP -\fIDIR\fR +any .RS 4 -Selects the monitor in the given (spacial) direction relative to the active monitor\&. +Selects the first monitor that matches the given selectors\&. .RE .PP -\fICYCLE_DIR\fR +last .RS 4 -Selects the monitor in the given (cyclic) direction relative to the active monitor\&. +Selects the previously focused monitor relative to the reference monitor\&. .RE .PP -primary +newest .RS 4 -Selects the primary monitor\&. +Selects the newest monitor in the history of the focused monitors\&. .RE .PP -last +older +.RS 4 +Selects the monitor older than the reference monitor in the history\&. +.RE +.PP +newer .RS 4 -Selects the previously focused monitor\&. +Selects the monitor newer than the reference monitor in the history\&. .RE .PP focused @@ -389,14 +473,29 @@ focused Selects the currently focused monitor\&. .RE .PP -older +pointed .RS 4 -Selects the monitor older than the focused monitor in the history\&. +Selects the monitor under the pointer\&. .RE .PP -newer +primary +.RS 4 +Selects the primary monitor\&. +.RE +.PP +^ +.RS 4 +Selects the nth monitor\&. +.RE +.PP + +.RS 4 +Selects the monitor with the given ID\&. +.RE +.PP + .RS 4 -Selects the monitor newer than the focused monitor in the history\&. +Selects the monitor with the given name\&. .RE .RE .sp @@ -441,11 +540,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 @@ -458,6 +555,18 @@ private Tries to keep the same tiling position/size\&. .RE .PP +locked +.RS 4 +Ignores the +\fBnode \-\-close\fR +message\&. +.RE +.PP +marked +.RS 4 +Is marked (useful for deferred actions)\&. A marked node becomes unmarked after being sent on a preselected node\&. +.RE +.PP urgent .RS 4 Has its urgency hint set\&. This flag is set externally\&. @@ -467,6 +576,9 @@ Has its urgency hint set\&. This flag is set externally\&. There\(cqs three stacking layers: BELOW, NORMAL and ABOVE\&. .sp 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, 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 @@ -479,6 +591,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 @@ -499,24 +613,32 @@ Focus the selected or given node\&. Activate the selected or given node\&. .RE .PP -\fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR +\fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR [\fB\-\-follow\fR] .RS 4 -Send the selected node to the given desktop\&. +Send the selected node to the given desktop\&. If +\fB\-\-follow\fR +is passed, the focused node will stay focused\&. .RE .PP -\fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR +\fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR [\fB\-\-follow\fR] .RS 4 -Send the selected node to the given monitor\&. +Send the selected node to the given monitor\&. If +\fB\-\-follow\fR +is passed, the focused node will stay focused\&. .RE .PP -\fB\-n\fR, \fB\-\-to\-node\fR \fINODE_SEL\fR +\fB\-n\fR, \fB\-\-to\-node\fR \fINODE_SEL\fR [\fB\-\-follow\fR] .RS 4 -Transplant the selected node to the given node\&. +Send the selected node on the given node\&. If +\fB\-\-follow\fR +is passed, the focused node will stay focused\&. .RE .PP -\fB\-s\fR, \fB\-\-swap\fR \fINODE_SEL\fR +\fB\-s\fR, \fB\-\-swap\fR \fINODE_SEL\fR [\fB\-\-follow\fR] .RS 4 -Swap the selected node with the given node\&. +Swap the selected node with the given node\&. If +\fB\-\-follow\fR +is passed, the focused node will stay focused\&. .RE .PP \fB\-p\fR, \fB\-\-presel\-dir\fR [~]\fIDIR\fR|cancel @@ -527,7 +649,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 @@ -535,7 +657,25 @@ and the current preselection direction matches Set the splitting ratio of the preselection area\&. .RE .PP -\fB\-r\fR, \fB\-\-ratio\fR \fIRATIO\fR|(+|\-)\fIPIXELS\fR +\fB\-v\fR, \fB\-\-move\fR \fIdx\fR \fIdy\fR +.RS 4 +Move the selected window by +\fIdx\fR +pixels horizontally and +\fIdy\fR +pixels vertically\&. +.RE +.PP +\fB\-z\fR, \fB\-\-resize\fR top|left|bottom|right|top_left|top_right|bottom_right|bottom_left \fIdx\fR \fIdy\fR +.RS 4 +Resize the selected window by moving the given handle by +\fIdx\fR +pixels horizontally and +\fIdy\fR +pixels vertically\&. +.RE +.PP +\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 @@ -574,7 +714,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|marked[=on|off] .RS 4 Set or toggle the given flag for the selected node\&. .RE @@ -584,6 +724,11 @@ Set or toggle the given flag for the selected node\&. Set the stacking layer of the selected window\&. .RE .PP +\fB\-i\fR, \fB\-\-insert\-receptacle\fR +.RS 4 +Insert a receptacle node at the selected node\&. +.RE +.PP \fB\-c\fR, \fB\-\-close\fR .RS 4 Close the windows rooted at the selected node\&. @@ -605,6 +750,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 @@ -625,9 +772,18 @@ Focus the selected or given desktop\&. Activate the selected or given desktop\&. .RE .PP -\fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR +\fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR [\fB\-\-follow\fR] +.RS 4 +Send the selected desktop to the given monitor\&. If +\fB\-\-follow\fR +is passed, the focused desktop will stay focused\&. +.RE +.PP +\fB\-s\fR, \fB\-\-swap\fR \fIDESKTOP_SEL\fR [\fB\-\-follow\fR] .RS 4 -Send the selected desktop to the given monitor\&. +Swap the selected desktop with the given desktop\&. If +\fB\-\-follow\fR +is passed, the focused desktop will stay focused\&. .RE .PP \fB\-l\fR, \fB\-\-layout\fR \fICYCLE_DIR\fR|monocle|tiled @@ -640,11 +796,6 @@ Set or cycle the layout of the selected desktop\&. Rename the selected desktop\&. .RE .PP -\fB\-s\fR, \fB\-\-swap\fR \fIDESKTOP_SEL\fR -.RS 4 -Swap the selected desktop with the given desktop\&. -.RE -.PP \fB\-b\fR, \fB\-\-bubble\fR \fICYCLE_DIR\fR .RS 4 Bubble the selected desktop in the given direction\&. @@ -666,6 +817,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 @@ -681,14 +834,14 @@ monitor [\fIMONITOR_SEL\fR] \fICOMMANDS\fR Focus the selected or given monitor\&. .RE .PP -\fB\-a\fR, \fB\-\-add\-desktops\fR \&... +\fB\-s\fR, \fB\-\-swap\fR \fIMONITOR_SEL\fR .RS 4 -Create desktops with the given names in the selected monitor\&. +Swap the selected monitor with the given monitor\&. .RE .PP -\fB\-r\fR, \fB\-\-remove\-desktops\fR \&... +\fB\-a\fR, \fB\-\-add\-desktops\fR \&... .RS 4 -Remove desktops with the given names\&. +Create desktops with the given names in the selected monitor\&. .RE .PP \fB\-o\fR, \fB\-\-reorder\-desktops\fR \&... @@ -698,7 +851,7 @@ Reorder the desktops of the selected monitor to match the given order\&. .PP \fB\-d\fR, \fB\-\-reset\-desktops\fR \&... .RS 4 -Rename, add or remove desktops depending on whether the number of given names is equal, superior or inferior to the number of existing desktops\&. Incidentally reset the settings of the existing desktops\&. +Rename, add or remove desktops depending on whether the number of given names is equal, superior or inferior to the number of existing desktops\&. .RE .PP \fB\-g\fR, \fB\-\-rectangle\fR WxH+X+Y @@ -711,9 +864,9 @@ Set the rectangle of the selected monitor\&. Rename the selected monitor\&. .RE .PP -\fB\-s\fR, \fB\-\-swap\fR \fIMONITOR_SEL\fR +\fB\-r\fR, \fB\-\-remove\fR .RS 4 -Swap the selected monitor with the given monitor\&. +Remove the selected monitor\&. .RE .RE .SS "Query" @@ -736,20 +889,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 names 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 names of the matching monitors\&. +List the IDs (or names) of the matching monitors\&. .RE .PP \fB\-T\fR, \fB\-\-tree\fR @@ -766,7 +921,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, @@ -774,6 +929,14 @@ 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\&. Can only be used with +\fI\-M\fR +and +\fI\-D\fR\&. +.RE .RE .SS "Wm" .sp @@ -811,9 +974,9 @@ Load a world state from the given file\&. Add a monitor for the given name and rectangle\&. .RE .PP -\fB\-r\fR, \fB\-\-remove\-monitor\fR +\fB\-O\fR, \fB\-\-reorder\-monitors\fR \&... .RS 4 -Remove the monitor with the given name\&. +Reorder the list of monitors to match the given order\&. .RE .PP \fB\-o\fR, \fB\-\-adopt\-orphans\fR @@ -831,7 +994,7 @@ Enable or disable the recording of node focus history\&. Print the current status information\&. .RE .RE -.SS "Pointer" +.SS "Rule" .sp .it 1 an-trap .nr an-no-space-flag 1 @@ -841,7 +1004,7 @@ Print the current status information\&. \fBGeneral Syntax\fR .RS 4 .sp -pointer \fICOMMANDS\fR +rule \fICOMMANDS\fR .RE .sp .it 1 an-trap @@ -852,22 +1015,22 @@ pointer \fICOMMANDS\fR \fBCommands\fR .RS 4 .PP -\fB\-g\fR, \fB\-\-grab\fR focus|move|resize_side|resize_corner +\fB\-a\fR, \fB\-\-add\fR (|*)[:(|*)] [\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|marked|center|follow|manage|focus|border)=(on|off)] [rectangle=WxH+X+Y] .RS 4 -Initiate the given pointer action\&. +Create a new rule\&. .RE .PP -\fB\-t\fR, \fB\-\-track\fR +\fB\-r\fR, \fB\-\-remove\fR ^|head|tail|(|*)[:(|*)]\&... .RS 4 -Pass the pointer root coordinates for the current pointer action\&. +Remove the given rules\&. .RE .PP -\fB\-u\fR, \fB\-\-ungrab\fR +\fB\-l\fR, \fB\-\-list\fR .RS 4 -Terminate the current pointer action\&. +List the rules\&. .RE .RE -.SS "Rule" +.SS "Config" .sp .it 1 an-trap .nr an-no-space-flag 1 @@ -876,34 +1039,13 @@ Terminate the current pointer action\&. .ps +1 \fBGeneral Syntax\fR .RS 4 -.sp -rule \fICOMMANDS\fR -.RE -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.ps +1 -\fBCommands\fR -.RS 4 .PP -\fB\-a\fR, \fB\-\-add\fR (|*)[:(|*)] [\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)] +config [\-m \fIMONITOR_SEL\fR|\-d \fIDESKTOP_SEL\fR|\-n \fINODE_SEL\fR] [] .RS 4 -Create a new rule\&. -.RE -.PP -\fB\-r\fR, \fB\-\-remove\fR ^|head|tail|(|*)[:(|*)]\&... -.RS 4 -Remove the given rules\&. -.RE -.PP -\fB\-l\fR, \fB\-\-list\fR -.RS 4 -List the rules\&. +Get or set the value of \&. .RE .RE -.SS "Config" +.SS "Subscribe" .sp .it 1 an-trap .nr an-no-space-flag 1 @@ -913,26 +1055,34 @@ List the rules\&. \fBGeneral Syntax\fR .RS 4 .PP -config [\-m \fIMONITOR_SEL\fR|\-d \fIDESKTOP_SEL\fR|\-n \fINODE_SEL\fR] [] +subscribe [\fIOPTIONS\fR] (all|report|monitor|desktop|node|\&...)* .RS 4 -Get or set the value of \&. +Continuously print events\&. See the +\fBEVENTS\fR +section for the description of each event\&. .RE .RE -.SS "Subscribe" .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 -\fBGeneral Syntax\fR +\fBOptions\fR .RS 4 .PP -subscribe (all|report|monitor|desktop|node|\&...)* +\fB\-f\fR, \fB\-\-fifo\fR .RS 4 -Continuously print status information\&. See the -\fBEVENTS\fR -section for the detailed description of each event\&. +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" @@ -952,22 +1102,7 @@ Quit with an optional exit status\&. .RE .SH "EXIT CODES" .sp -If the server can\(cqt handle a message, \fBbspc\fR will return with one of the following exit codes: -.PP -1 -.RS 4 -Failure\&. -.RE -.PP -2 -.RS 4 -Syntax error\&. -.RE -.PP -3 -.RS 4 -Unknown command\&. -.RE +If the server can\(cqt handle a message, \fBbspc\fR will return with a non\-zero exit code\&. .SH "SETTINGS" .sp Colors are in the form \fI#RRGGBB\fR, booleans are \fItrue\fR, \fIon\fR, \fIfalse\fR or \fIoff\fR\&. @@ -1009,7 +1144,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 name, instance name, and intermediate consequences\&. 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 @@ -1023,14 +1158,13 @@ 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 +\fIdirectional_focus_tightness\fR .RS 4 -Base focusing on distances between windows\&. +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 @@ -1061,6 +1195,56 @@ 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: +\fBshift\fR, +\fBcontrol\fR, +\fBlock\fR, +\fBmod1\fR, +\fBmod2\fR, +\fBmod3\fR, +\fBmod4\fR, +\fBmod5\fR\&. +.RE +.PP +\fIpointer_action1\fR, \fIpointer_action2\fR, \fIpointer_action3\fR +.RS 4 +Action performed when pressing +\fIpointer_modifier\fR ++ +\fIbutton\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 +Button used for focusing a window (or a monitor)\&. The possible values are: +\fBbutton1\fR, +\fBbutton2\fR, +\fBbutton3\fR, +\fBany\fR, +\fBnone\fR\&. Defaults to +\fBbutton1\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 .RS 4 Focus the window under the pointer\&. @@ -1076,17 +1260,38 @@ 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 \fItrue\fR\&. .RE .PP +\fIhonor_size_hints\fR +.RS 4 +Apply ICCCM window size hints\&. +.RE +.PP \fIremove_disabled_monitors\fR .RS 4 Consider disabled monitors as disconnected\&. @@ -1107,18 +1312,42 @@ Merge overlapping monitors (the bigger remains)\&. .RS 4 Padding space added at the sides of the monitor or desktop\&. .RE -.SS "Default, Desktop Default and Window Settings" +.SS "Desktop Settings" +.PP +\fIwindow_gap\fR +.RS 4 +Size of the gap that separates windows\&. +.RE +.SS "Node Settings" .PP \fIborder_width\fR .RS 4 Window border width\&. .RE -.SS "Default and Desktop Settings" +.SH "POINTER BINDINGS" .PP -\fIwindow_gap\fR +\fIclick_to_focus\fR .RS 4 -Size of the gap that separates windows\&. +Focus the window (or the monitor) under the pointer if the value isn\(cqt +\fBnone\fR\&. +.RE +.PP +\fIpointer_modifier\fR + \fIbutton1\fR +.RS 4 +Move the window under the pointer\&. +.RE +.PP +\fIpointer_modifier\fR + \fIbutton2\fR +.RS 4 +Resize the window under the pointer by dragging the nearest side\&. .RE +.PP +\fIpointer_modifier\fR + \fIbutton3\fR +.RS 4 +Resize the window under the pointer by dragging the nearest corner\&. +.RE +.sp +The behavior of \fIpointer_modifier\fR + \fIbutton\fR can be modified through the \fIpointer_action\fR setting\&. .SH "EVENTS" .PP \fIreport\fR @@ -1126,107 +1355,107 @@ Size of the gap that separates windows\&. See the next section for the description of the format\&. .RE .PP -\fImonitor_add \fR +\fImonitor_add \fR .RS 4 A monitor is added\&. .RE .PP -\fImonitor_rename \fR +\fImonitor_rename \fR .RS 4 A monitor is renamed\&. .RE .PP -\fImonitor_remove \fR +\fImonitor_remove \fR .RS 4 A monitor is removed\&. .RE .PP -\fImonitor_swap \fR +\fImonitor_swap \fR .RS 4 A monitor is swapped\&. .RE .PP -\fImonitor_focus \fR +\fImonitor_focus \fR .RS 4 A monitor is focused\&. .RE .PP -\fImonitor_geometry \fR +\fImonitor_geometry \fR .RS 4 The geometry of a monitor changed\&. .RE .PP -\fIdesktop_add \fR +\fIdesktop_add \fR .RS 4 A desktop is added\&. .RE .PP -\fIdesktop_rename \fR +\fIdesktop_rename \fR .RS 4 A desktop is renamed\&. .RE .PP -\fIdesktop_remove \fR +\fIdesktop_remove \fR .RS 4 A desktop is removed\&. .RE .PP -\fIdesktop_swap \fR +\fIdesktop_swap \fR .RS 4 A desktop is swapped\&. .RE .PP -\fIdesktop_transfer \fR +\fIdesktop_transfer \fR .RS 4 A desktop is transferred\&. .RE .PP -\fIdesktop_focus \fR +\fIdesktop_focus \fR .RS 4 A desktop is focused\&. .RE .PP -\fIdesktop_activate \fR +\fIdesktop_activate \fR .RS 4 A desktop is activated\&. .RE .PP -\fIdesktop_layout tiled|monocle\fR +\fIdesktop_layout tiled|monocle\fR .RS 4 The layout of a desktop changed\&. .RE .PP -\fInode_manage \fR +\fInode_add \fR .RS 4 -A window is managed\&. +A node is added\&. .RE .PP -\fInode_unmanage \fR +\fInode_remove \fR .RS 4 -A window is unmanaged\&. +A node is removed\&. .RE .PP -\fInode_swap \fR +\fInode_swap \fR .RS 4 A node is swapped\&. .RE .PP -\fInode_transfer \fR +\fInode_transfer \fR .RS 4 A node is transferred\&. .RE .PP -\fInode_focus \fR +\fInode_focus \fR .RS 4 A node is focused\&. .RE .PP -\fInode_activate \fR +\fInode_activate \fR .RS 4 A node is activated\&. .RE .PP -\fInode_presel (dir DIR|ratio RATIO|cancel)\fR +\fInode_presel (dir DIR|ratio RATIO|cancel)\fR .RS 4 A node is preselected\&. .RE @@ -1236,25 +1465,30 @@ A node is preselected\&. A node is stacked below or above another node\&. .RE .PP -\fInode_geometry \fR +\fInode_geometry \fR .RS 4 The geometry of a window changed\&. .RE .PP -\fInode_state tiled|pseudo_tiled|floating|fullscreen on|off\fR +\fInode_state tiled|pseudo_tiled|floating|fullscreen on|off\fR .RS 4 The state of a window changed\&. .RE .PP -\fInode_flag sticky|private|locked|urgent on|off\fR +\fInode_flag hidden|sticky|private|locked|marked|urgent on|off\fR .RS 4 One of the flags of a node changed\&. .RE .PP -\fInode_layer below|normal|above\fR +\fInode_layer below|normal|above\fR .RS 4 The layer of a window changed\&. .RE +.PP +\fIpointer_action 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"