doc/bspwm.1

   1 '\" t
   2 .\"     Title: bspwm
   3 .\"    Author: [see the "Author" section]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
   5 .\"      Date: 07/27/2019
   6 .\"    Manual: Bspwm Manual
   7 .\"    Source: Bspwm 0.9.8
   8 .\"  Language: English
   9 .\"
  10 .TH "BSPWM" "1" "07/27/2019" "Bspwm 0\&.9\&.8" "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 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 bspwm \- Binary space partitioning window manager
  32 .SH "SYNOPSIS"
  33 .sp
  34 \fBbspwm\fR [\fB\-h\fR|\fB\-v\fR|\fB\-c\fR \fICONFIG_PATH\fR]
  35 .sp
  36 \fBbspc\fR \fIDOMAIN\fR [\fISELECTOR\fR] \fICOMMANDS\fR
  37 .sp
  38 \fBbspc\fR \fICOMMAND\fR [\fIOPTIONS\fR] [\fIARGUMENTS\fR]
  39 .SH "DESCRIPTION"
  40 .sp
  41 \fBbspwm\fR is a tiling window manager that represents windows as the leaves of a full binary tree\&.
  42 .sp
  43 It is controlled and configured via \fBbspc\fR\&.
  44 .SH "OPTIONS"
  45 .PP
  46 \fB\-h\fR
  47 .RS 4
  48 Print the synopsis and exit\&.
  49 .RE
  50 .PP
  51 \fB\-v\fR
  52 .RS 4
  53 Print the version and exit\&.
  54 .RE
  55 .PP
  56 \fB\-c\fR \fICONFIG_PATH\fR
  57 .RS 4
  58 Use the given configuration file\&.
  59 .RE
  60 .SH "COMMON DEFINITIONS"
  61 .sp
  62 .if n \{\
  63 .RS 4
  64 .\}
  65 .nf
  66 DIR         := north | west | south | east
  67 CYCLE_DIR   := next | prev
  68 .fi
  69 .if n \{\
  70 .RE
  71 .\}
  72 .SH "SELECTORS"
  73 .sp
  74 Selectors are used to select a target node, desktop, or monitor\&. A selector can either describe the target relatively or name it globally\&.
  75 .sp
  76 Selectors consist of an optional reference, a descriptor and any number of non\-conflicting modifiers as follows:
  77 .sp
  78 .if n \{\
  79 .RS 4
  80 .\}
  81 .nf
  82 [REFERENCE#]DESCRIPTOR(\&.MODIFIER)*
  83 .fi
  84 .if n \{\
  85 .RE
  86 .\}
  87 .sp
  88 The relative targets are computed in relation to the given reference (the default reference value is \fBfocused\fR)\&.
  89 .sp
  90 An exclamation mark can be prepended to any modifier in order to reverse its meaning\&.
  91 .sp
  92 The following characters cannot be used in monitor or desktop names: \fB#\fR, \fB:\fR, \fB\&.\fR\&.
  93 .sp
  94 The special selector \fB%<name>\fR can be used to select a monitor or a desktop with an invalid name\&.
  95 .SS "Node"
  96 .sp
  97 Select a node\&.
  98 .sp
  99 .if n \{\
 100 .RS 4
 101 .\}
 102 .nf
 103 NODE_SEL := [NODE_SEL#](DIR|CYCLE_DIR|PATH|any|last|newest|
 104                         older|newer|focused|pointed|biggest|smallest|
 105                         <node_id>)[\&.[!]focused][\&.[!]active][\&.[!]automatic][\&.[!]local]
 106                                   [\&.[!]leaf][\&.[!]window][\&.[!]STATE][\&.[!]FLAG][\&.[!]LAYER]
 107                                   [\&.[!]same_class][\&.[!]descendant_of][\&.[!]ancestor_of]
 108
 109 STATE := tiled|pseudo_tiled|floating|fullscreen
 110
 111 FLAG := hidden|sticky|private|locked|marked|urgent
 112
 113 LAYER := below|normal|above
 114
 115 PATH := @[DESKTOP_SEL:][[/]JUMP](/JUMP)*
 116
 117 JUMP := first|1|second|2|brother|parent|DIR
 118 .fi
 119 .if n \{\
 120 .RE
 121 .\}
 122 .sp
 123 .it 1 an-trap
 124 .nr an-no-space-flag 1
 125 .nr an-break-flag 1
 126 .br
 127 .ps +1
 128 \fBDescriptors\fR
 129 .RS 4
 130 .PP
 131 \fIDIR\fR
 132 .RS 4
 133 Selects the window in the given (spacial) direction relative to the reference node\&.
 134 .RE
 135 .PP
 136 \fICYCLE_DIR\fR
 137 .RS 4
 138 Selects the window in the given (cyclic) direction relative to the reference node\&.
 139 .RE
 140 .PP
 141 \fIPATH\fR
 142 .RS 4
 143 Selects the node at the given path\&.
 144 .RE
 145 .PP
 146 any
 147 .RS 4
 148 Selects the first node that matches the given selectors\&.
 149 .RE
 150 .PP
 151 last
 152 .RS 4
 153 Selects the previously focused node relative to the reference node\&.
 154 .RE
 155 .PP
 156 newest
 157 .RS 4
 158 Selects the newest node in the history of the focused node\&.
 159 .RE
 160 .PP
 161 older
 162 .RS 4
 163 Selects the node older than the reference node in the history\&.
 164 .RE
 165 .PP
 166 newer
 167 .RS 4
 168 Selects the node newer than the reference node in the history\&.
 169 .RE
 170 .PP
 171 focused
 172 .RS 4
 173 Selects the currently focused node\&.
 174 .RE
 175 .PP
 176 pointed
 177 .RS 4
 178 Selects the window under the pointer\&.
 179 .RE
 180 .PP
 181 biggest
 182 .RS 4
 183 Selects the biggest window\&.
 184 .RE
 185 .PP
 186 smallest
 187 .RS 4
 188 Selects the smallest window\&.
 189 .RE
 190 .PP
 191 <node_id>
 192 .RS 4
 193 Selects the node with the given ID\&.
 194 .RE
 195 .RE
 196 .sp
 197 .it 1 an-trap
 198 .nr an-no-space-flag 1
 199 .nr an-break-flag 1
 200 .br
 201 .ps +1
 202 \fBPath Jumps\fR
 203 .RS 4
 204 .sp
 205 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)\&.
 206 .PP
 207 1|first
 208 .RS 4
 209 Jumps to the first child\&.
 210 .RE
 211 .PP
 212 2|second
 213 .RS 4
 214 Jumps to the second child\&.
 215 .RE
 216 .PP
 217 brother
 218 .RS 4
 219 Jumps to the brother node\&.
 220 .RE
 221 .PP
 222 parent
 223 .RS 4
 224 Jumps to the parent node\&.
 225 .RE
 226 .PP
 227 \fIDIR\fR
 228 .RS 4
 229 Jumps to the node holding the edge in the given direction\&.
 230 .RE
 231 .RE
 232 .sp
 233 .it 1 an-trap
 234 .nr an-no-space-flag 1
 235 .nr an-break-flag 1
 236 .br
 237 .ps +1
 238 \fBModifiers\fR
 239 .RS 4
 240 .PP
 241 [!]focused
 242 .RS 4
 243 Only consider the focused node\&.
 244 .RE
 245 .PP
 246 [!]active
 247 .RS 4
 248 Only consider nodes that are the focused node of their desktop\&.
 249 .RE
 250 .PP
 251 [!]automatic
 252 .RS 4
 253 Only consider nodes in automatic insertion mode\&. See also
 254 \fB\-\-presel\-dir\fR
 255 under
 256 \fBNode\fR
 257 in the
 258 \fBDOMAINS\fR
 259 section below\&.
 260 .RE
 261 .PP
 262 [!]local
 263 .RS 4
 264 Only consider nodes in the reference desktop\&.
 265 .RE
 266 .PP
 267 [!]leaf
 268 .RS 4
 269 Only consider leaf nodes\&.
 270 .RE
 271 .PP
 272 [!]window
 273 .RS 4
 274 Only consider nodes that hold a window\&.
 275 .RE
 276 .PP
 277 [!](tiled|pseudo_tiled|floating|fullscreen)
 278 .RS 4
 279 Only consider windows in the given state\&.
 280 .RE
 281 .PP
 282 [!]same_class
 283 .RS 4
 284 Only consider windows that have the same class as the reference window\&.
 285 .RE
 286 .PP
 287 [!]descendant_of
 288 .RS 4
 289 Only consider nodes that are descendants of the reference node\&.
 290 .RE
 291 .PP
 292 [!]ancestor_of
 293 .RS 4
 294 Only consider nodes that are ancestors of the reference node\&.
 295 .RE
 296 .PP
 297 [!](hidden|sticky|private|locked|marked|urgent)
 298 .RS 4
 299 Only consider windows that have the given flag set\&.
 300 .RE
 301 .PP
 302 [!](below|normal|above)
 303 .RS 4
 304 Only consider windows in the given layer\&.
 305 .RE
 306 .RE
 307 .SS "Desktop"
 308 .sp
 309 Select a desktop\&.
 310 .sp
 311 .if n \{\
 312 .RS 4
 313 .\}
 314 .nf
 315 DESKTOP_SEL := [DESKTOP_SEL#](CYCLE_DIR|any|last|newest|older|newer|
 316                               [MONITOR_SEL:](focused|^<n>)|
 317                               <desktop_id>|<desktop_name>)[\&.[!]focused][\&.[!]active]
 318                                                           [\&.[!]occupied][\&.[!]urgent][\&.[!]local]
 319 .fi
 320 .if n \{\
 321 .RE
 322 .\}
 323 .sp
 324 .it 1 an-trap
 325 .nr an-no-space-flag 1
 326 .nr an-break-flag 1
 327 .br
 328 .ps +1
 329 \fBDescriptors\fR
 330 .RS 4
 331 .PP
 332 \fICYCLE_DIR\fR
 333 .RS 4
 334 Selects the desktop in the given direction relative to the reference desktop\&.
 335 .RE
 336 .PP
 337 any
 338 .RS 4
 339 Selects the first desktop that matches the given selectors\&.
 340 .RE
 341 .PP
 342 last
 343 .RS 4
 344 Selects the previously focused desktop relative to the reference desktop\&.
 345 .RE
 346 .PP
 347 newest
 348 .RS 4
 349 Selects the newest desktop in the history of the focused desktops\&.
 350 .RE
 351 .PP
 352 older
 353 .RS 4
 354 Selects the desktop older than the reference desktop in the history\&.
 355 .RE
 356 .PP
 357 newer
 358 .RS 4
 359 Selects the desktop newer than the reference desktop in the history\&.
 360 .RE
 361 .PP
 362 focused
 363 .RS 4
 364 Selects the currently focused desktop\&.
 365 .RE
 366 .PP
 367 ^<n>
 368 .RS 4
 369 Selects the nth desktop\&. If
 370 \fBMONITOR_SEL\fR
 371 is given, selects the nth desktop on the selected monitor\&.
 372 .RE
 373 .PP
 374 <desktop_id>
 375 .RS 4
 376 Selects the desktop with the given ID\&.
 377 .RE
 378 .PP
 379 <desktop_name>
 380 .RS 4
 381 Selects the desktop with the given name\&.
 382 .RE
 383 .RE
 384 .sp
 385 .it 1 an-trap
 386 .nr an-no-space-flag 1
 387 .nr an-break-flag 1
 388 .br
 389 .ps +1
 390 \fBModifiers\fR
 391 .RS 4
 392 .PP
 393 [!]focused
 394 .RS 4
 395 Only consider the focused desktop\&.
 396 .RE
 397 .PP
 398 [!]active
 399 .RS 4
 400 Only consider desktops that are the focused desktop of their monitor\&.
 401 .RE
 402 .PP
 403 [!]occupied
 404 .RS 4
 405 Only consider occupied desktops\&.
 406 .RE
 407 .PP
 408 [!]urgent
 409 .RS 4
 410 Only consider urgent desktops\&.
 411 .RE
 412 .PP
 413 [!]local
 414 .RS 4
 415 Only consider desktops inside the reference monitor\&.
 416 .RE
 417 .RE
 418 .SS "Monitor"
 419 .sp
 420 Select a monitor\&.
 421 .sp
 422 .if n \{\
 423 .RS 4
 424 .\}
 425 .nf
 426 MONITOR_SEL := [MONITOR_SEL#](DIR|CYCLE_DIR|any|last|newest|older|newer|
 427                               focused|pointed|primary|^<n>|
 428                               <monitor_id>|<monitor_name>)[\&.[!]focused][\&.[!]occupied]
 429 .fi
 430 .if n \{\
 431 .RE
 432 .\}
 433 .sp
 434 .it 1 an-trap
 435 .nr an-no-space-flag 1
 436 .nr an-break-flag 1
 437 .br
 438 .ps +1
 439 \fBDescriptors\fR
 440 .RS 4
 441 .PP
 442 \fIDIR\fR
 443 .RS 4
 444 Selects the monitor in the given (spacial) direction relative to the reference monitor\&.
 445 .RE
 446 .PP
 447 \fICYCLE_DIR\fR
 448 .RS 4
 449 Selects the monitor in the given (cyclic) direction relative to the reference monitor\&.
 450 .RE
 451 .PP
 452 any
 453 .RS 4
 454 Selects the first monitor that matches the given selectors\&.
 455 .RE
 456 .PP
 457 last
 458 .RS 4
 459 Selects the previously focused monitor relative to the reference monitor\&.
 460 .RE
 461 .PP
 462 newest
 463 .RS 4
 464 Selects the newest monitor in the history of the focused monitors\&.
 465 .RE
 466 .PP
 467 older
 468 .RS 4
 469 Selects the monitor older than the reference monitor in the history\&.
 470 .RE
 471 .PP
 472 newer
 473 .RS 4
 474 Selects the monitor newer than the reference monitor in the history\&.
 475 .RE
 476 .PP
 477 focused
 478 .RS 4
 479 Selects the currently focused monitor\&.
 480 .RE
 481 .PP
 482 pointed
 483 .RS 4
 484 Selects the monitor under the pointer\&.
 485 .RE
 486 .PP
 487 primary
 488 .RS 4
 489 Selects the primary monitor\&.
 490 .RE
 491 .PP
 492 ^<n>
 493 .RS 4
 494 Selects the nth monitor\&.
 495 .RE
 496 .PP
 497 <monitor_id>
 498 .RS 4
 499 Selects the monitor with the given ID\&.
 500 .RE
 501 .PP
 502 <monitor_name>
 503 .RS 4
 504 Selects the monitor with the given name\&.
 505 .RE
 506 .RE
 507 .sp
 508 .it 1 an-trap
 509 .nr an-no-space-flag 1
 510 .nr an-break-flag 1
 511 .br
 512 .ps +1
 513 \fBModifiers\fR
 514 .RS 4
 515 .PP
 516 [!]focused
 517 .RS 4
 518 Only consider the focused monitor\&.
 519 .RE
 520 .PP
 521 [!]occupied
 522 .RS 4
 523 Only consider monitors where the focused desktop is occupied\&.
 524 .RE
 525 .RE
 526 .SH "WINDOW STATES"
 527 .PP
 528 tiled
 529 .RS 4
 530 Its size and position are determined by the window tree\&.
 531 .RE
 532 .PP
 533 pseudo_tiled
 534 .RS 4
 535 A tiled window that automatically shrinks but doesn\(cqt stretch beyond its floating size\&.
 536 .RE
 537 .PP
 538 floating
 539 .RS 4
 540 Can be moved/resized freely\&. Although it doesn\(cqt use any tiling space, it is still part of the window tree\&.
 541 .RE
 542 .PP
 543 fullscreen
 544 .RS 4
 545 Fills its monitor rectangle and has no borders\&.
 546 .RE
 547 .SH "NODE FLAGS"
 548 .PP
 549 hidden
 550 .RS 4
 551 Is hidden and doesn\(cqt occupy any tiling space\&.
 552 .RE
 553 .PP
 554 sticky
 555 .RS 4
 556 Stays in the focused desktop of its monitor\&.
 557 .RE
 558 .PP
 559 private
 560 .RS 4
 561 Tries to keep the same tiling position/size\&.
 562 .RE
 563 .PP
 564 locked
 565 .RS 4
 566 Ignores the
 567 \fBnode \-\-close\fR
 568 message\&.
 569 .RE
 570 .PP
 571 marked
 572 .RS 4
 573 Is marked (useful for deferred actions)\&. A marked node becomes unmarked after being sent on a preselected node\&.
 574 .RE
 575 .PP
 576 urgent
 577 .RS 4
 578 Has its urgency hint set\&. This flag is set externally\&.
 579 .RE
 580 .SH "STACKING LAYERS"
 581 .sp
 582 There\(cqs three stacking layers: BELOW, NORMAL and ABOVE\&.
 583 .sp
 584 In each layer, the window are orderered as follow: tiled & pseudo\-tiled < floating < fullscreen\&.
 585 .SH "RECEPTACLES"
 586 .sp
 587 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\&.
 588 .SH "DOMAINS"
 589 .SS "Node"
 590 .sp
 591 .it 1 an-trap
 592 .nr an-no-space-flag 1
 593 .nr an-break-flag 1
 594 .br
 595 .ps +1
 596 \fBGeneral Syntax\fR
 597 .RS 4
 598 .sp
 599 node [\fINODE_SEL\fR] \fICOMMANDS\fR
 600 .sp
 601 If \fINODE_SEL\fR is omitted, \fBfocused\fR is assumed\&.
 602 .RE
 603 .sp
 604 .it 1 an-trap
 605 .nr an-no-space-flag 1
 606 .nr an-break-flag 1
 607 .br
 608 .ps +1
 609 \fBCommands\fR
 610 .RS 4
 611 .PP
 612 \fB\-f\fR, \fB\-\-focus\fR [\fINODE_SEL\fR]
 613 .RS 4
 614 Focus the selected or given node\&.
 615 .RE
 616 .PP
 617 \fB\-a\fR, \fB\-\-activate\fR [\fINODE_SEL\fR]
 618 .RS 4
 619 Activate the selected or given node\&.
 620 .RE
 621 .PP
 622 \fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR [\fB\-\-follow\fR]
 623 .RS 4
 624 Send the selected node to the given desktop\&. If
 625 \fB\-\-follow\fR
 626 is passed, the focused node will stay focused\&.
 627 .RE
 628 .PP
 629 \fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR [\fB\-\-follow\fR]
 630 .RS 4
 631 Send the selected node to the given monitor\&. If
 632 \fB\-\-follow\fR
 633 is passed, the focused node will stay focused\&.
 634 .RE
 635 .PP
 636 \fB\-n\fR, \fB\-\-to\-node\fR \fINODE_SEL\fR [\fB\-\-follow\fR]
 637 .RS 4
 638 Send the selected node on the given node\&. If
 639 \fB\-\-follow\fR
 640 is passed, the focused node will stay focused\&.
 641 .RE
 642 .PP
 643 \fB\-s\fR, \fB\-\-swap\fR \fINODE_SEL\fR [\fB\-\-follow\fR]
 644 .RS 4
 645 Swap the selected node with the given node\&. If
 646 \fB\-\-follow\fR
 647 is passed, the focused node will stay focused\&.
 648 .RE
 649 .PP
 650 \fB\-p\fR, \fB\-\-presel\-dir\fR [~]\fIDIR\fR|cancel
 651 .RS 4
 652 Preselect the splitting area of the selected node (or cancel the preselection)\&. If
 653 \fB~\fR
 654 is prepended to
 655 \fIDIR\fR
 656 and the current preselection direction matches
 657 \fIDIR\fR, then the argument is interpreted as
 658 \fBcancel\fR\&. A node with a preselected area is said to be in "manual insertion mode"\&.
 659 .RE
 660 .PP
 661 \fB\-o\fR, \fB\-\-presel\-ratio\fR \fIRATIO\fR
 662 .RS 4
 663 Set the splitting ratio of the preselection area\&.
 664 .RE
 665 .PP
 666 \fB\-v\fR, \fB\-\-move\fR \fIdx\fR \fIdy\fR
 667 .RS 4
 668 Move the selected window by
 669 \fIdx\fR
 670 pixels horizontally and
 671 \fIdy\fR
 672 pixels vertically\&.
 673 .RE
 674 .PP
 675 \fB\-z\fR, \fB\-\-resize\fR top|left|bottom|right|top_left|top_right|bottom_right|bottom_left \fIdx\fR \fIdy\fR
 676 .RS 4
 677 Resize the selected window by moving the given handle by
 678 \fIdx\fR
 679 pixels horizontally and
 680 \fIdy\fR
 681 pixels vertically\&.
 682 .RE
 683 .PP
 684 \fB\-r\fR, \fB\-\-ratio\fR \fIRATIO\fR|(+|\-)(\fIPIXELS\fR|\fIFRACTION\fR)
 685 .RS 4
 686 Set the splitting ratio of the selected node (0 <
 687 \fIRATIO\fR
 688 < 1)\&.
 689 .RE
 690 .PP
 691 \fB\-R\fR, \fB\-\-rotate\fR \fI90|270|180\fR
 692 .RS 4
 693 Rotate the tree rooted at the selected node\&.
 694 .RE
 695 .PP
 696 \fB\-F\fR, \fB\-\-flip\fR \fIhorizontal|vertical\fR
 697 .RS 4
 698 Flip the the tree rooted at selected node\&.
 699 .RE
 700 .PP
 701 \fB\-E\fR, \fB\-\-equalize\fR
 702 .RS 4
 703 Reset the split ratios of the tree rooted at the selected node to their default value\&.
 704 .RE
 705 .PP
 706 \fB\-B\fR, \fB\-\-balance\fR
 707 .RS 4
 708 Adjust the split ratios of the tree rooted at the selected node so that all windows occupy the same area\&.
 709 .RE
 710 .PP
 711 \fB\-C\fR, \fB\-\-circulate\fR forward|backward
 712 .RS 4
 713 Circulate the windows of the tree rooted at the selected node\&.
 714 .RE
 715 .PP
 716 \fB\-t\fR, \fB\-\-state\fR [~](tiled|pseudo_tiled|floating|fullscreen)
 717 .RS 4
 718 Set the state of the selected window\&. If
 719 \fB~\fR
 720 is present and the current state matches the given state, then the argument is interpreted as the last state\&.
 721 .RE
 722 .PP
 723 \fB\-g\fR, \fB\-\-flag\fR hidden|sticky|private|locked|marked[=on|off]
 724 .RS 4
 725 Set or toggle the given flag for the selected node\&.
 726 .RE
 727 .PP
 728 \fB\-l\fR, \fB\-\-layer\fR below|normal|above
 729 .RS 4
 730 Set the stacking layer of the selected window\&.
 731 .RE
 732 .PP
 733 \fB\-i\fR, \fB\-\-insert\-receptacle\fR
 734 .RS 4
 735 Insert a receptacle node at the selected node\&.
 736 .RE
 737 .PP
 738 \fB\-c\fR, \fB\-\-close\fR
 739 .RS 4
 740 Close the windows rooted at the selected node\&.
 741 .RE
 742 .PP
 743 \fB\-k\fR, \fB\-\-kill\fR
 744 .RS 4
 745 Kill the windows rooted at the selected node\&.
 746 .RE
 747 .RE
 748 .SS "Desktop"
 749 .sp
 750 .it 1 an-trap
 751 .nr an-no-space-flag 1
 752 .nr an-break-flag 1
 753 .br
 754 .ps +1
 755 \fBGeneral Syntax\fR
 756 .RS 4
 757 .sp
 758 desktop [\fIDESKTOP_SEL\fR] \fICOMMANDS\fR
 759 .sp
 760 If \fIDESKTOP_SEL\fR is omitted, \fBfocused\fR is assumed\&.
 761 .RE
 762 .sp
 763 .it 1 an-trap
 764 .nr an-no-space-flag 1
 765 .nr an-break-flag 1
 766 .br
 767 .ps +1
 768 \fBCOMMANDS\fR
 769 .RS 4
 770 .PP
 771 \fB\-f\fR, \fB\-\-focus\fR [\fIDESKTOP_SEL\fR]
 772 .RS 4
 773 Focus the selected or given desktop\&.
 774 .RE
 775 .PP
 776 \fB\-a\fR, \fB\-\-activate\fR [\fIDESKTOP_SEL\fR]
 777 .RS 4
 778 Activate the selected or given desktop\&.
 779 .RE
 780 .PP
 781 \fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR [\fB\-\-follow\fR]
 782 .RS 4
 783 Send the selected desktop to the given monitor\&. If
 784 \fB\-\-follow\fR
 785 is passed, the focused desktop will stay focused\&.
 786 .RE
 787 .PP
 788 \fB\-s\fR, \fB\-\-swap\fR \fIDESKTOP_SEL\fR [\fB\-\-follow\fR]
 789 .RS 4
 790 Swap the selected desktop with the given desktop\&. If
 791 \fB\-\-follow\fR
 792 is passed, the focused desktop will stay focused\&.
 793 .RE
 794 .PP
 795 \fB\-l\fR, \fB\-\-layout\fR \fICYCLE_DIR\fR|monocle|tiled
 796 .RS 4
 797 Set or cycle the layout of the selected desktop\&.
 798 .RE
 799 .PP
 800 \fB\-n\fR, \fB\-\-rename\fR <new_name>
 801 .RS 4
 802 Rename the selected desktop\&.
 803 .RE
 804 .PP
 805 \fB\-b\fR, \fB\-\-bubble\fR \fICYCLE_DIR\fR
 806 .RS 4
 807 Bubble the selected desktop in the given direction\&.
 808 .RE
 809 .PP
 810 \fB\-r\fR, \fB\-\-remove\fR
 811 .RS 4
 812 Remove the selected desktop\&.
 813 .RE
 814 .RE
 815 .SS "Monitor"
 816 .sp
 817 .it 1 an-trap
 818 .nr an-no-space-flag 1
 819 .nr an-break-flag 1
 820 .br
 821 .ps +1
 822 \fBGeneral Syntax\fR
 823 .RS 4
 824 .sp
 825 monitor [\fIMONITOR_SEL\fR] \fICOMMANDS\fR
 826 .sp
 827 If \fIMONITOR_SEL\fR is omitted, \fBfocused\fR is assumed\&.
 828 .RE
 829 .sp
 830 .it 1 an-trap
 831 .nr an-no-space-flag 1
 832 .nr an-break-flag 1
 833 .br
 834 .ps +1
 835 \fBCommands\fR
 836 .RS 4
 837 .PP
 838 \fB\-f\fR, \fB\-\-focus\fR [\fIMONITOR_SEL\fR]
 839 .RS 4
 840 Focus the selected or given monitor\&.
 841 .RE
 842 .PP
 843 \fB\-s\fR, \fB\-\-swap\fR \fIMONITOR_SEL\fR
 844 .RS 4
 845 Swap the selected monitor with the given monitor\&.
 846 .RE
 847 .PP
 848 \fB\-a\fR, \fB\-\-add\-desktops\fR <name>\&...
 849 .RS 4
 850 Create desktops with the given names in the selected monitor\&.
 851 .RE
 852 .PP
 853 \fB\-o\fR, \fB\-\-reorder\-desktops\fR <name>\&...
 854 .RS 4
 855 Reorder the desktops of the selected monitor to match the given order\&.
 856 .RE
 857 .PP
 858 \fB\-d\fR, \fB\-\-reset\-desktops\fR <name>\&...
 859 .RS 4
 860 Rename, add or remove desktops depending on whether the number of given names is equal, superior or inferior to the number of existing desktops\&.
 861 .RE
 862 .PP
 863 \fB\-g\fR, \fB\-\-rectangle\fR WxH+X+Y
 864 .RS 4
 865 Set the rectangle of the selected monitor\&.
 866 .RE
 867 .PP
 868 \fB\-n\fR, \fB\-\-rename\fR <new_name>
 869 .RS 4
 870 Rename the selected monitor\&.
 871 .RE
 872 .PP
 873 \fB\-r\fR, \fB\-\-remove\fR
 874 .RS 4
 875 Remove the selected monitor\&.
 876 .RE
 877 .RE
 878 .SS "Query"
 879 .sp
 880 .it 1 an-trap
 881 .nr an-no-space-flag 1
 882 .nr an-break-flag 1
 883 .br
 884 .ps +1
 885 \fBGeneral Syntax\fR
 886 .RS 4
 887 .sp
 888 query \fICOMMANDS\fR [\fIOPTIONS\fR]
 889 .RE
 890 .sp
 891 .it 1 an-trap
 892 .nr an-no-space-flag 1
 893 .nr an-break-flag 1
 894 .br
 895 .ps +1
 896 \fBCommands\fR
 897 .RS 4
 898 .sp
 899 The optional selectors are references\&.
 900 .PP
 901 \fB\-N\fR, \fB\-\-nodes\fR [\fINODE_SEL\fR]
 902 .RS 4
 903 List the IDs of the matching nodes\&.
 904 .RE
 905 .PP
 906 \fB\-D\fR, \fB\-\-desktops\fR [\fIDESKTOP_SEL\fR]
 907 .RS 4
 908 List the IDs (or names) of the matching desktops\&.
 909 .RE
 910 .PP
 911 \fB\-M\fR, \fB\-\-monitors\fR [\fIMONITOR_SEL\fR]
 912 .RS 4
 913 List the IDs (or names) of the matching monitors\&.
 914 .RE
 915 .PP
 916 \fB\-T\fR, \fB\-\-tree\fR
 917 .RS 4
 918 Print a JSON representation of the matching item\&.
 919 .RE
 920 .RE
 921 .sp
 922 .it 1 an-trap
 923 .nr an-no-space-flag 1
 924 .nr an-break-flag 1
 925 .br
 926 .ps +1
 927 \fBOptions\fR
 928 .RS 4
 929 .PP
 930 \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]
 931 .RS 4
 932 Constrain matches to the selected monitor, desktop or node\&. The descriptor can be omitted for
 933 \fI\-M\fR,
 934 \fI\-D\fR
 935 and
 936 \fI\-N\fR\&.
 937 .RE
 938 .PP
 939 \fB\-\-names\fR
 940 .RS 4
 941 Print names instead of IDs\&. Can only be used with
 942 \fI\-M\fR
 943 and
 944 \fI\-D\fR\&.
 945 .RE
 946 .RE
 947 .SS "Wm"
 948 .sp
 949 .it 1 an-trap
 950 .nr an-no-space-flag 1
 951 .nr an-break-flag 1
 952 .br
 953 .ps +1
 954 \fBGeneral Syntax\fR
 955 .RS 4
 956 .sp
 957 wm \fICOMMANDS\fR
 958 .RE
 959 .sp
 960 .it 1 an-trap
 961 .nr an-no-space-flag 1
 962 .nr an-break-flag 1
 963 .br
 964 .ps +1
 965 \fBCommands\fR
 966 .RS 4
 967 .PP
 968 \fB\-d\fR, \fB\-\-dump\-state\fR
 969 .RS 4
 970 Dump the current world state on standard output\&.
 971 .RE
 972 .PP
 973 \fB\-l\fR, \fB\-\-load\-state\fR <file_path>
 974 .RS 4
 975 Load a world state from the given file\&. The path must be absolute\&.
 976 .RE
 977 .PP
 978 \fB\-a\fR, \fB\-\-add\-monitor\fR <name> WxH+X+Y
 979 .RS 4
 980 Add a monitor for the given name and rectangle\&.
 981 .RE
 982 .PP
 983 \fB\-O\fR, \fB\-\-reorder\-monitors\fR <name>\&...
 984 .RS 4
 985 Reorder the list of monitors to match the given order\&.
 986 .RE
 987 .PP
 988 \fB\-o\fR, \fB\-\-adopt\-orphans\fR
 989 .RS 4
 990 Manage all the unmanaged windows remaining from a previous session\&.
 991 .RE
 992 .PP
 993 \fB\-h\fR, \fB\-\-record\-history\fR on|off
 994 .RS 4
 995 Enable or disable the recording of node focus history\&.
 996 .RE
 997 .PP
 998 \fB\-g\fR, \fB\-\-get\-status\fR
 999 .RS 4
1000 Print the current status information\&.
1001 .RE
1002 .PP
1003 \fB\-r\fR, \fB\-\-restart\fR
1004 .RS 4
1005 Restart the window manager
1006 .RE
1007 .RE
1008 .SS "Rule"
1009 .sp
1010 .it 1 an-trap
1011 .nr an-no-space-flag 1
1012 .nr an-break-flag 1
1013 .br
1014 .ps +1
1015 \fBGeneral Syntax\fR
1016 .RS 4
1017 .sp
1018 rule \fICOMMANDS\fR
1019 .RE
1020 .sp
1021 .it 1 an-trap
1022 .nr an-no-space-flag 1
1023 .nr an-break-flag 1
1024 .br
1025 .ps +1
1026 \fBCommands\fR
1027 .RS 4
1028 .PP
1029 \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|marked|center|follow|manage|focus|border)=(on|off)] [rectangle=WxH+X+Y]
1030 .RS 4
1031 Create a new rule\&.
1032 .RE
1033 .PP
1034 \fB\-r\fR, \fB\-\-remove\fR ^<n>|head|tail|(<class_name>|*)[:(<instance_name>|*)]\&...
1035 .RS 4
1036 Remove the given rules\&.
1037 .RE
1038 .PP
1039 \fB\-l\fR, \fB\-\-list\fR
1040 .RS 4
1041 List the rules\&.
1042 .RE
1043 .RE
1044 .SS "Config"
1045 .sp
1046 .it 1 an-trap
1047 .nr an-no-space-flag 1
1048 .nr an-break-flag 1
1049 .br
1050 .ps +1
1051 \fBGeneral Syntax\fR
1052 .RS 4
1053 .PP
1054 config [\-m \fIMONITOR_SEL\fR|\-d \fIDESKTOP_SEL\fR|\-n \fINODE_SEL\fR] <setting> [<value>]
1055 .RS 4
1056 Get or set the value of <setting>\&.
1057 .RE
1058 .RE
1059 .SS "Subscribe"
1060 .sp
1061 .it 1 an-trap
1062 .nr an-no-space-flag 1
1063 .nr an-break-flag 1
1064 .br
1065 .ps +1
1066 \fBGeneral Syntax\fR
1067 .RS 4
1068 .PP
1069 subscribe [\fIOPTIONS\fR] (all|report|monitor|desktop|node|\&...)*
1070 .RS 4
1071 Continuously print events\&. See the
1072 \fBEVENTS\fR
1073 section for the description of each event\&.
1074 .RE
1075 .RE
1076 .sp
1077 .it 1 an-trap
1078 .nr an-no-space-flag 1
1079 .nr an-break-flag 1
1080 .br
1081 .ps +1
1082 \fBOptions\fR
1083 .RS 4
1084 .PP
1085 \fB\-f\fR, \fB\-\-fifo\fR
1086 .RS 4
1087 Print a path to a FIFO from which events can be read and return\&.
1088 .RE
1089 .PP
1090 \fB\-c\fR, \fB\-\-count\fR \fICOUNT\fR
1091 .RS 4
1092 Stop the corresponding
1093 \fBbspc\fR
1094 process after having received
1095 \fICOUNT\fR
1096 events\&.
1097 .RE
1098 .RE
1099 .SS "Quit"
1100 .sp
1101 .it 1 an-trap
1102 .nr an-no-space-flag 1
1103 .nr an-break-flag 1
1104 .br
1105 .ps +1
1106 \fBGeneral Syntax\fR
1107 .RS 4
1108 .PP
1109 quit [<status>]
1110 .RS 4
1111 Quit with an optional exit status\&.
1112 .RE
1113 .RE
1114 .SH "EXIT CODES"
1115 .sp
1116 If the server can\(cqt handle a message, \fBbspc\fR will return with a non\-zero exit code\&.
1117 .SH "SETTINGS"
1118 .sp
1119 Colors are in the form \fI#RRGGBB\fR, booleans are \fItrue\fR, \fIon\fR, \fIfalse\fR or \fIoff\fR\&.
1120 .sp
1121 All the boolean settings are \fIfalse\fR by default unless stated otherwise\&.
1122 .SS "Global Settings"
1123 .PP
1124 \fInormal_border_color\fR
1125 .RS 4
1126 Color of the border of an unfocused window\&.
1127 .RE
1128 .PP
1129 \fIactive_border_color\fR
1130 .RS 4
1131 Color of the border of a focused window of an unfocused monitor\&.
1132 .RE
1133 .PP
1134 \fIfocused_border_color\fR
1135 .RS 4
1136 Color of the border of a focused window of a focused monitor\&.
1137 .RE
1138 .PP
1139 \fIpresel_feedback_color\fR
1140 .RS 4
1141 Color of the
1142 \fBnode \-\-presel\-{dir,ratio}\fR
1143 message feedback area\&.
1144 .RE
1145 .PP
1146 \fIsplit_ratio\fR
1147 .RS 4
1148 Default split ratio\&.
1149 .RE
1150 .PP
1151 \fIstatus_prefix\fR
1152 .RS 4
1153 Prefix prepended to each of the status lines\&.
1154 .RE
1155 .PP
1156 \fIexternal_rules_command\fR
1157 .RS 4
1158 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:
1159 \fBkey1=value1 key2=value2 \&...\fR
1160 (the valid key/value pairs are given in the description of the
1161 \fIrule\fR
1162 command)\&.
1163 .RE
1164 .PP
1165 \fIautomatic_scheme\fR
1166 .RS 4
1167 The insertion scheme used when the insertion point is in automatic mode\&. Accept the following values:
1168 \fBlongest_side\fR,
1169 \fBalternate\fR,
1170 \fBspiral\fR\&.
1171 .RE
1172 .PP
1173 \fIinitial_polarity\fR
1174 .RS 4
1175 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:
1176 \fBfirst_child\fR,
1177 \fBsecond_child\fR\&.
1178 .RE
1179 .PP
1180 \fIdirectional_focus_tightness\fR
1181 .RS 4
1182 The tightness of the algorithm used to decide whether a window is on the
1183 \fIDIR\fR
1184 side of another window\&. Accept the following values:
1185 \fBhigh\fR,
1186 \fBlow\fR\&.
1187 .RE
1188 .PP
1189 \fIremoval_adjustment\fR
1190 .RS 4
1191 Adjust the brother when unlinking a node from the tree in accordance with the automatic insertion scheme\&.
1192 .RE
1193 .PP
1194 \fIpresel_feedback\fR
1195 .RS 4
1196 Draw the preselection feedback area\&. Defaults to
1197 \fItrue\fR\&.
1198 .RE
1199 .PP
1200 \fIborderless_monocle\fR
1201 .RS 4
1202 Remove borders of tiled windows for the
1203 \fBmonocle\fR
1204 desktop layout\&.
1205 .RE
1206 .PP
1207 \fIgapless_monocle\fR
1208 .RS 4
1209 Remove gaps of tiled windows for the
1210 \fBmonocle\fR
1211 desktop layout\&.
1212 .RE
1213 .PP
1214 \fItop_monocle_padding\fR, \fIright_monocle_padding\fR, \fIbottom_monocle_padding\fR, \fIleft_monocle_padding\fR
1215 .RS 4
1216 Padding space added at the sides of the screen for the
1217 \fBmonocle\fR
1218 desktop layout\&.
1219 .RE
1220 .PP
1221 \fIsingle_monocle\fR
1222 .RS 4
1223 Set the desktop layout to
1224 \fBmonocle\fR
1225 if there\(cqs only one tiled window in the tree\&.
1226 .RE
1227 .PP
1228 \fIpointer_motion_interval\fR
1229 .RS 4
1230 The minimum interval, in milliseconds, between two motion notify events\&.
1231 .RE
1232 .PP
1233 \fIpointer_modifier\fR
1234 .RS 4
1235 Keyboard modifier used for moving or resizing windows\&. Accept the following values:
1236 \fBshift\fR,
1237 \fBcontrol\fR,
1238 \fBlock\fR,
1239 \fBmod1\fR,
1240 \fBmod2\fR,
1241 \fBmod3\fR,
1242 \fBmod4\fR,
1243 \fBmod5\fR\&.
1244 .RE
1245 .PP
1246 \fIpointer_action1\fR, \fIpointer_action2\fR, \fIpointer_action3\fR
1247 .RS 4
1248 Action performed when pressing
1249 \fIpointer_modifier\fR
1250 +
1251 \fIbutton<n>\fR\&. Accept the following values:
1252 \fBmove\fR,
1253 \fBresize_side\fR,
1254 \fBresize_corner\fR,
1255 \fBfocus\fR,
1256 \fBnone\fR\&.
1257 .RE
1258 .PP
1259 \fIclick_to_focus\fR
1260 .RS 4
1261 Button used for focusing a window (or a monitor)\&. The possible values are:
1262 \fBbutton1\fR,
1263 \fBbutton2\fR,
1264 \fBbutton3\fR,
1265 \fBany\fR,
1266 \fBnone\fR\&. Defaults to
1267 \fBbutton1\fR\&.
1268 .RE
1269 .PP
1270 \fIswallow_first_click\fR
1271 .RS 4
1272 Don\(cqt replay the click that makes a window focused if
1273 \fIclick_to_focus\fR
1274 isn\(cqt
1275 \fBnone\fR\&.
1276 .RE
1277 .PP
1278 \fIfocus_follows_pointer\fR
1279 .RS 4
1280 Focus the window under the pointer\&.
1281 .RE
1282 .PP
1283 \fIpointer_follows_focus\fR
1284 .RS 4
1285 When focusing a window, put the pointer at its center\&.
1286 .RE
1287 .PP
1288 \fIpointer_follows_monitor\fR
1289 .RS 4
1290 When focusing a monitor, put the pointer at its center\&.
1291 .RE
1292 .PP
1293 \fImapping_events_count\fR
1294 .RS 4
1295 Handle the next
1296 \fBmapping_events_count\fR
1297 mapping notify events\&. A negative value implies that every event needs to be handled\&.
1298 .RE
1299 .PP
1300 \fIignore_ewmh_focus\fR
1301 .RS 4
1302 Ignore EWMH focus requests coming from applications\&.
1303 .RE
1304 .PP
1305 \fIignore_ewmh_fullscreen\fR
1306 .RS 4
1307 Block the fullscreen state transitions that originate from an EWMH request\&. The possible values are:
1308 \fBnone\fR,
1309 \fBall\fR, or a comma separated list of the following values:
1310 \fBenter\fR,
1311 \fBexit\fR\&.
1312 .RE
1313 .PP
1314 \fIignore_ewmh_struts\fR
1315 .RS 4
1316 BIgnore strut hinting from clients requesting to reserve space (i\&.e\&. task bars)\&.
1317 .RE
1318 .PP
1319 \fIcenter_pseudo_tiled\fR
1320 .RS 4
1321 Center pseudo tiled windows into their tiling rectangles\&. Defaults to
1322 \fItrue\fR\&.
1323 .RE
1324 .PP
1325 \fIhonor_size_hints\fR
1326 .RS 4
1327 Apply ICCCM window size hints\&.
1328 .RE
1329 .PP
1330 \fIremove_disabled_monitors\fR
1331 .RS 4
1332 Consider disabled monitors as disconnected\&.
1333 .RE
1334 .PP
1335 \fIremove_unplugged_monitors\fR
1336 .RS 4
1337 Remove unplugged monitors\&.
1338 .RE
1339 .PP
1340 \fImerge_overlapping_monitors\fR
1341 .RS 4
1342 Merge overlapping monitors (the bigger remains)\&.
1343 .RE
1344 .SS "Monitor and Desktop Settings"
1345 .PP
1346 \fItop_padding\fR, \fIright_padding\fR, \fIbottom_padding\fR, \fIleft_padding\fR
1347 .RS 4
1348 Padding space added at the sides of the monitor or desktop\&.
1349 .RE
1350 .SS "Desktop Settings"
1351 .PP
1352 \fIwindow_gap\fR
1353 .RS 4
1354 Size of the gap that separates windows\&.
1355 .RE
1356 .SS "Node Settings"
1357 .PP
1358 \fIborder_width\fR
1359 .RS 4
1360 Window border width\&.
1361 .RE
1362 .SH "POINTER BINDINGS"
1363 .PP
1364 \fIclick_to_focus\fR
1365 .RS 4
1366 Focus the window (or the monitor) under the pointer if the value isn\(cqt
1367 \fBnone\fR\&.
1368 .RE
1369 .PP
1370 \fIpointer_modifier\fR + \fIbutton1\fR
1371 .RS 4
1372 Move the window under the pointer\&.
1373 .RE
1374 .PP
1375 \fIpointer_modifier\fR + \fIbutton2\fR
1376 .RS 4
1377 Resize the window under the pointer by dragging the nearest side\&.
1378 .RE
1379 .PP
1380 \fIpointer_modifier\fR + \fIbutton3\fR
1381 .RS 4
1382 Resize the window under the pointer by dragging the nearest corner\&.
1383 .RE
1384 .sp
1385 The behavior of \fIpointer_modifier\fR + \fIbutton<n>\fR can be modified through the \fIpointer_action<n>\fR setting\&.
1386 .SH "EVENTS"
1387 .PP
1388 \fIreport\fR
1389 .RS 4
1390 See the next section for the description of the format\&.
1391 .RE
1392 .PP
1393 \fImonitor_add <monitor_id> <monitor_name> <monitor_geometry>\fR
1394 .RS 4
1395 A monitor is added\&.
1396 .RE
1397 .PP
1398 \fImonitor_rename <monitor_id> <old_name> <new_name>\fR
1399 .RS 4
1400 A monitor is renamed\&.
1401 .RE
1402 .PP
1403 \fImonitor_remove <monitor_id>\fR
1404 .RS 4
1405 A monitor is removed\&.
1406 .RE
1407 .PP
1408 \fImonitor_swap <src_monitor_id> <dst_monitor_id>\fR
1409 .RS 4
1410 A monitor is swapped\&.
1411 .RE
1412 .PP
1413 \fImonitor_focus <monitor_id>\fR
1414 .RS 4
1415 A monitor is focused\&.
1416 .RE
1417 .PP
1418 \fImonitor_geometry <monitor_id> <monitor_geometry>\fR
1419 .RS 4
1420 The geometry of a monitor changed\&.
1421 .RE
1422 .PP
1423 \fIdesktop_add <monitor_id> <desktop_id> <desktop_name>\fR
1424 .RS 4
1425 A desktop is added\&.
1426 .RE
1427 .PP
1428 \fIdesktop_rename <monitor_id> <desktop_id> <old_name> <new_name>\fR
1429 .RS 4
1430 A desktop is renamed\&.
1431 .RE
1432 .PP
1433 \fIdesktop_remove <monitor_id> <desktop_id>\fR
1434 .RS 4
1435 A desktop is removed\&.
1436 .RE
1437 .PP
1438 \fIdesktop_swap <src_monitor_id> <src_desktop_id> <dst_monitor_id> <dst_desktop_id>\fR
1439 .RS 4
1440 A desktop is swapped\&.
1441 .RE
1442 .PP
1443 \fIdesktop_transfer <src_monitor_id> <src_desktop_id> <dst_monitor_id>\fR
1444 .RS 4
1445 A desktop is transferred\&.
1446 .RE
1447 .PP
1448 \fIdesktop_focus <monitor_id> <desktop_id>\fR
1449 .RS 4
1450 A desktop is focused\&.
1451 .RE
1452 .PP
1453 \fIdesktop_activate <monitor_id> <desktop_id>\fR
1454 .RS 4
1455 A desktop is activated\&.
1456 .RE
1457 .PP
1458 \fIdesktop_layout <monitor_id> <desktop_id> tiled|monocle\fR
1459 .RS 4
1460 The layout of a desktop changed\&.
1461 .RE
1462 .PP
1463 \fInode_add <monitor_id> <desktop_id> <ip_id> <node_id>\fR
1464 .RS 4
1465 A node is added\&.
1466 .RE
1467 .PP
1468 \fInode_remove <monitor_id> <desktop_id> <node_id>\fR
1469 .RS 4
1470 A node is removed\&.
1471 .RE
1472 .PP
1473 \fInode_swap <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>\fR
1474 .RS 4
1475 A node is swapped\&.
1476 .RE
1477 .PP
1478 \fInode_transfer <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>\fR
1479 .RS 4
1480 A node is transferred\&.
1481 .RE
1482 .PP
1483 \fInode_focus <monitor_id> <desktop_id> <node_id>\fR
1484 .RS 4
1485 A node is focused\&.
1486 .RE
1487 .PP
1488 \fInode_activate <monitor_id> <desktop_id> <node_id>\fR
1489 .RS 4
1490 A node is activated\&.
1491 .RE
1492 .PP
1493 \fInode_presel <monitor_id> <desktop_id> <node_id> (dir DIR|ratio RATIO|cancel)\fR
1494 .RS 4
1495 A node is preselected\&.
1496 .RE
1497 .PP
1498 \fInode_stack <node_id_1> below|above <node_id_2>\fR
1499 .RS 4
1500 A node is stacked below or above another node\&.
1501 .RE
1502 .PP
1503 \fInode_geometry <monitor_id> <desktop_id> <node_id> <node_geometry>\fR
1504 .RS 4
1505 The geometry of a window changed\&.
1506 .RE
1507 .PP
1508 \fInode_state <monitor_id> <desktop_id> <node_id> tiled|pseudo_tiled|floating|fullscreen on|off\fR
1509 .RS 4
1510 The state of a window changed\&.
1511 .RE
1512 .PP
1513 \fInode_flag <monitor_id> <desktop_id> <node_id> hidden|sticky|private|locked|marked|urgent on|off\fR
1514 .RS 4
1515 One of the flags of a node changed\&.
1516 .RE
1517 .PP
1518 \fInode_layer <monitor_id> <desktop_id> <node_id> below|normal|above\fR
1519 .RS 4
1520 The layer of a window changed\&.
1521 .RE
1522 .PP
1523 \fIpointer_action <monitor_id> <desktop_id> <node_id> move|resize_corner|resize_side begin|end\fR
1524 .RS 4
1525 A pointer action occured\&.
1526 .RE
1527 .sp
1528 Please note that \fBbspwm\fR initializes monitors before it reads messages on its socket, therefore the initial monitor events can\(cqt be received\&.
1529 .SH "REPORT FORMAT"
1530 .sp
1531 Each report event message is composed of items separated by colons\&.
1532 .sp
1533 Each item has the form \fI<type><value>\fR where \fI<type>\fR is the first character of the item\&.
1534 .PP
1535 \fIM<monitor_name>\fR
1536 .RS 4
1537 Focused monitor\&.
1538 .RE
1539 .PP
1540 \fIm<monitor_name>\fR
1541 .RS 4
1542 Unfocused monitor\&.
1543 .RE
1544 .PP
1545 \fIO<desktop_name>\fR
1546 .RS 4
1547 Occupied focused desktop\&.
1548 .RE
1549 .PP
1550 \fIo<desktop_name>\fR
1551 .RS 4
1552 Occupied unfocused desktop\&.
1553 .RE
1554 .PP
1555 \fIF<desktop_name>\fR
1556 .RS 4
1557 Free focused desktop\&.
1558 .RE
1559 .PP
1560 \fIf<desktop_name>\fR
1561 .RS 4
1562 Free unfocused desktop\&.
1563 .RE
1564 .PP
1565 \fIU<desktop_name>\fR
1566 .RS 4
1567 Urgent focused desktop\&.
1568 .RE
1569 .PP
1570 \fIu<desktop_name>\fR
1571 .RS 4
1572 Urgent unfocused desktop\&.
1573 .RE
1574 .PP
1575 \fIL(T|M)\fR
1576 .RS 4
1577 Layout of the focused desktop of a monitor\&.
1578 .RE
1579 .PP
1580 \fIT(T|P|F|=|@)\fR
1581 .RS 4
1582 State of the focused node of a focused desktop\&.
1583 .RE
1584 .PP
1585 \fIG(S?P?L?M?)\fR
1586 .RS 4
1587 Active flags of the focused node of a focused desktop\&.
1588 .RE
1589 .SH "ENVIRONMENT VARIABLES"
1590 .PP
1591 \fIBSPWM_SOCKET\fR
1592 .RS 4
1593 The path of the socket used for the communication between
1594 \fBbspc\fR
1595 and
1596 \fBbspwm\fR\&. If it isn\(cqt defined, then the following path is used:
1597 \fI/tmp/bspwm<host_name>_<display_number>_<screen_number>\-socket\fR\&.
1598 .RE
1599 .SH "CONTRIBUTORS"
1600 .sp
1601 .RS 4
1602 .ie n \{\
1603 \h'-04'\(bu\h'+03'\c
1604 .\}
1605 .el \{\
1606 .sp -1
1607 .IP \(bu 2.3
1608 .\}
1609 Steven Allen <steven at stebalien\&.com>
1610 .RE
1611 .sp
1612 .RS 4
1613 .ie n \{\
1614 \h'-04'\(bu\h'+03'\c
1615 .\}
1616 .el \{\
1617 .sp -1
1618 .IP \(bu 2.3
1619 .\}
1620 Thomas Adam <thomas at xteddy\&.org>
1621 .RE
1622 .sp
1623 .RS 4
1624 .ie n \{\
1625 \h'-04'\(bu\h'+03'\c
1626 .\}
1627 .el \{\
1628 .sp -1
1629 .IP \(bu 2.3
1630 .\}
1631 Ivan Kanakarakis <ivan\&.kanak at gmail\&.com>
1632 .RE
1633 .SH "AUTHOR"
1634 .sp
1635 Bastien Dejean <nihilhill at gmail\&.com>