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: 09/17/2013
   6 .\"    Manual: Bspwm Manual
   7 .\"    Source: Bspwm 0.8
   8 .\"  Language: English
   9 .\"
  10 .TH "BSPWM" "1" "09/17/2013" "Bspwm 0\&.8" "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|\fB\-s\fR \fIPANEL_FIFO\fR|\fB\-p\fR \fIPANEL_PREFIX\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 .PP
  59 \fB\-s\fR \fIPANEL_FIFO\fR
  60 .RS 4
  61 Write the internal state to the given FIFO\&.
  62 .RE
  63 .PP
  64 \fB\-p\fR \fIPANEL_PREFIX\fR
  65 .RS 4
  66 Start every line written to the
  67 \fIPANEL_FIFO\fR
  68 with the given prefix\&.
  69 .RE
  70 .SH "CONFIGURATION"
  71 .sp
  72 \fBbspwm\fR has only two sources of informations: the X events it receives and the messages it reads on a dedicated socket\&.
  73 .sp
  74 The default configuration file is \fI$XDG_CONFIG_HOME/bspwm/bspwmrc\fR\&.
  75 .sp
  76 Keyboard and pointer bindings are defined with sxhkd\&.
  77 .sp
  78 Example configuration files can be found in the \fBexamples\fR directory\&.
  79 .SH "SPLITTING MODES"
  80 .sp
  81 New windows are inserted in the tree as close as possible to the focused window\&.
  82 .sp
  83 There is only two splitting modes: \fIautomatic\fR and \fImanual\fR\&.
  84 .sp
  85 The default mode is \fIautomatic\fR\&. The \fImanual\fR mode is entered by sending a \fBpreselection\fR message\&.
  86 .sp
  87 Example: insertion of a new node (number 4) into the given tree in \fIautomatic\fR mode:
  88 .sp
  89 .if n \{\
  90 .RS 4
  91 .\}
  92 .nf
  93               b                                   c
  94              / \e                                 / \e
  95             3   a              \-\->              4   b
  96             ^  / \e                              ^  / \e
  97               2   1                               3   a
  98                                                      / \e
  99                                                     2   1
 100  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+         +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
 101  |            |            |         |            |            |
 102  |            |     2      |         |            |     3      |
 103  |            |            |         |            |            |
 104  |     3      |\-\-\-\-\-\-\-\-\-\-\-\-|   \-\->   |     4      |\-\-\-\-\-\-\-\-\-\-\-\-|
 105  |     ^      |            |         |     ^      |     |      |
 106  |            |     1      |         |            |  1  |  2   |
 107  |            |            |         |            |     |      |
 108  +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+         +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
 109 .fi
 110 .if n \{\
 111 .RE
 112 .\}
 113 .sp
 114 Same departure, but the mode is \fImanual\fR, and a \fBwindow \-\-presel up\fR message was sent beforehand:
 115 .sp
 116 .if n \{\
 117 .RS 4
 118 .\}
 119 .nf
 120              b                                   b
 121             / \e                                 / \e
 122            3   a              \-\->              c   a
 123            ^  / \e                             / \e / \e
 124              2   1                           4  3 2  1
 125                                              ^
 126 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+         +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
 127 |            |            |         |            |            |
 128 |            |     2      |         |     4      |     2      |
 129 |            |            |         |     ^      |            |
 130 |     3      |\-\-\-\-\-\-\-\-\-\-\-\-|   \-\->   |\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-|
 131 |     ^      |            |         |            |            |
 132 |            |     1      |         |     3      |     1      |
 133 |            |            |         |            |            |
 134 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+         +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
 135 .fi
 136 .if n \{\
 137 .RE
 138 .\}
 139 .SH "CONTAINERS"
 140 .sp
 141 Each monitor contains at least one desktop\&.
 142 .sp
 143 Each desktop contains at most one tree\&.
 144 .SH "COMMON DEFINITIONS"
 145 .sp
 146 .if n \{\
 147 .RS 4
 148 .\}
 149 .nf
 150 DIR         := left | right | up | down
 151 CYCLE_DIR   := next | prev
 152 .fi
 153 .if n \{\
 154 .RE
 155 .\}
 156 .SH "SELECTORS"
 157 .sp
 158 Selectors are used to select a target window, desktop, or monitor\&. A selector can either describe the target relatively or name it globally\&.
 159 .sp
 160 Descriptive (relative) selectors consist of a primary selector and any number of non\-conflicting modifiers as follows:
 161 .sp
 162 .if n \{\
 163 .RS 4
 164 .\}
 165 .nf
 166 PRIMARY_SELECTOR[\&.MODIFIER]*
 167 .fi
 168 .if n \{\
 169 .RE
 170 .\}
 171 .sp
 172 For obvious reasons, neither desktops nor monitors names may be valid descriptive selectors\&.
 173 .SS "Window"
 174 .sp
 175 Select a window\&.
 176 .sp
 177 .if n \{\
 178 .RS 4
 179 .\}
 180 .nf
 181 WINDOW_SEL := <window_id>
 182             | (DIR|CYCLE_DIR|biggest|last|focused)[\&.floating|\&.tiled][\&.like|\&.unlike][\&.automatic|\&.manual][\&.urgent|\&.nonurgent]
 183 .fi
 184 .if n \{\
 185 .RE
 186 .\}
 187 .sp
 188 .it 1 an-trap
 189 .nr an-no-space-flag 1
 190 .nr an-break-flag 1
 191 .br
 192 .ps +1
 193 \fBPrimary Selectors\fR
 194 .RS 4
 195 .PP
 196 \fIDIR\fR
 197 .RS 4
 198 Selects the window in the given (spacial) direction relative to the active window\&.
 199 .RE
 200 .PP
 201 \fICYCLE_DIR\fR
 202 .RS 4
 203 Selects the window in the given (cyclic) direction\&.
 204 .RE
 205 .PP
 206 biggest
 207 .RS 4
 208 Selects the biggest window on the current desktop\&.
 209 .RE
 210 .PP
 211 last
 212 .RS 4
 213 Selects the previously focused window on the current desktop\&.
 214 .RE
 215 .PP
 216 focused
 217 .RS 4
 218 Selects the currently focused window\&.
 219 .RE
 220 .RE
 221 .sp
 222 .it 1 an-trap
 223 .nr an-no-space-flag 1
 224 .nr an-break-flag 1
 225 .br
 226 .ps +1
 227 \fBModifiers\fR
 228 .RS 4
 229 .PP
 230 floating
 231 .RS 4
 232 Only consider floating windows\&.
 233 .RE
 234 .PP
 235 tiled
 236 .RS 4
 237 Only consider tiled windows\&.
 238 .RE
 239 .PP
 240 like
 241 .RS 4
 242 Only consider windows that have the same class as the current window\&.
 243 .RE
 244 .PP
 245 unlike
 246 .RS 4
 247 Only consider windows that have a different class than the current window\&.
 248 .RE
 249 .PP
 250 automatic
 251 .RS 4
 252 Only consider windows in automatic splitting mode\&.
 253 .RE
 254 .PP
 255 manual
 256 .RS 4
 257 Only consider windows in manual splitting mode (see
 258 \fB\-\-presel\fR)\&.
 259 .RE
 260 .PP
 261 urgent
 262 .RS 4
 263 Only consider urgent windows\&.
 264 .RE
 265 .PP
 266 nonurgent
 267 .RS 4
 268 Only consider nonurgent windows\&.
 269 .RE
 270 .RE
 271 .SS "Desktop"
 272 .sp
 273 Select a desktop\&.
 274 .sp
 275 .if n \{\
 276 .RS 4
 277 .\}
 278 .nf
 279 DESKTOP_SEL := <desktop_name>
 280              | ^<n>
 281              | (CYCLE_DIR|last|focused)[\&.occupied|\&.free][\&.urgent|\&.nonurgent]
 282 .fi
 283 .if n \{\
 284 .RE
 285 .\}
 286 .sp
 287 .it 1 an-trap
 288 .nr an-no-space-flag 1
 289 .nr an-break-flag 1
 290 .br
 291 .ps +1
 292 \fBPrimary Selectors\fR
 293 .RS 4
 294 .PP
 295 <desktop_name>
 296 .RS 4
 297 Selects the desktop with the given name\&.
 298 .RE
 299 .PP
 300 ^<n>
 301 .RS 4
 302 Selects the nth desktop\&.
 303 .RE
 304 .PP
 305 \fICYCLE_DIR\fR
 306 .RS 4
 307 Selects the desktop in the given direction relative to the active desktop\&.
 308 .RE
 309 .PP
 310 last
 311 .RS 4
 312 Selects the previously focused desktop\&.
 313 .RE
 314 .PP
 315 focused
 316 .RS 4
 317 Selects the currently focused desktop\&.
 318 .RE
 319 .RE
 320 .sp
 321 .it 1 an-trap
 322 .nr an-no-space-flag 1
 323 .nr an-break-flag 1
 324 .br
 325 .ps +1
 326 \fBModifiers\fR
 327 .RS 4
 328 .PP
 329 occupied
 330 .RS 4
 331 Only consider occupied desktops\&.
 332 .RE
 333 .PP
 334 free
 335 .RS 4
 336 Only consider free desktops\&.
 337 .RE
 338 .PP
 339 urgent
 340 .RS 4
 341 Only consider urgent desktops\&.
 342 .RE
 343 .PP
 344 nonurgent
 345 .RS 4
 346 Only consider nonurgent desktops\&.
 347 .RE
 348 .RE
 349 .SS "Monitor"
 350 .sp
 351 Select a monitor\&.
 352 .sp
 353 .if n \{\
 354 .RS 4
 355 .\}
 356 .nf
 357 MONITOR_SEL := <monitor_name>
 358              | ^<n>
 359              | (DIR|CYCLE_DIR|last|primary|focused)[\&.occupied|\&.free]
 360 .fi
 361 .if n \{\
 362 .RE
 363 .\}
 364 .sp
 365 .it 1 an-trap
 366 .nr an-no-space-flag 1
 367 .nr an-break-flag 1
 368 .br
 369 .ps +1
 370 \fBPrimary Selectors\fR
 371 .RS 4
 372 .PP
 373 <monitor_name>
 374 .RS 4
 375 Selects the monitor with the given name\&.
 376 .RE
 377 .PP
 378 ^<n>
 379 .RS 4
 380 Selects the nth monitor\&.
 381 .RE
 382 .PP
 383 \fIDIR\fR
 384 .RS 4
 385 Selects the monitor in the given (spacial) direction relative to the active monitor\&.
 386 .RE
 387 .PP
 388 \fICYCLE_DIR\fR
 389 .RS 4
 390 Selects the monitor in the given (cyclic) direction relative to the active monitor\&.
 391 .RE
 392 .PP
 393 primary
 394 .RS 4
 395 Selects the primary monitor\&.
 396 .RE
 397 .PP
 398 last
 399 .RS 4
 400 Selects the previously focused monitor\&.
 401 .RE
 402 .PP
 403 focused
 404 .RS 4
 405 Selects the currently focused monitor\&.
 406 .RE
 407 .RE
 408 .sp
 409 .it 1 an-trap
 410 .nr an-no-space-flag 1
 411 .nr an-break-flag 1
 412 .br
 413 .ps +1
 414 \fBModifiers\fR
 415 .RS 4
 416 .PP
 417 occupied
 418 .RS 4
 419 Only consider monitors where the focused desktop is occupied\&.
 420 .RE
 421 .PP
 422 free
 423 .RS 4
 424 Only consider monitors where the focused desktop is free\&.
 425 .RE
 426 .RE
 427 .SH "COMMANDS"
 428 .SS "Window"
 429 .sp
 430 .it 1 an-trap
 431 .nr an-no-space-flag 1
 432 .nr an-break-flag 1
 433 .br
 434 .ps +1
 435 \fBGeneral Syntax\fR
 436 .RS 4
 437 .sp
 438 window [\fIWINDOW_SEL\fR] \fIOPTIONS\fR
 439 .RE
 440 .sp
 441 .it 1 an-trap
 442 .nr an-no-space-flag 1
 443 .nr an-break-flag 1
 444 .br
 445 .ps +1
 446 \fBOptions\fR
 447 .RS 4
 448 .PP
 449 \fB\-f\fR, \fB\-\-focus\fR [\fIWINDOW_SEL\fR]
 450 .RS 4
 451 Focus the selected or given window\&.
 452 .RE
 453 .PP
 454 \fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR
 455 .RS 4
 456 Send the selected window to the given desktop\&.
 457 .RE
 458 .PP
 459 \fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR
 460 .RS 4
 461 Send the selected window to the given monitor\&.
 462 .RE
 463 .PP
 464 \fB\-w\fR, \fB\-\-to\-window\fR \fIWINDOW_SEL\fR
 465 .RS 4
 466 Transplant the selected window to the given window\&.
 467 .RE
 468 .PP
 469 \fB\-s\fR, \fB\-\-swap\fR \fIWINDOW_SEL\fR
 470 .RS 4
 471 Swap the selected window with the given window\&.
 472 .RE
 473 .PP
 474 \fB\-p\fR, \fB\-\-presel\fR \fIDIR\fR|cancel
 475 .RS 4
 476 Preselect the splitting area of the selected window (or cancel the preselection)\&.
 477 .RE
 478 .PP
 479 \fB\-r\fR, \fB\-\-ratio\fR \fIRATIO\fR
 480 .RS 4
 481 Set the splitting ratio of the selected window (0 <
 482 \fIRATIO\fR
 483 < 1)\&.
 484 .RE
 485 .PP
 486 \fB\-e\fR, \fB\-\-edge\fR \fIDIR\fR \fIRATIO\fR|pull|push
 487 .RS 4
 488 Set the splitting ratio (or pull, or push) the edge located in the given direction in relation to the selected window\&.
 489 .RE
 490 .PP
 491 \fB\-R\fR, \fB\-\-rotate\fR \fIDIR\fR \fI90|270|180\fR
 492 .RS 4
 493 Rotate the tree holding the edge located in the given direction in relation to the selected window\&.
 494 .RE
 495 .PP
 496 \fB\-t\fR, \fB\-\-toggle\fR floating|fullscreen|locked[=on|off]
 497 .RS 4
 498 Set or toggle the given state for the selected window\&.
 499 .RE
 500 .PP
 501 \fB\-c\fR, \fB\-\-close\fR
 502 .RS 4
 503 Close the selected window\&.
 504 .RE
 505 .PP
 506 \fB\-k\fR, \fB\-\-kill\fR
 507 .RS 4
 508 Kill the selected window\&.
 509 .RE
 510 .RE
 511 .SS "Desktop"
 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 \fBGeneral Syntax\fR
 519 .RS 4
 520 .sp
 521 desktop [\fIDESKTOP_SEL\fR] \fIOPTIONS\fR
 522 .RE
 523 .sp
 524 .it 1 an-trap
 525 .nr an-no-space-flag 1
 526 .nr an-break-flag 1
 527 .br
 528 .ps +1
 529 \fBOptions\fR
 530 .RS 4
 531 .PP
 532 \fB\-f\fR, \fB\-\-focus\fR [\fIDESKTOP_SEL\fR]
 533 .RS 4
 534 Focus the selected or given desktop\&.
 535 .RE
 536 .PP
 537 \fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR
 538 .RS 4
 539 Send the selected desktop to the given monitor\&.
 540 .RE
 541 .PP
 542 \fB\-l\fR, \fB\-\-layout\fR \fICYCLE_DIR\fR|monocle|tiled
 543 .RS 4
 544 Set or cycle the layout of the selected desktop\&.
 545 .RE
 546 .PP
 547 \fB\-n\fR, \fB\-\-rename\fR <new_name>
 548 .RS 4
 549 Rename the selected desktop\&.
 550 .RE
 551 .PP
 552 \fB\-s\fR, \fB\-\-swap\fR \fIDESKTOP_SEL\fR
 553 .RS 4
 554 Swap the selected desktop with the given desktop\&.
 555 .RE
 556 .PP
 557 \fB\-r\fR, \fB\-\-remove\fR
 558 .RS 4
 559 Remove the selected desktop\&.
 560 .RE
 561 .PP
 562 \fB\-c\fR, \fB\-\-cancel\-presel\fR
 563 .RS 4
 564 Cancel the preselection of all the windows of the selected desktop\&.
 565 .RE
 566 .PP
 567 \fB\-F\fR, \fB\-\-flip\fR \fIhorizontal|vertical\fR
 568 .RS 4
 569 Flip the tree of the selected desktop\&.
 570 .RE
 571 .PP
 572 \fB\-R\fR, \fB\-\-rotate\fR \fI90|270|180\fR
 573 .RS 4
 574 Rotate the tree of the selected desktop\&.
 575 .RE
 576 .PP
 577 \fB\-B\fR, \fB\-\-balance\fR
 578 .RS 4
 579 Adjust the split ratios of the tree of the selected desktop so that all windows occupy the same area\&.
 580 .RE
 581 .PP
 582 \fB\-C\fR, \fB\-\-circulate\fR forward|backward
 583 .RS 4
 584 Circulate the leaves of the tree of the selected desktop\&.
 585 .RE
 586 .RE
 587 .SS "Monitor"
 588 .sp
 589 .it 1 an-trap
 590 .nr an-no-space-flag 1
 591 .nr an-break-flag 1
 592 .br
 593 .ps +1
 594 \fBGeneral Syntax\fR
 595 .RS 4
 596 .sp
 597 monitor [\fIMONITOR_SEL\fR] \fIOPTIONS\fR
 598 .RE
 599 .sp
 600 .it 1 an-trap
 601 .nr an-no-space-flag 1
 602 .nr an-break-flag 1
 603 .br
 604 .ps +1
 605 \fBOptions\fR
 606 .RS 4
 607 .PP
 608 \fB\-f\fR, \fB\-\-focus\fR [\fIMONITOR_SEL\fR]
 609 .RS 4
 610 Focus the selected or given monitor\&.
 611 .RE
 612 .PP
 613 \fB\-a\fR, \fB\-\-add\-desktops\fR <name>\&...
 614 .RS 4
 615 Create desktops with the given names in the selected monitor\&.
 616 .RE
 617 .PP
 618 \fB\-r\fR, \fB\-\-remove\-desktops\fR <name>\&...
 619 .RS 4
 620 Remove desktops with the given names\&.
 621 .RE
 622 .PP
 623 \fB\-n\fR, \fB\-\-rename\fR <new_name>
 624 .RS 4
 625 Rename the selected monitor\&.
 626 .RE
 627 .PP
 628 \fB\-s\fR, \fB\-\-swap\fR \fIMONITOR_SEL\fR
 629 .RS 4
 630 Swap the selected monitor with the given monitor\&.
 631 .RE
 632 .RE
 633 .SS "Query"
 634 .sp
 635 .it 1 an-trap
 636 .nr an-no-space-flag 1
 637 .nr an-break-flag 1
 638 .br
 639 .ps +1
 640 \fBGeneral Syntax\fR
 641 .RS 4
 642 .sp
 643 query \fIOPTIONS\fR
 644 .RE
 645 .sp
 646 .it 1 an-trap
 647 .nr an-no-space-flag 1
 648 .nr an-break-flag 1
 649 .br
 650 .ps +1
 651 \fBOptions\fR
 652 .RS 4
 653 .PP
 654 \fB\-W\fR, \fB\-\-windows\fR
 655 .RS 4
 656 List matching windows\&.
 657 .RE
 658 .PP
 659 \fB\-D\fR, \fB\-\-desktops\fR
 660 .RS 4
 661 List matching desktops\&.
 662 .RE
 663 .PP
 664 \fB\-M\fR, \fB\-\-monitors\fR
 665 .RS 4
 666 List matching monitors\&.
 667 .RE
 668 .PP
 669 \fB\-T\fR, \fB\-\-tree\fR
 670 .RS 4
 671 Print tree rooted at query\&.
 672 .RE
 673 .PP
 674 \fB\-H\fR, \fB\-\-history\fR
 675 .RS 4
 676 Print the history as it relates to the query\&.
 677 .RE
 678 .PP
 679 [\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]]
 680 .RS 4
 681 Constrain matches to the selected monitor, desktop or window\&.
 682 .RE
 683 .RE
 684 .SS "Restore"
 685 .sp
 686 .it 1 an-trap
 687 .nr an-no-space-flag 1
 688 .nr an-break-flag 1
 689 .br
 690 .ps +1
 691 \fBGeneral Syntax\fR
 692 .RS 4
 693 .sp
 694 restore \fIOPTIONS\fR
 695 .RE
 696 .sp
 697 .it 1 an-trap
 698 .nr an-no-space-flag 1
 699 .nr an-break-flag 1
 700 .br
 701 .ps +1
 702 \fBOptions\fR
 703 .RS 4
 704 .PP
 705 \fB\-T\fR, \fB\-\-tree\fR <file_path>
 706 .RS 4
 707 Load the desktop trees from the given file\&.
 708 .RE
 709 .PP
 710 \fB\-H\fR, \fB\-\-history\fR <file_path>
 711 .RS 4
 712 Load the focus history from the given file\&.
 713 .RE
 714 .RE
 715 .SS "Control"
 716 .sp
 717 .it 1 an-trap
 718 .nr an-no-space-flag 1
 719 .nr an-break-flag 1
 720 .br
 721 .ps +1
 722 \fBGeneral Syntax\fR
 723 .RS 4
 724 .sp
 725 control \fIOPTIONS\fR
 726 .RE
 727 .sp
 728 .it 1 an-trap
 729 .nr an-no-space-flag 1
 730 .nr an-break-flag 1
 731 .br
 732 .ps +1
 733 \fBOptions\fR
 734 .RS 4
 735 .PP
 736 \fB\-\-adopt\-orphans\fR
 737 .RS 4
 738 Manage all the unmanaged windows remaining from a previous session\&.
 739 .RE
 740 .PP
 741 \fB\-\-put\-status\fR
 742 .RS 4
 743 Write the current internal state to the panel FIFO\&.
 744 .RE
 745 .PP
 746 \fB\-\-toggle\-visibility\fR
 747 .RS 4
 748 Toggle the visibility of all the windows\&.
 749 .RE
 750 .PP
 751 \fB\-\-float\-upcoming\fR
 752 .RS 4
 753 Toggle the floating state of the upcoming window\&.
 754 .RE
 755 .RE
 756 .SS "Pointer"
 757 .sp
 758 .it 1 an-trap
 759 .nr an-no-space-flag 1
 760 .nr an-break-flag 1
 761 .br
 762 .ps +1
 763 \fBGeneral Syntax\fR
 764 .RS 4
 765 .sp
 766 pointer \fIOPTIONS\fR
 767 .RE
 768 .sp
 769 .it 1 an-trap
 770 .nr an-no-space-flag 1
 771 .nr an-break-flag 1
 772 .br
 773 .ps +1
 774 \fBOptions\fR
 775 .RS 4
 776 .PP
 777 \fB\-t\fR, \fB\-\-track\fR <x> <y>
 778 .RS 4
 779 Pass the pointer root coordinates for the current pointer action\&.
 780 .RE
 781 .PP
 782 \fB\-g\fR, \fB\-\-grab\fR focus|move|resize_side|resize_corner
 783 .RS 4
 784 Perform the given pointer action\&.
 785 .RE
 786 .RE
 787 .SS "Rule"
 788 .sp
 789 .it 1 an-trap
 790 .nr an-no-space-flag 1
 791 .nr an-break-flag 1
 792 .br
 793 .ps +1
 794 \fBGeneral Syntax\fR
 795 .RS 4
 796 .sp
 797 rule \fIOPTIONS\fR
 798 .RE
 799 .sp
 800 .it 1 an-trap
 801 .nr an-no-space-flag 1
 802 .nr an-break-flag 1
 803 .br
 804 .ps +1
 805 \fBOptions\fR
 806 .RS 4
 807 .PP
 808 \fB\-a\fR, \fB\-\-add\fR <pattern> [\-d \fIDESKTOP_SEL\fR [\-\-follow]] [\-\-floating] [\-\-focus] [\-\-unmanage]
 809 .RS 4
 810 Create a new rule (<pattern> must match the class or instance name)\&.
 811 .RE
 812 .PP
 813 \fB\-r\fR, \fB\-\-rm\fR <rule_uid>\&...
 814 .RS 4
 815 Remove the rules with the given UIDs\&.
 816 .RE
 817 .PP
 818 \fB\-l\fR, \fB\-\-list\fR [<pattern>]
 819 .RS 4
 820 List the rules\&.
 821 .RE
 822 .RE
 823 .SS "Config"
 824 .sp
 825 .it 1 an-trap
 826 .nr an-no-space-flag 1
 827 .nr an-break-flag 1
 828 .br
 829 .ps +1
 830 \fBGeneral Syntax\fR
 831 .RS 4
 832 .PP
 833 config [\-m \fIMONITOR_SEL\fR|\-d \fIDESKTOP_SEL\fR] <key> [<value>]
 834 .RS 4
 835 Get or set the value of <key>\&.
 836 .RE
 837 .RE
 838 .SS "Quit"
 839 .sp
 840 .it 1 an-trap
 841 .nr an-no-space-flag 1
 842 .nr an-break-flag 1
 843 .br
 844 .ps +1
 845 \fBGeneral Syntax\fR
 846 .RS 4
 847 .PP
 848 quit [<status>]
 849 .RS 4
 850 Quit with an optional exit status\&.
 851 .RE
 852 .RE
 853 .SH "SETTINGS"
 854 .sp
 855 Colors are either X color names or \fI#RRGGBB\fR, booleans are \fItrue\fR or \fIfalse\fR\&.
 856 .sp
 857 All the boolean settings are \fIfalse\fR by default\&.
 858 .SS "Global Settings"
 859 .PP
 860 \fIfocused_border_color\fR
 861 .RS 4
 862 Color of the border of a focused window of a focused monitor\&.
 863 .RE
 864 .PP
 865 \fIactive_border_color\fR
 866 .RS 4
 867 Color of the border of a focused window of an unfocused monitor\&.
 868 .RE
 869 .PP
 870 \fInormal_border_color\fR
 871 .RS 4
 872 Color of the border of an unfocused window\&.
 873 .RE
 874 .PP
 875 \fIpresel_border_color\fR
 876 .RS 4
 877 Color of the
 878 \fBpresel\fR
 879 message feedback\&.
 880 .RE
 881 .PP
 882 \fIfocused_locked_border_color\fR
 883 .RS 4
 884 Color of the border of a focused locked window of a focused monitor\&.
 885 .RE
 886 .PP
 887 \fIactive_locked_border_color\fR
 888 .RS 4
 889 Color of the border of a focused locked window of an unfocused monitor\&.
 890 .RE
 891 .PP
 892 \fInormal_locked_border_color\fR
 893 .RS 4
 894 Color of the border of an unfocused locked window\&.
 895 .RE
 896 .PP
 897 \fIurgent_border_color\fR
 898 .RS 4
 899 Color of the border of an urgent window\&.
 900 .RE
 901 .PP
 902 \fIborder_width\fR
 903 .RS 4
 904 Window border width\&.
 905 .RE
 906 .PP
 907 \fIsplit_ratio\fR
 908 .RS 4
 909 Default split ratio\&.
 910 .RE
 911 .PP
 912 \fIhistory_aware_focus\fR
 913 .RS 4
 914 Give priority to the focus history when focusing nodes\&.
 915 .RE
 916 .PP
 917 \fIborderless_monocle\fR
 918 .RS 4
 919 Remove borders for tiled windows in monocle mode\&.
 920 .RE
 921 .PP
 922 \fIgapless_monocle\fR
 923 .RS 4
 924 Remove gaps for tiled windows in monocle mode\&.
 925 .RE
 926 .PP
 927 \fIfocus_follows_pointer\fR
 928 .RS 4
 929 Focus the window under the pointer\&.
 930 .RE
 931 .PP
 932 \fIpointer_follows_monitor\fR
 933 .RS 4
 934 When focusing a monitor, put the pointer at its center\&.
 935 .RE
 936 .PP
 937 \fIauto_alternate\fR
 938 .RS 4
 939 Interpret two consecutive identical
 940 \fBuse\fR
 941 messages as an
 942 \fBalternate\fR
 943 message\&.
 944 .RE
 945 .PP
 946 \fIauto_cancel\fR
 947 .RS 4
 948 Interpret two consecutive identical
 949 \fBpresel\fR
 950 messages as a
 951 \fBcancel\fR
 952 message\&.
 953 .RE
 954 .PP
 955 \fIapply_floating_atom\fR
 956 .RS 4
 957 Set the value of the
 958 \fI_BSPWM_FLOATING_WINDOW\fR
 959 atom of each window according to its floating state\&.
 960 .RE
 961 .SS "Monitor Settings"
 962 .PP
 963 \fItop_padding\fR, \fIright_padding\fR, \fIbottom_padding\fR, \fIleft_padding\fR
 964 .RS 4
 965 Padding space added at the sides of the monitor\&.
 966 .RE
 967 .SS "Desktop Settings"
 968 .PP
 969 \fIwindow_gap\fR
 970 .RS 4
 971 Size of the gap that separates windows\&.
 972 .RE
 973 .SH "ENVIRONMENT VARIABLES"
 974 .PP
 975 \fIBSPWM_SOCKET\fR
 976 .RS 4
 977 The path of the socket used for the communication between
 978 \fBbspc\fR
 979 and
 980 \fBbspwm\fR\&. If it isn\(cqt defined, then the following path is used:
 981 \fI/tmp/bspwm\-socket\fR\&.
 982 .RE
 983 .SH "PANELS"
 984 .sp
 985 .RS 4
 986 .ie n \{\
 987 \h'-04'\(bu\h'+03'\c
 988 .\}
 989 .el \{\
 990 .sp -1
 991 .IP \(bu 2.3
 992 .\}
 993 Any EWMH compliant panel (e\&.g\&.:
 994 \fItint2\fR,
 995 \fIbmpanel2\fR, etc\&.)\&.
 996 .RE
 997 .sp
 998 .RS 4
 999 .ie n \{\
1000 \h'-04'\(bu\h'+03'\c
1001 .\}
1002 .el \{\
1003 .sp -1
1004 .IP \(bu 2.3
1005 .\}
1006 A custom panel if the
1007 \fI\-s\fR
1008 flag is used (have a look at the files in
1009 \fIexamples/panel\fR)\&.
1010 .RE
1011 .SH "KEY FEATURES"
1012 .sp
1013 .RS 4
1014 .ie n \{\
1015 \h'-04'\(bu\h'+03'\c
1016 .\}
1017 .el \{\
1018 .sp -1
1019 .IP \(bu 2.3
1020 .\}
1021 Configured and controlled through messages\&.
1022 .RE
1023 .sp
1024 .RS 4
1025 .ie n \{\
1026 \h'-04'\(bu\h'+03'\c
1027 .\}
1028 .el \{\
1029 .sp -1
1030 .IP \(bu 2.3
1031 .\}
1032 Multiple monitors support (via
1033 \fIRandR\fR)\&.
1034 .RE
1035 .sp
1036 .RS 4
1037 .ie n \{\
1038 \h'-04'\(bu\h'+03'\c
1039 .\}
1040 .el \{\
1041 .sp -1
1042 .IP \(bu 2.3
1043 .\}
1044 EWMH support (\fBtint2\fR
1045 works)\&.
1046 .RE
1047 .sp
1048 .RS 4
1049 .ie n \{\
1050 \h'-04'\(bu\h'+03'\c
1051 .\}
1052 .el \{\
1053 .sp -1
1054 .IP \(bu 2.3
1055 .\}
1056 Hybrid tiling\&.
1057 .RE
1058 .SH "CONTRIBUTORS"
1059 .sp
1060 .RS 4
1061 .ie n \{\
1062 \h'-04'\(bu\h'+03'\c
1063 .\}
1064 .el \{\
1065 .sp -1
1066 .IP \(bu 2.3
1067 .\}
1068 Steven Allen <steven at stebalien\&.com>
1069 .RE
1070 .sp
1071 .RS 4
1072 .ie n \{\
1073 \h'-04'\(bu\h'+03'\c
1074 .\}
1075 .el \{\
1076 .sp -1
1077 .IP \(bu 2.3
1078 .\}
1079 Thomas Adam <thomas at xteddy\&.org>
1080 .RE
1081 .sp
1082 .RS 4
1083 .ie n \{\
1084 \h'-04'\(bu\h'+03'\c
1085 .\}
1086 .el \{\
1087 .sp -1
1088 .IP \(bu 2.3
1089 .\}
1090 Ivan Kanakarakis <ivan\&.kanak at gmail\&.com>
1091 .RE
1092 .SH "AUTHOR"
1093 .sp
1094 Bastien Dejean <baskerville at lavabit\&.com>
1095 .SH "MAILING LIST"
1096 .sp
1097 bspwm at librelist\&.com