3 .\" Author: [see the "Author" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
6 .\" Manual: Bspwm Manual
7 .\" Source: Bspwm 0.9.10-26-gbadfd6c
10 .TH "BSPWM" "1" "05/28/2021" "Bspwm 0\&.9\&.10\-26\-gbadfd6c" "Bspwm Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 bspwm \- Binary space partitioning window manager
34 \fBbspwm\fR [\fB\-h\fR|\fB\-v\fR|\fB\-c\fR \fICONFIG_PATH\fR]
36 \fBbspc\fR \fIDOMAIN\fR [\fISELECTOR\fR] \fICOMMANDS\fR
38 \fBbspc\fR \fICOMMAND\fR [\fIOPTIONS\fR] [\fIARGUMENTS\fR]
41 \fBbspwm\fR is a tiling window manager that represents windows as the leaves of a full binary tree\&.
43 It is controlled and configured via \fBbspc\fR\&.
48 Print the synopsis and exit\&.
53 Print the version and exit\&.
56 \fB\-c\fR \fICONFIG_PATH\fR
58 Use the given configuration file\&.
60 .SH "COMMON DEFINITIONS"
66 DIR := north | west | south | east
67 CYCLE_DIR := next | prev
74 Selectors are used to select a target node, desktop, or monitor\&. A selector can either describe the target relatively or name it globally\&.
76 Selectors consist of an optional reference, a descriptor and any number of non\-conflicting modifiers as follows:
82 [REFERENCE#]DESCRIPTOR(\&.MODIFIER)*
88 The relative targets are computed in relation to the given reference (the default reference value is \fBfocused\fR)\&.
90 An exclamation mark can be prepended to any modifier in order to reverse its meaning\&.
92 The following characters cannot be used in monitor or desktop names: \fB#\fR, \fB:\fR, \fB\&.\fR\&.
94 The special selector \fB%<name>\fR can be used to select a monitor or a desktop with an invalid name\&.
103 NODE_SEL := [NODE_SEL#](DIR|CYCLE_DIR|PATH|any|first_ancestor|last|newest|
104 older|newer|focused|pointed|biggest|smallest|
105 <node_id>)[\&.[!]focused][\&.[!]active][\&.[!]automatic][\&.[!]local]
106 [\&.[!]leaf][\&.[!]window][\&.[!]STATE][\&.[!]FLAG][\&.[!]LAYER][\&.[!]SPLIT_TYPE]
107 [\&.[!]same_class][\&.[!]descendant_of][\&.[!]ancestor_of]
109 STATE := tiled|pseudo_tiled|floating|fullscreen
111 FLAG := hidden|sticky|private|locked|marked|urgent
113 LAYER := below|normal|above
115 SPLIT_TYPE := horizontal|vertical
117 PATH := @[DESKTOP_SEL:][[/]JUMP](/JUMP)*
119 JUMP := first|1|second|2|brother|parent|DIR
126 .nr an-no-space-flag 1
135 Selects the window in the given (spacial) direction relative to the reference node\&.
140 Selects the node in the given (cyclic) direction relative to the reference node within a depth\-first in\-order traversal of the tree\&.
145 Selects the node at the given path\&.
150 Selects the first node that matches the given selectors\&.
155 Selects the first ancestor of the reference node that matches the given selectors\&.
160 Selects the previously focused node relative to the reference node\&.
165 Selects the newest node in the history of the focused node\&.
170 Selects the node older than the reference node in the history\&.
175 Selects the node newer than the reference node in the history\&.
180 Selects the currently focused node\&.
185 Selects the leaf under the pointer\&.
190 Selects the biggest leaf\&.
195 Selects the smallest leaf\&.
200 Selects the node with the given ID\&.
205 .nr an-no-space-flag 1
212 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)\&.
216 Jumps to the first child\&.
221 Jumps to the second child\&.
226 Jumps to the brother node\&.
231 Jumps to the parent node\&.
236 Jumps to the node holding the edge in the given direction\&.
241 .nr an-no-space-flag 1
250 Only consider the focused node\&.
255 Only consider nodes that are the focused node of their desktop\&.
260 Only consider nodes in automatic insertion mode\&. See also
261 \fB\-\-presel\-dir\fR
271 Only consider nodes in the reference desktop\&.
276 Only consider leaf nodes\&.
281 Only consider nodes that hold a window\&.
284 [!](tiled|pseudo_tiled|floating|fullscreen)
286 Only consider windows in the given state\&.
291 Only consider windows that have the same class as the reference window\&.
296 Only consider nodes that are descendants of the reference node\&.
301 Only consider nodes that are ancestors of the reference node\&.
304 [!](hidden|sticky|private|locked|marked|urgent)
306 Only consider windows that have the given flag set\&.
309 [!](below|normal|above)
311 Only consider windows in the given layer\&.
314 [!](horizontal|vertical)
316 Only consider nodes with the given split type\&.
327 DESKTOP_SEL := [DESKTOP_SEL#](CYCLE_DIR|any|last|newest|older|newer|
328 [MONITOR_SEL:](focused|^<n>)|
329 <desktop_id>|<desktop_name>)[\&.[!]focused][\&.[!]active]
330 [\&.[!]occupied][\&.[!]urgent][\&.[!]local]
331 [\&.[!]LAYOUT][\&.[!]user_LAYOUT]
333 LAYOUT := tiled|monocle
340 .nr an-no-space-flag 1
349 Selects the desktop in the given direction relative to the reference desktop\&.
354 Selects the first desktop that matches the given selectors\&.
359 Selects the previously focused desktop relative to the reference desktop\&.
364 Selects the newest desktop in the history of the focused desktops\&.
369 Selects the desktop older than the reference desktop in the history\&.
374 Selects the desktop newer than the reference desktop in the history\&.
379 Selects the currently focused desktop\&.
384 Selects the nth desktop\&. If
386 is given, selects the nth desktop on the selected monitor\&.
391 Selects the desktop with the given ID\&.
396 Selects the desktop with the given name\&.
401 .nr an-no-space-flag 1
410 Only consider the focused desktop\&.
415 Only consider desktops that are the focused desktop of their monitor\&.
420 Only consider occupied desktops\&.
425 Only consider urgent desktops\&.
430 Only consider desktops inside the reference monitor\&.
435 Only consider desktops with the given layout\&.
438 [!](user_tiled|user_monocle)
440 Only consider desktops which have the given layout as userLayout\&.
451 MONITOR_SEL := [MONITOR_SEL#](DIR|CYCLE_DIR|any|last|newest|older|newer|
452 focused|pointed|primary|^<n>|
453 <monitor_id>|<monitor_name>)[\&.[!]focused][\&.[!]occupied]
460 .nr an-no-space-flag 1
469 Selects the monitor in the given (spacial) direction relative to the reference monitor\&.
474 Selects the monitor in the given (cyclic) direction relative to the reference monitor\&.
479 Selects the first monitor that matches the given selectors\&.
484 Selects the previously focused monitor relative to the reference monitor\&.
489 Selects the newest monitor in the history of the focused monitors\&.
494 Selects the monitor older than the reference monitor in the history\&.
499 Selects the monitor newer than the reference monitor in the history\&.
504 Selects the currently focused monitor\&.
509 Selects the monitor under the pointer\&.
514 Selects the primary monitor\&.
519 Selects the nth monitor\&.
524 Selects the monitor with the given ID\&.
529 Selects the monitor with the given name\&.
534 .nr an-no-space-flag 1
543 Only consider the focused monitor\&.
548 Only consider monitors where the focused desktop is occupied\&.
555 Its size and position are determined by the window tree\&.
560 A tiled window that automatically shrinks but doesn\(cqt stretch beyond its floating size\&.
565 Can be moved/resized freely\&. Although it doesn\(cqt use any tiling space, it is still part of the window tree\&.
570 Fills its monitor rectangle and has no borders\&.
576 Is hidden and doesn\(cqt occupy any tiling space\&.
581 Stays in the focused desktop of its monitor\&.
586 Tries to keep the same tiling position/size\&.
598 Is marked (useful for deferred actions)\&. A marked node becomes unmarked after being sent on a preselected node\&.
603 Has its urgency hint set\&. This flag is set externally\&.
605 .SH "STACKING LAYERS"
607 There\(cqs three stacking layers: BELOW, NORMAL and ABOVE\&.
609 In each layer, the window are orderered as follow: tiled & pseudo\-tiled < floating < fullscreen\&.
612 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\&.
617 .nr an-no-space-flag 1
624 node [\fINODE_SEL\fR] \fICOMMANDS\fR
626 If \fINODE_SEL\fR is omitted, \fBfocused\fR is assumed\&.
630 .nr an-no-space-flag 1
637 \fB\-f\fR, \fB\-\-focus\fR [\fINODE_SEL\fR]
639 Focus the selected or given node\&.
642 \fB\-a\fR, \fB\-\-activate\fR [\fINODE_SEL\fR]
644 Activate the selected or given node\&.
647 \fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR [\fB\-\-follow\fR]
649 Send the selected node to the given desktop\&. If
651 is passed, the focused node will stay focused\&.
654 \fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR [\fB\-\-follow\fR]
656 Send the selected node to the given monitor\&. If
658 is passed, the focused node will stay focused\&.
661 \fB\-n\fR, \fB\-\-to\-node\fR \fINODE_SEL\fR [\fB\-\-follow\fR]
663 Send the selected node on the given node\&. If
665 is passed, the focused node will stay focused\&.
668 \fB\-s\fR, \fB\-\-swap\fR \fINODE_SEL\fR [\fB\-\-follow\fR]
670 Swap the selected node with the given node\&. If
672 is passed, the focused node will stay focused\&.
675 \fB\-p\fR, \fB\-\-presel\-dir\fR [~]\fIDIR\fR|cancel
677 Preselect the splitting area of the selected node (or cancel the preselection)\&. If
681 and the current preselection direction matches
682 \fIDIR\fR, then the argument is interpreted as
683 \fBcancel\fR\&. A node with a preselected area is said to be in "manual insertion mode"\&.
686 \fB\-o\fR, \fB\-\-presel\-ratio\fR \fIRATIO\fR
688 Set the splitting ratio of the preselection area\&.
691 \fB\-v\fR, \fB\-\-move\fR \fIdx\fR \fIdy\fR
693 Move the selected window by
695 pixels horizontally and
700 \fB\-z\fR, \fB\-\-resize\fR top|left|bottom|right|top_left|top_right|bottom_right|bottom_left \fIdx\fR \fIdy\fR
702 Resize the selected window by moving the given handle by
704 pixels horizontally and
709 \fB\-r\fR, \fB\-\-ratio\fR \fIRATIO\fR|(+|\-)(\fIPIXELS\fR|\fIFRACTION\fR)
711 Set the splitting ratio of the selected node (0 <
716 \fB\-R\fR, \fB\-\-rotate\fR \fI90|270|180\fR
718 Rotate the tree rooted at the selected node\&.
721 \fB\-F\fR, \fB\-\-flip\fR \fIhorizontal|vertical\fR
723 Flip the tree rooted at selected node\&.
726 \fB\-E\fR, \fB\-\-equalize\fR
728 Reset the split ratios of the tree rooted at the selected node to their default value\&.
731 \fB\-B\fR, \fB\-\-balance\fR
733 Adjust the split ratios of the tree rooted at the selected node so that all windows occupy the same area\&.
736 \fB\-C\fR, \fB\-\-circulate\fR forward|backward
738 Circulate the windows of the tree rooted at the selected node\&.
741 \fB\-t\fR, \fB\-\-state\fR ~|[~]\fISTATE\fR
743 Set the state of the selected window\&. If
745 is present and the current state matches
746 \fISTATE\fR, then the argument is interpreted as its last state\&. If the argument is just
750 omitted, then the state of the selected window is set to its last state\&.
753 \fB\-g\fR, \fB\-\-flag\fR hidden|sticky|private|locked|marked[=on|off]
755 Set or toggle the given flag for the selected node\&.
758 \fB\-l\fR, \fB\-\-layer\fR below|normal|above
760 Set the stacking layer of the selected window\&.
763 \fB\-i\fR, \fB\-\-insert\-receptacle\fR
765 Insert a receptacle node at the selected node\&.
768 \fB\-c\fR, \fB\-\-close\fR
770 Close the windows rooted at the selected node\&.
773 \fB\-k\fR, \fB\-\-kill\fR
775 Kill the windows rooted at the selected node\&.
781 .nr an-no-space-flag 1
788 desktop [\fIDESKTOP_SEL\fR] \fICOMMANDS\fR
790 If \fIDESKTOP_SEL\fR is omitted, \fBfocused\fR is assumed\&.
794 .nr an-no-space-flag 1
801 \fB\-f\fR, \fB\-\-focus\fR [\fIDESKTOP_SEL\fR]
803 Focus the selected or given desktop\&.
806 \fB\-a\fR, \fB\-\-activate\fR [\fIDESKTOP_SEL\fR]
808 Activate the selected or given desktop\&.
811 \fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR [\fB\-\-follow\fR]
813 Send the selected desktop to the given monitor\&. If
815 is passed, the focused desktop will stay focused\&.
818 \fB\-s\fR, \fB\-\-swap\fR \fIDESKTOP_SEL\fR [\fB\-\-follow\fR]
820 Swap the selected desktop with the given desktop\&. If
822 is passed, the focused desktop will stay focused\&.
825 \fB\-l\fR, \fB\-\-layout\fR \fICYCLE_DIR\fR|monocle|tiled
827 Set or cycle the layout of the selected desktop\&.
830 \fB\-n\fR, \fB\-\-rename\fR <new_name>
832 Rename the selected desktop\&.
835 \fB\-b\fR, \fB\-\-bubble\fR \fICYCLE_DIR\fR
837 Bubble the selected desktop in the given direction\&.
840 \fB\-r\fR, \fB\-\-remove\fR
842 Remove the selected desktop\&.
848 .nr an-no-space-flag 1
855 monitor [\fIMONITOR_SEL\fR] \fICOMMANDS\fR
857 If \fIMONITOR_SEL\fR is omitted, \fBfocused\fR is assumed\&.
861 .nr an-no-space-flag 1
868 \fB\-f\fR, \fB\-\-focus\fR [\fIMONITOR_SEL\fR]
870 Focus the selected or given monitor\&.
873 \fB\-s\fR, \fB\-\-swap\fR \fIMONITOR_SEL\fR
875 Swap the selected monitor with the given monitor\&.
878 \fB\-a\fR, \fB\-\-add\-desktops\fR <name>\&...
880 Create desktops with the given names in the selected monitor\&.
883 \fB\-o\fR, \fB\-\-reorder\-desktops\fR <name>\&...
885 Reorder the desktops of the selected monitor to match the given order\&.
888 \fB\-d\fR, \fB\-\-reset\-desktops\fR <name>\&...
890 Rename, add or remove desktops depending on whether the number of given names is equal, superior or inferior to the number of existing desktops\&.
893 \fB\-g\fR, \fB\-\-rectangle\fR WxH+X+Y
895 Set the rectangle of the selected monitor\&.
898 \fB\-n\fR, \fB\-\-rename\fR <new_name>
900 Rename the selected monitor\&.
903 \fB\-r\fR, \fB\-\-remove\fR
905 Remove the selected monitor\&.
911 .nr an-no-space-flag 1
918 query \fICOMMANDS\fR [\fIOPTIONS\fR]
922 .nr an-no-space-flag 1
929 The optional selectors are references\&.
931 \fB\-N\fR, \fB\-\-nodes\fR [\fINODE_SEL\fR]
933 List the IDs of the matching nodes\&.
936 \fB\-D\fR, \fB\-\-desktops\fR [\fIDESKTOP_SEL\fR]
938 List the IDs (or names) of the matching desktops\&.
941 \fB\-M\fR, \fB\-\-monitors\fR [\fIMONITOR_SEL\fR]
943 List the IDs (or names) of the matching monitors\&.
946 \fB\-T\fR, \fB\-\-tree\fR
948 Print a JSON representation of the matching item\&.
953 .nr an-no-space-flag 1
960 \fB\-m\fR,\fB\-\-monitor\fR [\fIMONITOR_SEL\fR|\fIMONITOR_MODIFIERS\fR], \fB\-d\fR,\fB\-\-desktop\fR [\fIDESKTOP_SEL\fR|\fIDESKTOP_MODIFIERS\fR], \fB\-n\fR, \fB\-\-node\fR [\fINODE_SEL\fR|\fINODE_MODIFIERS\fR]
962 Constrain matches to the selected monitors, desktops or nodes\&.
967 Print names instead of IDs\&. Can only be used with
976 .nr an-no-space-flag 1
987 .nr an-no-space-flag 1
994 \fB\-d\fR, \fB\-\-dump\-state\fR
996 Dump the current world state on standard output\&.
999 \fB\-l\fR, \fB\-\-load\-state\fR <file_path>
1001 Load a world state from the given file\&. The path must be absolute\&.
1004 \fB\-a\fR, \fB\-\-add\-monitor\fR <name> WxH+X+Y
1006 Add a monitor for the given name and rectangle\&.
1009 \fB\-O\fR, \fB\-\-reorder\-monitors\fR <name>\&...
1011 Reorder the list of monitors to match the given order\&.
1014 \fB\-o\fR, \fB\-\-adopt\-orphans\fR
1016 Manage all the unmanaged windows remaining from a previous session\&.
1019 \fB\-h\fR, \fB\-\-record\-history\fR on|off
1021 Enable or disable the recording of node focus history\&.
1024 \fB\-g\fR, \fB\-\-get\-status\fR
1026 Print the current status information\&.
1029 \fB\-r\fR, \fB\-\-restart\fR
1031 Restart the window manager
1037 .nr an-no-space-flag 1
1041 \fBGeneral Syntax\fR
1048 .nr an-no-space-flag 1
1055 \fB\-a\fR, \fB\-\-add\fR (<class_name>|*)[:(<instance_name>|*)[:(<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|marked|center|follow|manage|focus|border)=(on|off)] [rectangle=WxH+X+Y]
1057 Create a new rule\&.
1060 \fB\-r\fR, \fB\-\-remove\fR ^<n>|head|tail|(<class_name>|*)[:(<instance_name>|*)[:(<name>|*)]]\&...
1062 Remove the given rules\&.
1065 \fB\-l\fR, \fB\-\-list\fR
1073 .nr an-no-space-flag 1
1077 \fBGeneral Syntax\fR
1080 config [\-m \fIMONITOR_SEL\fR|\-d \fIDESKTOP_SEL\fR|\-n \fINODE_SEL\fR] <setting> [<value>]
1082 Get or set the value of <setting>\&.
1088 .nr an-no-space-flag 1
1092 \fBGeneral Syntax\fR
1095 subscribe [\fIOPTIONS\fR] (all|report|monitor|desktop|node|\&...)*
1097 Continuously print events\&. See the
1099 section for the description of each event\&.
1104 .nr an-no-space-flag 1
1111 \fB\-f\fR, \fB\-\-fifo\fR
1113 Print a path to a FIFO from which events can be read and return\&.
1116 \fB\-c\fR, \fB\-\-count\fR \fICOUNT\fR
1118 Stop the corresponding
1120 process after having received
1128 .nr an-no-space-flag 1
1132 \fBGeneral Syntax\fR
1137 Quit with an optional exit status\&.
1142 If the server can\(cqt handle a message, \fBbspc\fR will return with a non\-zero exit code\&.
1145 Colors are in the form \fI#RRGGBB\fR, booleans are \fItrue\fR, \fIon\fR, \fIfalse\fR or \fIoff\fR\&.
1147 All the boolean settings are \fIfalse\fR by default unless stated otherwise\&.
1148 .SS "Global Settings"
1150 \fInormal_border_color\fR
1152 Color of the border of an unfocused window\&.
1155 \fIactive_border_color\fR
1157 Color of the border of a focused window of an unfocused monitor\&.
1160 \fIfocused_border_color\fR
1162 Color of the border of a focused window of a focused monitor\&.
1165 \fIpresel_feedback_color\fR
1168 \fBnode \-\-presel\-{dir,ratio}\fR
1169 message feedback area\&.
1174 Default split ratio\&.
1179 Prefix prepended to each of the status lines\&.
1182 \fIexternal_rules_command\fR
1184 Absolute path to the 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:
1185 \fBkey1=value1 key2=value2 \&...\fR
1186 (the valid key/value pairs are given in the description of the
1191 \fIautomatic_scheme\fR
1193 The insertion scheme used when the insertion point is in automatic mode\&. Accept the following values:
1199 \fIinitial_polarity\fR
1201 On which child should a new window be attached when adding a window on a single window tree in automatic mode\&. Accept the following values:
1203 \fBsecond_child\fR\&.
1206 \fIdirectional_focus_tightness\fR
1208 The tightness of the algorithm used to decide whether a window is on the
1210 side of another window\&. Accept the following values:
1215 \fIremoval_adjustment\fR
1217 Adjust the brother when unlinking a node from the tree in accordance with the automatic insertion scheme\&.
1220 \fIpresel_feedback\fR
1222 Draw the preselection feedback area\&. Defaults to
1226 \fIborderless_monocle\fR
1228 Remove borders of tiled windows for the
1233 \fIgapless_monocle\fR
1235 Remove gaps of tiled windows for the
1240 \fItop_monocle_padding\fR, \fIright_monocle_padding\fR, \fIbottom_monocle_padding\fR, \fIleft_monocle_padding\fR
1242 Padding space added at the sides of the screen for the
1247 \fIsingle_monocle\fR
1249 Set the desktop layout to
1251 if there\(cqs only one tiled window in the tree\&.
1254 \fIborderless_singleton\fR
1256 Remove borders of the only window on the only monitor regardless its layout\&.
1259 \fIpointer_motion_interval\fR
1261 The minimum interval, in milliseconds, between two motion notify events\&.
1264 \fIpointer_modifier\fR
1266 Keyboard modifier used for moving or resizing windows\&. Accept the following values:
1277 \fIpointer_action1\fR, \fIpointer_action2\fR, \fIpointer_action3\fR
1279 Action performed when pressing
1280 \fIpointer_modifier\fR
1282 \fIbutton<n>\fR\&. Accept the following values:
1285 \fBresize_corner\fR,
1290 \fIclick_to_focus\fR
1292 Button used for focusing a window (or a monitor)\&. The possible values are:
1297 \fBnone\fR\&. Defaults to
1301 \fIswallow_first_click\fR
1303 Don\(cqt replay the click that makes a window focused if
1304 \fIclick_to_focus\fR
1309 \fIfocus_follows_pointer\fR
1311 Focus the window under the pointer\&.
1314 \fIpointer_follows_focus\fR
1316 When focusing a window, put the pointer at its center\&.
1319 \fIpointer_follows_monitor\fR
1321 When focusing a monitor, put the pointer at its center\&.
1324 \fImapping_events_count\fR
1327 \fBmapping_events_count\fR
1328 mapping notify events\&. A negative value implies that every event needs to be handled\&.
1331 \fIignore_ewmh_focus\fR
1333 Ignore EWMH focus requests coming from applications\&.
1336 \fIignore_ewmh_fullscreen\fR
1338 Block the fullscreen state transitions that originate from an EWMH request\&. The possible values are:
1340 \fBall\fR, or a comma separated list of the following values:
1345 \fIignore_ewmh_struts\fR
1347 Ignore strut hinting from clients requesting to reserve space (i\&.e\&. task bars)\&.
1350 \fIcenter_pseudo_tiled\fR
1352 Center pseudo tiled windows into their tiling rectangles\&. Defaults to
1356 \fIhonor_size_hints\fR
1358 Apply ICCCM window size hints\&.
1361 \fIremove_disabled_monitors\fR
1363 Consider disabled monitors as disconnected\&.
1366 \fIremove_unplugged_monitors\fR
1368 Remove unplugged monitors\&.
1371 \fImerge_overlapping_monitors\fR
1373 Merge overlapping monitors (the bigger remains)\&.
1375 .SS "Monitor and Desktop Settings"
1377 \fItop_padding\fR, \fIright_padding\fR, \fIbottom_padding\fR, \fIleft_padding\fR
1379 Padding space added at the sides of the monitor or desktop\&.
1381 .SS "Desktop Settings"
1385 Size of the gap that separates windows\&.
1391 Window border width\&.
1393 .SH "POINTER BINDINGS"
1395 \fIclick_to_focus\fR
1397 Focus the window (or the monitor) under the pointer if the value isn\(cqt
1401 \fIpointer_modifier\fR + \fIbutton1\fR
1403 Move the window under the pointer\&.
1406 \fIpointer_modifier\fR + \fIbutton2\fR
1408 Resize the window under the pointer by dragging the nearest side\&.
1411 \fIpointer_modifier\fR + \fIbutton3\fR
1413 Resize the window under the pointer by dragging the nearest corner\&.
1416 The behavior of \fIpointer_modifier\fR + \fIbutton<n>\fR can be modified through the \fIpointer_action<n>\fR setting\&.
1421 See the next section for the description of the format\&.
1424 \fImonitor_add <monitor_id> <monitor_name> <monitor_geometry>\fR
1426 A monitor is added\&.
1429 \fImonitor_rename <monitor_id> <old_name> <new_name>\fR
1431 A monitor is renamed\&.
1434 \fImonitor_remove <monitor_id>\fR
1436 A monitor is removed\&.
1439 \fImonitor_swap <src_monitor_id> <dst_monitor_id>\fR
1441 A monitor is swapped\&.
1444 \fImonitor_focus <monitor_id>\fR
1446 A monitor is focused\&.
1449 \fImonitor_geometry <monitor_id> <monitor_geometry>\fR
1451 The geometry of a monitor changed\&.
1454 \fIdesktop_add <monitor_id> <desktop_id> <desktop_name>\fR
1456 A desktop is added\&.
1459 \fIdesktop_rename <monitor_id> <desktop_id> <old_name> <new_name>\fR
1461 A desktop is renamed\&.
1464 \fIdesktop_remove <monitor_id> <desktop_id>\fR
1466 A desktop is removed\&.
1469 \fIdesktop_swap <src_monitor_id> <src_desktop_id> <dst_monitor_id> <dst_desktop_id>\fR
1471 A desktop is swapped\&.
1474 \fIdesktop_transfer <src_monitor_id> <src_desktop_id> <dst_monitor_id>\fR
1476 A desktop is transferred\&.
1479 \fIdesktop_focus <monitor_id> <desktop_id>\fR
1481 A desktop is focused\&.
1484 \fIdesktop_activate <monitor_id> <desktop_id>\fR
1486 A desktop is activated\&.
1489 \fIdesktop_layout <monitor_id> <desktop_id> tiled|monocle\fR
1491 The layout of a desktop changed\&.
1494 \fInode_add <monitor_id> <desktop_id> <ip_id> <node_id>\fR
1499 \fInode_remove <monitor_id> <desktop_id> <node_id>\fR
1501 A node is removed\&.
1504 \fInode_swap <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>\fR
1506 A node is swapped\&.
1509 \fInode_transfer <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>\fR
1511 A node is transferred\&.
1514 \fInode_focus <monitor_id> <desktop_id> <node_id>\fR
1516 A node is focused\&.
1519 \fInode_activate <monitor_id> <desktop_id> <node_id>\fR
1521 A node is activated\&.
1524 \fInode_presel <monitor_id> <desktop_id> <node_id> (dir DIR|ratio RATIO|cancel)\fR
1526 A node is preselected\&.
1529 \fInode_stack <node_id_1> below|above <node_id_2>\fR
1531 A node is stacked below or above another node\&.
1534 \fInode_geometry <monitor_id> <desktop_id> <node_id> <node_geometry>\fR
1536 The geometry of a window changed\&.
1539 \fInode_state <monitor_id> <desktop_id> <node_id> tiled|pseudo_tiled|floating|fullscreen on|off\fR
1541 The state of a window changed\&.
1544 \fInode_flag <monitor_id> <desktop_id> <node_id> hidden|sticky|private|locked|marked|urgent on|off\fR
1546 One of the flags of a node changed\&.
1549 \fInode_layer <monitor_id> <desktop_id> <node_id> below|normal|above\fR
1551 The layer of a window changed\&.
1554 \fIpointer_action <monitor_id> <desktop_id> <node_id> move|resize_corner|resize_side begin|end\fR
1556 A pointer action occurred\&.
1559 Please note that \fBbspwm\fR initializes monitors before it reads messages on its socket, therefore the initial monitor events can\(cqt be received\&.
1562 Each report event message is composed of items separated by colons\&.
1564 Each item has the form \fI<type><value>\fR where \fI<type>\fR is the first character of the item\&.
1566 \fIM<monitor_name>\fR
1571 \fIm<monitor_name>\fR
1573 Unfocused monitor\&.
1576 \fIO<desktop_name>\fR
1578 Occupied focused desktop\&.
1581 \fIo<desktop_name>\fR
1583 Occupied unfocused desktop\&.
1586 \fIF<desktop_name>\fR
1588 Free focused desktop\&.
1591 \fIf<desktop_name>\fR
1593 Free unfocused desktop\&.
1596 \fIU<desktop_name>\fR
1598 Urgent focused desktop\&.
1601 \fIu<desktop_name>\fR
1603 Urgent unfocused desktop\&.
1608 Layout of the focused desktop of a monitor\&.
1613 State of the focused node of a focused desktop\&.
1618 Active flags of the focused node of a focused desktop\&.
1620 .SH "ENVIRONMENT VARIABLES"
1624 The path of the socket used for the communication between
1627 \fBbspwm\fR\&. If it isn\(cqt defined, then the following path is used:
1628 \fI/tmp/bspwm<host_name>_<display_number>_<screen_number>\-socket\fR\&.
1634 \h'-04'\(bu\h'+03'\c
1640 Steven Allen <steven at stebalien\&.com>
1645 \h'-04'\(bu\h'+03'\c
1651 Thomas Adam <thomas at xteddy\&.org>
1656 \h'-04'\(bu\h'+03'\c
1662 Ivan Kanakarakis <ivan\&.kanak at gmail\&.com>
1666 Bastien Dejean <nihilhill at gmail\&.com>