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