3 .\" Author: [see the "Author" section]
4 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
6 .\" Manual: Bspwm Manual
7 .\" Source: Bspwm 0.9.3-42-g0ba0ca3
10 .TH "BSPWM" "1" "01/14/2018" "Bspwm 0\&.9\&.3\-42\-g0ba0ca3" "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|last|
104 older|newer|focused|pointed|
105 biggest|<node_id>)[\&.[!]focused][\&.[!]automatic][\&.[!]local][\&.[!]active]
106 [\&.[!]leaf][\&.[!]window][\&.[!]STATE][\&.[!]FLAG][\&.[!]LAYER]
107 [\&.[!]same_class][\&.[!]descendant_of][\&.[!]ancestor_of]
109 STATE := tiled|pseudo_tiled|floating|fullscreen
111 FLAG := hidden|sticky|private|locked|urgent
113 LAYER := below|normal|above
115 PATH := @[DESKTOP_SEL:][[/]JUMP](/JUMP)*
117 JUMP := first|1|second|2|brother|parent|DIR
124 .nr an-no-space-flag 1
133 Selects the window in the given (spacial) direction relative to the reference node\&.
138 Selects the window in the given (cyclic) direction relative to the reference node\&.
143 Selects the node at the given path\&.
148 Selects the previously focused node relative to the reference node\&.
153 Selects the node older than the reference node in the history\&.
158 Selects the node newer than the reference node in the history\&.
163 Selects the currently focused node\&.
168 Selects the window under the pointer\&.
173 Selects the biggest window\&.
178 Selects the node with the given ID\&.
183 .nr an-no-space-flag 1
190 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)\&.
194 Jumps to the first child\&.
199 Jumps to the second child\&.
204 Jumps to the brother node\&.
209 Jumps to the parent node\&.
214 Jumps to the node holding the edge in the given direction\&.
219 .nr an-no-space-flag 1
228 Only consider focused or unfocused nodes\&.
233 Only consider nodes in automatic or manual insertion mode\&. See also
234 \fB\-\-presel\-dir\fR
244 Only consider nodes in or not in the reference desktop\&.
249 Only consider nodes in or not in the active desktop of their monitor\&.
254 Only consider leaves or internal nodes\&.
259 Only consider nodes that hold or don\(cqt hold a window\&.
262 [!](tiled|pseudo_tiled|floating|fullscreen)
264 Only consider windows in or not in the given state\&.
269 Only consider windows that have or don\(cqt have the same class as the reference window\&.
274 Only consider nodes that are or aren\(cqt descendants of the reference node\&.
279 Only consider nodes that are or aren\(cqt ancestors of the reference node\&.
282 [!](hidden|sticky|private|locked|urgent)
284 Only consider windows that have or don\(cqt have the given flag set\&.
287 [!](below|normal|above)
289 Only consider windows in or not in the given layer\&.
300 DESKTOP_SEL := [DESKTOP_SEL#](CYCLE_DIR|last|older|newer|
301 [MONITOR_SEL:](focused|^<n>)|
302 <desktop_id>|<desktop_name>)[\&.[!]occupied][\&.[!]focused][\&.[!]urgent][\&.[!]local]
309 .nr an-no-space-flag 1
318 Selects the desktop in the given direction relative to the reference desktop\&.
323 Selects the previously focused desktop relative to the reference desktop\&.
328 Selects the desktop older than the reference desktop in the history\&.
333 Selects the desktop newer than the reference desktop in the history\&.
338 Selects the currently focused desktop\&.
343 Selects the nth desktop\&. If
345 is given, selects the nth desktop on the selected monitor\&.
350 Selects the desktop with the given ID\&.
355 Selects the desktop with the given name\&.
360 .nr an-no-space-flag 1
369 Only consider occupied or free desktops\&.
374 Only consider focused or unfocused desktops\&.
379 Only consider urgent or non urgent desktops\&.
384 Only consider desktops inside or outside of the reference monitor\&.
395 MONITOR_SEL := [MONITOR_SEL#](DIR|CYCLE_DIR|last|older|newer|
396 focused|pointed|primary|^<n>|
397 <monitor_id>|<monitor_name>)[\&.[!]occupied][\&.[!]focused]
404 .nr an-no-space-flag 1
413 Selects the monitor in the given (spacial) direction relative to the reference monitor\&.
418 Selects the monitor in the given (cyclic) direction relative to the reference monitor\&.
423 Selects the previously focused monitor relative to the reference monitor\&.
428 Selects the monitor older than the reference monitor in the history\&.
433 Selects the monitor newer than the reference monitor in the history\&.
438 Selects the currently focused monitor\&.
443 Selects the monitor under the pointer\&.
448 Selects the primary monitor\&.
453 Selects the nth monitor\&.
458 Selects the monitor with the given ID\&.
463 Selects the monitor with the given name\&.
468 .nr an-no-space-flag 1
477 Only consider monitors where the focused desktop is occupied or free\&.
482 Only consider focused or unfocused monitors\&.
489 Its size and position are determined by the splitting type and ratio of each node of its path in the window tree\&.
494 Has an unrestricted size while being centered in its tiling space\&.
499 Can be moved/resized freely\&. Although it doesn\(cqt occupy any tiling space, it is still part of the window tree\&.
504 Fills its monitor rectangle and has no borders\&. It is send in the ABOVE layer by default\&.
510 Is hidden and doesn\(cqt occupy any tiling space\&.
515 Stays in the focused desktop of its monitor\&.
520 Tries to keep the same tiling position/size\&.
532 Has its urgency hint set\&. This flag is set externally\&.
534 .SH "STACKING LAYERS"
536 There\(cqs three stacking layers: BELOW, NORMAL and ABOVE\&.
538 In each layer, the window are orderered as follow: tiled & pseudo\-tiled < fullscreen < floating\&.
543 .nr an-no-space-flag 1
550 node [\fINODE_SEL\fR] \fICOMMANDS\fR
552 If \fINODE_SEL\fR is omitted, \fBfocused\fR is assumed\&.
556 .nr an-no-space-flag 1
563 \fB\-f\fR, \fB\-\-focus\fR [\fINODE_SEL\fR]
565 Focus the selected or given node\&.
568 \fB\-a\fR, \fB\-\-activate\fR [\fINODE_SEL\fR]
570 Activate the selected or given node\&.
573 \fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR [\fB\-\-follow\fR]
575 Send the selected node to the given desktop\&. If
577 is passed, the focused node will stay focused\&.
580 \fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR [\fB\-\-follow\fR]
582 Send the selected node to the given monitor\&. If
584 is passed, the focused node will stay focused\&.
587 \fB\-n\fR, \fB\-\-to\-node\fR \fINODE_SEL\fR [\fB\-\-follow\fR]
589 Send the selected node on the given node\&. If
591 is passed, the focused node will stay focused\&.
594 \fB\-s\fR, \fB\-\-swap\fR \fINODE_SEL\fR [\fB\-\-follow\fR]
596 Swap the selected node with the given node\&. If
598 is passed, the focused node will stay focused\&.
601 \fB\-p\fR, \fB\-\-presel\-dir\fR [~]\fIDIR\fR|cancel
603 Preselect the splitting area of the selected node (or cancel the preselection)\&. If
607 and the current preselection direction matches
608 \fIDIR\fR, then the argument is interpreted as
609 \fBcancel\fR\&. A node with a preselected area is said to be in "manual insertion mode"\&.
612 \fB\-o\fR, \fB\-\-presel\-ratio\fR \fIRATIO\fR
614 Set the splitting ratio of the preselection area\&.
617 \fB\-v\fR, \fB\-\-move\fR \fIdx\fR \fIdy\fR
619 Move the selected window by
621 pixels horizontally and
626 \fB\-z\fR, \fB\-\-resize\fR top|left|bottom|right|top_left|top_right|bottom_right|bottom_left \fIdx\fR \fIdy\fR
628 Resize the selected window by moving the given handle by
630 pixels horizontally and
635 \fB\-r\fR, \fB\-\-ratio\fR \fIRATIO\fR|(+|\-)(\fIPIXELS\fR|\fIFRACTION\fR)
637 Set the splitting ratio of the selected node (0 <
642 \fB\-R\fR, \fB\-\-rotate\fR \fI90|270|180\fR
644 Rotate the tree rooted at the selected node\&.
647 \fB\-F\fR, \fB\-\-flip\fR \fIhorizontal|vertical\fR
649 Flip the the tree rooted at selected node\&.
652 \fB\-E\fR, \fB\-\-equalize\fR
654 Reset the split ratios of the tree rooted at the selected node to their default value\&.
657 \fB\-B\fR, \fB\-\-balance\fR
659 Adjust the split ratios of the tree rooted at the selected node so that all windows occupy the same area\&.
662 \fB\-C\fR, \fB\-\-circulate\fR forward|backward
664 Circulate the windows of the tree rooted at the selected node\&.
667 \fB\-t\fR, \fB\-\-state\fR [~](tiled|pseudo_tiled|floating|fullscreen)
669 Set the state of the selected window\&. If
671 is present and the current state matches the given state, then the argument is interpreted as the last state\&.
674 \fB\-g\fR, \fB\-\-flag\fR hidden|sticky|private|locked[=on|off]
676 Set or toggle the given flag for the selected node\&.
679 \fB\-l\fR, \fB\-\-layer\fR below|normal|above
681 Set the stacking layer of the selected window\&.
684 \fB\-i\fR, \fB\-\-insert\-receptacle\fR
686 Insert a receptacle node at the selected node\&.
689 \fB\-c\fR, \fB\-\-close\fR
691 Close the windows rooted at the selected node\&.
694 \fB\-k\fR, \fB\-\-kill\fR
696 Kill the windows rooted at the selected node\&.
702 .nr an-no-space-flag 1
709 desktop [\fIDESKTOP_SEL\fR] \fICOMMANDS\fR
711 If \fIDESKTOP_SEL\fR is omitted, \fBfocused\fR is assumed\&.
715 .nr an-no-space-flag 1
722 \fB\-f\fR, \fB\-\-focus\fR [\fIDESKTOP_SEL\fR]
724 Focus the selected or given desktop\&.
727 \fB\-a\fR, \fB\-\-activate\fR [\fIDESKTOP_SEL\fR]
729 Activate the selected or given desktop\&.
732 \fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR [\fB\-\-follow\fR]
734 Send the selected desktop to the given monitor\&. If
736 is passed, the focused desktop will stay focused\&.
739 \fB\-s\fR, \fB\-\-swap\fR \fIDESKTOP_SEL\fR [\fB\-\-follow\fR]
741 Swap the selected desktop with the given desktop\&. If
743 is passed, the focused desktop will stay focused\&.
746 \fB\-l\fR, \fB\-\-layout\fR \fICYCLE_DIR\fR|monocle|tiled
748 Set or cycle the layout of the selected desktop\&.
751 \fB\-n\fR, \fB\-\-rename\fR <new_name>
753 Rename the selected desktop\&.
756 \fB\-b\fR, \fB\-\-bubble\fR \fICYCLE_DIR\fR
758 Bubble the selected desktop in the given direction\&.
761 \fB\-r\fR, \fB\-\-remove\fR
763 Remove the selected desktop\&.
769 .nr an-no-space-flag 1
776 monitor [\fIMONITOR_SEL\fR] \fICOMMANDS\fR
778 If \fIMONITOR_SEL\fR is omitted, \fBfocused\fR is assumed\&.
782 .nr an-no-space-flag 1
789 \fB\-f\fR, \fB\-\-focus\fR [\fIMONITOR_SEL\fR]
791 Focus the selected or given monitor\&.
794 \fB\-s\fR, \fB\-\-swap\fR \fIMONITOR_SEL\fR
796 Swap the selected monitor with the given monitor\&.
799 \fB\-a\fR, \fB\-\-add\-desktops\fR <name>\&...
801 Create desktops with the given names in the selected monitor\&.
804 \fB\-o\fR, \fB\-\-reorder\-desktops\fR <name>\&...
806 Reorder the desktops of the selected monitor to match the given order\&.
809 \fB\-d\fR, \fB\-\-reset\-desktops\fR <name>\&...
811 Rename, add or remove desktops depending on whether the number of given names is equal, superior or inferior to the number of existing desktops\&.
814 \fB\-g\fR, \fB\-\-rectangle\fR WxH+X+Y
816 Set the rectangle of the selected monitor\&.
819 \fB\-n\fR, \fB\-\-rename\fR <new_name>
821 Rename the selected monitor\&.
824 \fB\-r\fR, \fB\-\-remove\fR
826 Remove the selected monitor\&.
832 .nr an-no-space-flag 1
839 query \fICOMMANDS\fR [\fIOPTIONS\fR]
843 .nr an-no-space-flag 1
850 The optional selectors are references\&.
852 \fB\-N\fR, \fB\-\-nodes\fR [\fINODE_SEL\fR]
854 List the IDs of the matching nodes\&.
857 \fB\-D\fR, \fB\-\-desktops\fR [\fIDESKTOP_SEL\fR]
859 List the IDs (or names) of the matching desktops\&.
862 \fB\-M\fR, \fB\-\-monitors\fR [\fIMONITOR_SEL\fR]
864 List the IDs (or names) of the matching monitors\&.
867 \fB\-T\fR, \fB\-\-tree\fR
869 Print a JSON representation of the matching item\&.
874 .nr an-no-space-flag 1
881 \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]
883 Constrain matches to the selected monitor, desktop or node\&. The descriptor can be omitted for
892 Print names instead of IDs\&. Can only be used with
901 .nr an-no-space-flag 1
912 .nr an-no-space-flag 1
919 \fB\-d\fR, \fB\-\-dump\-state\fR
921 Dump the current world state on standard output\&.
924 \fB\-l\fR, \fB\-\-load\-state\fR <file_path>
926 Load a world state from the given file\&.
929 \fB\-a\fR, \fB\-\-add\-monitor\fR <name> WxH+X+Y
931 Add a monitor for the given name and rectangle\&.
934 \fB\-O\fR, \fB\-\-reorder\-monitors\fR <name>\&...
936 Reorder the list of monitors to match the given order\&.
939 \fB\-o\fR, \fB\-\-adopt\-orphans\fR
941 Manage all the unmanaged windows remaining from a previous session\&.
944 \fB\-h\fR, \fB\-\-record\-history\fR on|off
946 Enable or disable the recording of node focus history\&.
949 \fB\-g\fR, \fB\-\-get\-status\fR
951 Print the current status information\&.
957 .nr an-no-space-flag 1
968 .nr an-no-space-flag 1
975 \fB\-a\fR, \fB\-\-add\fR (<class_name>|*)[:(<instance_name>|*)] [\fB\-o\fR|\fB\-\-one\-shot\fR] [monitor=MONITOR_SEL|desktop=DESKTOP_SEL|node=NODE_SEL] [state=STATE] [layer=LAYER] [split_dir=DIR] [split_ratio=RATIO] [(hidden|sticky|private|locked|center|follow|manage|focus|border)=(on|off)] [rectangle=WxH+X+Y]
980 \fB\-r\fR, \fB\-\-remove\fR ^<n>|head|tail|(<class_name>|*)[:(<instance_name>|*)]\&...
982 Remove the given rules\&.
985 \fB\-l\fR, \fB\-\-list\fR
993 .nr an-no-space-flag 1
1000 config [\-m \fIMONITOR_SEL\fR|\-d \fIDESKTOP_SEL\fR|\-n \fINODE_SEL\fR] <setting> [<value>]
1002 Get or set the value of <setting>\&.
1008 .nr an-no-space-flag 1
1012 \fBGeneral Syntax\fR
1015 subscribe [\fIOPTIONS\fR] (all|report|monitor|desktop|node|\&...)*
1017 Continuously print events\&. See the
1019 section for the description of each event\&.
1024 .nr an-no-space-flag 1
1031 \fB\-f\fR, \fB\-\-fifo\fR
1033 Print a path to a FIFO from which events can be read and return\&.
1036 \fB\-c\fR, \fB\-\-count\fR \fICOUNT\fR
1038 Stop the corresponding
1040 process after having received
1048 .nr an-no-space-flag 1
1052 \fBGeneral Syntax\fR
1057 Quit with an optional exit status\&.
1062 If the server can\(cqt handle a message, \fBbspc\fR will return with a non\-zero exit code\&.
1065 Colors are in the form \fI#RRGGBB\fR, booleans are \fItrue\fR, \fIon\fR, \fIfalse\fR or \fIoff\fR\&.
1067 All the boolean settings are \fIfalse\fR by default unless stated otherwise\&.
1068 .SS "Global Settings"
1070 \fInormal_border_color\fR
1072 Color of the border of an unfocused window\&.
1075 \fIactive_border_color\fR
1077 Color of the border of a focused window of an unfocused monitor\&.
1080 \fIfocused_border_color\fR
1082 Color of the border of a focused window of a focused monitor\&.
1085 \fIpresel_feedback_color\fR
1088 \fBnode \-\-presel\-{dir,ratio}\fR
1089 message feedback area\&.
1094 Default split ratio\&.
1099 Prefix prepended to each of the status lines\&.
1102 \fIexternal_rules_command\fR
1104 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:
1105 \fBkey1=value1 key2=value2 \&...\fR
1106 (the valid key/value pairs are given in the description of the
1111 \fIinitial_polarity\fR
1113 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:
1115 \fBsecond_child\fR\&.
1118 \fIdirectional_focus_tightness\fR
1120 The tightness of the algorithm used to decide whether a window is on the
1122 side of another window\&. Accept the following values:
1127 \fIborderless_monocle\fR
1129 Remove borders of tiled windows for the
1134 \fIgapless_monocle\fR
1136 Remove gaps of tiled windows for the
1141 \fIpaddingless_monocle\fR
1143 Remove padding space for the
1148 \fIsingle_monocle\fR
1150 Set the desktop layout to
1152 if there\(cqs only one tiled window in the tree\&.
1155 \fIpointer_motion_interval\fR
1157 The minimum interval, in milliseconds, between two motion notify events\&.
1160 \fIpointer_modifier\fR
1162 Keyboard modifier used for moving or resizing windows\&. Accept the following values:
1173 \fIpointer_action1\fR, \fIpointer_action2\fR, \fIpointer_action3\fR
1175 Action performed when pressing
1176 \fIpointer_modifier\fR
1178 \fIbutton<n>\fR\&. Accept the following values:
1181 \fBresize_corner\fR,
1186 \fIclick_to_focus\fR
1188 Button used for focusing a window (or a monitor)\&. The possible values are:
1196 \fIswallow_first_click\fR
1198 Don\(cqt replay the click that makes a window focused if
1199 \fIclick_to_focus\fR
1204 \fIfocus_follows_pointer\fR
1206 Focus the window under the pointer\&.
1209 \fIpointer_follows_focus\fR
1211 When focusing a window, put the pointer at its center\&.
1214 \fIpointer_follows_monitor\fR
1216 When focusing a monitor, put the pointer at its center\&.
1219 \fIignore_ewmh_focus\fR
1221 Ignore EWMH focus requests coming from applications\&.
1224 \fIcenter_pseudo_tiled\fR
1226 Center pseudo tiled windows into their tiling rectangles\&. Defaults to
1230 \fIhonor_size_hints\fR
1232 Apply ICCCM window size hints\&.
1235 \fIremove_disabled_monitors\fR
1237 Consider disabled monitors as disconnected\&.
1240 \fIremove_unplugged_monitors\fR
1242 Remove unplugged monitors\&.
1245 \fImerge_overlapping_monitors\fR
1247 Merge overlapping monitors (the bigger remains)\&.
1249 .SS "Monitor and Desktop Settings"
1251 \fItop_padding\fR, \fIright_padding\fR, \fIbottom_padding\fR, \fIleft_padding\fR
1253 Padding space added at the sides of the monitor or desktop\&.
1255 .SS "Desktop Settings"
1259 Size of the gap that separates windows\&.
1265 Window border width\&.
1267 .SH "POINTER BINDINGS"
1269 \fIclick_to_focus\fR
1271 Focus the window (or the monitor) under the pointer if the value isn\(cqt
1275 \fIpointer_modifier\fR + \fIbutton1\fR
1277 Move the window under the pointer\&.
1280 \fIpointer_modifier\fR + \fIbutton2\fR
1282 Resize the window under the pointer by dragging the nearest side\&.
1285 \fIpointer_modifier\fR + \fIbutton3\fR
1287 Resize the window under the pointer by dragging the nearest corner\&.
1290 The behavior of \fIpointer_modifier\fR + \fIbutton<n>\fR can be modified through the \fIpointer_action<n>\fR setting\&.
1295 See the next section for the description of the format\&.
1298 \fImonitor_add <monitor_id> <monitor_name> <monitor_geometry>\fR
1300 A monitor is added\&.
1303 \fImonitor_rename <monitor_id> <old_name> <new_name>\fR
1305 A monitor is renamed\&.
1308 \fImonitor_remove <monitor_id>\fR
1310 A monitor is removed\&.
1313 \fImonitor_swap <src_monitor_id> <dst_monitor_id>\fR
1315 A monitor is swapped\&.
1318 \fImonitor_focus <monitor_id>\fR
1320 A monitor is focused\&.
1323 \fImonitor_geometry <monitor_id> <monitor_geometry>\fR
1325 The geometry of a monitor changed\&.
1328 \fIdesktop_add <monitor_id> <desktop_id> <desktop_name>\fR
1330 A desktop is added\&.
1333 \fIdesktop_rename <monitor_id> <desktop_id> <old_name> <new_name>\fR
1335 A desktop is renamed\&.
1338 \fIdesktop_remove <monitor_id> <desktop_id>\fR
1340 A desktop is removed\&.
1343 \fIdesktop_swap <src_monitor_id> <src_desktop_id> <dst_monitor_id> <dst_desktop_id>\fR
1345 A desktop is swapped\&.
1348 \fIdesktop_transfer <src_monitor_id> <src_desktop_id> <dst_monitor_id>\fR
1350 A desktop is transferred\&.
1353 \fIdesktop_focus <monitor_id> <desktop_id>\fR
1355 A desktop is focused\&.
1358 \fIdesktop_activate <monitor_id> <desktop_id>\fR
1360 A desktop is activated\&.
1363 \fIdesktop_layout <monitor_id> <desktop_id> tiled|monocle\fR
1365 The layout of a desktop changed\&.
1368 \fInode_add <monitor_id> <desktop_id> <ip_id> <node_id>\fR
1373 \fInode_remove <monitor_id> <desktop_id> <node_id>\fR
1375 A node is removed\&.
1378 \fInode_swap <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>\fR
1380 A node is swapped\&.
1383 \fInode_transfer <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>\fR
1385 A node is transferred\&.
1388 \fInode_focus <monitor_id> <desktop_id> <node_id>\fR
1390 A node is focused\&.
1393 \fInode_activate <monitor_id> <desktop_id> <node_id>\fR
1395 A node is activated\&.
1398 \fInode_presel <monitor_id> <desktop_id> <node_id> (dir DIR|ratio RATIO|cancel)\fR
1400 A node is preselected\&.
1403 \fInode_stack <node_id_1> below|above <node_id_2>\fR
1405 A node is stacked below or above another node\&.
1408 \fInode_geometry <monitor_id> <desktop_id> <node_id> <node_geometry>\fR
1410 The geometry of a window changed\&.
1413 \fInode_state <monitor_id> <desktop_id> <node_id> tiled|pseudo_tiled|floating|fullscreen on|off\fR
1415 The state of a window changed\&.
1418 \fInode_flag <monitor_id> <desktop_id> <node_id> hidden|sticky|private|locked|urgent on|off\fR
1420 One of the flags of a node changed\&.
1423 \fInode_layer <monitor_id> <desktop_id> <node_id> below|normal|above\fR
1425 The layer of a window changed\&.
1428 \fIpointer_action <monitor_id> <desktop_id> <node_id> move|resize_corner|resize_side begin|end\fR
1430 A pointer action occured\&.
1433 Please note that \fBbspwm\fR initializes monitors before it reads messages on its socket, therefore the initial monitor events can\(cqt be received\&.
1436 Each report event message is composed of items separated by colons\&.
1438 Each item has the form \fI<type><value>\fR where \fI<type>\fR is the first character of the item\&.
1440 \fIM<monitor_name>\fR
1445 \fIm<monitor_name>\fR
1447 Unfocused monitor\&.
1450 \fIO<desktop_name>\fR
1452 Occupied focused desktop\&.
1455 \fIo<desktop_name>\fR
1457 Occupied unfocused desktop\&.
1460 \fIF<desktop_name>\fR
1462 Free focused desktop\&.
1465 \fIf<desktop_name>\fR
1467 Free unfocused desktop\&.
1470 \fIU<desktop_name>\fR
1472 Urgent focused desktop\&.
1475 \fIu<desktop_name>\fR
1477 Urgent unfocused desktop\&.
1482 Layout of the focused desktop of a monitor\&.
1487 State of the focused node of a focused desktop\&.
1492 Active flags of the focused node of a focused desktop\&.
1494 .SH "ENVIRONMENT VARIABLES"
1498 The path of the socket used for the communication between
1501 \fBbspwm\fR\&. If it isn\(cqt defined, then the following path is used:
1502 \fI/tmp/bspwm<host_name>_<display_number>_<screen_number>\-socket\fR\&.
1508 \h'-04'\(bu\h'+03'\c
1514 Steven Allen <steven at stebalien\&.com>
1519 \h'-04'\(bu\h'+03'\c
1525 Thomas Adam <thomas at xteddy\&.org>
1530 \h'-04'\(bu\h'+03'\c
1536 Ivan Kanakarakis <ivan\&.kanak at gmail\&.com>
1540 Bastien Dejean <nihilhill at gmail\&.com>