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