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