doc/bspwm.1.asciidoc

   1 :man source:   Bspwm
   2 :man version:  {revnumber}
   3 :man manual:   Bspwm Manual
   4
   5 bspwm(1)
   6 ========
   7
   8 Name
   9 ----
  10
  11 bspwm - Binary space partitioning window manager
  12
  13 Synopsis
  14 --------
  15
  16 *bspwm* [*-h*|*-v*|*-c* 'CONFIG_PATH']
  17
  18 *bspc* 'DOMAIN' ['SELECTOR'] 'COMMANDS'
  19
  20 *bspc* 'COMMAND' ['OPTIONS'] ['ARGUMENTS']
  21
  22 Description
  23 -----------
  24
  25 *bspwm* is a tiling window manager that represents windows as the leaves of a full binary tree.
  26
  27 It is controlled and configured via *bspc*.
  28
  29
  30 Options
  31 -------
  32
  33 *-h*::
  34         Print the synopsis and exit.
  35
  36 *-v*::
  37         Print the version and exit.
  38
  39 *-c* 'CONFIG_PATH'::
  40         Use the given configuration file.
  41
  42 Common Definitions
  43 ------------------
  44
  45 ----
  46 DIR         := north | west | south | east
  47 CYCLE_DIR   := next | prev
  48 ----
  49
  50 Selectors
  51 ---------
  52
  53 Selectors are used to select a target node, desktop, or monitor. A selector
  54 can either describe the target relatively or name it globally.
  55
  56 Selectors consist of an optional reference, a descriptor and any number of
  57 non-conflicting modifiers as follows:
  58
  59         [REFERENCE#]DESCRIPTOR(.MODIFIER)*
  60
  61 The relative targets are computed in relation to the given reference (the
  62 default reference value is *focused*).
  63
  64 An exclamation mark can be prepended to any modifier in order to reverse its
  65 meaning.
  66
  67 The following characters cannot be used in monitor or desktop names: *#*, *:*, *.*.
  68
  69 The special selector *%<name>* can be used to select a monitor or a desktop with an invalid name.
  70
  71 Node
  72 ~~~~
  73
  74 Select a node.
  75
  76 ----
  77 NODE_SEL := [NODE_SEL#](DIR|CYCLE_DIR|PATH|any|first_ancestor|last|newest|
  78                         older|newer|focused|pointed|biggest|smallest|
  79                         <node_id>)[.[!]focused][.[!]active][.[!]automatic][.[!]local]
  80                                   [.[!]leaf][.[!]window][.[!]STATE][.[!]FLAG][.[!]LAYER][.[!]SPLIT_TYPE]
  81                                   [.[!]same_class][.[!]descendant_of][.[!]ancestor_of]
  82
  83 STATE := tiled|pseudo_tiled|floating|fullscreen
  84
  85 FLAG := hidden|sticky|private|locked|marked|urgent
  86
  87 LAYER := below|normal|above
  88
  89 SPLIT_TYPE := horizontal|vertical
  90
  91 PATH := @[DESKTOP_SEL:][[/]JUMP](/JUMP)*
  92
  93 JUMP := first|1|second|2|brother|parent|DIR
  94 ----
  95
  96 Descriptors
  97 ^^^^^^^^^^^
  98
  99 'DIR'::
 100         Selects the window in the given (spacial) direction relative to the reference node.
 101
 102 'CYCLE_DIR'::
 103         Selects the node in the given (cyclic) direction relative to the reference node within a depth-first in-order traversal of the tree.
 104
 105 'PATH'::
 106         Selects the node at the given path.
 107
 108 any::
 109         Selects the first node that matches the given selectors.
 110
 111 first_ancestor::
 112         Selects the first ancestor of the reference node that matches the given selectors.
 113
 114 last::
 115         Selects the previously focused node relative to the reference node.
 116
 117 newest::
 118         Selects the newest node in the history of the focused node.
 119
 120 older::
 121         Selects the node older than the reference node in the history.
 122
 123 newer::
 124         Selects the node newer than the reference node in the history.
 125
 126 focused::
 127         Selects the currently focused node.
 128
 129 pointed::
 130         Selects the leaf under the pointer.
 131
 132 biggest::
 133         Selects the biggest leaf.
 134
 135 smallest::
 136         Selects the smallest leaf.
 137
 138 <node_id>::
 139         Selects the node with the given ID.
 140
 141 Path Jumps
 142 ^^^^^^^^^^
 143
 144 The initial node is the focused node (or the root if the path starts with '/') of the reference desktop (or the selected desktop if the path has a 'DESKTOP_SEL' prefix).
 145
 146 1|first::
 147         Jumps to the first child.
 148
 149 2|second::
 150         Jumps to the second child.
 151
 152 brother::
 153         Jumps to the brother node.
 154
 155 parent::
 156         Jumps to the parent node.
 157
 158 'DIR'::
 159         Jumps to the node holding the edge in the given direction.
 160
 161 Modifiers
 162 ^^^^^^^^^
 163
 164 [!]focused::
 165         Only consider the focused node.
 166
 167 [!]active::
 168         Only consider nodes that are the focused node of their desktop.
 169
 170 [!]automatic::
 171         Only consider nodes in automatic insertion mode. See also *--presel-dir* under *Node* in the *DOMAINS* section below.
 172
 173 [!]local::
 174         Only consider nodes in the reference desktop.
 175
 176 [!]leaf::
 177         Only consider leaf nodes.
 178
 179 [!]window::
 180         Only consider nodes that hold a window.
 181
 182 [!](tiled|pseudo_tiled|floating|fullscreen)::
 183         Only consider windows in the given state.
 184
 185 [!]same_class::
 186         Only consider windows that have the same class as the reference window.
 187
 188 [!]descendant_of::
 189         Only consider nodes that are descendants of the reference node.
 190
 191 [!]ancestor_of::
 192         Only consider nodes that are ancestors of the reference node.
 193
 194 [!](hidden|sticky|private|locked|marked|urgent)::
 195         Only consider windows that have the given flag set.
 196
 197 [!](below|normal|above)::
 198         Only consider windows in the given layer.
 199
 200 [!](horizontal|vertical)::
 201         Only consider nodes with the given split type.
 202
 203
 204 Desktop
 205 ~~~~~~~
 206
 207 Select a desktop.
 208
 209 ----
 210 DESKTOP_SEL := [DESKTOP_SEL#](CYCLE_DIR|any|last|newest|older|newer|
 211                               [MONITOR_SEL:](focused|^<n>)|
 212                               <desktop_id>|<desktop_name>)[.[!]focused][.[!]active]
 213                                                           [.[!]occupied][.[!]urgent][.[!]local]
 214                                                           [.[!]LAYOUT][.[!]user_LAYOUT]
 215
 216 LAYOUT := tiled|monocle
 217 ----
 218
 219 Descriptors
 220 ^^^^^^^^^^^
 221
 222 'CYCLE_DIR'::
 223         Selects the desktop in the given direction relative to the reference desktop.
 224
 225 any::
 226         Selects the first desktop that matches the given selectors.
 227
 228 last::
 229         Selects the previously focused desktop relative to the reference desktop.
 230
 231 newest::
 232         Selects the newest desktop in the history of the focused desktops.
 233
 234 older::
 235         Selects the desktop older than the reference desktop in the history.
 236
 237 newer::
 238         Selects the desktop newer than the reference desktop in the history.
 239
 240 focused::
 241         Selects the currently focused desktop.
 242
 243 ^<n>::
 244         Selects the nth desktop. If *MONITOR_SEL* is given, selects the nth desktop on the selected monitor.
 245
 246 <desktop_id>::
 247         Selects the desktop with the given ID.
 248
 249 <desktop_name>::
 250         Selects the desktop with the given name.
 251
 252 Modifiers
 253 ^^^^^^^^^
 254
 255 [!]focused::
 256         Only consider the focused desktop.
 257
 258 [!]active::
 259         Only consider desktops that are the focused desktop of their monitor.
 260
 261 [!]occupied::
 262         Only consider occupied desktops.
 263
 264 [!]urgent::
 265         Only consider urgent desktops.
 266
 267 [!]local::
 268         Only consider desktops inside the reference monitor.
 269
 270 [!](tiled|monocle)::
 271         Only consider desktops with the given layout.
 272
 273 [!](user_tiled|user_monocle)::
 274         Only consider desktops which have the given layout as userLayout.
 275
 276 Monitor
 277 ~~~~~~~
 278
 279 Select a monitor.
 280
 281 ----
 282 MONITOR_SEL := [MONITOR_SEL#](DIR|CYCLE_DIR|any|last|newest|older|newer|
 283                               focused|pointed|primary|^<n>|
 284                               <monitor_id>|<monitor_name>)[.[!]focused][.[!]occupied]
 285 ----
 286
 287 Descriptors
 288 ^^^^^^^^^^^
 289
 290 'DIR'::
 291         Selects the monitor in the given (spacial) direction relative to the reference monitor.
 292
 293 'CYCLE_DIR'::
 294         Selects the monitor in the given (cyclic) direction relative to the reference monitor.
 295
 296 any::
 297         Selects the first monitor that matches the given selectors.
 298
 299 last::
 300         Selects the previously focused monitor relative to the reference monitor.
 301
 302 newest::
 303         Selects the newest monitor in the history of the focused monitors.
 304
 305 older::
 306         Selects the monitor older than the reference monitor in the history.
 307
 308 newer::
 309         Selects the monitor newer than the reference monitor in the history.
 310
 311 focused::
 312         Selects the currently focused monitor.
 313
 314 pointed::
 315         Selects the monitor under the pointer.
 316
 317 primary::
 318         Selects the primary monitor.
 319
 320 ^<n>::
 321         Selects the nth monitor.
 322
 323 <monitor_id>::
 324         Selects the monitor with the given ID.
 325
 326 <monitor_name>::
 327         Selects the monitor with the given name.
 328
 329
 330 Modifiers
 331 ^^^^^^^^^
 332
 333 [!]focused::
 334         Only consider the focused monitor.
 335
 336 [!]occupied::
 337         Only consider monitors where the focused desktop is occupied.
 338
 339
 340
 341 Window States
 342 -------------
 343
 344 tiled::
 345         Its size and position are determined by the window tree.
 346
 347 pseudo_tiled::
 348         A tiled window that automatically shrinks but doesn't stretch beyond its floating size.
 349
 350 floating::
 351         Can be moved/resized freely. Although it doesn't use any tiling space, it is still part of the window tree.
 352
 353 fullscreen::
 354         Fills its monitor rectangle and has no borders.
 355
 356
 357 Node Flags
 358 ----------
 359
 360 hidden::
 361         Is hidden and doesn't occupy any tiling space.
 362
 363 sticky::
 364         Stays in the focused desktop of its monitor.
 365
 366 private::
 367         Tries to keep the same tiling position/size.
 368
 369 locked::
 370         Ignores the *node --close* message.
 371
 372 marked::
 373         Is marked (useful for deferred actions). A marked node becomes unmarked after being sent on a preselected node.
 374
 375 urgent::
 376         Has its urgency hint set. This flag is set externally.
 377
 378
 379 Stacking Layers
 380 --------------
 381
 382 There's three stacking layers: BELOW, NORMAL and ABOVE.
 383
 384 In each layer, the window are orderered as follow: tiled & pseudo-tiled < floating < fullscreen.
 385
 386 Receptacles
 387 -----------
 388
 389 A leaf node that doesn't 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 'examples/receptacles' to store and recreate layouts.
 390
 391
 392 Domains
 393 -------
 394
 395 Node
 396 ~~~~
 397
 398 General Syntax
 399 ^^^^^^^^^^^^^^
 400
 401 node ['NODE_SEL'] 'COMMANDS'
 402
 403 If 'NODE_SEL' is omitted, *focused* is assumed.
 404
 405 Commands
 406 ^^^^^^^^
 407 *-f*, *--focus* ['NODE_SEL']::
 408         Focus the selected or given node.
 409
 410 *-a*, *--activate* ['NODE_SEL']::
 411         Activate the selected or given node.
 412
 413 *-d*, *--to-desktop* 'DESKTOP_SEL' [*--follow*]::
 414         Send the selected node to the given desktop. If *--follow* is passed, the focused node will stay focused.
 415
 416 *-m*, *--to-monitor* 'MONITOR_SEL' [*--follow*]::
 417         Send the selected node to the given monitor. If *--follow* is passed, the focused node will stay focused.
 418
 419 *-n*, *--to-node* 'NODE_SEL' [*--follow*]::
 420         Send the selected node on the given node. If *--follow* is passed, the focused node will stay focused.
 421
 422 *-s*, *--swap* 'NODE_SEL' [*--follow*]::
 423         Swap the selected node with the given node. If *--follow* is passed, the focused node will stay focused.
 424
 425 *-p*, *--presel-dir* \[~]'DIR'|cancel::
 426         Preselect the splitting area of the selected node (or cancel the preselection). If *~* is prepended to 'DIR' and the current preselection direction matches 'DIR', then the argument is interpreted as *cancel*. A node with a preselected area is said to be in "manual insertion mode".
 427
 428 *-o*, *--presel-ratio* 'RATIO'::
 429         Set the splitting ratio of the preselection area.
 430
 431 *-v*, *--move* 'dx' 'dy'::
 432         Move the selected window by 'dx' pixels horizontally and 'dy' pixels vertically.
 433
 434 *-z*, *--resize* top|left|bottom|right|top_left|top_right|bottom_right|bottom_left 'dx' 'dy'::
 435         Resize the selected window by moving the given handle by 'dx' pixels horizontally and 'dy' pixels vertically.
 436
 437 *-r*, *--ratio* 'RATIO'|(+|-)('PIXELS'|'FRACTION')::
 438         Set the splitting ratio of the selected node (0 < 'RATIO' < 1).
 439
 440 *-R*, *--rotate* '90|270|180'::
 441         Rotate the tree rooted at the selected node.
 442
 443 *-F*, *--flip* 'horizontal|vertical'::
 444         Flip the the tree rooted at selected node.
 445
 446 *-E*, *--equalize*::
 447         Reset the split ratios of the tree rooted at the selected node to their default value.
 448
 449 *-B*, *--balance*::
 450         Adjust the split ratios of the tree rooted at the selected node so that all windows occupy the same area.
 451
 452 *-C*, *--circulate* forward|backward::
 453         Circulate the windows of the tree rooted at the selected node.
 454
 455 *-t*, *--state* [~](tiled|pseudo_tiled|floating|fullscreen)::
 456         Set the state of the selected window. If *~* is present and the current state matches the given state, then the argument is interpreted as the last state.
 457
 458 *-g*, *--flag* hidden|sticky|private|locked|marked[=on|off]::
 459         Set or toggle the given flag for the selected node.
 460
 461 *-l*, *--layer* below|normal|above::
 462         Set the stacking layer of the selected window.
 463
 464 *-i*, *--insert-receptacle*::
 465         Insert a receptacle node at the selected node.
 466
 467 *-c*, *--close*::
 468         Close the windows rooted at the selected node.
 469
 470 *-k*, *--kill*::
 471         Kill the windows rooted at the selected node.
 472
 473 Desktop
 474 ~~~~~~~
 475
 476 General Syntax
 477 ^^^^^^^^^^^^^^
 478
 479 desktop ['DESKTOP_SEL'] 'COMMANDS'
 480
 481 If 'DESKTOP_SEL' is omitted, *focused* is assumed.
 482
 483 COMMANDS
 484 ^^^^^^^^
 485 *-f*, *--focus* ['DESKTOP_SEL']::
 486         Focus the selected or given desktop.
 487
 488 *-a*, *--activate* ['DESKTOP_SEL']::
 489         Activate the selected or given desktop.
 490
 491 *-m*, *--to-monitor* 'MONITOR_SEL' [*--follow*]::
 492         Send the selected desktop to the given monitor. If *--follow* is passed, the focused desktop will stay focused.
 493
 494 *-s*, *--swap* 'DESKTOP_SEL' [*--follow*]::
 495         Swap the selected desktop with the given desktop. If *--follow* is passed, the focused desktop will stay focused.
 496
 497 *-l*, *--layout* 'CYCLE_DIR'|monocle|tiled::
 498         Set or cycle the layout of the selected desktop.
 499
 500 *-n*, *--rename* <new_name>::
 501         Rename the selected desktop.
 502
 503 *-b*, *--bubble* 'CYCLE_DIR'::
 504         Bubble the selected desktop in the given direction.
 505
 506 *-r*, *--remove*::
 507         Remove the selected desktop.
 508
 509 Monitor
 510 ~~~~~~~
 511
 512 General Syntax
 513 ^^^^^^^^^^^^^^
 514
 515 monitor ['MONITOR_SEL'] 'COMMANDS'
 516
 517 If 'MONITOR_SEL' is omitted, *focused* is assumed.
 518
 519 Commands
 520 ^^^^^^^^
 521 *-f*, *--focus* ['MONITOR_SEL']::
 522         Focus the selected or given monitor.
 523
 524 *-s*, *--swap* 'MONITOR_SEL'::
 525         Swap the selected monitor with the given monitor.
 526
 527 *-a*, *--add-desktops* <name>...::
 528         Create desktops with the given names in the selected monitor.
 529
 530 *-o*, *--reorder-desktops* <name>...::
 531         Reorder the desktops of the selected monitor to match the given order.
 532
 533 *-d*, *--reset-desktops* <name>...::
 534         Rename, add or remove desktops depending on whether the number of given names is equal, superior or inferior to the number of existing desktops.
 535
 536 *-g*, *--rectangle* WxH+X+Y::
 537         Set the rectangle of the selected monitor.
 538
 539 *-n*, *--rename* <new_name>::
 540         Rename the selected monitor.
 541
 542 *-r*, *--remove*::
 543         Remove the selected monitor.
 544
 545 Query
 546 ~~~~~
 547
 548 General Syntax
 549 ^^^^^^^^^^^^^^
 550
 551 query 'COMMANDS' ['OPTIONS']
 552
 553 Commands
 554 ^^^^^^^^
 555
 556 The optional selectors are references.
 557
 558 *-N*, *--nodes* ['NODE_SEL']::
 559         List the IDs of the matching nodes.
 560
 561 *-D*, *--desktops* ['DESKTOP_SEL']::
 562         List the IDs (or names) of the matching desktops.
 563
 564 *-M*, *--monitors* ['MONITOR_SEL']::
 565         List the IDs (or names) of the matching monitors.
 566
 567 *-T*, *--tree*::
 568         Print a JSON representation of the matching item.
 569
 570 Options
 571 ^^^^^^^
 572
 573 *-m*,*--monitor* ['MONITOR_SEL'|'MONITOR_MODIFIERS']::
 574 *-d*,*--desktop* ['DESKTOP_SEL'|'DESKTOP_MODIFIERS']::
 575 *-n*, *--node* ['NODE_SEL'|'NODE_MODIFIERS']::
 576         Constrain matches to the selected monitors, desktops or nodes.
 577
 578 *--names*::
 579         Print names instead of IDs. Can only be used with '-M' and '-D'.
 580
 581 Wm
 582 ~~
 583
 584 General Syntax
 585 ^^^^^^^^^^^^^^
 586
 587 wm 'COMMANDS'
 588
 589 Commands
 590 ^^^^^^^^
 591
 592 *-d*, *--dump-state*::
 593         Dump the current world state on standard output.
 594
 595 *-l*, *--load-state* <file_path>::
 596         Load a world state from the given file. The path must be absolute.
 597
 598 *-a*, *--add-monitor* <name> WxH+X+Y::
 599         Add a monitor for the given name and rectangle.
 600
 601 *-O*, *--reorder-monitors* <name>...::
 602         Reorder the list of monitors to match the given order.
 603
 604 *-o*, *--adopt-orphans*::
 605         Manage all the unmanaged windows remaining from a previous session.
 606
 607 *-h*, *--record-history* on|off::
 608         Enable or disable the recording of node focus history.
 609
 610 *-g*, *--get-status*::
 611         Print the current status information.
 612
 613 *-r*, *--restart*::
 614         Restart the window manager
 615
 616 Rule
 617 ~~~~
 618
 619 General Syntax
 620 ^^^^^^^^^^^^^^
 621
 622 rule 'COMMANDS'
 623
 624 Commands
 625 ^^^^^^^^
 626
 627 *-a*, *--add* (<class_name>|\*)[:(<instance_name>|\*)[:(<name>|\*)]] [*-o*|*--one-shot*] [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]::
 628         Create a new rule.
 629
 630 *-r*, *--remove* ^<n>|head|tail|(<class_name>|\*)[:(<instance_name>|\*)[:(<name>|*)]]...::
 631         Remove the given rules.
 632
 633 *-l*, *--list*::
 634         List the rules.
 635
 636 Config
 637 ~~~~~~
 638
 639 General Syntax
 640 ^^^^^^^^^^^^^^
 641
 642 config [-m 'MONITOR_SEL'|-d 'DESKTOP_SEL'|-n 'NODE_SEL'] <setting> [<value>]::
 643         Get or set the value of <setting>.
 644
 645 Subscribe
 646 ~~~~~~~~~
 647
 648 General Syntax
 649 ^^^^^^^^^^^^^^
 650 subscribe ['OPTIONS'] (all|report|monitor|desktop|node|...)*::
 651         Continuously print events. See the *EVENTS* section for the description of each event.
 652
 653 Options
 654 ^^^^^^^
 655
 656 *-f*, *--fifo*::
 657         Print a path to a FIFO from which events can be read and return.
 658
 659 *-c*, *--count* 'COUNT'::
 660         Stop the corresponding *bspc* process after having received 'COUNT' events.
 661
 662 Quit
 663 ~~~~
 664
 665 General Syntax
 666 ^^^^^^^^^^^^^^
 667
 668 quit [<status>]::
 669         Quit with an optional exit status.
 670
 671 Exit Codes
 672 ----------
 673
 674 If the server can't handle a message, *bspc* will return with a non-zero exit code.
 675
 676 Settings
 677 --------
 678 Colors are in the form '#RRGGBB', booleans are 'true', 'on', 'false' or 'off'.
 679
 680 All the boolean settings are 'false' by default unless stated otherwise.
 681
 682 Global Settings
 683 ~~~~~~~~~~~~~~~
 684
 685 'normal_border_color'::
 686         Color of the border of an unfocused window.
 687
 688 'active_border_color'::
 689         Color of the border of a focused window of an unfocused monitor.
 690
 691 'focused_border_color'::
 692         Color of the border of a focused window of a focused monitor.
 693
 694 'presel_feedback_color'::
 695         Color of the *node --presel-{dir,ratio}* message feedback area.
 696
 697 'split_ratio'::
 698         Default split ratio.
 699
 700 'status_prefix'::
 701         Prefix prepended to each of the status lines.
 702
 703 'external_rules_command'::
 704         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: *key1=value1 key2=value2 ...* (the valid key/value pairs are given in the description of the 'rule' command).
 705
 706 'automatic_scheme'::
 707         The insertion scheme used when the insertion point is in automatic mode. Accept the following values: *longest_side*, *alternate*, *spiral*.
 708
 709 'initial_polarity'::
 710         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: *first_child*, *second_child*.
 711
 712 'directional_focus_tightness'::
 713         The tightness of the algorithm used to decide whether a window is on the 'DIR' side of another window. Accept the following values: *high*, *low*.
 714
 715 'removal_adjustment'::
 716         Adjust the brother when unlinking a node from the tree in accordance with the automatic insertion scheme.
 717
 718 'presel_feedback'::
 719         Draw the preselection feedback area. Defaults to 'true'.
 720
 721 'borderless_monocle'::
 722         Remove borders of tiled windows for the *monocle* desktop layout.
 723
 724 'gapless_monocle'::
 725         Remove gaps of tiled windows for the *monocle* desktop layout.
 726
 727 'top_monocle_padding'::
 728 'right_monocle_padding'::
 729 'bottom_monocle_padding'::
 730 'left_monocle_padding'::
 731         Padding space added at the sides of the screen for the *monocle* desktop layout.
 732
 733 'single_monocle'::
 734         Set the desktop layout to *monocle* if there's only one tiled window in the tree.
 735
 736 'pointer_motion_interval'::
 737         The minimum interval, in milliseconds, between two motion notify events.
 738
 739 'pointer_modifier'::
 740         Keyboard modifier used for moving or resizing windows. Accept the following values: *shift*, *control*, *lock*, *mod1*, *mod2*, *mod3*, *mod4*, *mod5*.
 741
 742 'pointer_action1'::
 743 'pointer_action2'::
 744 'pointer_action3'::
 745         Action performed when pressing 'pointer_modifier' + 'button<n>'. Accept the following values: *move*, *resize_side*, *resize_corner*, *focus*, *none*.
 746
 747 'click_to_focus'::
 748         Button used for focusing a window (or a monitor). The possible values are: *button1*, *button2*, *button3*, *any*, *none*. Defaults to *button1*.
 749
 750 'swallow_first_click'::
 751         Don't replay the click that makes a window focused if 'click_to_focus' isn't *none*.
 752
 753 'focus_follows_pointer'::
 754         Focus the window under the pointer.
 755
 756 'pointer_follows_focus'::
 757         When focusing a window, put the pointer at its center.
 758
 759 'pointer_follows_monitor'::
 760         When focusing a monitor, put the pointer at its center.
 761
 762 'mapping_events_count'::
 763         Handle the next *mapping_events_count* mapping notify events. A negative value implies that every event needs to be handled.
 764
 765 'ignore_ewmh_focus'::
 766         Ignore EWMH focus requests coming from applications.
 767
 768 'ignore_ewmh_fullscreen'::
 769         Block the fullscreen state transitions that originate from an EWMH request. The possible values are: *none*, *all*, or a comma separated list of the following values: *enter*, *exit*.
 770
 771 'ignore_ewmh_struts'::
 772         Ignore strut hinting from clients requesting to reserve space (i.e. task bars).
 773
 774 'center_pseudo_tiled'::
 775         Center pseudo tiled windows into their tiling rectangles. Defaults to 'true'.
 776
 777 'honor_size_hints'::
 778         Apply ICCCM window size hints.
 779
 780 'remove_disabled_monitors'::
 781         Consider disabled monitors as disconnected.
 782
 783 'remove_unplugged_monitors'::
 784         Remove unplugged monitors.
 785
 786 'merge_overlapping_monitors'::
 787         Merge overlapping monitors (the bigger remains).
 788
 789 Monitor and Desktop Settings
 790 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 791
 792 'top_padding'::
 793 'right_padding'::
 794 'bottom_padding'::
 795 'left_padding'::
 796         Padding space added at the sides of the monitor or desktop.
 797
 798 Desktop Settings
 799 ~~~~~~~~~~~~~~~~
 800
 801 'window_gap'::
 802         Size of the gap that separates windows.
 803
 804 Node Settings
 805 ~~~~~~~~~~~~~
 806
 807 'border_width'::
 808         Window border width.
 809
 810 Pointer Bindings
 811 ----------------
 812
 813 'click_to_focus'::
 814         Focus the window (or the monitor) under the pointer if the value isn't *none*.
 815
 816 'pointer_modifier' + 'button1'::
 817         Move the window under the pointer.
 818
 819 'pointer_modifier' + 'button2'::
 820         Resize the window under the pointer by dragging the nearest side.
 821
 822 'pointer_modifier' + 'button3'::
 823         Resize the window under the pointer by dragging the nearest corner.
 824
 825 The behavior of 'pointer_modifier' + 'button<n>' can be modified through the 'pointer_action<n>' setting.
 826
 827 Events
 828 ------
 829
 830 'report'::
 831         See the next section for the description of the format.
 832
 833 'monitor_add <monitor_id> <monitor_name> <monitor_geometry>'::
 834         A monitor is added.
 835
 836 'monitor_rename <monitor_id> <old_name> <new_name>'::
 837         A monitor is renamed.
 838
 839 'monitor_remove <monitor_id>'::
 840         A monitor is removed.
 841
 842 'monitor_swap <src_monitor_id> <dst_monitor_id>'::
 843         A monitor is swapped.
 844
 845 'monitor_focus <monitor_id>'::
 846         A monitor is focused.
 847
 848 'monitor_geometry <monitor_id> <monitor_geometry>'::
 849         The geometry of a monitor changed.
 850
 851 'desktop_add <monitor_id> <desktop_id> <desktop_name>'::
 852         A desktop is added.
 853
 854 'desktop_rename <monitor_id> <desktop_id> <old_name> <new_name>'::
 855         A desktop is renamed.
 856
 857 'desktop_remove <monitor_id> <desktop_id>'::
 858         A desktop is removed.
 859
 860 'desktop_swap <src_monitor_id> <src_desktop_id> <dst_monitor_id> <dst_desktop_id>'::
 861         A desktop is swapped.
 862
 863 'desktop_transfer <src_monitor_id> <src_desktop_id> <dst_monitor_id>'::
 864         A desktop is transferred.
 865
 866 'desktop_focus <monitor_id> <desktop_id>'::
 867         A desktop is focused.
 868
 869 'desktop_activate <monitor_id> <desktop_id>'::
 870         A desktop is activated.
 871
 872 'desktop_layout <monitor_id> <desktop_id> tiled|monocle'::
 873         The layout of a desktop changed.
 874
 875 'node_add <monitor_id> <desktop_id> <ip_id> <node_id>'::
 876         A node is added.
 877
 878 'node_remove <monitor_id> <desktop_id> <node_id>'::
 879         A node is removed.
 880
 881 'node_swap <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>'::
 882         A node is swapped.
 883
 884 'node_transfer <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>'::
 885         A node is transferred.
 886
 887 'node_focus <monitor_id> <desktop_id> <node_id>'::
 888         A node is focused.
 889
 890 'node_activate <monitor_id> <desktop_id> <node_id>'::
 891         A node is activated.
 892
 893 'node_presel <monitor_id> <desktop_id> <node_id> (dir DIR|ratio RATIO|cancel)'::
 894         A node is preselected.
 895
 896 'node_stack <node_id_1> below|above <node_id_2>'::
 897         A node is stacked below or above another node.
 898
 899 'node_geometry <monitor_id> <desktop_id> <node_id> <node_geometry>'::
 900         The geometry of a window changed.
 901
 902 'node_state <monitor_id> <desktop_id> <node_id> tiled|pseudo_tiled|floating|fullscreen on|off'::
 903         The state of a window changed.
 904
 905 'node_flag <monitor_id> <desktop_id> <node_id> hidden|sticky|private|locked|marked|urgent on|off'::
 906         One of the flags of a node changed.
 907
 908 'node_layer <monitor_id> <desktop_id> <node_id> below|normal|above'::
 909         The layer of a window changed.
 910
 911 'pointer_action <monitor_id> <desktop_id> <node_id> move|resize_corner|resize_side begin|end'::
 912         A pointer action occurred.
 913
 914 Please note that *bspwm* initializes monitors before it reads messages on its socket, therefore the initial monitor events can't be received.
 915
 916 Report Format
 917 -------------
 918
 919 Each report event message is composed of items separated by colons.
 920
 921 Each item has the form '<type><value>' where '<type>' is the first character of the item.
 922
 923 'M<monitor_name>'::
 924         Focused monitor.
 925
 926 'm<monitor_name>'::
 927         Unfocused monitor.
 928
 929 'O<desktop_name>'::
 930         Occupied focused desktop.
 931
 932 'o<desktop_name>'::
 933         Occupied unfocused desktop.
 934
 935 'F<desktop_name>'::
 936         Free focused desktop.
 937
 938 'f<desktop_name>'::
 939         Free unfocused desktop.
 940
 941 'U<desktop_name>'::
 942         Urgent focused desktop.
 943
 944 'u<desktop_name>'::
 945         Urgent unfocused desktop.
 946
 947 'L(T|M)'::
 948         Layout of the focused desktop of a monitor.
 949
 950 'T(T|P|F|=|@)'::
 951         State of the focused node of a focused desktop.
 952
 953 'G(S?P?L?M?)'::
 954         Active flags of the focused node of a focused desktop.
 955
 956 Environment Variables
 957 ---------------------
 958
 959 'BSPWM_SOCKET'::
 960         The path of the socket used for the communication between *bspc* and *bspwm*. If it isn't defined, then the following path is used: '/tmp/bspwm<host_name>_<display_number>_<screen_number>-socket'.
 961
 962 Contributors
 963 ------------
 964
 965 * Steven Allen <steven at stebalien.com>
 966 * Thomas Adam <thomas at xteddy.org>
 967 * Ivan Kanakarakis <ivan.kanak at gmail.com>
 968
 969 Author
 970 ------
 971
 972 Bastien Dejean <nihilhill at gmail.com>