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