spectrwm.1

   1 .\" Copyright (c) 2009 Marco Peereboom <marco@peereboom.us>
   2 .\" Copyright (c) 2009 Darrin Chandler <dwchandler@stilyagin.com>
   3 .\"
   4 .\" Permission to use, copy, modify, and distribute this software for any
   5 .\" purpose with or without fee is hereby granted, provided that the above
   6 .\" copyright notice and this permission notice appear in all copies.
   7 .\"
   8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15 .\"
  16 .Dd $Mdocdate: February 15 2012 $
  17 .Dt SPECTRWM 1
  18 .Os
  19 .Sh NAME
  20 .Nm spectrwm
  21 .Nd window manager for X11
  22 .Sh SYNOPSIS
  23 .Nm spectrwm
  24 .Sh DESCRIPTION
  25 .Nm
  26 is a minimalistic window manager that tries to stay out of the way so that
  27 valuable screen real estate can be used for much more important stuff.
  28 It has sane defaults and does not require one to learn a language to do any
  29 configuration.
  30 It was written by hackers for hackers and it strives to be small, compact and
  31 fast.
  32 .Pp
  33 When
  34 .Nm
  35 starts up, it reads settings from its configuration file,
  36 .Pa spectrwm.conf .
  37 See the
  38 .Sx CONFIGURATION FILES
  39 section below.
  40 .Pp
  41 The following notation is used throughout this page:
  42 .Pp
  43 .Bl -tag -width Ds -offset indent -compact
  44 .It Cm M
  45 Meta
  46 .It Cm S
  47 Shift
  48 .It Aq Cm Name
  49 Named key
  50 .It Cm M1
  51 Mouse button 1
  52 .It Cm M3
  53 Mouse button 3
  54 .El
  55 .Pp
  56 .Nm
  57 is very simple in its use.
  58 Most of the actions are initiated via key or mouse bindings.
  59 See the
  60 .Sx BINDINGS
  61 section below for defaults and customizations.
  62 .Sh CONFIGURATION FILES
  63 .Nm
  64 first tries to open the user specific file,
  65 .Pa ~/.spectrwm.conf .
  66 If that file is unavailable,
  67 it then tries to open the global configuration file
  68 .Pa /etc/spectrwm.conf .
  69 .Pp
  70 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
  71 For example:
  72 .Pp
  73 .Dl color_focus = red
  74 .Pp
  75 Enabling or disabling an option is done by using 1 or 0 respectively.
  76 .Pp
  77 The file supports the following keywords:
  78 .Bl -tag -width 2m
  79 .It Ic autorun
  80 Launch an application in a specified workspace at start-of-day.
  81 Defined in the format ws[<idx>]:application, e.g. ws[2]:xterm launches an
  82 xterm in workspace 2.
  83 .It Ic bar_action
  84 External script that populates additional information in the status bar,
  85 such as battery life.
  86 .It Ic bar_at_bottom
  87 Place the statusbar at the bottom of each region instead of the top.
  88 .It Ic bar_border Ns Bq Ar x
  89 Color of the status bar border in screen
  90 .Ar x .
  91 .It Ic bar_border_width
  92 Set status bar border thickness in pixels.
  93 Disable border by setting to 0.
  94 .It Ic bar_color Ns Bq Ar x
  95 Color of the status bar window in screen
  96 .Ar x .
  97 .It Ic bar_delay
  98 Update frequency, in seconds, of external script that populates the status bar.
  99 .It Ic bar_enabled
 100 Enable or disable status bar.
 101 .It Ic bar_font
 102 Status bar font.
 103 .It Ic bar_font_color Ns Bq Ar x
 104 Color of the font in status bar in screen
 105 .Ar x .
 106 .It Ic bar_justify
 107 Justify the status bar text. Possible values are
 108 .Pa left ,
 109 .Pa center ,
 110 and
 111 .Pa right .
 112 .It Ic bind Ns Bq Ar x
 113 Bind key combo to action
 114 .Ar x .
 115 See the
 116 .Sx BINDINGS
 117 section below.
 118 .It Ic border_width
 119 Set window border thickness in pixels.
 120 Disable all borders by setting to 0.
 121 .It Ic clock_enabled
 122 Enable or disable displaying the clock in the status bar.
 123 Disable by setting to 0
 124 so a custom clock could be used in the
 125 .Pa bar_action
 126 script.
 127 .It Ic color_focus
 128 Border color of the currently focussed window.
 129 .It Ic color_unfocus
 130 Border color of unfocussed windows.
 131 .It Ic dialog_ratio
 132 Some applications have dialogue windows that are too small to be useful.
 133 This ratio is the screen size to what they will be resized.
 134 For example, 0.6 is 60% of the physical screen size.
 135 .It Ic disable_border
 136 Remove border when bar is disabled and there is only one window on the screen.
 137 .It Ic focus_mode
 138 Using a value of
 139 .Pa follow_cursor
 140 will make the window manager focus the window
 141 under the mouse when switching workspaces and creating windows.
 142 .It Ic keyboard_mapping
 143 Clear all key bindings and load new key bindings from the specified file.
 144 This allows you to load pre-defined key bindings for your keyboard layout.
 145 See the
 146 .Sx KEYBOARD MAPPING FILES
 147 section below for a list of keyboard mapping files that have been provided
 148 for several keyboard layouts.
 149 .It Ic layout
 150 Select layout to use at start-of-day.
 151 Defined in the format
 152 ws[idx]:master_grow:master_add:stack_inc:layout:always_raise:stack_mode, e.g.
 153 ws[2]:-4:0:1:0:horizontal sets worskspace 2 to the horizontal stack mode and
 154 shrinks the master area by 4 ticks and adds one window to the stack, while
 155 maintaining default floating window behavior.
 156 Possible stack_mode values are
 157 .Pa vertical ,
 158 .Pa horizontal
 159 and
 160 .Pa fullscreen .
 161 .Pp
 162 See
 163 .Pa master_grow ,
 164 .Pa master_shrink ,
 165 .Pa master_add ,
 166 .Pa master_del ,
 167 .Pa stack_inc ,
 168 .Pa stack_dec ,
 169 and
 170 .Pa always_raise
 171 for more information.
 172 Note that the stacking options are complicated and have side-effects.
 173 One should familiarize oneself with these commands before experimenting with the
 174 .Pa layout
 175 option.
 176 .Pp
 177 This setting is not retained at restart.
 178 .It Ic modkey
 179 Change mod key.
 180 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
 181 .It Ic program Ns Bq Ar p
 182 Define new action to spawn a program
 183 .Ar p .
 184 See the
 185 .Sx PROGRAMS
 186 section below.
 187 .It Ic quirk Ns Bq Ar c:n
 188 Add "quirk" for windows with class
 189 .Ar c
 190 and name
 191 .Ar n .
 192 See the
 193 .Sx QUIRKS
 194 section below.
 195 .It Ic region
 196 Allocates a custom region, removing any autodetected regions which occupy the same
 197 space on the screen.
 198 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y,
 199 e.g.\& screen[1]:800x1200+0+0.
 200 .Pp
 201 To make a screen span multiple monitors, create a region big enough to cover
 202 them all, e.g. screen[1]:2048x768+0+0 makes the screen span two monitors with
 203 1024x768 resolution sitting one next to the other.
 204 .It Ic stack_enabled
 205 Enable or disable displaying the current stacking algorithm in the status bar.
 206 .It Ic term_width
 207 Set a preferred minimum width for the terminal.
 208 If this value is greater than 0,
 209 .Nm
 210 will attempt to adjust the font sizes in the terminal to keep the terminal
 211 width above this number as the window is resized.
 212 Only
 213 .Xr xterm 1
 214 is currently supported.
 215 The
 216 .Xr xterm 1
 217 binary must not be setuid or setgid, which it is by default on most systems.
 218 Users may need to set program[term] (see the
 219 .Sx PROGRAMS
 220 section) to use an alternate copy of the
 221 .Xr xterm 1
 222 binary without the setgid bit set.
 223 .It Ic title_class_enabled
 224 Enable or disable displaying the window class in the status bar.
 225 Enable by setting to 1.
 226 .It Ic title_name_enabled
 227 Enable or disable displaying the window title in the status bar.
 228 Enable by setting to 1.
 229 .It Ic urgent_enabled
 230 Enable or disable the urgency hint.
 231 Note that many terminal emulators require this to be enabled for it to
 232 propagate.
 233 In xterm, for example, one needs to add the following line
 234 .Pa xterm.urgentOnBell: true
 235 to
 236 .Pa .Xdefaults .
 237 .It Ic verbose_layout
 238 Enable or disable displaying the current master and stack values in the status
 239 bar.
 240 Enable by setting to 1.
 241 .It Ic window_name_enabled
 242 Enable or disable displaying the window name in the status bar.
 243 Enable by setting to 1.
 244 .It Ic workspace_limit
 245 Set the total number of workspaces available.  Minimum is 1, maximum is 22.
 246 .El
 247 .Pp
 248 Colors need to be specified per the
 249 .Xr XQueryColor 3
 250 specification and fonts need to be specified per the
 251 .Xr XQueryFont 3
 252 specification.
 253 .Pp
 254 To list the available fonts in your system see
 255 .Xr fc-list 1
 256 or
 257 .Xr xlsfonts 1
 258 manpages.
 259 The
 260 .Xr xfontsel 1
 261 application can help you to show the X Logical Font Description ("XLFD") used
 262 as setting in the keyword
 263 .Pa bar_font .
 264 .Sh PROGRAMS
 265 .Nm
 266 allows you to define custom actions to launch programs of your choice and then
 267 bind them the same as with built-in actions.
 268 See the
 269 .Sx BINDINGS
 270 section below.
 271 .Pp
 272 The default programs are described below:
 273 .Pp
 274 .Bl -tag -width "screenshot_wind" -offset indent -compact
 275 .It Cm term
 276 xterm
 277 .It Cm screenshot_all
 278 screenshot.sh full
 279 .It Cm screenshot_wind
 280 screenshot.sh window
 281 .It Cm lock
 282 xlock
 283 .It Cm initscr
 284 initscreen.sh
 285 .It Cm menu
 286 dmenu_run \-fn $bar_font \-nb $bar_color \-nf $bar_font_color \-sb $bar_border \-sf $bar_color
 287 .El
 288 .Pp
 289 Custom programs in the configuration file are specified as follows:
 290 .Pp
 291 .Dl program[<name>] = <progpath> [<arg> [... <arg>]]
 292 .Pp
 293 .Aq name
 294 is any identifier that does not conflict with a built-in action or keyword,
 295 .Aq progpath
 296 is the desired program, and
 297 .Aq arg
 298 is zero or more arguments to the program.
 299 .Pp
 300 The following variables represent settable values in
 301 .Nm
 302 (see the
 303 .Sx CONFIGURATION FILES
 304 section above),
 305 and may be used in the
 306 .Aq arg
 307 fields and will be substituted for values at the time the program is spawned:
 308 .Pp
 309 .Bl -tag -width "$bar_font_color" -offset indent -compact
 310 .It Cm $bar_border
 311 .It Cm $bar_color
 312 .It Cm $bar_font
 313 .It Cm $bar_font_color
 314 .It Cm $color_focus
 315 .It Cm $color_unfocus
 316 .El
 317 .Pp
 318 Example:
 319 .Bd -literal -offset indent
 320 program[ff] = /usr/local/bin/firefox http://spectrwm.org/
 321 bind[ff] = Mod+Shift+b # Now Mod+Shift+B launches firefox
 322 .Ed
 323 .Pp
 324 To undo the previous:
 325 .Bd -literal -offset indent
 326 bind[] = Mod+Shift+b
 327 program[ff] =
 328 .Ed
 329 .Sh BINDINGS
 330 .Nm
 331 provides many functions (or actions) accessed via key or mouse bindings.
 332 .Pp
 333 The current mouse bindings are described below:
 334 .Pp
 335 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
 336 .It Cm M1
 337 Focus window
 338 .It Cm M-M1
 339 Move window
 340 .It Cm M-M3
 341 Resize window
 342 .It Cm M-S-M3
 343 Resize window while maintaining it centered
 344 .El
 345 .Pp
 346 The default key bindings are described below:
 347 .Pp
 348 .Bl -tag -width "M-j, M-<TAB>XXXXXX" -offset indent -compact
 349 .It Cm M-S- Ns Aq Cm Return
 350 term
 351 .It Cm M-p
 352 menu
 353 .It Cm M-S-q
 354 quit
 355 .It Cm M-q
 356 restart
 357 .It Cm M- Ns Aq Cm Space
 358 cycle_layout
 359 .It Cm M-S- Ns Aq Cm \e
 360 flip_layout
 361 .It Cm M-S- Ns Aq Cm Space
 362 stack_reset
 363 .It Cm M-h
 364 master_shrink
 365 .It Cm M-l
 366 master_grow
 367 .It Cm M-,
 368 master_add
 369 .It Cm M-.
 370 master_del
 371 .It Cm M-S-,
 372 stack_inc
 373 .It Cm M-S-.
 374 stack_dec
 375 .It Cm M- Ns Aq Cm Return
 376 swap_main
 377 .It Xo
 378 .Cm M-j ,
 379 .Cm M- Ns Aq Cm TAB
 380 .Xc
 381 focus_next
 382 .It Xo
 383 .Cm M-k ,
 384 .Cm M-S- Ns Aq Cm TAB
 385 .Xc
 386 focus_prev
 387 .It Cm M-m
 388 focus_main
 389 .It Cm M-S-j
 390 swap_next
 391 .It Cm M-S-k
 392 swap_prev
 393 .It Cm M-b
 394 bar_toggle
 395 .It Cm M-x
 396 wind_del
 397 .It Cm M-S-x
 398 wind_kill
 399 .It Cm M- Ns Aq Ar 1-9,0,F1-F12
 400 .Pf ws_ Aq Ar 1-22
 401 .It Cm M-S- Ns Aq Ar 1-9,0,F1-F12
 402 .Pf mvws_ Ns Aq Ar 1-22
 403 .It Cm M- Ns Aq Cm Right
 404 ws_next
 405 .It Cm M- Ns Aq Cm Left
 406 ws_prev
 407 .It Cm M- Ns Aq Cm Up
 408 ws_next_all
 409 .It Cm M- Ns Aq Cm Down
 410 ws_prev_all
 411 .It Cm M-a
 412 ws_prior
 413 .It Cm M-S- Ns Aq Cm Right
 414 screen_next
 415 .It Cm M-S- Ns Aq Cm Left
 416 screen_prev
 417 .It Cm M-s
 418 screenshot_all
 419 .It Cm M-S-s
 420 screenshot_wind
 421 .It Cm M-S-v
 422 version
 423 .It Cm M-t
 424 float_toggle
 425 .It Cm M-S- Ns Aq Cm Delete
 426 lock
 427 .It Cm M-S-i
 428 initscr
 429 .It Cm M-w
 430 iconify
 431 .It Cm M-S-w
 432 uniconify
 433 .It Cm M-S-r
 434 always_raise
 435 .It Cm M-v
 436 button2
 437 .It Cm M--
 438 width_shrink
 439 .It Cm M-=
 440 width_grow
 441 .It Cm M-S--
 442 height_shrink
 443 .It Cm M-S-=
 444 height_grow
 445 .It Cm M-[
 446 move_left
 447 .It Cm M-]
 448 move_right
 449 .It Cm M-S-[
 450 move_up
 451 .It Cm M-S-]
 452 move_down
 453 .It Cm M-S-/
 454 name_workspace
 455 .It Cm M-/
 456 search_workspace
 457 .It Cm M-f
 458 search_win
 459 .El
 460 .Pp
 461 The action names and descriptions are listed below:
 462 .Pp
 463 .Bl -tag -width "M-j, M-<TAB>XXXX" -offset indent -compact
 464 .It Cm term
 465 Spawn a new terminal
 466 (see
 467 .Sx PROGRAMS
 468 above).
 469 .It Cm menu
 470 Menu
 471 (see
 472 .Sx PROGRAMS
 473 above).
 474 .It Cm quit
 475 Quit
 476 .Nm .
 477 .It Cm restart
 478 Restart
 479 .Nm .
 480 .It Cm cycle_layout
 481 Cycle layout.
 482 .It Cm flip_layout
 483 Swap the master and stacking areas.
 484 .It Cm stack_reset
 485 Reset layout.
 486 .It Cm master_shrink
 487 Shrink master area.
 488 .It Cm master_grow
 489 Grow master area.
 490 .It Cm master_add
 491 Add windows to master area.
 492 .It Cm master_del
 493 Remove windows from master area.
 494 .It Cm stack_inc
 495 Add columns/rows to stacking area.
 496 .It Cm stack_dec
 497 Remove columns/rows from stacking area.
 498 .It Cm swap_main
 499 Move current window to master area.
 500 .It Cm focus_next
 501 Focus next window in workspace.
 502 .It Cm focus_prev
 503 Focus previous window in workspace.
 504 .It Cm focus_main
 505 Focus on main window in workspace.
 506 .It Cm swap_next
 507 Swap with next window in workspace.
 508 .It Cm swap_prev
 509 Swap with previous window in workspace.
 510 .It Cm bar_toggle
 511 Toggle status bar in all workspaces.
 512 .It Cm wind_del
 513 Delete current window in workspace.
 514 .It Cm wind_kill
 515 Destroy current window in workspace.
 516 .It Cm ws_ Ns Ar n
 517 Switch to workspace
 518 .Ar n ,
 519 where
 520 .Ar n
 521 is 1 through workspace_limit.
 522 .It Cm mvws_ Ns Ar n
 523 Move current window to workspace
 524 .Ar n ,
 525 where
 526 .Ar n
 527 is 1 through workspace_limit.
 528 .It Cm ws_next
 529 Switch to next workspace with a window in it.
 530 .It Cm ws_prev
 531 Switch to previous workspace with a window in it.
 532 .It Cm ws_next_all
 533 Switch to next workspace.
 534 .It Cm ws_prev_all
 535 Switch to previous workspace.
 536 .It Cm ws_prior
 537 Switch to last visited workspace.
 538 .It Cm screen_next
 539 Move pointer to next region.
 540 .It Cm screen_prev
 541 Move pointer to previous region.
 542 .It Cm screenshot_all
 543 Take screenshot of entire screen (if enabled)
 544 (see
 545 .Sx PROGRAMS
 546 above).
 547 .It Cm screenshot_wind
 548 Take screenshot of selected window (if enabled)
 549 (see
 550 .Sx PROGRAMS
 551 above).
 552 .It Cm version
 553 Toggle version in status bar.
 554 .It Cm float_toggle
 555 Toggle focused window between tiled and floating.
 556 .It Cm lock
 557 Lock screen
 558 (see
 559 .Sx PROGRAMS
 560 above).
 561 .It Cm initscr
 562 Reinitialize physical screens
 563 (see
 564 .Sx PROGRAMS
 565 above).
 566 .It Cm iconify
 567 Minimize (unmap) currently focused window.
 568 .It Cm uniconify
 569 Maximize (map) window returned by dmenu selection.
 570 .It Cm always_raise
 571 When set tiled windows are allowed to obscure floating windows.
 572 .It Cm button2
 573 Fake a middle mouse button click (mouse button 2).
 574 .It Cm width_shrink
 575 Shrink the width of a floating window.
 576 .It Cm width_grow
 577 Grow the width of a floating window.
 578 .It Cm height_shrink
 579 Shrink the height of a floating window.
 580 .It Cm height_grow
 581 Grow the height of a floating window.
 582 .It Cm move_left
 583 Move a floating window a step to the left.
 584 .It Cm move_right
 585 Move a floating window a step to the right.
 586 .It Cm move_up
 587 Move a floating window a step upwards.
 588 .It Cm move_down
 589 Move a floating window a step downwards.
 590 .It Cm name_workspace
 591 Name the current workspace.
 592 .It Cm search_workspace
 593 Search for a workspace.
 594 .It Cm search_win
 595 Search the windows in the current workspace.
 596 .El
 597 .Pp
 598 Custom bindings in the configuration file are specified as follows:
 599 .Pp
 600 .Dl bind[<action>] = <keys>
 601 .Pp
 602 .Aq action
 603 is one of the actions listed above (or empty) and
 604 .Aq keys
 605 is in the form of zero or more modifier keys
 606 (MOD, Mod1, Shift, etc.) and one or more normal keys
 607 (b, space, etc.), separated by "+".
 608 For example:
 609 .Bd -literal -offset indent
 610 bind[reset] = Mod4+q # bind Windows-key + q to reset
 611 bind[] = Mod1+q # unbind Alt + q
 612 .Ed
 613 .Pp
 614 To use the currently defined
 615 .Ic modkey ,
 616 specify MOD as the modifier key.
 617 .Pp
 618 Multiple key combinations may be bound to the same action.
 619 .Pp
 620 To bind non-latin characters such as å or π you must enter the xkb
 621 character name instead of the character itself. Run xev, focus the window
 622 and press the specific key and in the terminal output read the symbol name.
 623 In the fallowing example for å:
 624 .Bd -literal -offset indent
 625 KeyPress event, serial 41, synthetic NO, window 0x2600001,
 626     root 0x15a, subw 0x0, time 106213808, (11,5), root:(359,823),
 627     state 0x0, keycode 24 (keysym 0xe5, aring), same_screen YES,
 628     XLookupString gives 2 bytes: (c3 a5) "å"
 629     XmbLookupString gives 2 bytes: (c3 a5) "å"
 630     XFilterEvent returns: False
 631 .Ed
 632 .Pp
 633 The xkb name is aring. In other words, in .spectrwm.conf add:
 634 .Bd -literal -offset indent
 635 bind[program] = MOD+aring
 636 .Ed
 637 .Sh KEYBOARD MAPPING FILES
 638 Keyboard mapping files for several keyboard layouts are listed
 639 below.
 640 These files can be used with the
 641 .Pa keyboard_mapping
 642 setting to load pre-defined key bindings for the specified
 643 keyboard layout.
 644 .Pp
 645 .Bl -tag -width "spectrwm_XX.confXXX" -offset indent -compact
 646 .It Cm spectrwm_cz.conf
 647 Czech Republic keyboard layout
 648 .It Cm spectrwm_es.conf
 649 Spanish keyboard layout
 650 .It Cm spectrwm_fr.conf
 651 French keyboard layout
 652 .It Cm spectrwm_fr_ch.conf
 653 Swiss French keyboard layout
 654 .It Cm spectrwm_se.conf
 655 Swedish keyboard layout
 656 .It Cm spectrwm_us.conf
 657 United States keyboard layout
 658 .El
 659 .Sh QUIRKS
 660 .Nm
 661 provides "quirks" which handle windows that must be treated specially
 662 in a tiling window manager, such as some dialogs and fullscreen apps.
 663 .Pp
 664 The default quirks are described below:
 665 .Pp
 666 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
 667 .It Firefox\-bin:firefox\-bin
 668 TRANSSZ
 669 .It Firefox:Dialog
 670 FLOAT
 671 .It Gimp:gimp
 672 FLOAT + ANYWHERE
 673 .It MPlayer:xv
 674 FLOAT + FULLSCREEN + FOCUSPREV
 675 .It OpenOffice.org 2.4:VCLSalFrame
 676 FLOAT
 677 .It OpenOffice.org 3.1:VCLSalFrame
 678 FLOAT
 679 .It pcb:pcb
 680 FLOAT
 681 .It xine:Xine Window
 682 FLOAT + ANYWHERE
 683 .It xine:xine Panel
 684 FLOAT + ANYWHERE
 685 .It xine:xine Video Fullscreen Window
 686 FULLSCREEN + FLOAT
 687 .It Xitk:Xitk Combo
 688 FLOAT + ANYWHERE
 689 .It Xitk:Xine Window
 690 FLOAT + ANYWHERE
 691 .It XTerm:xterm
 692 XTERM_FONTADJ
 693 .El
 694 .Pp
 695 The quirks themselves are described below:
 696 .Pp
 697 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
 698 .It FLOAT
 699 This window should not be tiled, but allowed to float freely.
 700 .It TRANSSZ
 701 Adjusts size on transient windows that are too small using dialog_ratio
 702 (see
 703 .Sx CONFIGURATION FILES ) .
 704 .It ANYWHERE
 705 Allow window to position itself, uncentered.
 706 .It XTERM_FONTADJ
 707 Adjust xterm fonts when resizing.
 708 .It FULLSCREEN
 709 Remove border to allow window to use full screen size.
 710 .It FOCUSPREV
 711 On exit force focus on previously focused application not previous application
 712 in the stack.
 713 .El
 714 .Pp
 715 Custom quirks in the configuration file are specified as follows:
 716 .Pp
 717 .Dl quirk[<class>:<name>] = <quirk> [ + <quirk> ... ]
 718 .Pp
 719 .Aq class
 720 and
 721 .Aq name
 722 specify the window to which the quirk(s) apply, and
 723 .Aq quirk
 724 is one of the quirks from the list above.
 725 For example:
 726 .Bd -literal -offset indent
 727 quirk[MPlayer:xv] = FLOAT + FULLSCREEN + FOCUSPREV
 728 quirk[pcb:pcb] = NONE  # remove existing quirk
 729 .Ed
 730 .Pp
 731 You can obtain
 732 .Aq class
 733 and
 734 .Aq name
 735 by running
 736 .Xr xprop 1
 737 and then clicking on the desired window.
 738 In the following example the main window of Firefox was clicked:
 739 .Bd -literal -offset indent
 740 $ xprop | grep WM_CLASS
 741 WM_CLASS(STRING) = "Navigator", "Firefox"
 742 .Ed
 743 .Pp
 744 Note that grepping for WM_CLASS flips class and name.
 745 In the example above the quirk entry would be:
 746 .Bd -literal -offset indent
 747 quirk[Firefox:Navigator] = FLOAT
 748 .Ed
 749 .Pp
 750 .Nm
 751 also automatically assigns quirks to windows based on the value
 752 of the window's _NET_WM_WINDOW_TYPE property as follows:
 753 .Pp
 754 .Bl -tag -width "_NET_WM_WINDOW_TYPE_TOOLBAR<TAB>XXX" -offset indent -compact
 755 .It _NET_WM_WINDOW_TYPE_DOCK
 756 FLOAT + ANYWHERE
 757 .It _NET_WM_WINDOW_TYPE_TOOLBAR
 758 FLOAT + ANYWHERE
 759 .It _NET_WM_WINDOW_TYPE_UTILITY
 760 FLOAT + ANYWHERE
 761 .It _NET_WM_WINDOW_TYPE_SPLASH
 762 FLOAT
 763 .It _NET_WM_WINDOW_TYPE_DIALOG
 764 FLOAT
 765 .El
 766 .Pp
 767 In all other cases, no automatic quirks are assigned to the window.
 768 Quirks specified in the configuration file override the automatic quirks.
 769 .Sh EWMH
 770 .Nm
 771 partially implements the Extended Window Manager Hints (EWMH) specification.
 772 This enables controlling windows as well as
 773 .Nm
 774 itself from external scripts and programs.
 775 This is achieved by
 776 .Nm
 777 responding to certain ClientMessage events.
 778 From the terminal these events
 779 can be conveniently sent using tools such as
 780 .Xr wmctrl 1
 781 and
 782 .Xr xdotool 1 .
 783 For the
 784 actual format of these ClientMessage events, see the EWMH specification.
 785 .Pp
 786 The id of the currently focused window is stored in the _NET_ACTIVE_WINDOW
 787 property of the root window.
 788 This can be used for example to retrieve the
 789 title of the currently active window with
 790 .Xr xprop 1
 791 and
 792 .Xr grep 1 :
 793 .Bd -literal -offset indent
 794 $ WINDOWID=`xprop \-root _NET_ACTIVE_WINDOW | grep \-o "0x.*"`
 795 $ xprop \-id $WINDOWID WM_NAME | grep \-o "\\".*\\""
 796 .Ed
 797 .Pp
 798 A window can be focused by sending a _NET_ACTIVE_WINDOW client message
 799 to the root window.
 800 For example, using
 801 .Xr wmctrl 1
 802 to send the message
 803 (assuming 0x4a0000b is the id of the window to be focused):
 804 .Bd -literal -offset indent
 805 $ wmctrl \-i \-a 0x4a0000b
 806 .Ed
 807 .Pp
 808 Windows can be closed by sending a _NET_CLOSE_WINDOW client message
 809 to the root window.
 810 For example, using
 811 .Xr wmctrl 1
 812 to send the message
 813 (assuming 0x4a0000b is the id of the window to be closed):
 814 .Bd -literal -offset indent
 815 $ wmctrl \-i \-c 0x4a0000b
 816 .Ed
 817 .Pp
 818 Windows can be floated and un-floated by adding or removing the
 819 _NET_WM_STATE_ABOVE atom from the _NET_WM_STATE property of the window.
 820 This can be achieved by sending a _NET_WM_STATE client message to the
 821 root window.
 822 For example, the following toggles the floating state of
 823 a window using
 824 .Xr wmctrl 1
 825 to send the message (assuming 0x4a0000b is the  id of the window floated
 826 or un-floated):
 827 .Bd -literal -offset indent
 828 $ wmctrl \-i \-r 0x4a0000b \-b toggle,_NET_WM_STATE_ABOVE
 829 .Ed
 830 .Pp
 831 Floating windows can also be resized and moved by sending a
 832 _NET_MOVERESIZE_WINDOW client message to the root window.
 833 For example,
 834 using
 835 .Xr wmctrl 1
 836 to send the message (assuming 0x4a0000b is the id of
 837 the window to be resize/moved):
 838 .Bd -literal -offset indent
 839 $ wmctrl \-i \-r 0x4a0000b \-e 0,100,50,640,480
 840 .Ed
 841 .Pp
 842 This moves the window to (100,50) and resizes it to 640x480.
 843 .Pp
 844 Any _NET_MOVERESIZE_WINDOW events received for stacked windows are ignored.
 845 .Sh SIGNALS
 846 Sending
 847 .Nm
 848 a HUP signal will restart it.
 849 .Sh FILES
 850 .Bl -tag -width "/etc/spectrwm.confXXX" -compact
 851 .It Pa ~/.spectrwm.conf
 852 .Nm
 853 user specific settings.
 854 .It Pa /etc/spectrwm.conf
 855 .Nm
 856 global settings.
 857 .El
 858 .Sh HISTORY
 859 .Nm
 860 was inspired by xmonad & dwm.
 861 .Sh AUTHORS
 862 .An -nosplit
 863 .Nm
 864 was written by:
 865 .Pp
 866 .Bl -tag -width "Ryan Thomas McBride Aq mcbride@countersiege.com " -offset indent -compact
 867 .It Cm Marco Peereboom Aq marco@peereboom.us
 868 .It Cm Ryan Thomas McBride Aq mcbride@countersiege.com
 869 .It Cm Darrin Chandler Aq dwchandler@stilyagin.com
 870 .It Cm Pierre-Yves Ritschard Aq pyr@spootnik.org
 871 .It Cm Tuukka Kataja Aq stuge@xor.fi
 872 .It Cm Jason L. Wright Aq jason@thought.net
 873 .It Cm Reginald Kennedy Aq rk@rejii.com
 874 .It Cm Lawrence Teo Aq lteo@lteo.net
 875 .It Cm Tiago Cunha Aq tcunha@gmx.com
 876 .El