doc/bspwm.1

   1 '\" t
   2 .\"     Title: bspwm
   3 .\"    Author: [see the "Author" section]
   4 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
   5 .\"      Date: 11/15/2015
   6 .\"    Manual: Bspwm Manual
   7 .\"    Source: Bspwm 0.9
   8 .\"  Language: English
   9 .\"
  10 .TH "BSPWM" "1" "11/15/2015" "Bspwm 0\&.9" "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 \fICOMMAND\fR [\fIARGUMENTS\fR]
  37 .SH "DESCRIPTION"
  38 .sp
  39 \fBbspwm\fR is a tiling window manager that represents windows as the leaves of a full binary tree\&.
  40 .sp
  41 It is controlled and configured via \fBbspc\fR\&.
  42 .SH "OPTIONS"
  43 .PP
  44 \fB\-h\fR
  45 .RS 4
  46 Print the synopsis and exit\&.
  47 .RE
  48 .PP
  49 \fB\-v\fR
  50 .RS 4
  51 Print the version and exit\&.
  52 .RE
  53 .PP
  54 \fB\-c\fR \fICONFIG_PATH\fR
  55 .RS 4
  56 Use the given configuration file\&.
  57 .RE
  58 .SH "COMMON DEFINITIONS"
  59 .sp
  60 .if n \{\
  61 .RS 4
  62 .\}
  63 .nf
  64 DIR         := left | right | up | down
  65 CYCLE_DIR   := next | prev
  66 .fi
  67 .if n \{\
  68 .RE
  69 .\}
  70 .SH "SELECTORS"
  71 .sp
  72 Selectors are used to select a target window, desktop, or monitor\&. A selector can either describe the target relatively or name it globally\&.
  73 .sp
  74 Descriptive (relative) selectors consist of a primary selector and any number of non\-conflicting modifiers as follows:
  75 .sp
  76 .if n \{\
  77 .RS 4
  78 .\}
  79 .nf
  80 PRIMARY_SELECTOR[\&.MODIFIER]*
  81 .fi
  82 .if n \{\
  83 .RE
  84 .\}
  85 .sp
  86 For obvious reasons, neither desktop nor monitor names may be valid descriptive selectors\&.
  87 .SS "Window"
  88 .sp
  89 Select a window\&.
  90 .sp
  91 .if n \{\
  92 .RS 4
  93 .\}
  94 .nf
  95 WINDOW_SEL := <window_id>
  96             | (DIR|CYCLE_DIR|biggest|last|focused|older|newer)[\&.manual|\&.automatic][\&.tiled|nontiled][\&.pseudotiled|\&.nonpseudotiled][\&.floating|\&.nonfloating][\&.fullscreen|\&.nonfullscreen][\&.below|\&.normal|\&.above][\&.local|\&.foreign][\&.like|\&.unlike][\&.focused|\&.unfocused][\&.urgent|\&.nonurgent][\&.sticky|\&.nonsticky][\&.public|\&.private][\&.locked|\&.unlocked]
  97 .fi
  98 .if n \{\
  99 .RE
 100 .\}
 101 .sp
 102 .it 1 an-trap
 103 .nr an-no-space-flag 1
 104 .nr an-break-flag 1
 105 .br
 106 .ps +1
 107 \fBPrimary Selectors\fR
 108 .RS 4
 109 .PP
 110 \fIDIR\fR
 111 .RS 4
 112 Selects the window in the given (spacial) direction relative to the active window\&.
 113 .RE
 114 .PP
 115 \fICYCLE_DIR\fR
 116 .RS 4
 117 Selects the window in the given (cyclic) direction\&.
 118 .RE
 119 .PP
 120 biggest
 121 .RS 4
 122 Selects the biggest window on the current desktop\&.
 123 .RE
 124 .PP
 125 last
 126 .RS 4
 127 Selects the previously focused window\&.
 128 .RE
 129 .PP
 130 focused
 131 .RS 4
 132 Selects the currently focused window\&.
 133 .RE
 134 .PP
 135 older
 136 .RS 4
 137 Selects the window older than the focused window in the history\&.
 138 .RE
 139 .PP
 140 newer
 141 .RS 4
 142 Selects the window newer than the focused window in the history\&.
 143 .RE
 144 .RE
 145 .sp
 146 .it 1 an-trap
 147 .nr an-no-space-flag 1
 148 .nr an-break-flag 1
 149 .br
 150 .ps +1
 151 \fBModifiers\fR
 152 .RS 4
 153 .PP
 154 tiled
 155 .RS 4
 156 Only consider tiled windows\&.
 157 .RE
 158 .PP
 159 nontiled
 160 .RS 4
 161 Only consider tiled windows\&.
 162 .RE
 163 .PP
 164 pseudotiled
 165 .RS 4
 166 Only consider pseudo\-tiled windows\&.
 167 .RE
 168 .PP
 169 nonpseudotiled
 170 .RS 4
 171 Only consider non pseudo\-tiled windows\&.
 172 .RE
 173 .PP
 174 floating
 175 .RS 4
 176 Only consider floating windows\&.
 177 .RE
 178 .PP
 179 nonfloating
 180 .RS 4
 181 Only consider non floating windows\&.
 182 .RE
 183 .PP
 184 fullscreen
 185 .RS 4
 186 Only consider fullscreen windows\&.
 187 .RE
 188 .PP
 189 nonfullscreen
 190 .RS 4
 191 Only consider non fullscreen windows\&.
 192 .RE
 193 .PP
 194 manual
 195 .RS 4
 196 Only consider windows in manual splitting mode\&.
 197 .RE
 198 .PP
 199 automatic
 200 .RS 4
 201 Only consider windows in automatic splitting mode\&.
 202 .RE
 203 .PP
 204 focused
 205 .RS 4
 206 Only consider focused windows\&.
 207 .RE
 208 .PP
 209 unfocused
 210 .RS 4
 211 Only consider unfocused windows\&.
 212 .RE
 213 .PP
 214 below
 215 .RS 4
 216 Only consider windows of the BELOW layer\&.
 217 .RE
 218 .PP
 219 normal
 220 .RS 4
 221 Only consider windows of the NORMAL layer\&.
 222 .RE
 223 .PP
 224 above
 225 .RS 4
 226 Only consider windows of the ABOVE layer\&.
 227 .RE
 228 .PP
 229 like
 230 .RS 4
 231 Only consider windows that have the same class as the current window\&.
 232 .RE
 233 .PP
 234 unlike
 235 .RS 4
 236 Only consider windows that have a different class than the current window\&.
 237 .RE
 238 .PP
 239 local
 240 .RS 4
 241 Only consider windows of the current desktop\&.
 242 .RE
 243 .PP
 244 foreign
 245 .RS 4
 246 Only consider windows outside of the current desktop\&.
 247 .RE
 248 .PP
 249 private
 250 .RS 4
 251 Only consider private windows\&.
 252 .RE
 253 .PP
 254 public
 255 .RS 4
 256 Only consider non private windows\&.
 257 .RE
 258 .PP
 259 urgent
 260 .RS 4
 261 Only consider urgent windows\&.
 262 .RE
 263 .PP
 264 nonurgent
 265 .RS 4
 266 Only consider non urgent windows\&.
 267 .RE
 268 .PP
 269 sticky
 270 .RS 4
 271 Only consider sticky windows\&.
 272 .RE
 273 .PP
 274 nonsticky
 275 .RS 4
 276 Only consider non sticky windows\&.
 277 .RE
 278 .PP
 279 locked
 280 .RS 4
 281 Only consider locked windows\&.
 282 .RE
 283 .PP
 284 unlocked
 285 .RS 4
 286 Only consider non locked windows\&.
 287 .RE
 288 .RE
 289 .SS "Desktop"
 290 .sp
 291 Select a desktop\&.
 292 .sp
 293 .if n \{\
 294 .RS 4
 295 .\}
 296 .nf
 297 DESKTOP_SEL := <desktop_name>
 298              | [MONITOR_SEL:]^<n>
 299              | (CYCLE_DIR|last|[MONITOR_SEL:]focused|older|newer)[\&.occupied|\&.free][\&.urgent|\&.nonurgent][\&.local|\&.foreign]
 300 .fi
 301 .if n \{\
 302 .RE
 303 .\}
 304 .sp
 305 .it 1 an-trap
 306 .nr an-no-space-flag 1
 307 .nr an-break-flag 1
 308 .br
 309 .ps +1
 310 \fBPrimary Selectors\fR
 311 .RS 4
 312 .PP
 313 <desktop_name>
 314 .RS 4
 315 Selects the desktop with the given name\&.
 316 .RE
 317 .PP
 318 ^<n>
 319 .RS 4
 320 Selects the nth desktop\&.
 321 .RE
 322 .PP
 323 \fICYCLE_DIR\fR
 324 .RS 4
 325 Selects the desktop in the given direction relative to the active desktop\&.
 326 .RE
 327 .PP
 328 last
 329 .RS 4
 330 Selects the previously focused desktop\&.
 331 .RE
 332 .PP
 333 focused
 334 .RS 4
 335 Selects the currently focused desktop\&.
 336 .RE
 337 .PP
 338 older
 339 .RS 4
 340 Selects the desktop older than the focused desktop in the history\&.
 341 .RE
 342 .PP
 343 newer
 344 .RS 4
 345 Selects the desktop newer than the focused desktop in the history\&.
 346 .RE
 347 .RE
 348 .sp
 349 .it 1 an-trap
 350 .nr an-no-space-flag 1
 351 .nr an-break-flag 1
 352 .br
 353 .ps +1
 354 \fBModifiers\fR
 355 .RS 4
 356 .PP
 357 occupied
 358 .RS 4
 359 Only consider occupied desktops\&.
 360 .RE
 361 .PP
 362 free
 363 .RS 4
 364 Only consider free desktops\&.
 365 .RE
 366 .PP
 367 urgent
 368 .RS 4
 369 Only consider urgent desktops\&.
 370 .RE
 371 .PP
 372 nonurgent
 373 .RS 4
 374 Only consider non urgent desktops\&.
 375 .RE
 376 .PP
 377 local
 378 .RS 4
 379 Only consider desktops of the current monitor\&.
 380 .RE
 381 .PP
 382 foreign
 383 .RS 4
 384 Only consider desktops outside of the current monitor\&.
 385 .RE
 386 .RE
 387 .SS "Monitor"
 388 .sp
 389 Select a monitor\&.
 390 .sp
 391 .if n \{\
 392 .RS 4
 393 .\}
 394 .nf
 395 MONITOR_SEL := <monitor_name>
 396              | ^<n>
 397              | (DIR|CYCLE_DIR|last|primary|focused|older|newer)[\&.occupied|\&.free]
 398 .fi
 399 .if n \{\
 400 .RE
 401 .\}
 402 .sp
 403 .it 1 an-trap
 404 .nr an-no-space-flag 1
 405 .nr an-break-flag 1
 406 .br
 407 .ps +1
 408 \fBPrimary Selectors\fR
 409 .RS 4
 410 .PP
 411 <monitor_name>
 412 .RS 4
 413 Selects the monitor with the given name\&.
 414 .RE
 415 .PP
 416 ^<n>
 417 .RS 4
 418 Selects the nth monitor\&.
 419 .RE
 420 .PP
 421 \fIDIR\fR
 422 .RS 4
 423 Selects the monitor in the given (spacial) direction relative to the active monitor\&.
 424 .RE
 425 .PP
 426 \fICYCLE_DIR\fR
 427 .RS 4
 428 Selects the monitor in the given (cyclic) direction relative to the active monitor\&.
 429 .RE
 430 .PP
 431 primary
 432 .RS 4
 433 Selects the primary monitor\&.
 434 .RE
 435 .PP
 436 last
 437 .RS 4
 438 Selects the previously focused monitor\&.
 439 .RE
 440 .PP
 441 focused
 442 .RS 4
 443 Selects the currently focused monitor\&.
 444 .RE
 445 .PP
 446 older
 447 .RS 4
 448 Selects the monitor older than the focused monitor in the history\&.
 449 .RE
 450 .PP
 451 newer
 452 .RS 4
 453 Selects the monitor newer than the focused monitor in the history\&.
 454 .RE
 455 .RE
 456 .sp
 457 .it 1 an-trap
 458 .nr an-no-space-flag 1
 459 .nr an-break-flag 1
 460 .br
 461 .ps +1
 462 \fBModifiers\fR
 463 .RS 4
 464 .PP
 465 occupied
 466 .RS 4
 467 Only consider monitors where the focused desktop is occupied\&.
 468 .RE
 469 .PP
 470 free
 471 .RS 4
 472 Only consider monitors where the focused desktop is free\&.
 473 .RE
 474 .RE
 475 .SH "WINDOW STATES"
 476 .PP
 477 tiled
 478 .RS 4
 479 Its size and position are determined by the splitting type and ratio of each node of its path in the window tree\&.
 480 .RE
 481 .PP
 482 pseudo_tiled
 483 .RS 4
 484 Has an unrestricted size while being centered in its tiling space\&.
 485 .RE
 486 .PP
 487 floating
 488 .RS 4
 489 Can be moved/resized freely\&. Although it doesn\(cqt occupy any tiling space, it is still part of the window tree\&.
 490 .RE
 491 .PP
 492 fullscreen
 493 .RS 4
 494 Fills its monitor rectangle and has no borders\&. It is send in the ABOVE layer by default\&.
 495 .RE
 496 .SH "WINDOW FLAGS"
 497 .PP
 498 locked
 499 .RS 4
 500 Ignores the
 501 \fBwindow \-\-close\fR
 502 message\&.
 503 .RE
 504 .PP
 505 sticky
 506 .RS 4
 507 Stays in the focused desktop of its monitor\&.
 508 .RE
 509 .PP
 510 private
 511 .RS 4
 512 Tries to keep the same tiling position/size\&.
 513 .RE
 514 .PP
 515 urgent
 516 .RS 4
 517 Has its urgency hint set\&. This flag is set externally\&.
 518 .RE
 519 .SH "STACKING LAYERS"
 520 .sp
 521 There\(cqs three stacking layers: BELOW, NORMAL and ABOVE\&.
 522 .sp
 523 In each layer, the window are orderered as follow: tiled & pseudo\-tiled < fullscreen < floating\&.
 524 .SH "COMMANDS"
 525 .SS "Window"
 526 .sp
 527 .it 1 an-trap
 528 .nr an-no-space-flag 1
 529 .nr an-break-flag 1
 530 .br
 531 .ps +1
 532 \fBGeneral Syntax\fR
 533 .RS 4
 534 .sp
 535 window [\fIWINDOW_SEL\fR] \fIOPTIONS\fR
 536 .RE
 537 .sp
 538 .it 1 an-trap
 539 .nr an-no-space-flag 1
 540 .nr an-break-flag 1
 541 .br
 542 .ps +1
 543 \fBOptions\fR
 544 .RS 4
 545 .PP
 546 \fB\-f\fR, \fB\-\-focus\fR [\fIWINDOW_SEL\fR]
 547 .RS 4
 548 Focus the selected or given window\&.
 549 .RE
 550 .PP
 551 \fB\-a\fR, \fB\-\-activate\fR [\fIWINDOW_SEL\fR]
 552 .RS 4
 553 Activate the selected or given window\&.
 554 .RE
 555 .PP
 556 \fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR
 557 .RS 4
 558 Send the selected window to the given desktop\&.
 559 .RE
 560 .PP
 561 \fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR
 562 .RS 4
 563 Send the selected window to the given monitor\&.
 564 .RE
 565 .PP
 566 \fB\-w\fR, \fB\-\-to\-window\fR \fIWINDOW_SEL\fR
 567 .RS 4
 568 Transplant the selected window to the given window\&.
 569 .RE
 570 .PP
 571 \fB\-s\fR, \fB\-\-swap\fR \fIWINDOW_SEL\fR
 572 .RS 4
 573 Swap the selected window with the given window\&.
 574 .RE
 575 .PP
 576 \fB\-p\fR, \fB\-\-presel\fR \fIDIR\fR|cancel
 577 .RS 4
 578 Preselect the splitting area of the selected window (or cancel the preselection)\&.
 579 .RE
 580 .PP
 581 \fB\-r\fR, \fB\-\-ratio\fR \fIRATIO\fR
 582 .RS 4
 583 Set the splitting ratio of the selected window (0 <
 584 \fIRATIO\fR
 585 < 1)\&.
 586 .RE
 587 .PP
 588 \fB\-e\fR, \fB\-\-edge\fR \fIDIR\fR \fIRATIO\fR|\(+-\fIPIXELS\fR
 589 .RS 4
 590 Set or change the splitting ratio of the edge located in the given direction in relation to the selected window\&.
 591 .RE
 592 .PP
 593 \fB\-R\fR, \fB\-\-rotate\fR \fIDIR\fR \fI90|270|180\fR
 594 .RS 4
 595 Rotate the tree holding the edge located in the given direction in relation to the selected window\&.
 596 .RE
 597 .PP
 598 \fB\-t\fR, \fB\-\-state\fR tiled|pseudo_tiled|floating|fullscreen
 599 .RS 4
 600 Set the state of the selected window\&.
 601 .RE
 602 .PP
 603 \fB\-g\fR, \fB\-\-flag\fR locked|sticky|private[=on|off]
 604 .RS 4
 605 Set or toggle the given flag for the selected window\&.
 606 .RE
 607 .PP
 608 \fB\-l\fR, \fB\-\-layer\fR below|normal|above
 609 .RS 4
 610 Set the stacking layer of the selected window\&.
 611 .RE
 612 .PP
 613 \fB\-c\fR, \fB\-\-close\fR
 614 .RS 4
 615 Close the selected window\&.
 616 .RE
 617 .PP
 618 \fB\-k\fR, \fB\-\-kill\fR
 619 .RS 4
 620 Kill the selected window\&.
 621 .RE
 622 .RE
 623 .SS "Desktop"
 624 .sp
 625 .it 1 an-trap
 626 .nr an-no-space-flag 1
 627 .nr an-break-flag 1
 628 .br
 629 .ps +1
 630 \fBGeneral Syntax\fR
 631 .RS 4
 632 .sp
 633 desktop [\fIDESKTOP_SEL\fR] \fIOPTIONS\fR
 634 .RE
 635 .sp
 636 .it 1 an-trap
 637 .nr an-no-space-flag 1
 638 .nr an-break-flag 1
 639 .br
 640 .ps +1
 641 \fBOptions\fR
 642 .RS 4
 643 .PP
 644 \fB\-f\fR, \fB\-\-focus\fR [\fIDESKTOP_SEL\fR]
 645 .RS 4
 646 Focus the selected or given desktop\&.
 647 .RE
 648 .PP
 649 \fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR
 650 .RS 4
 651 Send the selected desktop to the given monitor\&.
 652 .RE
 653 .PP
 654 \fB\-l\fR, \fB\-\-layout\fR \fICYCLE_DIR\fR|monocle|tiled
 655 .RS 4
 656 Set or cycle the layout of the selected desktop\&.
 657 .RE
 658 .PP
 659 \fB\-n\fR, \fB\-\-rename\fR <new_name>
 660 .RS 4
 661 Rename the selected desktop\&.
 662 .RE
 663 .PP
 664 \fB\-s\fR, \fB\-\-swap\fR \fIDESKTOP_SEL\fR
 665 .RS 4
 666 Swap the selected desktop with the given desktop\&.
 667 .RE
 668 .PP
 669 \fB\-b\fR, \fB\-\-bubble\fR \fICYCLE_DIR\fR
 670 .RS 4
 671 Bubble the selected desktop in the given direction\&.
 672 .RE
 673 .PP
 674 \fB\-r\fR, \fB\-\-remove\fR
 675 .RS 4
 676 Remove the selected desktop\&.
 677 .RE
 678 .PP
 679 \fB\-c\fR, \fB\-\-cancel\-presel\fR
 680 .RS 4
 681 Cancel the preselection of all the windows of the selected desktop\&.
 682 .RE
 683 .PP
 684 \fB\-F\fR, \fB\-\-flip\fR \fIhorizontal|vertical\fR
 685 .RS 4
 686 Flip the tree of the selected desktop\&.
 687 .RE
 688 .PP
 689 \fB\-R\fR, \fB\-\-rotate\fR \fI90|270|180\fR
 690 .RS 4
 691 Rotate the tree of the selected desktop\&.
 692 .RE
 693 .PP
 694 \fB\-E\fR, \fB\-\-equalize\fR
 695 .RS 4
 696 Reset the split ratios of the tree of the selected desktop\&.
 697 .RE
 698 .PP
 699 \fB\-B\fR, \fB\-\-balance\fR
 700 .RS 4
 701 Adjust the split ratios of the tree of the selected desktop so that all windows occupy the same area\&.
 702 .RE
 703 .PP
 704 \fB\-C\fR, \fB\-\-circulate\fR forward|backward
 705 .RS 4
 706 Circulate the leaves of the tree of the selected desktop\&.
 707 .RE
 708 .RE
 709 .SS "Monitor"
 710 .sp
 711 .it 1 an-trap
 712 .nr an-no-space-flag 1
 713 .nr an-break-flag 1
 714 .br
 715 .ps +1
 716 \fBGeneral Syntax\fR
 717 .RS 4
 718 .sp
 719 monitor [\fIMONITOR_SEL\fR] \fIOPTIONS\fR
 720 .RE
 721 .sp
 722 .it 1 an-trap
 723 .nr an-no-space-flag 1
 724 .nr an-break-flag 1
 725 .br
 726 .ps +1
 727 \fBOptions\fR
 728 .RS 4
 729 .PP
 730 \fB\-f\fR, \fB\-\-focus\fR [\fIMONITOR_SEL\fR]
 731 .RS 4
 732 Focus the selected or given monitor\&.
 733 .RE
 734 .PP
 735 \fB\-a\fR, \fB\-\-add\-desktops\fR <name>\&...
 736 .RS 4
 737 Create desktops with the given names in the selected monitor\&.
 738 .RE
 739 .PP
 740 \fB\-r\fR, \fB\-\-remove\-desktops\fR <name>\&...
 741 .RS 4
 742 Remove desktops with the given names\&.
 743 .RE
 744 .PP
 745 \fB\-o\fR, \fB\-\-reorder\-desktops\fR <name>\&...
 746 .RS 4
 747 Reorder the desktops of the selected monitor to match the given order\&.
 748 .RE
 749 .PP
 750 \fB\-d\fR, \fB\-\-reset\-desktops\fR <name>\&...
 751 .RS 4
 752 Rename, add or remove desktops depending on whether the number of given names is equal, superior or inferior to the number of existing desktops\&. Incidentally reset the settings of the existing desktops\&.
 753 .RE
 754 .PP
 755 \fB\-n\fR, \fB\-\-rename\fR <new_name>
 756 .RS 4
 757 Rename the selected monitor\&.
 758 .RE
 759 .PP
 760 \fB\-s\fR, \fB\-\-swap\fR \fIMONITOR_SEL\fR
 761 .RS 4
 762 Swap the selected monitor with the given monitor\&.
 763 .RE
 764 .RE
 765 .SS "Query"
 766 .sp
 767 .it 1 an-trap
 768 .nr an-no-space-flag 1
 769 .nr an-break-flag 1
 770 .br
 771 .ps +1
 772 \fBGeneral Syntax\fR
 773 .RS 4
 774 .sp
 775 query \fIOPTIONS\fR
 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 \fBOptions\fR
 784 .RS 4
 785 .PP
 786 \fB\-W\fR, \fB\-\-windows\fR
 787 .RS 4
 788 List matching windows\&.
 789 .RE
 790 .PP
 791 \fB\-D\fR, \fB\-\-desktops\fR
 792 .RS 4
 793 List matching desktops\&.
 794 .RE
 795 .PP
 796 \fB\-M\fR, \fB\-\-monitors\fR
 797 .RS 4
 798 List matching monitors\&.
 799 .RE
 800 .PP
 801 \fB\-T\fR, \fB\-\-tree\fR
 802 .RS 4
 803 Print tree rooted at query\&.
 804 .RE
 805 .PP
 806 \fB\-H\fR, \fB\-\-history\fR
 807 .RS 4
 808 Print the history as it relates to the query\&.
 809 .RE
 810 .PP
 811 \fB\-S\fR, \fB\-\-stack\fR
 812 .RS 4
 813 Print the window stacking order\&.
 814 .RE
 815 .PP
 816 [\fB\-m\fR,\fB\-\-monitor\fR [\fIMONITOR_SEL\fR]] | [\fB\-d\fR,\fB\-\-desktop\fR [\fIDESKTOP_SEL\fR]] | [\fB\-w\fR, \fB\-\-window\fR [\fIWINDOW_SEL\fR]]
 817 .RS 4
 818 Constrain matches to the selected monitor, desktop or window\&.
 819 .RE
 820 .RE
 821 .SS "Restore"
 822 .sp
 823 .it 1 an-trap
 824 .nr an-no-space-flag 1
 825 .nr an-break-flag 1
 826 .br
 827 .ps +1
 828 \fBGeneral Syntax\fR
 829 .RS 4
 830 .sp
 831 restore \fIOPTIONS\fR
 832 .RE
 833 .sp
 834 .it 1 an-trap
 835 .nr an-no-space-flag 1
 836 .nr an-break-flag 1
 837 .br
 838 .ps +1
 839 \fBOptions\fR
 840 .RS 4
 841 .PP
 842 \fB\-T\fR, \fB\-\-tree\fR <file_path>
 843 .RS 4
 844 Load the desktop trees from the given file\&.
 845 .RE
 846 .PP
 847 \fB\-H\fR, \fB\-\-history\fR <file_path>
 848 .RS 4
 849 Load the focus history from the given file\&.
 850 .RE
 851 .PP
 852 \fB\-S\fR, \fB\-\-stack\fR <file_path>
 853 .RS 4
 854 Load the window stacking order from the given file\&.
 855 .RE
 856 .RE
 857 .SS "Control"
 858 .sp
 859 .it 1 an-trap
 860 .nr an-no-space-flag 1
 861 .nr an-break-flag 1
 862 .br
 863 .ps +1
 864 \fBGeneral Syntax\fR
 865 .RS 4
 866 .sp
 867 control \fIOPTIONS\fR
 868 .RE
 869 .sp
 870 .it 1 an-trap
 871 .nr an-no-space-flag 1
 872 .nr an-break-flag 1
 873 .br
 874 .ps +1
 875 \fBOptions\fR
 876 .RS 4
 877 .PP
 878 \fB\-\-adopt\-orphans\fR
 879 .RS 4
 880 Manage all the unmanaged windows remaining from a previous session\&.
 881 .RE
 882 .PP
 883 \fB\-\-toggle\-visibility\fR
 884 .RS 4
 885 Toggle the visibility of all the windows\&.
 886 .RE
 887 .PP
 888 \fB\-\-record\-history\fR on|off
 889 .RS 4
 890 Enable or disable the recording of window focus history\&.
 891 .RE
 892 .PP
 893 \fB\-\-subscribe\fR (all|report|monitor|desktop|window|\&...)*
 894 .RS 4
 895 Continuously print status information\&. See the
 896 \fBEVENTS\fR
 897 section for the detailed description of each event\&.
 898 .RE
 899 .PP
 900 \fB\-\-get\-status\fR
 901 .RS 4
 902 Print the current status information\&.
 903 .RE
 904 .RE
 905 .SS "Pointer"
 906 .sp
 907 .it 1 an-trap
 908 .nr an-no-space-flag 1
 909 .nr an-break-flag 1
 910 .br
 911 .ps +1
 912 \fBGeneral Syntax\fR
 913 .RS 4
 914 .sp
 915 pointer \fIOPTIONS\fR
 916 .RE
 917 .sp
 918 .it 1 an-trap
 919 .nr an-no-space-flag 1
 920 .nr an-break-flag 1
 921 .br
 922 .ps +1
 923 \fBOptions\fR
 924 .RS 4
 925 .PP
 926 \fB\-g\fR, \fB\-\-grab\fR focus|move|resize_side|resize_corner
 927 .RS 4
 928 Initiate the given pointer action\&.
 929 .RE
 930 .PP
 931 \fB\-t\fR, \fB\-\-track\fR <x> <y>
 932 .RS 4
 933 Pass the pointer root coordinates for the current pointer action\&.
 934 .RE
 935 .PP
 936 \fB\-u\fR, \fB\-\-ungrab\fR
 937 .RS 4
 938 Terminate the current pointer action\&.
 939 .RE
 940 .RE
 941 .SS "Rule"
 942 .sp
 943 .it 1 an-trap
 944 .nr an-no-space-flag 1
 945 .nr an-break-flag 1
 946 .br
 947 .ps +1
 948 \fBGeneral Syntax\fR
 949 .RS 4
 950 .sp
 951 rule \fIOPTIONS\fR
 952 .RE
 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 \fBOptions\fR
 960 .RS 4
 961 .PP
 962 \fB\-a\fR, \fB\-\-add\fR <class_name>|<instance_name>|* [\fB\-o\fR|\fB\-\-one\-shot\fR] [monitor=MONITOR_SEL|desktop=DESKTOP_SEL|window=WINDOW_SEL] [state=STATE] [layer=LAYER] [split_dir=DIR] [split_ratio=RATIO] [(locked|sticky|private|center|follow|manage|focus|border)=(on|off)]
 963 .RS 4
 964 Create a new rule\&.
 965 .RE
 966 .PP
 967 \fB\-r\fR, \fB\-\-remove\fR ^<n>|head|tail|<class_name>|<instance_name>|*\&...
 968 .RS 4
 969 Remove the given rules\&.
 970 .RE
 971 .PP
 972 \fB\-l\fR, \fB\-\-list\fR [<class_name>|<instance_name>|*]
 973 .RS 4
 974 List the rules\&.
 975 .RE
 976 .RE
 977 .SS "Config"
 978 .sp
 979 .it 1 an-trap
 980 .nr an-no-space-flag 1
 981 .nr an-break-flag 1
 982 .br
 983 .ps +1
 984 \fBGeneral Syntax\fR
 985 .RS 4
 986 .PP
 987 config [\-m \fIMONITOR_SEL\fR|\-d \fIDESKTOP_SEL\fR|\-w \fIWINDOW_SEL\fR] <key> [<value>]
 988 .RS 4
 989 Get or set the value of <key>\&.
 990 .RE
 991 .RE
 992 .SS "Quit"
 993 .sp
 994 .it 1 an-trap
 995 .nr an-no-space-flag 1
 996 .nr an-break-flag 1
 997 .br
 998 .ps +1
 999 \fBGeneral Syntax\fR
1000 .RS 4
1001 .PP
1002 quit [<status>]
1003 .RS 4
1004 Quit with an optional exit status\&.
1005 .RE
1006 .RE
1007 .SH "EXIT CODES"
1008 .sp
1009 If the server can\(cqt handle a message, \fBbspc\fR will return with one of the following exit codes:
1010 .PP
1011 1
1012 .RS 4
1013 Failure\&.
1014 .RE
1015 .PP
1016 2
1017 .RS 4
1018 Syntax error\&.
1019 .RE
1020 .PP
1021 3
1022 .RS 4
1023 Unknown command\&.
1024 .RE
1025 .SH "SETTINGS"
1026 .sp
1027 Colors are either \fI#RRGGBB\fR or X color names, booleans are \fItrue\fR, \fIon\fR, \fIfalse\fR or \fIoff\fR\&.
1028 .sp
1029 All the boolean settings are \fIfalse\fR by default unless stated otherwise\&.
1030 .SS "Global Settings"
1031 .PP
1032 \fIfocused_border_color\fR
1033 .RS 4
1034 Color of the border of a focused window of a focused monitor\&.
1035 .RE
1036 .PP
1037 \fIactive_border_color\fR
1038 .RS 4
1039 Color of the border of a focused window of an unfocused monitor\&.
1040 .RE
1041 .PP
1042 \fInormal_border_color\fR
1043 .RS 4
1044 Color of the border of an unfocused window\&.
1045 .RE
1046 .PP
1047 \fIpresel_border_color\fR
1048 .RS 4
1049 Color of the
1050 \fBwindow \-\-presel\fR
1051 message feedback\&.
1052 .RE
1053 .PP
1054 \fIfocused_locked_border_color\fR
1055 .RS 4
1056 Color of the border of a focused locked window of a focused monitor\&.
1057 .RE
1058 .PP
1059 \fIactive_locked_border_color\fR
1060 .RS 4
1061 Color of the border of a focused locked window of an unfocused monitor\&.
1062 .RE
1063 .PP
1064 \fInormal_locked_border_color\fR
1065 .RS 4
1066 Color of the border of an unfocused locked window\&.
1067 .RE
1068 .PP
1069 \fIfocused_sticky_border_color\fR
1070 .RS 4
1071 Color of the border of a focused sticky window of a focused monitor\&.
1072 .RE
1073 .PP
1074 \fIactive_sticky_border_color\fR
1075 .RS 4
1076 Color of the border of a focused sticky window of an unfocused monitor\&.
1077 .RE
1078 .PP
1079 \fInormal_sticky_border_color\fR
1080 .RS 4
1081 Color of the border of an unfocused sticky window\&.
1082 .RE
1083 .PP
1084 \fIfocused_private_border_color\fR
1085 .RS 4
1086 Color of the border of a focused private window of a focused monitor\&.
1087 .RE
1088 .PP
1089 \fIactive_private_border_color\fR
1090 .RS 4
1091 Color of the border of a focused private window of an unfocused monitor\&.
1092 .RE
1093 .PP
1094 \fInormal_private_border_color\fR
1095 .RS 4
1096 Color of the border of an unfocused private window\&.
1097 .RE
1098 .PP
1099 \fIurgent_border_color\fR
1100 .RS 4
1101 Color of the border of an urgent window\&.
1102 .RE
1103 .PP
1104 \fIsplit_ratio\fR
1105 .RS 4
1106 Default split ratio\&.
1107 .RE
1108 .PP
1109 \fIstatus_prefix\fR
1110 .RS 4
1111 Prefix prepended to each of the status lines\&.
1112 .RE
1113 .PP
1114 \fIexternal_rules_command\fR
1115 .RS 4
1116 External command used to retrieve rule consequences\&. The command will receive the the ID of the window being processed as its first argument and the class and instance names as second and third arguments\&. The output of that command must have the following format:
1117 \fBkey1=value1 key2=value2 \&...\fR
1118 (the valid key/value pairs are given in the description of the
1119 \fIrule\fR
1120 command)\&.
1121 .RE
1122 .PP
1123 \fIinitial_polarity\fR
1124 .RS 4
1125 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:
1126 \fBfirst_child\fR,
1127 \fBsecond_child\fR\&.
1128 .RE
1129 .PP
1130 \fIhistory_aware_focus\fR
1131 .RS 4
1132 Give priority to the focus history when focusing nodes\&.
1133 .RE
1134 .PP
1135 \fIfocus_by_distance\fR
1136 .RS 4
1137 Base focusing on distances between windows\&.
1138 .RE
1139 .PP
1140 \fIborderless_monocle\fR
1141 .RS 4
1142 Remove borders of tiled windows for the
1143 \fBmonocle\fR
1144 desktop layout\&.
1145 .RE
1146 .PP
1147 \fIgapless_monocle\fR
1148 .RS 4
1149 Remove gaps of tiled windows for the
1150 \fBmonocle\fR
1151 desktop layout\&.
1152 .RE
1153 .PP
1154 \fIleaf_monocle\fR
1155 .RS 4
1156 Set the desktop layout to
1157 \fBmonocle\fR
1158 if there\(cqs only one tiled window in the tree\&.
1159 .RE
1160 .PP
1161 \fIfocus_follows_pointer\fR
1162 .RS 4
1163 Focus the window under the pointer\&.
1164 .RE
1165 .PP
1166 \fIpointer_follows_focus\fR
1167 .RS 4
1168 When focusing a window, put the pointer at its center\&.
1169 .RE
1170 .PP
1171 \fIpointer_follows_monitor\fR
1172 .RS 4
1173 When focusing a monitor, put the pointer at its center\&.
1174 .RE
1175 .PP
1176 \fIauto_alternate\fR
1177 .RS 4
1178 Interpret consecutive identical
1179 \fB\-\-focus\fR
1180 arguments as the
1181 \fBlast\fR
1182 selector for the
1183 \fBmonitor\fR
1184 and
1185 \fBdesktop\fR
1186 commands\&.
1187 .RE
1188 .PP
1189 \fIauto_cancel\fR
1190 .RS 4
1191 Interpret consecutive identical
1192 \fB\-\-presel\fR
1193 arguments as
1194 \fB\-\-cancel\-presel\fR
1195 option\&.
1196 .RE
1197 .PP
1198 \fIignore_ewmh_focus\fR
1199 .RS 4
1200 Ignore EWMH focus requests coming from applications\&.
1201 .RE
1202 .PP
1203 \fIcenter_pseudo_tiled\fR
1204 .RS 4
1205 Center pseudo tiled windows into their tiling rectangles\&. Defaults to
1206 \fItrue\fR\&.
1207 .RE
1208 .PP
1209 \fIremove_disabled_monitors\fR
1210 .RS 4
1211 Consider disabled monitors as disconnected\&.
1212 .RE
1213 .PP
1214 \fIremove_unplugged_monitors\fR
1215 .RS 4
1216 Remove unplugged monitors\&.
1217 .RE
1218 .PP
1219 \fImerge_overlapping_monitors\fR
1220 .RS 4
1221 Merge overlapping monitors (the bigger remains)\&.
1222 .RE
1223 .SS "Monitor and Desktop Settings"
1224 .PP
1225 \fItop_padding\fR, \fIright_padding\fR, \fIbottom_padding\fR, \fIleft_padding\fR
1226 .RS 4
1227 Padding space added at the sides of the monitor or desktop\&.
1228 .RE
1229 .SS "Default, Desktop Default and Window Settings"
1230 .PP
1231 \fIborder_width\fR
1232 .RS 4
1233 Window border width\&.
1234 .RE
1235 .SS "Default and Desktop Settings"
1236 .PP
1237 \fIwindow_gap\fR
1238 .RS 4
1239 Size of the gap that separates windows\&.
1240 .RE
1241 .SH "EVENTS"
1242 .PP
1243 \fIreport\fR
1244 .RS 4
1245 See the next section for the description of the format\&.
1246 .RE
1247 .PP
1248 \fImonitor_add <monitor_name> <monitor_id> <monitor_geometry>\fR
1249 .RS 4
1250 A monitor is added\&.
1251 .RE
1252 .PP
1253 \fImonitor_rename <old_name> <new_name>\fR
1254 .RS 4
1255 A monitor is renamed\&.
1256 .RE
1257 .PP
1258 \fImonitor_remove <monitor_name>\fR
1259 .RS 4
1260 A monitor is removed\&.
1261 .RE
1262 .PP
1263 \fImonitor_focus <monitor_name>\fR
1264 .RS 4
1265 A monitor is focused\&.
1266 .RE
1267 .PP
1268 \fImonitor_geometry <monitor_name> <monitor_geometry>\fR
1269 .RS 4
1270 The geometry of a monitor changed\&.
1271 .RE
1272 .PP
1273 \fIdesktop_add <monitor_name> <desktop_name>\fR
1274 .RS 4
1275 A desktop is added\&.
1276 .RE
1277 .PP
1278 \fIdesktop_rename <monitor_name> <old_name> <new_name>\fR
1279 .RS 4
1280 A desktop is renamed\&.
1281 .RE
1282 .PP
1283 \fIdesktop_remove <monitor_name> <desktop_name>\fR
1284 .RS 4
1285 A desktop is removed\&.
1286 .RE
1287 .PP
1288 \fIdesktop_swap <src_monitor_name> <src_desktop_name> <dst_monitor_name> <dst_desktop_name>\fR
1289 .RS 4
1290 A desktop is swapped\&.
1291 .RE
1292 .PP
1293 \fIdesktop_transfer <src_monitor_name> <src_desktop_name> <dst_monitor_name>\fR
1294 .RS 4
1295 A desktop is transferred\&.
1296 .RE
1297 .PP
1298 \fIdesktop_focus <monitor_name> <desktop_name>\fR
1299 .RS 4
1300 A desktop is focused\&.
1301 .RE
1302 .PP
1303 \fIdesktop_layout <monitor_name> <desktop_name> tiled|monocle\fR
1304 .RS 4
1305 The layout of a desktop changed\&.
1306 .RE
1307 .PP
1308 \fIwindow_manage <monitor_name> <desktop_name> <window_id> <ip_id>\fR
1309 .RS 4
1310 A window is managed\&.
1311 .RE
1312 .PP
1313 \fIwindow_unmanage <monitor_name> <desktop_name> <window_id>\fR
1314 .RS 4
1315 A window is unmanaged\&.
1316 .RE
1317 .PP
1318 \fIwindow_swap <src_monitor_name> <src_desktop_name> <src_window_id> <dst_monitor_name> <dst_desktop_name> <dst_window_id>\fR
1319 .RS 4
1320 A window is swapped\&.
1321 .RE
1322 .PP
1323 \fIwindow_transfer <src_monitor_name> <src_desktop_name> <src_window_id> <dst_monitor_name> <dst_desktop_name> <dst_window_id>\fR
1324 .RS 4
1325 A window is transferred\&.
1326 .RE
1327 .PP
1328 \fIwindow_focus <monitor_name> <desktop_name> <window_id>\fR
1329 .RS 4
1330 A window is focused\&.
1331 .RE
1332 .PP
1333 \fIwindow_activate <monitor_name> <desktop_name> <window_id>\fR
1334 .RS 4
1335 A window is activated\&.
1336 .RE
1337 .PP
1338 \fIwindow_geometry <monitor_name> <desktop_name> <window_id> <window_geometry>\fR
1339 .RS 4
1340 The geometry of a window changed\&.
1341 .RE
1342 .PP
1343 \fIwindow_state <monitor_name> <desktop_name> <window_id> tiled|pseudo_tiled|floating|fullscreen on|off\fR
1344 .RS 4
1345 The state of a window changed\&.
1346 .RE
1347 .PP
1348 \fIwindow_flag <monitor_name> <desktop_name> <window_id> sticky|private|locked|urgent on|off\fR
1349 .RS 4
1350 One of the flags of a window changed\&.
1351 .RE
1352 .PP
1353 \fIwindow_layer <monitor_name> <desktop_name> <window_id> below|normal|above\fR
1354 .RS 4
1355 The layer of a window changed\&.
1356 .RE
1357 .sp
1358 Please note that \fBbspwm\fR initializes monitors before it reads messages on its socket, therefore the initial monitor events can\(cqt be received\&.
1359 .SH "REPORT FORMAT"
1360 .sp
1361 Each report event message is composed of items separated by colons\&.
1362 .sp
1363 Each item has the form \fI<type><value>\fR where \fI<type>\fR is the first character of the item\&.
1364 .PP
1365 \fIM<monitor_name>\fR
1366 .RS 4
1367 Focused monitor\&.
1368 .RE
1369 .PP
1370 \fIm<monitor_name>\fR
1371 .RS 4
1372 Unfocused monitor\&.
1373 .RE
1374 .PP
1375 \fIO<desktop_name>\fR
1376 .RS 4
1377 Occupied focused desktop\&.
1378 .RE
1379 .PP
1380 \fIo<desktop_name>\fR
1381 .RS 4
1382 Occupied unfocused desktop\&.
1383 .RE
1384 .PP
1385 \fIF<desktop_name>\fR
1386 .RS 4
1387 Free focused desktop\&.
1388 .RE
1389 .PP
1390 \fIf<desktop_name>\fR
1391 .RS 4
1392 Free unfocused desktop\&.
1393 .RE
1394 .PP
1395 \fIU<desktop_name>\fR
1396 .RS 4
1397 Urgent focused desktop\&.
1398 .RE
1399 .PP
1400 \fIu<desktop_name>\fR
1401 .RS 4
1402 Urgent unfocused desktop\&.
1403 .RE
1404 .PP
1405 \fIL(T|M)\fR
1406 .RS 4
1407 Layout of the focused desktop of a monitor\&.
1408 .RE
1409 .SH "ENVIRONMENT VARIABLES"
1410 .PP
1411 \fIBSPWM_SOCKET\fR
1412 .RS 4
1413 The path of the socket used for the communication between
1414 \fBbspc\fR
1415 and
1416 \fBbspwm\fR\&. If it isn\(cqt defined, then the following path is used:
1417 \fI/tmp/bspwm<host_name>_<display_number>_<screen_number>\-socket\fR\&.
1418 .RE
1419 .SH "CONTRIBUTORS"
1420 .sp
1421 .RS 4
1422 .ie n \{\
1423 \h'-04'\(bu\h'+03'\c
1424 .\}
1425 .el \{\
1426 .sp -1
1427 .IP \(bu 2.3
1428 .\}
1429 Steven Allen <steven at stebalien\&.com>
1430 .RE
1431 .sp
1432 .RS 4
1433 .ie n \{\
1434 \h'-04'\(bu\h'+03'\c
1435 .\}
1436 .el \{\
1437 .sp -1
1438 .IP \(bu 2.3
1439 .\}
1440 Thomas Adam <thomas at xteddy\&.org>
1441 .RE
1442 .sp
1443 .RS 4
1444 .ie n \{\
1445 \h'-04'\(bu\h'+03'\c
1446 .\}
1447 .el \{\
1448 .sp -1
1449 .IP \(bu 2.3
1450 .\}
1451 Ivan Kanakarakis <ivan\&.kanak at gmail\&.com>
1452 .RE
1453 .SH "AUTHOR"
1454 .sp
1455 Bastien Dejean <nihilhill at gmail\&.com>