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