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