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 .It Ic workspace_limit
 309 Set the total number of workspaces available.  Minimum is 1, maximum is 22.
 310 .El
 311 .Pp
 312 Colors need to be specified per the
 313 .Xr XQueryColor 3
 314 specification and fonts need to be specified per the
 315 .Xr XQueryFont 3
 316 specification.
 317 .Pp
 318 To list the available fonts in your system see
 319 .Xr fc-list 1
 320 or
 321 .Xr xlsfonts 1
 322 manpages.
 323 The
 324 .Xr xfontsel 1
 325 application can help you to show the X Logical Font Description ("XLFD") used
 326 as setting in the keyword
 327 .Pa bar_font .
 328 .Sh PROGRAMS
 329 .Nm
 330 allows you to define custom actions to launch programs of your choice and then
 331 bind them the same as with built-in actions.
 332 See the
 333 .Sx BINDINGS
 334 section below.
 335 .Pp
 336 The default programs are described below:
 337 .Pp
 338 .Bl -tag -width "screenshot_wind" -offset indent -compact
 339 .It Cm term
 340 xterm
 341 .It Cm screenshot_all
 342 screenshot.sh full
 343 .It Cm screenshot_wind
 344 screenshot.sh window
 345 .It Cm lock
 346 xlock
 347 .It Cm initscr
 348 initscreen.sh
 349 .It Cm menu
 350 dmenu_run \-fn $bar_font \-nb $bar_color \-nf $bar_font_color \-sb $bar_border \-sf $bar_color
 351 .El
 352 .Pp
 353 Custom programs in the configuration file are specified as follows:
 354 .Pp
 355 .Dl program[<name>] = <progpath> [<arg> [... <arg>]]
 356 .Pp
 357 .Aq name
 358 is any identifier that does not conflict with a built-in action or keyword,
 359 .Aq progpath
 360 is the desired program, and
 361 .Aq arg
 362 is zero or more arguments to the program.
 363 .Pp
 364 The following variables represent settable values in
 365 .Nm
 366 (see the
 367 .Sx CONFIGURATION FILES
 368 section above),
 369 and may be used in the
 370 .Aq arg
 371 fields and will be substituted for values at the time the program is spawned:
 372 .Pp
 373 .Bl -tag -width "$bar_font_color" -offset indent -compact
 374 .It Cm $bar_border
 375 .It Cm $bar_color
 376 .It Cm $bar_font
 377 .It Cm $bar_font_color
 378 .It Cm $color_focus
 379 .It Cm $color_unfocus
 380 .El
 381 .Pp
 382 Example:
 383 .Bd -literal -offset indent
 384 program[ff] = /usr/local/bin/firefox http://spectrwm.org/
 385 bind[ff] = Mod+Shift+b # Now Mod+Shift+B launches firefox
 386 .Ed
 387 .Pp
 388 To undo the previous:
 389 .Bd -literal -offset indent
 390 bind[] = Mod+Shift+b
 391 program[ff] =
 392 .Ed
 393 .Sh BINDINGS
 394 .Nm
 395 provides many functions (or actions) accessed via key or mouse bindings.
 396 .Pp
 397 The current mouse bindings are described below:
 398 .Pp
 399 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
 400 .It Cm M1
 401 Focus window
 402 .It Cm M-M1
 403 Move window
 404 .It Cm M-M3
 405 Resize window
 406 .It Cm M-S-M3
 407 Resize window while maintaining it centered
 408 .El
 409 .Pp
 410 The default key bindings are described below:
 411 .Pp
 412 .Bl -tag -width "M-j, M-<TAB>XXXXXX" -offset indent -compact
 413 .It Cm M-S- Ns Aq Cm Return
 414 term
 415 .It Cm M-p
 416 menu
 417 .It Cm M-S-q
 418 quit
 419 .It Cm M-q
 420 restart
 421 .It Cm M- Ns Aq Cm Space
 422 cycle_layout
 423 .It Cm M-S- Ns Aq Cm \e
 424 flip_layout
 425 .It Cm M-S- Ns Aq Cm Space
 426 stack_reset
 427 .It Cm M-h
 428 master_shrink
 429 .It Cm M-l
 430 master_grow
 431 .It Cm M-,
 432 master_add
 433 .It Cm M-.
 434 master_del
 435 .It Cm M-S-,
 436 stack_inc
 437 .It Cm M-S-.
 438 stack_dec
 439 .It Cm M- Ns Aq Cm Return
 440 swap_main
 441 .It Xo
 442 .Cm M-j ,
 443 .Cm M- Ns Aq Cm TAB
 444 .Xc
 445 focus_next
 446 .It Xo
 447 .Cm M-k ,
 448 .Cm M-S- Ns Aq Cm TAB
 449 .Xc
 450 focus_prev
 451 .It Cm M-m
 452 focus_main
 453 .It Cm M-S-j
 454 swap_next
 455 .It Cm M-S-k
 456 swap_prev
 457 .It Cm M-b
 458 bar_toggle
 459 .It Cm M-x
 460 wind_del
 461 .It Cm M-S-x
 462 wind_kill
 463 .It Cm M- Ns Aq Ar 1-9,0,F1-F12
 464 .Pf ws_ Aq Ar 1-22
 465 .It Cm M-S- Ns Aq Ar 1-9,0,F1-F12
 466 .Pf mvws_ Ns Aq Ar 1-22
 467 .It Cm M- Ns Aq Cm Right
 468 ws_next
 469 .It Cm M- Ns Aq Cm Left
 470 ws_prev
 471 .It Cm M- Ns Aq Cm Up
 472 ws_next_all
 473 .It Cm M- Ns Aq Cm Down
 474 ws_prev_all
 475 .It Cm M-a
 476 ws_prior
 477 .It Cm M-S- Ns Aq Cm Right
 478 screen_next
 479 .It Cm M-S- Ns Aq Cm Left
 480 screen_prev
 481 .It Cm M-s
 482 screenshot_all
 483 .It Cm M-S-s
 484 screenshot_wind
 485 .It Cm M-S-v
 486 version
 487 .It Cm M-t
 488 float_toggle
 489 .It Cm M-S- Ns Aq Cm Delete
 490 lock
 491 .It Cm M-S-i
 492 initscr
 493 .It Cm M-w
 494 iconify
 495 .It Cm M-S-w
 496 uniconify
 497 .It Cm M-S-r
 498 always_raise
 499 .It Cm M-v
 500 button2
 501 .It Cm M--
 502 width_shrink
 503 .It Cm M-=
 504 width_grow
 505 .It Cm M-S--
 506 height_shrink
 507 .It Cm M-S-=
 508 height_grow
 509 .It Cm M-[
 510 move_left
 511 .It Cm M-]
 512 move_right
 513 .It Cm M-S-[
 514 move_up
 515 .It Cm M-S-]
 516 move_down
 517 .It Cm M-S-/
 518 name_workspace
 519 .It Cm M-/
 520 search_workspace
 521 .It Cm M-f
 522 search_win
 523 .El
 524 .Pp
 525 The action names and descriptions are listed below:
 526 .Pp
 527 .Bl -tag -width "M-j, M-<TAB>XXXX" -offset indent -compact
 528 .It Cm term
 529 Spawn a new terminal
 530 (see
 531 .Sx PROGRAMS
 532 above).
 533 .It Cm menu
 534 Menu
 535 (see
 536 .Sx PROGRAMS
 537 above).
 538 .It Cm quit
 539 Quit
 540 .Nm .
 541 .It Cm restart
 542 Restart
 543 .Nm .
 544 .It Cm cycle_layout
 545 Cycle layout.
 546 .It Cm flip_layout
 547 Swap the master and stacking areas.
 548 .It Cm stack_reset
 549 Reset layout.
 550 .It Cm master_shrink
 551 Shrink master area.
 552 .It Cm master_grow
 553 Grow master area.
 554 .It Cm master_add
 555 Add windows to master area.
 556 .It Cm master_del
 557 Remove windows from master area.
 558 .It Cm stack_inc
 559 Add columns/rows to stacking area.
 560 .It Cm stack_dec
 561 Remove columns/rows from stacking area.
 562 .It Cm swap_main
 563 Move current window to master area.
 564 .It Cm focus_next
 565 Focus next window in workspace.
 566 .It Cm focus_prev
 567 Focus previous window in workspace.
 568 .It Cm focus_main
 569 Focus on main window in workspace.
 570 .It Cm swap_next
 571 Swap with next window in workspace.
 572 .It Cm swap_prev
 573 Swap with previous window in workspace.
 574 .It Cm bar_toggle
 575 Toggle status bar in all workspaces.
 576 .It Cm wind_del
 577 Delete current window in workspace.
 578 .It Cm wind_kill
 579 Destroy current window in workspace.
 580 .It Cm ws_ Ns Ar n
 581 Switch to workspace
 582 .Ar n ,
 583 where
 584 .Ar n
 585 is 1 through workspace_limit.
 586 .It Cm mvws_ Ns Ar n
 587 Move current window to workspace
 588 .Ar n ,
 589 where
 590 .Ar n
 591 is 1 through workspace_limit.
 592 .It Cm ws_next
 593 Switch to next workspace with a window in it.
 594 .It Cm ws_prev
 595 Switch to previous workspace with a window in it.
 596 .It Cm ws_next_all
 597 Switch to next workspace.
 598 .It Cm ws_prev_all
 599 Switch to previous workspace.
 600 .It Cm ws_prior
 601 Switch to last visited workspace.
 602 .It Cm screen_next
 603 Move pointer to next region.
 604 .It Cm screen_prev
 605 Move pointer to previous region.
 606 .It Cm screenshot_all
 607 Take screenshot of entire screen (if enabled)
 608 (see
 609 .Sx PROGRAMS
 610 above).
 611 .It Cm screenshot_wind
 612 Take screenshot of selected window (if enabled)
 613 (see
 614 .Sx PROGRAMS
 615 above).
 616 .It Cm version
 617 Toggle version in status bar.
 618 .It Cm float_toggle
 619 Toggle focused window between tiled and floating.
 620 .It Cm lock
 621 Lock screen
 622 (see
 623 .Sx PROGRAMS
 624 above).
 625 .It Cm initscr
 626 Reinitialize physical screens
 627 (see
 628 .Sx PROGRAMS
 629 above).
 630 .It Cm iconify
 631 Minimize (unmap) currently focused window.
 632 .It Cm uniconify
 633 Maximize (map) window returned by dmenu selection.
 634 .It Cm always_raise
 635 When set tiled windows are allowed to obscure floating windows.
 636 .It Cm button2
 637 Fake a middle mouse button click (mouse button 2).
 638 .It Cm width_shrink
 639 Shrink the width of a floating window.
 640 .It Cm width_grow
 641 Grow the width of a floating window.
 642 .It Cm height_shrink
 643 Shrink the height of a floating window.
 644 .It Cm height_grow
 645 Grow the height of a floating window.
 646 .It Cm move_left
 647 Move a floating window a step to the left.
 648 .It Cm move_right
 649 Move a floating window a step to the right.
 650 .It Cm move_up
 651 Move a floating window a step upwards.
 652 .It Cm move_down
 653 Move a floating window a step downwards.
 654 .It Cm name_workspace
 655 Name the current workspace.
 656 .It Cm search_workspace
 657 Search for a workspace.
 658 .It Cm search_win
 659 Search the windows in the current workspace.
 660 .El
 661 .Pp
 662 Custom bindings in the configuration file are specified as follows:
 663 .Pp
 664 .Dl bind[<action>] = <keys>
 665 .Pp
 666 .Aq action
 667 is one of the actions listed above (or empty) and
 668 .Aq keys
 669 is in the form of zero or more modifier keys
 670 (MOD, Mod1, Shift, etc.) and one or more normal keys
 671 (b, space, etc.), separated by "+".
 672 For example:
 673 .Bd -literal -offset indent
 674 bind[reset] = Mod4+q # bind Windows-key + q to reset
 675 bind[] = Mod1+q # unbind Alt + q
 676 .Ed
 677 .Pp
 678 To use the currently defined
 679 .Ic modkey ,
 680 specify MOD as the modifier key.
 681 .Pp
 682 Multiple key combinations may be bound to the same action.
 683 .Pp
 684 To bind non-latin characters such as å or π you must enter the xkb
 685 character name instead of the character itself. Run xev, focus the window
 686 and press the specific key and in the terminal output read the symbol name.
 687 In the fallowing example for å:
 688 .Bd -literal -offset indent
 689 KeyPress event, serial 41, synthetic NO, window 0x2600001,
 690     root 0x15a, subw 0x0, time 106213808, (11,5), root:(359,823),
 691     state 0x0, keycode 24 (keysym 0xe5, aring), same_screen YES,
 692     XLookupString gives 2 bytes: (c3 a5) "å"
 693     XmbLookupString gives 2 bytes: (c3 a5) "å"
 694     XFilterEvent returns: False
 695 .Ed
 696 .Pp
 697 The xkb name is aring. In other words, in .spectrwm.conf add:
 698 .Bd -literal -offset indent
 699 bind[program] = MOD+aring
 700 .Ed
 701 .Sh KEYBOARD MAPPING FILES
 702 Keyboard mapping files for several keyboard layouts are listed
 703 below.
 704 These files can be used with the
 705 .Pa keyboard_mapping
 706 setting to load pre-defined key bindings for the specified
 707 keyboard layout.
 708 .Pp
 709 .Bl -tag -width "spectrwm_XX.confXXX" -offset indent -compact
 710 .It Cm spectrwm_cz.conf
 711 Czech Republic keyboard layout
 712 .It Cm spectrwm_es.conf
 713 Spanish keyboard layout
 714 .It Cm spectrwm_fr.conf
 715 French keyboard layout
 716 .It Cm spectrwm_fr_ch.conf
 717 Swiss French keyboard layout
 718 .It Cm spectrwm_se.conf
 719 Swedish keyboard layout
 720 .It Cm spectrwm_us.conf
 721 United States keyboard layout
 722 .El
 723 .Sh QUIRKS
 724 .Nm
 725 provides "quirks" which handle windows that must be treated specially
 726 in a tiling window manager, such as some dialogs and fullscreen apps.
 727 .Pp
 728 The default quirks are described below:
 729 .Pp
 730 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
 731 .It Firefox\-bin:firefox\-bin
 732 TRANSSZ
 733 .It Firefox:Dialog
 734 FLOAT
 735 .It Gimp:gimp
 736 FLOAT + ANYWHERE
 737 .It MPlayer:xv
 738 FLOAT + FULLSCREEN + FOCUSPREV
 739 .It OpenOffice.org 2.4:VCLSalFrame
 740 FLOAT
 741 .It OpenOffice.org 3.1:VCLSalFrame
 742 FLOAT
 743 .It pcb:pcb
 744 FLOAT
 745 .It xine:Xine Window
 746 FLOAT + ANYWHERE
 747 .It xine:xine Panel
 748 FLOAT + ANYWHERE
 749 .It xine:xine Video Fullscreen Window
 750 FULLSCREEN + FLOAT
 751 .It Xitk:Xitk Combo
 752 FLOAT + ANYWHERE
 753 .It Xitk:Xine Window
 754 FLOAT + ANYWHERE
 755 .It XTerm:xterm
 756 XTERM_FONTADJ
 757 .El
 758 .Pp
 759 The quirks themselves are described below:
 760 .Pp
 761 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
 762 .It FLOAT
 763 This window should not be tiled, but allowed to float freely.
 764 .It TRANSSZ
 765 Adjusts size on transient windows that are too small using dialog_ratio
 766 (see
 767 .Sx CONFIGURATION FILES ) .
 768 .It ANYWHERE
 769 Allow window to position itself, uncentered.
 770 .It XTERM_FONTADJ
 771 Adjust xterm fonts when resizing.
 772 .It FULLSCREEN
 773 Remove border to allow window to use full screen size.
 774 .It FOCUSPREV
 775 On exit force focus on previously focused application not previous application
 776 in the stack.
 777 .El
 778 .Pp
 779 Custom quirks in the configuration file are specified as follows:
 780 .Pp
 781 .Dl quirk[<class>:<name>] = <quirk> [ + <quirk> ... ]
 782 .Pp
 783 .Aq class
 784 and
 785 .Aq name
 786 specify the window to which the quirk(s) apply, and
 787 .Aq quirk
 788 is one of the quirks from the list above.
 789 For example:
 790 .Bd -literal -offset indent
 791 quirk[MPlayer:xv] = FLOAT + FULLSCREEN + FOCUSPREV
 792 quirk[pcb:pcb] = NONE  # remove existing quirk
 793 .Ed
 794 .Pp
 795 You can obtain
 796 .Aq class
 797 and
 798 .Aq name
 799 by running
 800 .Xr xprop 1
 801 and then clicking on the desired window.
 802 In the following example the main window of Firefox was clicked:
 803 .Bd -literal -offset indent
 804 $ xprop | grep WM_CLASS
 805 WM_CLASS(STRING) = "Navigator", "Firefox"
 806 .Ed
 807 .Pp
 808 Note that grepping for WM_CLASS flips class and name.
 809 In the example above the quirk entry would be:
 810 .Bd -literal -offset indent
 811 quirk[Firefox:Navigator] = FLOAT
 812 .Ed
 813 .Pp
 814 .Nm
 815 also automatically assigns quirks to windows based on the value
 816 of the window's _NET_WM_WINDOW_TYPE property as follows:
 817 .Pp
 818 .Bl -tag -width "_NET_WM_WINDOW_TYPE_TOOLBAR<TAB>XXX" -offset indent -compact
 819 .It _NET_WM_WINDOW_TYPE_DOCK
 820 FLOAT + ANYWHERE
 821 .It _NET_WM_WINDOW_TYPE_TOOLBAR
 822 FLOAT + ANYWHERE
 823 .It _NET_WM_WINDOW_TYPE_UTILITY
 824 FLOAT + ANYWHERE
 825 .It _NET_WM_WINDOW_TYPE_SPLASH
 826 FLOAT
 827 .It _NET_WM_WINDOW_TYPE_DIALOG
 828 FLOAT
 829 .El
 830 .Pp
 831 In all other cases, no automatic quirks are assigned to the window.
 832 Quirks specified in the configuration file override the automatic quirks.
 833 .Sh EWMH
 834 .Nm
 835 partially implements the Extended Window Manager Hints (EWMH) specification.
 836 This enables controlling windows as well as
 837 .Nm
 838 itself from external scripts and programs.
 839 This is achieved by
 840 .Nm
 841 responding to certain ClientMessage events.
 842 From the terminal these events
 843 can be conveniently sent using tools such as
 844 .Xr wmctrl 1
 845 and
 846 .Xr xdotool 1 .
 847 For the
 848 actual format of these ClientMessage events, see the EWMH specification.
 849 .Pp
 850 The id of the currently focused window is stored in the _NET_ACTIVE_WINDOW
 851 property of the root window.
 852 This can be used for example to retrieve the
 853 title of the currently active window with
 854 .Xr xprop 1
 855 and
 856 .Xr grep 1 :
 857 .Bd -literal -offset indent
 858 $ WINDOWID=`xprop \-root _NET_ACTIVE_WINDOW | grep \-o "0x.*"`
 859 $ xprop \-id $WINDOWID WM_NAME | grep \-o "\\".*\\""
 860 .Ed
 861 .Pp
 862 A window can be focused by sending a _NET_ACTIVE_WINDOW client message
 863 to the root window.
 864 For example, using
 865 .Xr wmctrl 1
 866 to send the message
 867 (assuming 0x4a0000b is the id of the window to be focused):
 868 .Bd -literal -offset indent
 869 $ wmctrl \-i \-a 0x4a0000b
 870 .Ed
 871 .Pp
 872 Windows can be closed by sending a _NET_CLOSE_WINDOW client message
 873 to the root window.
 874 For example, using
 875 .Xr wmctrl 1
 876 to send the message
 877 (assuming 0x4a0000b is the id of the window to be closed):
 878 .Bd -literal -offset indent
 879 $ wmctrl \-i \-c 0x4a0000b
 880 .Ed
 881 .Pp
 882 Windows can be floated and un-floated by adding or removing the
 883 _NET_WM_STATE_ABOVE atom from the _NET_WM_STATE property of the window.
 884 This can be achieved by sending a _NET_WM_STATE client message to the
 885 root window.
 886 For example, the following toggles the floating state of
 887 a window using
 888 .Xr wmctrl 1
 889 to send the message (assuming 0x4a0000b is the  id of the window floated
 890 or un-floated):
 891 .Bd -literal -offset indent
 892 $ wmctrl \-i \-r 0x4a0000b \-b toggle,_NET_WM_STATE_ABOVE
 893 .Ed
 894 .Pp
 895 Floating windows can also be resized and moved by sending a
 896 _NET_MOVERESIZE_WINDOW client message to the root window.
 897 For example,
 898 using
 899 .Xr wmctrl 1
 900 to send the message (assuming 0x4a0000b is the id of
 901 the window to be resize/moved):
 902 .Bd -literal -offset indent
 903 $ wmctrl \-i \-r 0x4a0000b \-e 0,100,50,640,480
 904 .Ed
 905 .Pp
 906 This moves the window to (100,50) and resizes it to 640x480.
 907 .Pp
 908 Any _NET_MOVERESIZE_WINDOW events received for stacked windows are ignored.
 909 .Sh SIGNALS
 910 Sending
 911 .Nm
 912 a HUP signal will restart it.
 913 .Sh FILES
 914 .Bl -tag -width "/etc/spectrwm.confXXX" -compact
 915 .It Pa ~/.spectrwm.conf
 916 .Nm
 917 user specific settings.
 918 .It Pa /etc/spectrwm.conf
 919 .Nm
 920 global settings.
 921 .El
 922 .Sh HISTORY
 923 .Nm
 924 was inspired by xmonad & dwm.
 925 .Sh AUTHORS
 926 .An -nosplit
 927 .Nm
 928 was written by:
 929 .Pp
 930 .Bl -tag -width "Ryan Thomas McBride Aq mcbride@countersiege.com " -offset indent -compact
 931 .It Cm Marco Peereboom Aq marco@peereboom.us
 932 .It Cm Ryan Thomas McBride Aq mcbride@countersiege.com
 933 .It Cm Darrin Chandler Aq dwchandler@stilyagin.com
 934 .It Cm Pierre-Yves Ritschard Aq pyr@spootnik.org
 935 .It Cm Tuukka Kataja Aq stuge@xor.fi
 936 .It Cm Jason L. Wright Aq jason@thought.net
 937 .It Cm Reginald Kennedy Aq rk@rejii.com
 938 .It Cm Lawrence Teo Aq lteo@lteo.net
 939 .It Cm Tiago Cunha Aq tcunha@gmx.com
 940 .El