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