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