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