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