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