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