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