code.delx.au - spectrwm/blob - spectrwm.1

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