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