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