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