X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=doc%2Fbspwm.1;h=ca04ae63089d9caa4270c8c79761255eea2df7ba;hb=336095739e2de94109e55e544c806770316c822c;hp=cee3823d101da64cab69ae588769f6e79222f71b;hpb=d3166dd399fe0fece83a2b01de50587ca7d7e26f;p=bspwm.git diff --git a/doc/bspwm.1 b/doc/bspwm.1 index cee3823..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: 11/26/2015 +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 06/19/2018 .\" Manual: Bspwm Manual -.\" Source: Bspwm 0.9 +.\" Source: Bspwm 0.9.5-3-gdb5b0cd .\" Language: English .\" -.TH "BSPWM" "1" "11/26/2015" "Bspwm 0\&.9" "Bspwm Manual" +.TH "BSPWM" "1" "06/19/2018" "Bspwm 0\&.9\&.5\-3\-gdb5b0cd" "Bspwm Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,7 +33,9 @@ bspwm \- Binary space partitioning window manager .sp \fBbspwm\fR [\fB\-h\fR|\fB\-v\fR|\fB\-c\fR \fICONFIG_PATH\fR] .sp -\fBbspc\fR \fICOMMAND\fR [\fIARGUMENTS\fR] +\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\&. @@ -61,7 +63,7 @@ Use the given configuration file\&. .RS 4 .\} .nf -DIR := left | right | up | down +DIR := north | west | south | east CYCLE_DIR := next | prev .fi .if n \{\ @@ -69,32 +71,50 @@ CYCLE_DIR := next | prev .\} .SH "SELECTORS" .sp -Selectors are used to select a target window, desktop, or monitor\&. A selector can either describe the target relatively or name it globally\&. +Selectors are used to select a target node, desktop, or monitor\&. A selector can either describe the target relatively or name it globally\&. .sp -Descriptive (relative) selectors consist of a primary selector 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 -PRIMARY_SELECTOR[\&.MODIFIER]* +[REFERENCE#]DESCRIPTOR(\&.MODIFIER)* .fi .if n \{\ .RE .\} .sp -For obvious reasons, neither desktop nor monitor names may be valid descriptive selectors\&. +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 -An exclamation mark can be prepended to certain modifiers in order to reverse their meaning\&. -.SS "Window" +The following characters cannot be used in monitor or desktop names: \fB#\fR, \fB:\fR, \fB\&.\fR\&. .sp -Select a window\&. +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\&. .sp .if n \{\ .RS 4 .\} .nf -WINDOW_SEL := (|DIR|CYCLE_DIR|biggest|last|focused|older|newer)[\&.[!]automatic][\&.[!](tiled|pseudo_tiled|floating|fullscreen)][\&.[!](below|normal|above)][\&.[!]local][\&.[!]same_class][\&.[!]focused][\&.[!](urgent|sticky|private|locked)] +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 := hidden|sticky|private|locked|marked|urgent + +LAYER := below|normal|above + +PATH := @[DESKTOP_SEL:][[/]JUMP](/JUMP)* + +JUMP := first|1|second|2|brother|parent|DIR .fi .if n \{\ .RE @@ -105,42 +125,108 @@ WINDOW_SEL := (|DIR|CYCLE_DIR|biggest|last|focused|older|newer)[\&.[! .nr an-break-flag 1 .br .ps +1 -\fBPrimary Selectors\fR +\fBDescriptors\fR .RS 4 .PP \fIDIR\fR .RS 4 -Selects the window in the given (spacial) direction relative to the active window\&. +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 -biggest +\fIPATH\fR +.RS 4 +Selects the node at the given path\&. +.RE +.PP +any .RS 4 -Selects the biggest window on the current desktop\&. +Selects the first node that matches the given selectors\&. .RE .PP last .RS 4 -Selects the previously focused window\&. +Selects the previously focused node relative to the reference node\&. .RE .PP -focused +newest .RS 4 -Selects the currently focused window\&. +Selects the newest node in the history of the focused node\&. .RE .PP older .RS 4 -Selects the window older than the focused window in the history\&. +Selects the node older than the reference node in the history\&. .RE .PP newer .RS 4 -Selects the window newer than the focused window in the history\&. +Selects the node newer than the reference node in the history\&. +.RE +.PP +focused +.RS 4 +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\&. +.RE +.PP +smallest +.RS 4 +Selects the smallest window\&. +.RE +.PP + +.RS 4 +Selects the node with the given ID\&. +.RE +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\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 reference desktop (or the selected desktop if the path has a \fIDESKTOP_SEL\fR prefix)\&. +.PP +1|first +.RS 4 +Jumps to the first child\&. +.RE +.PP +2|second +.RS 4 +Jumps to the second child\&. +.RE +.PP +brother +.RS 4 +Jumps to the brother node\&. +.RE +.PP +parent +.RS 4 +Jumps to the parent node\&. +.RE +.PP +\fIDIR\fR +.RS 4 +Jumps to the node holding the edge in the given direction\&. .RE .RE .sp @@ -152,32 +238,63 @@ Selects the window newer than the focused window in the history\&. \fBModifiers\fR .RS 4 .PP -[!](tiled|pseudo_tiled|floating|fullscreen) +[!]focused .RS 4 -Only consider windows having or not having the given state\&. +Only consider focused or unfocused nodes\&. .RE .PP [!]automatic .RS 4 -Only consider windows 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 -[!]focused +[!]local .RS 4 -Only consider focused or unfocused windows\&. +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\&. +.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\&. .RE .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 -[!]local +[!]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 windows in or not in the current desktop\&. +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 @@ -195,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 @@ -206,27 +325,37 @@ DESKTOP_SEL := (|[MONITOR_SEL:](focused|^)CYCLE_DIR|last|older| .nr an-break-flag 1 .br .ps +1 -\fBPrimary Selectors\fR +\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 previously focused desktop\&. +Selects the newest desktop in the history of the focused desktops\&. +.RE +.PP +older +.RS 4 +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 @@ -234,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 @@ -270,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" @@ -281,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 @@ -292,37 +430,42 @@ MONITOR_SEL := (|^|DIR|CYCLE_DIR|last|primary|focused|older|new .nr an-break-flag 1 .br .ps +1 -\fBPrimary Selectors\fR +\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 previously focused monitor\&. +Selects the monitor older than the reference monitor in the history\&. +.RE +.PP +newer +.RS 4 +Selects the monitor newer than the reference monitor in the history\&. .RE .PP focused @@ -330,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 @@ -380,13 +538,11 @@ fullscreen .RS 4 Fills its monitor rectangle and has no borders\&. It is send in the ABOVE layer by default\&. .RE -.SH "WINDOW FLAGS" +.SH "NODE FLAGS" .PP -locked +hidden .RS 4 -Ignores the -\fBwindow \-\-close\fR -message\&. +Is hidden and doesn\(cqt occupy any tiling space\&. .RE .PP sticky @@ -399,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\&. @@ -408,8 +576,11 @@ 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 "COMMANDS" -.SS "Window" +.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 .it 1 an-trap .nr an-no-space-flag 1 @@ -419,7 +590,9 @@ In each layer, the window are orderered as follow: tiled & pseudo\-tiled < fulls \fBGeneral Syntax\fR .RS 4 .sp -window [\fIWINDOW_SEL\fR] \fIOPTIONS\fR +node [\fINODE_SEL\fR] \fICOMMANDS\fR +.sp +If \fINODE_SEL\fR is omitted, \fBfocused\fR is assumed\&. .RE .sp .it 1 an-trap @@ -427,69 +600,123 @@ window [\fIWINDOW_SEL\fR] \fIOPTIONS\fR .nr an-break-flag 1 .br .ps +1 -\fBOptions\fR +\fBCommands\fR +.RS 4 +.PP +\fB\-f\fR, \fB\-\-focus\fR [\fINODE_SEL\fR] +.RS 4 +Focus the selected or given node\&. +.RE +.PP +\fB\-a\fR, \fB\-\-activate\fR [\fINODE_SEL\fR] +.RS 4 +Activate the selected or given node\&. +.RE +.PP +\fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR [\fB\-\-follow\fR] .RS 4 +Send the selected node to the given desktop\&. If +\fB\-\-follow\fR +is passed, the focused node will stay focused\&. +.RE .PP -\fB\-f\fR, \fB\-\-focus\fR [\fIWINDOW_SEL\fR] +\fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR [\fB\-\-follow\fR] .RS 4 -Focus the selected or given window\&. +Send the selected node to the given monitor\&. If +\fB\-\-follow\fR +is passed, the focused node will stay focused\&. .RE .PP -\fB\-a\fR, \fB\-\-activate\fR [\fIWINDOW_SEL\fR] +\fB\-n\fR, \fB\-\-to\-node\fR \fINODE_SEL\fR [\fB\-\-follow\fR] .RS 4 -Activate the selected or given window\&. +Send the selected node on the given node\&. If +\fB\-\-follow\fR +is passed, the focused node will stay focused\&. .RE .PP -\fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR +\fB\-s\fR, \fB\-\-swap\fR \fINODE_SEL\fR [\fB\-\-follow\fR] .RS 4 -Send the selected window to the given desktop\&. +Swap the selected node with the given node\&. 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\-p\fR, \fB\-\-presel\-dir\fR [~]\fIDIR\fR|cancel .RS 4 -Send the selected window to the given monitor\&. +Preselect the splitting area of the selected node (or cancel the preselection)\&. If +\fB~\fR +is prepended to +\fIDIR\fR +and the current preselection direction matches +\fIDIR\fR, then the argument is interpreted as +\fBcancel\fR\&. A node with a preselected area is said to be in "manual insertion mode"\&. .RE .PP -\fB\-w\fR, \fB\-\-to\-window\fR \fIWINDOW_SEL\fR +\fB\-o\fR, \fB\-\-presel\-ratio\fR \fIRATIO\fR .RS 4 -Transplant the selected window to the given window\&. +Set the splitting ratio of the preselection area\&. .RE .PP -\fB\-s\fR, \fB\-\-swap\fR \fIWINDOW_SEL\fR +\fB\-v\fR, \fB\-\-move\fR \fIdx\fR \fIdy\fR .RS 4 -Swap the selected window with the given window\&. +Move the selected window by +\fIdx\fR +pixels horizontally and +\fIdy\fR +pixels vertically\&. .RE .PP -\fB\-p\fR, \fB\-\-presel\fR \fIDIR\fR|cancel +\fB\-z\fR, \fB\-\-resize\fR top|left|bottom|right|top_left|top_right|bottom_right|bottom_left \fIdx\fR \fIdy\fR .RS 4 -Preselect the splitting area of the selected window (or cancel the preselection)\&. +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 +\fB\-r\fR, \fB\-\-ratio\fR \fIRATIO\fR|(+|\-)(\fIPIXELS\fR|\fIFRACTION\fR) .RS 4 -Set the splitting ratio of the selected window (0 < +Set the splitting ratio of the selected node (0 < \fIRATIO\fR < 1)\&. .RE .PP -\fB\-e\fR, \fB\-\-edge\fR \fIDIR\fR \fIRATIO\fR|\(+-\fIPIXELS\fR +\fB\-R\fR, \fB\-\-rotate\fR \fI90|270|180\fR .RS 4 -Set or change the splitting ratio of the edge located in the given direction in relation to the selected window\&. +Rotate the tree rooted at the selected node\&. .RE .PP -\fB\-R\fR, \fB\-\-rotate\fR \fIDIR\fR \fI90|270|180\fR +\fB\-F\fR, \fB\-\-flip\fR \fIhorizontal|vertical\fR .RS 4 -Rotate the tree holding the edge located in the given direction in relation to the selected window\&. +Flip the the tree rooted at selected node\&. .RE .PP -\fB\-t\fR, \fB\-\-state\fR tiled|pseudo_tiled|floating|fullscreen +\fB\-E\fR, \fB\-\-equalize\fR +.RS 4 +Reset the split ratios of the tree rooted at the selected node to their default value\&. +.RE +.PP +\fB\-B\fR, \fB\-\-balance\fR +.RS 4 +Adjust the split ratios of the tree rooted at the selected node so that all windows occupy the same area\&. +.RE +.PP +\fB\-C\fR, \fB\-\-circulate\fR forward|backward .RS 4 -Set the state of the selected window\&. +Circulate the windows of the tree rooted at the selected node\&. .RE .PP -\fB\-g\fR, \fB\-\-flag\fR locked|sticky|private[=on|off] +\fB\-t\fR, \fB\-\-state\fR [~](tiled|pseudo_tiled|floating|fullscreen) .RS 4 -Set or toggle the given flag for the selected window\&. +Set the state of the selected window\&. If +\fB~\fR +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 hidden|sticky|private|locked|marked[=on|off] +.RS 4 +Set or toggle the given flag for the selected node\&. .RE .PP \fB\-l\fR, \fB\-\-layer\fR below|normal|above @@ -497,14 +724,19 @@ Set or toggle the given flag for the selected window\&. 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 selected window\&. +Close the windows rooted at the selected node\&. .RE .PP \fB\-k\fR, \fB\-\-kill\fR .RS 4 -Kill the selected window\&. +Kill the windows rooted at the selected node\&. .RE .RE .SS "Desktop" @@ -517,7 +749,9 @@ Kill the selected window\&. \fBGeneral Syntax\fR .RS 4 .sp -desktop [\fIDESKTOP_SEL\fR] \fIOPTIONS\fR +desktop [\fIDESKTOP_SEL\fR] \fICOMMANDS\fR +.sp +If \fIDESKTOP_SEL\fR is omitted, \fBfocused\fR is assumed\&. .RE .sp .it 1 an-trap @@ -525,7 +759,7 @@ desktop [\fIDESKTOP_SEL\fR] \fIOPTIONS\fR .nr an-break-flag 1 .br .ps +1 -\fBOptions\fR +\fBCOMMANDS\fR .RS 4 .PP \fB\-f\fR, \fB\-\-focus\fR [\fIDESKTOP_SEL\fR] @@ -533,9 +767,23 @@ desktop [\fIDESKTOP_SEL\fR] \fIOPTIONS\fR Focus the selected or given desktop\&. .RE .PP -\fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR +\fB\-a\fR, \fB\-\-activate\fR [\fIDESKTOP_SEL\fR] +.RS 4 +Activate the selected or given desktop\&. +.RE +.PP +\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 @@ -548,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\&. @@ -562,36 +805,6 @@ Bubble the selected desktop in the given direction\&. .RS 4 Remove the selected desktop\&. .RE -.PP -\fB\-c\fR, \fB\-\-cancel\-presel\fR -.RS 4 -Cancel the preselection of all the windows of the selected desktop\&. -.RE -.PP -\fB\-F\fR, \fB\-\-flip\fR \fIhorizontal|vertical\fR -.RS 4 -Flip the tree of the selected desktop\&. -.RE -.PP -\fB\-R\fR, \fB\-\-rotate\fR \fI90|270|180\fR -.RS 4 -Rotate the tree of the selected desktop\&. -.RE -.PP -\fB\-E\fR, \fB\-\-equalize\fR -.RS 4 -Reset the split ratios of the tree of the selected desktop\&. -.RE -.PP -\fB\-B\fR, \fB\-\-balance\fR -.RS 4 -Adjust the split ratios of the tree of the selected desktop so that all windows occupy the same area\&. -.RE -.PP -\fB\-C\fR, \fB\-\-circulate\fR forward|backward -.RS 4 -Circulate the leaves of the tree of the selected desktop\&. -.RE .RE .SS "Monitor" .sp @@ -603,7 +816,9 @@ Circulate the leaves of the tree of the selected desktop\&. \fBGeneral Syntax\fR .RS 4 .sp -monitor [\fIMONITOR_SEL\fR] \fIOPTIONS\fR +monitor [\fIMONITOR_SEL\fR] \fICOMMANDS\fR +.sp +If \fIMONITOR_SEL\fR is omitted, \fBfocused\fR is assumed\&. .RE .sp .it 1 an-trap @@ -611,7 +826,7 @@ monitor [\fIMONITOR_SEL\fR] \fIOPTIONS\fR .nr an-break-flag 1 .br .ps +1 -\fBOptions\fR +\fBCommands\fR .RS 4 .PP \fB\-f\fR, \fB\-\-focus\fR [\fIMONITOR_SEL\fR] @@ -619,14 +834,14 @@ monitor [\fIMONITOR_SEL\fR] \fIOPTIONS\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 \&... @@ -636,7 +851,12 @@ 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 +.RS 4 +Set the rectangle of the selected monitor\&. .RE .PP \fB\-n\fR, \fB\-\-rename\fR @@ -644,9 +864,9 @@ Rename, add or remove desktops depending on whether the number of given names is 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" @@ -659,7 +879,7 @@ Swap the selected monitor with the given monitor\&. \fBGeneral Syntax\fR .RS 4 .sp -query \fIOPTIONS\fR +query \fICOMMANDS\fR [\fIOPTIONS\fR] .RE .sp .it 1 an-trap @@ -667,55 +887,30 @@ query \fIOPTIONS\fR .nr an-break-flag 1 .br .ps +1 -\fBOptions\fR +\fBCommands\fR .RS 4 +.sp +The optional selectors are references\&. .PP -\fB\-W\fR, \fB\-\-windows\fR +\fB\-N\fR, \fB\-\-nodes\fR [\fINODE_SEL\fR] .RS 4 -List the IDs of the matching windows\&. +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 .RS 4 Print a JSON representation of the matching item\&. .RE -.PP -\fB\-H\fR, \fB\-\-history\fR -.RS 4 -Print the focus history as it relates to the query\&. -.RE -.PP -\fB\-S\fR, \fB\-\-stack\fR -.RS 4 -Print the window stacking order\&. -.RE -.PP -[\fB\-m\fR,\fB\-\-monitor\fR [\fIMONITOR_SEL\fR]] | [\fB\-d\fR,\fB\-\-desktop\fR [\fIDESKTOP_SEL\fR]] | [\fB\-w\fR, \fB\-\-window\fR [\fIWINDOW_SEL\fR]] -.RS 4 -Constrain matches to the selected monitor, desktop or window\&. -.RE -.RE -.SS "Restore" -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.ps +1 -\fBGeneral Syntax\fR -.RS 4 -.sp -restore \fIOPTIONS\fR .RE .sp .it 1 an-trap @@ -726,22 +921,24 @@ restore \fIOPTIONS\fR \fBOptions\fR .RS 4 .PP -\fB\-T\fR, \fB\-\-tree\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 -Load the desktop trees from the given file\&. -.RE -.PP -\fB\-H\fR, \fB\-\-history\fR -.RS 4 -Load the focus history from the given file\&. +Constrain matches to the selected monitor, desktop or node\&. The descriptor can be omitted for +\fI\-M\fR, +\fI\-D\fR +and +\fI\-N\fR\&. .RE .PP -\fB\-S\fR, \fB\-\-stack\fR +\fB\-\-names\fR .RS 4 -Load the window stacking order from the given file\&. +Print names instead of IDs\&. Can only be used with +\fI\-M\fR +and +\fI\-D\fR\&. .RE .RE -.SS "Control" +.SS "Wm" .sp .it 1 an-trap .nr an-no-space-flag 1 @@ -751,7 +948,7 @@ Load the window stacking order from the given file\&. \fBGeneral Syntax\fR .RS 4 .sp -control \fIOPTIONS\fR +wm \fICOMMANDS\fR .RE .sp .it 1 an-trap @@ -759,37 +956,45 @@ control \fIOPTIONS\fR .nr an-break-flag 1 .br .ps +1 -\fBOptions\fR +\fBCommands\fR .RS 4 .PP -\fB\-\-adopt\-orphans\fR +\fB\-d\fR, \fB\-\-dump\-state\fR .RS 4 -Manage all the unmanaged windows remaining from a previous session\&. +Dump the current world state on standard output\&. .RE .PP -\fB\-\-toggle\-visibility\fR +\fB\-l\fR, \fB\-\-load\-state\fR .RS 4 -Toggle the visibility of all the windows\&. +Load a world state from the given file\&. .RE .PP -\fB\-\-record\-history\fR on|off +\fB\-a\fR, \fB\-\-add\-monitor\fR WxH+X+Y .RS 4 -Enable or disable the recording of window focus history\&. +Add a monitor for the given name and rectangle\&. .RE .PP -\fB\-\-subscribe\fR (all|report|monitor|desktop|window|\&...)* +\fB\-O\fR, \fB\-\-reorder\-monitors\fR \&... .RS 4 -Continuously print status information\&. See the -\fBEVENTS\fR -section for the detailed description of each event\&. +Reorder the list of monitors to match the given order\&. +.RE +.PP +\fB\-o\fR, \fB\-\-adopt\-orphans\fR +.RS 4 +Manage all the unmanaged windows remaining from a previous session\&. .RE .PP -\fB\-\-get\-status\fR +\fB\-h\fR, \fB\-\-record\-history\fR on|off +.RS 4 +Enable or disable the recording of node focus history\&. +.RE +.PP +\fB\-g\fR, \fB\-\-get\-status\fR .RS 4 Print the current status information\&. .RE .RE -.SS "Pointer" +.SS "Rule" .sp .it 1 an-trap .nr an-no-space-flag 1 @@ -799,7 +1004,7 @@ Print the current status information\&. \fBGeneral Syntax\fR .RS 4 .sp -pointer \fIOPTIONS\fR +rule \fICOMMANDS\fR .RE .sp .it 1 an-trap @@ -807,25 +1012,25 @@ pointer \fIOPTIONS\fR .nr an-break-flag 1 .br .ps +1 -\fBOptions\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 @@ -834,46 +1039,50 @@ Terminate the current pointer action\&. .ps +1 \fBGeneral Syntax\fR .RS 4 -.sp -rule \fIOPTIONS\fR +.PP +config [\-m \fIMONITOR_SEL\fR|\-d \fIDESKTOP_SEL\fR|\-n \fINODE_SEL\fR] [] +.RS 4 +Get or set the value of \&. .RE +.RE +.SS "Subscribe" .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\-a\fR, \fB\-\-add\fR ||* [\fB\-o\fR|\fB\-\-one\-shot\fR] [monitor=MONITOR_SEL|desktop=DESKTOP_SEL|window=WINDOW_SEL] [state=STATE] [layer=LAYER] [split_dir=DIR] [split_ratio=RATIO] [(locked|sticky|private|center|follow|manage|focus|border)=(on|off)] -.RS 4 -Create a new rule\&. -.RE -.PP -\fB\-r\fR, \fB\-\-remove\fR ^|head|tail|||*\&... +\fBGeneral Syntax\fR .RS 4 -Remove the given rules\&. -.RE .PP -\fB\-l\fR, \fB\-\-list\fR [||*] +subscribe [\fIOPTIONS\fR] (all|report|monitor|desktop|node|\&...)* .RS 4 -List the rules\&. +Continuously print events\&. See the +\fBEVENTS\fR +section for the description of each event\&. .RE .RE -.SS "Config" .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 -config [\-m \fIMONITOR_SEL\fR|\-d \fIDESKTOP_SEL\fR|\-w \fIWINDOW_SEL\fR] [] +\fB\-f\fR, \fB\-\-fifo\fR .RS 4 -Get or set the value of \&. +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" @@ -893,32 +1102,17 @@ 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 either \fI#RRGGBB\fR or X color names, booleans are \fItrue\fR, \fIon\fR, \fIfalse\fR or \fIoff\fR\&. +Colors are in the form \fI#RRGGBB\fR, booleans are \fItrue\fR, \fIon\fR, \fIfalse\fR or \fIoff\fR\&. .sp All the boolean settings are \fIfalse\fR by default unless stated otherwise\&. .SS "Global Settings" .PP -\fIfocused_border_color\fR +\fInormal_border_color\fR .RS 4 -Color of the border of a focused window of a focused monitor\&. +Color of the border of an unfocused window\&. .RE .PP \fIactive_border_color\fR @@ -926,66 +1120,16 @@ Color of the border of a focused window of a focused monitor\&. Color of the border of a focused window of an unfocused monitor\&. .RE .PP -\fInormal_border_color\fR +\fIfocused_border_color\fR .RS 4 -Color of the border of an unfocused window\&. +Color of the border of a focused window of a focused monitor\&. .RE .PP -\fIpresel_border_color\fR +\fIpresel_feedback_color\fR .RS 4 Color of the -\fBwindow \-\-presel\fR -message feedback\&. -.RE -.PP -\fIfocused_locked_border_color\fR -.RS 4 -Color of the border of a focused locked window of a focused monitor\&. -.RE -.PP -\fIactive_locked_border_color\fR -.RS 4 -Color of the border of a focused locked window of an unfocused monitor\&. -.RE -.PP -\fInormal_locked_border_color\fR -.RS 4 -Color of the border of an unfocused locked window\&. -.RE -.PP -\fIfocused_sticky_border_color\fR -.RS 4 -Color of the border of a focused sticky window of a focused monitor\&. -.RE -.PP -\fIactive_sticky_border_color\fR -.RS 4 -Color of the border of a focused sticky window of an unfocused monitor\&. -.RE -.PP -\fInormal_sticky_border_color\fR -.RS 4 -Color of the border of an unfocused sticky window\&. -.RE -.PP -\fIfocused_private_border_color\fR -.RS 4 -Color of the border of a focused private window of a focused monitor\&. -.RE -.PP -\fIactive_private_border_color\fR -.RS 4 -Color of the border of a focused private window of an unfocused monitor\&. -.RE -.PP -\fInormal_private_border_color\fR -.RS 4 -Color of the border of an unfocused private window\&. -.RE -.PP -\fIurgent_border_color\fR -.RS 4 -Color of the border of an urgent window\&. +\fBnode \-\-presel\-{dir,ratio}\fR +message feedback area\&. .RE .PP \fIsplit_ratio\fR @@ -1000,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 @@ -1014,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 +\fIdirectional_focus_tightness\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\&. +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 @@ -1038,13 +1181,70 @@ Remove gaps of tiled windows for the desktop layout\&. .RE .PP -\fIleaf_monocle\fR +\fIpaddingless_monocle\fR +.RS 4 +Remove padding space for the +\fBmonocle\fR +desktop layout\&. +.RE +.PP +\fIsingle_monocle\fR .RS 4 Set the desktop layout to \fBmonocle\fR 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\&. @@ -1060,31 +1260,25 @@ When focusing a window, put the pointer at its center\&. When focusing a monitor, put the pointer at its center\&. .RE .PP -\fIauto_alternate\fR +\fImapping_events_count\fR .RS 4 -Interpret consecutive identical -\fB\-\-focus\fR -arguments as the -\fBlast\fR -selector for the -\fBmonitor\fR -and -\fBdesktop\fR -commands\&. +Handle the next +\fBmapping_events_count\fR +mapping notify events\&. A negative value implies that every event needs to be handled\&. .RE .PP -\fIauto_cancel\fR +\fIignore_ewmh_focus\fR .RS 4 -Interpret consecutive identical -\fB\-\-presel\fR -arguments as -\fB\-\-cancel\-presel\fR -option\&. +Ignore EWMH focus requests coming from applications\&. .RE .PP -\fIignore_ewmh_focus\fR +\fIignore_ewmh_fullscreen\fR .RS 4 -Ignore EWMH focus requests coming from applications\&. +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 @@ -1093,6 +1287,11 @@ 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\&. @@ -1113,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 @@ -1132,115 +1355,140 @@ 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_focus \fR +\fImonitor_swap \fR +.RS 4 +A monitor is swapped\&. +.RE +.PP +\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_layout tiled|monocle\fR +\fIdesktop_activate \fR +.RS 4 +A desktop is activated\&. +.RE +.PP +\fIdesktop_layout tiled|monocle\fR .RS 4 The layout of a desktop changed\&. .RE .PP -\fIwindow_manage \fR +\fInode_add \fR +.RS 4 +A node is added\&. +.RE +.PP +\fInode_remove \fR .RS 4 -A window is managed\&. +A node is removed\&. .RE .PP -\fIwindow_unmanage \fR +\fInode_swap \fR .RS 4 -A window is unmanaged\&. +A node is swapped\&. .RE .PP -\fIwindow_swap \fR +\fInode_transfer \fR .RS 4 -A window is swapped\&. +A node is transferred\&. .RE .PP -\fIwindow_transfer \fR +\fInode_focus \fR .RS 4 -A window is transferred\&. +A node is focused\&. .RE .PP -\fIwindow_focus \fR +\fInode_activate \fR .RS 4 -A window is focused\&. +A node is activated\&. .RE .PP -\fIwindow_activate \fR +\fInode_presel (dir DIR|ratio RATIO|cancel)\fR .RS 4 -A window is activated\&. +A node is preselected\&. .RE .PP -\fIwindow_geometry \fR +\fInode_stack below|above \fR +.RS 4 +A node is stacked below or above another node\&. +.RE +.PP +\fInode_geometry \fR .RS 4 The geometry of a window changed\&. .RE .PP -\fIwindow_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 -\fIwindow_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 window changed\&. +One of the flags of a node changed\&. .RE .PP -\fIwindow_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" @@ -1293,6 +1541,16 @@ Urgent unfocused desktop\&. .RS 4 Layout of the focused desktop of a monitor\&. .RE +.PP +\fIT(T|P|F|=|@)\fR +.RS 4 +State of the focused node of a focused desktop\&. +.RE +.PP +\fIG(S?P?L?)\fR +.RS 4 +Active flags of the focused node of a focused desktop\&. +.RE .SH "ENVIRONMENT VARIABLES" .PP \fIBSPWM_SOCKET\fR