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