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