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: 07/29/2013
   6 .\"    Manual: Bspwm Manual
   7 .\"    Source: Bspwm 0.7
   8 .\"  Language: English
   9 .\"
  10 .TH "BSPWM" "1" "07/29/2013" "Bspwm 0\&.7" "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 \- Tiling window manager based on binary space partitioning
  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 have 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][\&.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              | (CYCLE_DIR|last|focused)[\&.occupied|\&.free][\&.urgent|\&.nonurgent]
 281 .fi
 282 .if n \{\
 283 .RE
 284 .\}
 285 .sp
 286 .it 1 an-trap
 287 .nr an-no-space-flag 1
 288 .nr an-break-flag 1
 289 .br
 290 .ps +1
 291 \fBPrimary Selectors\fR
 292 .RS 4
 293 .PP
 294 \fICYCLE_DIR\fR
 295 .RS 4
 296 Selects the desktop in the given direction relative to the active desktop\&.
 297 .RE
 298 .PP
 299 last
 300 .RS 4
 301 Selects the previously focused desktop\&.
 302 .RE
 303 .PP
 304 focused
 305 .RS 4
 306 Selects the currently focused desktop\&.
 307 .RE
 308 .RE
 309 .sp
 310 .it 1 an-trap
 311 .nr an-no-space-flag 1
 312 .nr an-break-flag 1
 313 .br
 314 .ps +1
 315 \fBModifiers\fR
 316 .RS 4
 317 .PP
 318 occupied
 319 .RS 4
 320 Only consider occupied desktops\&.
 321 .RE
 322 .PP
 323 free
 324 .RS 4
 325 Only consider free desktops\&.
 326 .RE
 327 .PP
 328 urgent
 329 .RS 4
 330 Only consider urgent desktops\&.
 331 .RE
 332 .PP
 333 nonurgent
 334 .RS 4
 335 Only consider nonurgent desktops\&.
 336 .RE
 337 .RE
 338 .SS "Monitor"
 339 .sp
 340 Select a monitor\&.
 341 .sp
 342 .if n \{\
 343 .RS 4
 344 .\}
 345 .nf
 346 MONITOR_SEL := <monitor_name>
 347              | (DIR|CYCLE_DIR|last|focused)[\&.occupied|\&.free]
 348 .fi
 349 .if n \{\
 350 .RE
 351 .\}
 352 .sp
 353 .it 1 an-trap
 354 .nr an-no-space-flag 1
 355 .nr an-break-flag 1
 356 .br
 357 .ps +1
 358 \fBPrimary Selectors\fR
 359 .RS 4
 360 .PP
 361 \fIDIR\fR
 362 .RS 4
 363 Selects the monitor in the given (spacial) direction relative to the active monitor\&.
 364 .RE
 365 .PP
 366 \fICYCLE_DIR\fR
 367 .RS 4
 368 Selects the monitor in the given (cyclic) direction relative to the active monitor\&.
 369 .RE
 370 .PP
 371 last
 372 .RS 4
 373 Selects the previously focused monitor\&.
 374 .RE
 375 .PP
 376 focused
 377 .RS 4
 378 Selects the currently focused monitor\&.
 379 .RE
 380 .RE
 381 .sp
 382 .it 1 an-trap
 383 .nr an-no-space-flag 1
 384 .nr an-break-flag 1
 385 .br
 386 .ps +1
 387 \fBModifiers\fR
 388 .RS 4
 389 .PP
 390 occupied
 391 .RS 4
 392 Only consider monitors where the focused desktop is occupied\&.
 393 .RE
 394 .PP
 395 free
 396 .RS 4
 397 Only consider monitors where the focused desktop is free\&.
 398 .RE
 399 .RE
 400 .SH "COMMANDS"
 401 .SS "Window"
 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 \fBGeneral Syntax\fR
 409 .RS 4
 410 .sp
 411 window [\fIWINDOW_SEL\fR] \fIOPTIONS\fR
 412 .RE
 413 .sp
 414 .it 1 an-trap
 415 .nr an-no-space-flag 1
 416 .nr an-break-flag 1
 417 .br
 418 .ps +1
 419 \fBOptions\fR
 420 .RS 4
 421 .PP
 422 \fB\-f\fR, \fB\-\-focus\fR [\fIWINDOW_SEL\fR]
 423 .RS 4
 424 Focus the selected or given window\&.
 425 .RE
 426 .PP
 427 \fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR
 428 .RS 4
 429 Send the selected window to the given desktop\&.
 430 .RE
 431 .PP
 432 \fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR
 433 .RS 4
 434 Send the selected window to the given monitor\&.
 435 .RE
 436 .PP
 437 \fB\-w\fR, \fB\-\-to\-window\fR \fIWINDOW_SEL\fR
 438 .RS 4
 439 Transplant the selected window to the given window\&.
 440 .RE
 441 .PP
 442 \fB\-s\fR, \fB\-\-swap\fR \fIWINDOW_SEL\fR
 443 .RS 4
 444 Swap the selected window with the given window\&.
 445 .RE
 446 .PP
 447 \fB\-p\fR, \fB\-\-presel\fR \fIDIR\fR|cancel
 448 .RS 4
 449 Preselect the splitting area of the selected window (or cancel the preselection)\&.
 450 .RE
 451 .PP
 452 \fB\-r\fR, \fB\-\-ratio\fR \fIRATIO\fR
 453 .RS 4
 454 Set the splitting ratio of the selected window (0 <
 455 \fIRATIO\fR
 456 < 1)\&.
 457 .RE
 458 .PP
 459 \fB\-e\fR, \fB\-\-edge\fR \fIDIR\fR \fIRATIO\fR|pull|push
 460 .RS 4
 461 Set the splitting ratio (or pull, or push) the edge located in the given direction in relation to the selected window\&.
 462 .RE
 463 .PP
 464 \fB\-t\fR, \fB\-\-toggle\fR floating|fullscreen|locked[=on|off]
 465 .RS 4
 466 Set or toggle the given state for the selected window\&.
 467 .RE
 468 .PP
 469 \fB\-c\fR, \fB\-\-close\fR
 470 .RS 4
 471 Close the selected window\&.
 472 .RE
 473 .PP
 474 \fB\-k\fR, \fB\-\-kill\fR
 475 .RS 4
 476 Kill the selected window\&.
 477 .RE
 478 .RE
 479 .SS "Desktop"
 480 .sp
 481 .it 1 an-trap
 482 .nr an-no-space-flag 1
 483 .nr an-break-flag 1
 484 .br
 485 .ps +1
 486 \fBGeneral Syntax\fR
 487 .RS 4
 488 .sp
 489 desktop [\fIDESKTOP_SEL\fR] \fIOPTIONS\fR
 490 .RE
 491 .sp
 492 .it 1 an-trap
 493 .nr an-no-space-flag 1
 494 .nr an-break-flag 1
 495 .br
 496 .ps +1
 497 \fBOptions\fR
 498 .RS 4
 499 .PP
 500 \fB\-f\fR, \fB\-\-focus\fR [\fIDESKTOP_SEL\fR]
 501 .RS 4
 502 Focus the selected or given desktop\&.
 503 .RE
 504 .PP
 505 \fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR
 506 .RS 4
 507 Send the selected desktop to the given monitor\&.
 508 .RE
 509 .PP
 510 \fB\-l\fR, \fB\-\-layout\fR \fICYCLE_DIR\fR|monocle|tiled
 511 .RS 4
 512 Set or cycle the layout of the selected desktop\&.
 513 .RE
 514 .PP
 515 \fB\-n\fR, \fB\-\-rename\fR <new_name>
 516 .RS 4
 517 Rename the selected desktop\&.
 518 .RE
 519 .PP
 520 \fB\-r\fR, \fB\-\-remove\fR
 521 .RS 4
 522 Remove the selected desktop\&.
 523 .RE
 524 .PP
 525 \fB\-c\fR, \fB\-\-cancel\-presel\fR
 526 .RS 4
 527 Cancel the preselection of all the windows of the selected desktop\&.
 528 .RE
 529 .PP
 530 \fB\-F\fR, \fB\-\-flip\fR \fIhorizontal|vertical\fR
 531 .RS 4
 532 Flip the tree of the selected desktop\&.
 533 .RE
 534 .PP
 535 \fB\-R\fR, \fB\-\-rotate\fR \fI90|270|180\fR
 536 .RS 4
 537 Rotate the tree of the selected desktop\&.
 538 .RE
 539 .PP
 540 \fB\-B\fR, \fB\-\-balance\fR
 541 .RS 4
 542 Adjust the split ratios of the tree of the selected desktop so that all windows occupy the same area\&.
 543 .RE
 544 .PP
 545 \fB\-C\fR, \fB\-\-circulate\fR forward|backward
 546 .RS 4
 547 Circulate the leaves of the tree of the selected desktop\&.
 548 .RE
 549 .RE
 550 .SS "Monitor"
 551 .sp
 552 .it 1 an-trap
 553 .nr an-no-space-flag 1
 554 .nr an-break-flag 1
 555 .br
 556 .ps +1
 557 \fBGeneral Syntax\fR
 558 .RS 4
 559 .sp
 560 monitor [\fIMONITOR_SEL\fR] \fIOPTIONS\fR
 561 .RE
 562 .sp
 563 .it 1 an-trap
 564 .nr an-no-space-flag 1
 565 .nr an-break-flag 1
 566 .br
 567 .ps +1
 568 \fBOptions\fR
 569 .RS 4
 570 .PP
 571 \fB\-f\fR, \fB\-\-focus\fR [\fIMONITOR_SEL\fR]
 572 .RS 4
 573 Focus the selected or given monitor\&.
 574 .RE
 575 .PP
 576 \fB\-a\fR, \fB\-\-add\-desktops\fR <name>\&...
 577 .RS 4
 578 Create desktops with the given names in the selected monitor\&.
 579 .RE
 580 .PP
 581 \fB\-r\fR, \fB\-\-remove\-desktops\fR <name>\&...
 582 .RS 4
 583 Remove desktops with the given names\&.
 584 .RE
 585 .PP
 586 \fB\-p\fR, \fB\-\-pad\fR <top> <right> <bottom> <left>
 587 .RS 4
 588 Set the padding of the selected monitor\&.
 589 .RE
 590 .PP
 591 \fB\-n\fR, \fB\-\-rename\fR <new_name>
 592 .RS 4
 593 Rename the selected monitor\&.
 594 .RE
 595 .RE
 596 .SS "Query"
 597 .sp
 598 .it 1 an-trap
 599 .nr an-no-space-flag 1
 600 .nr an-break-flag 1
 601 .br
 602 .ps +1
 603 \fBGeneral Syntax\fR
 604 .RS 4
 605 .sp
 606 query \fIOPTIONS\fR
 607 .RE
 608 .sp
 609 .it 1 an-trap
 610 .nr an-no-space-flag 1
 611 .nr an-break-flag 1
 612 .br
 613 .ps +1
 614 \fBOptions\fR
 615 .RS 4
 616 .PP
 617 \fB\-W\fR, \fB\-\-windows\fR
 618 .RS 4
 619 List matching windows\&.
 620 .RE
 621 .PP
 622 \fB\-D\fR, \fB\-\-desktops\fR
 623 .RS 4
 624 List matching desktops\&.
 625 .RE
 626 .PP
 627 \fB\-M\fR, \fB\-\-monitors\fR
 628 .RS 4
 629 List matching monitors\&.
 630 .RE
 631 .PP
 632 \fB\-T\fR, \fB\-\-tree\fR
 633 .RS 4
 634 Print tree rooted at query\&.
 635 .RE
 636 .PP
 637 \fB\-H\fR, \fB\-\-history\fR
 638 .RS 4
 639 Print the history as it relates to the query\&.
 640 .RE
 641 .PP
 642 [\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]]
 643 .RS 4
 644 Constrain matches to the selected monitor, desktop or window\&.
 645 .RE
 646 .RE
 647 .SS "Restore"
 648 .sp
 649 .it 1 an-trap
 650 .nr an-no-space-flag 1
 651 .nr an-break-flag 1
 652 .br
 653 .ps +1
 654 \fBGeneral Syntax\fR
 655 .RS 4
 656 .sp
 657 restore \fIOPTIONS\fR
 658 .RE
 659 .sp
 660 .it 1 an-trap
 661 .nr an-no-space-flag 1
 662 .nr an-break-flag 1
 663 .br
 664 .ps +1
 665 \fBOptions\fR
 666 .RS 4
 667 .PP
 668 \fB\-T\fR, \fB\-\-tree\fR <file_path>
 669 .RS 4
 670 Load the desktop trees from the given file\&.
 671 .RE
 672 .PP
 673 \fB\-H\fR, \fB\-\-history\fR <file_path>
 674 .RS 4
 675 Load the focus history from the given file\&.
 676 .RE
 677 .RE
 678 .SS "Control"
 679 .sp
 680 .it 1 an-trap
 681 .nr an-no-space-flag 1
 682 .nr an-break-flag 1
 683 .br
 684 .ps +1
 685 \fBGeneral Syntax\fR
 686 .RS 4
 687 .sp
 688 control \fIOPTIONS\fR
 689 .RE
 690 .sp
 691 .it 1 an-trap
 692 .nr an-no-space-flag 1
 693 .nr an-break-flag 1
 694 .br
 695 .ps +1
 696 \fBOptions\fR
 697 .RS 4
 698 .PP
 699 \fB\-\-adopt\-orphans\fR
 700 .RS 4
 701 Manage all the unmanaged windows remaining from a previous session\&.
 702 .RE
 703 .PP
 704 \fB\-\-put\-status\fR
 705 .RS 4
 706 Write the current internal state to the panel FIFO\&.
 707 .RE
 708 .PP
 709 \fB\-\-toggle\-visibility\fR
 710 .RS 4
 711 Toggle the visibility of all the managed windows\&.
 712 .RE
 713 .RE
 714 .SS "Pointer"
 715 .sp
 716 .it 1 an-trap
 717 .nr an-no-space-flag 1
 718 .nr an-break-flag 1
 719 .br
 720 .ps +1
 721 \fBGeneral Syntax\fR
 722 .RS 4
 723 .sp
 724 pointer \fIOPTIONS\fR
 725 .RE
 726 .sp
 727 .it 1 an-trap
 728 .nr an-no-space-flag 1
 729 .nr an-break-flag 1
 730 .br
 731 .ps +1
 732 \fBOptions\fR
 733 .RS 4
 734 .PP
 735 \fB\-t\fR, \fB\-\-track\fR <x> <y>
 736 .RS 4
 737 Pass the pointer root coordinates for the current pointer action\&.
 738 .RE
 739 .PP
 740 \fB\-g\fR, \fB\-\-grab\fR focus|move|resize_side|resize_corner
 741 .RS 4
 742 Perform the given pointer action\&.
 743 .RE
 744 .RE
 745 .SS "Rule"
 746 .sp
 747 .it 1 an-trap
 748 .nr an-no-space-flag 1
 749 .nr an-break-flag 1
 750 .br
 751 .ps +1
 752 \fBGeneral Syntax\fR
 753 .RS 4
 754 .sp
 755 rule \fIOPTIONS\fR
 756 .RE
 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 \fBOptions\fR
 764 .RS 4
 765 .PP
 766 \fB\-a\fR, \fB\-\-add\fR <pattern> [\-d \fIDESKTOP_SEL\fR [\-\-follow]] [\-\-floating]
 767 .RS 4
 768 Create a new rule (<pattern> must match the class or instance name)\&.
 769 .RE
 770 .PP
 771 \fB\-r\fR, \fB\-\-rm\fR <rule_uid>\&...
 772 .RS 4
 773 Remove the rules with the given UIDs\&.
 774 .RE
 775 .PP
 776 \fB\-l\fR, \fB\-\-list\fR [<pattern>]
 777 .RS 4
 778 List the rules\&.
 779 .RE
 780 .RE
 781 .SS "Config"
 782 .sp
 783 .it 1 an-trap
 784 .nr an-no-space-flag 1
 785 .nr an-break-flag 1
 786 .br
 787 .ps +1
 788 \fBGeneral Syntax\fR
 789 .RS 4
 790 .PP
 791 config <key> [<value>]
 792 .RS 4
 793 Get or set the value of <key>\&.
 794 .RE
 795 .RE
 796 .SS "Quit"
 797 .sp
 798 .it 1 an-trap
 799 .nr an-no-space-flag 1
 800 .nr an-break-flag 1
 801 .br
 802 .ps +1
 803 \fBGeneral Syntax\fR
 804 .RS 4
 805 .PP
 806 quit [<status>]
 807 .RS 4
 808 Quit with an optional exit status\&.
 809 .RE
 810 .RE
 811 .SH "SETTINGS"
 812 .sp
 813 Colors are either X color names or \fI#RRGGBB\fR, booleans are \fItrue\fR or \fIfalse\fR\&.
 814 .sp
 815 All the boolean settings are \fIfalse\fR by default\&.
 816 .PP
 817 \fIfocused_border_color\fR
 818 .RS 4
 819 Color of the border of a focused window of a focused monitor\&.
 820 .RE
 821 .PP
 822 \fIactive_border_color\fR
 823 .RS 4
 824 Color of the border of a focused window of an unfocused monitor\&.
 825 .RE
 826 .PP
 827 \fInormal_border_color\fR
 828 .RS 4
 829 Color of the border of an unfocused window\&.
 830 .RE
 831 .PP
 832 \fIpresel_border_color\fR
 833 .RS 4
 834 Color of the
 835 \fBpresel\fR
 836 message feedback\&.
 837 .RE
 838 .PP
 839 \fIfocused_locked_border_color\fR
 840 .RS 4
 841 Color of the border of a focused locked window of a focused monitor\&.
 842 .RE
 843 .PP
 844 \fIactive_locked_border_color\fR
 845 .RS 4
 846 Color of the border of a focused locked window of an unfocused monitor\&.
 847 .RE
 848 .PP
 849 \fInormal_locked_border_color\fR
 850 .RS 4
 851 Color of the border of an unfocused locked window\&.
 852 .RE
 853 .PP
 854 \fIurgent_border_color\fR
 855 .RS 4
 856 Color of the border of an urgent window\&.
 857 .RE
 858 .PP
 859 \fIborder_width\fR
 860 .RS 4
 861 Window border width\&.
 862 .RE
 863 .PP
 864 \fIwindow_gap\fR
 865 .RS 4
 866 Value of the gap that separates windows\&.
 867 .RE
 868 .PP
 869 \fIsplit_ratio\fR
 870 .RS 4
 871 Default split ratio\&.
 872 .RE
 873 .PP
 874 \fIwm_name\fR
 875 .RS 4
 876 The value that shall be used for the
 877 \fI_NET_WM_NAME\fR
 878 property of the root window\&.
 879 .RE
 880 .PP
 881 \fIborderless_monocle\fR
 882 .RS 4
 883 Remove borders for tiled windows in monocle mode\&.
 884 .RE
 885 .PP
 886 \fIgapless_monocle\fR
 887 .RS 4
 888 Remove gaps for tiled windows in monocle mode\&.
 889 .RE
 890 .PP
 891 \fIfocus_follows_pointer\fR
 892 .RS 4
 893 Focus the window under the pointer\&.
 894 .RE
 895 .PP
 896 \fIpointer_follows_monitor\fR
 897 .RS 4
 898 When focusing a monitor, put the pointer at its center\&.
 899 .RE
 900 .PP
 901 \fIadaptative_raise\fR
 902 .RS 4
 903 Prevent floating windows from being raised when they might cover other floating windows\&.
 904 .RE
 905 .PP
 906 \fIapply_shadow_property\fR
 907 .RS 4
 908 Enable shadows for floating windows via the
 909 \fI_COMPTON_SHADOW\fR
 910 property\&.
 911 .RE
 912 .PP
 913 \fIauto_alternate\fR
 914 .RS 4
 915 Interpret two consecutive identical
 916 \fBuse\fR
 917 messages as an
 918 \fBalternate\fR
 919 message\&.
 920 .RE
 921 .PP
 922 \fIauto_cancel\fR
 923 .RS 4
 924 Interpret two consecutive identical
 925 \fBpresel\fR
 926 messages as a
 927 \fBcancel\fR
 928 message\&.
 929 .RE
 930 .PP
 931 \fIhistory_aware_focus\fR
 932 .RS 4
 933 Give priority to the focus history when focusing nodes\&.
 934 .RE
 935 .SH "ENVIRONMENT VARIABLES"
 936 .PP
 937 \fIBSPWM_SOCKET\fR
 938 .RS 4
 939 The path of the socket used for the communication between
 940 \fBbspc\fR
 941 and
 942 \fBbspwm\fR\&.
 943 .RE
 944 .SH "PANELS"
 945 .sp
 946 .RS 4
 947 .ie n \{\
 948 \h'-04'\(bu\h'+03'\c
 949 .\}
 950 .el \{\
 951 .sp -1
 952 .IP \(bu 2.3
 953 .\}
 954 Any EWMH compliant panel (e\&.g\&.:
 955 \fItint2\fR,
 956 \fIbmpanel2\fR, etc\&.)\&.
 957 .RE
 958 .sp
 959 .RS 4
 960 .ie n \{\
 961 \h'-04'\(bu\h'+03'\c
 962 .\}
 963 .el \{\
 964 .sp -1
 965 .IP \(bu 2.3
 966 .\}
 967 A custom panel if the
 968 \fI\-s\fR
 969 flag is used (have a look at the files in
 970 \fIexamples/panel\fR)\&.
 971 .RE
 972 .SH "KEY FEATURES"
 973 .sp
 974 .RS 4
 975 .ie n \{\
 976 \h'-04'\(bu\h'+03'\c
 977 .\}
 978 .el \{\
 979 .sp -1
 980 .IP \(bu 2.3
 981 .\}
 982 Configured and controlled through messages\&.
 983 .RE
 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 Multiple monitors support (via
 994 \fIRandR\fR)\&.
 995 .RE
 996 .sp
 997 .RS 4
 998 .ie n \{\
 999 \h'-04'\(bu\h'+03'\c
1000 .\}
1001 .el \{\
1002 .sp -1
1003 .IP \(bu 2.3
1004 .\}
1005 EWMH support (\fBtint2\fR
1006 works)\&.
1007 .RE
1008 .sp
1009 .RS 4
1010 .ie n \{\
1011 \h'-04'\(bu\h'+03'\c
1012 .\}
1013 .el \{\
1014 .sp -1
1015 .IP \(bu 2.3
1016 .\}
1017 Hybrid tiling\&.
1018 .RE
1019 .SH "CONTRIBUTORS"
1020 .sp
1021 .RS 4
1022 .ie n \{\
1023 \h'-04'\(bu\h'+03'\c
1024 .\}
1025 .el \{\
1026 .sp -1
1027 .IP \(bu 2.3
1028 .\}
1029 Steven Allen <steven at stebalien\&.com>
1030 .RE
1031 .sp
1032 .RS 4
1033 .ie n \{\
1034 \h'-04'\(bu\h'+03'\c
1035 .\}
1036 .el \{\
1037 .sp -1
1038 .IP \(bu 2.3
1039 .\}
1040 Thomas Adam <thomas at xteddy\&.org>
1041 .RE
1042 .sp
1043 .RS 4
1044 .ie n \{\
1045 \h'-04'\(bu\h'+03'\c
1046 .\}
1047 .el \{\
1048 .sp -1
1049 .IP \(bu 2.3
1050 .\}
1051 Ivan Kanakarakis <ivan\&.kanak at gmail\&.com>
1052 .RE
1053 .SH "AUTHOR"
1054 .sp
1055 Bastien Dejean <baskerville at lavabit\&.com>
1056 .SH "MAILING LIST"
1057 .sp
1058 bspwm at librelist\&.com