doc/bspwm.1

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