spectrwm.1

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