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