scrotwm.1

   1 .\" Copyright (c) 2009 Marco Peereboom <marco@peereboom.us>
   2 .\" Copyright (c) 2009 Darrin Chandler <dwchandler@stilyagin.com>
   3 .\"
   4 .\" Permission to use, copy, modify, and distribute this software for any
   5 .\" purpose with or without fee is hereby granted, provided that the above
   6 .\" copyright notice and this permission notice appear in all copies.
   7 .\"
   8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15 .\"
  16 .Dd $Mdocdate: December 12 2011 $
  17 .Dt SCROTWM 1
  18 .Os
  19 .Sh NAME
  20 .Nm scrotwm
  21 .Nd window manager for X11
  22 .Sh SYNOPSIS
  23 .Nm scrotwm
  24 .Sh DESCRIPTION
  25 .Nm
  26 is a minimalistic window manager that tries to stay out of the way so that
  27 valuable screen real estate can be used for much more important stuff.
  28 It has sane defaults and does not require one to learn a language to do any
  29 configuration.
  30 It was written by hackers for hackers and it strives to be small, compact and
  31 fast.
  32 .Pp
  33 When
  34 .Nm
  35 starts up, it reads settings from its configuration file,
  36 .Pa scrotwm.conf .
  37 See the
  38 .Sx CONFIGURATION FILES
  39 section below.
  40 .Pp
  41 The following notation is used throughout this page:
  42 .Pp
  43 .Bl -tag -width Ds -offset indent -compact
  44 .It Cm M
  45 Meta
  46 .It Cm S
  47 Shift
  48 .It Aq Cm Name
  49 Named key
  50 .It Cm M1
  51 Mouse button 1
  52 .It Cm M3
  53 Mouse button 3
  54 .El
  55 .Pp
  56 .Nm
  57 is very simple in its use.
  58 Most of the actions are initiated via key or mouse bindings.
  59 See the
  60 .Sx BINDINGS
  61 section below for defaults and customizations.
  62 .Sh CONFIGURATION FILES
  63 .Nm
  64 first tries to open the user specific file,
  65 .Pa ~/.scrotwm.conf .
  66 If that file is unavailable,
  67 it then tries to open the global configuration file
  68 .Pa /etc/scrotwm.conf .
  69 .Pp
  70 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
  71 For example:
  72 .Pp
  73 .Dl color_focus = red
  74 .Pp
  75 Enabling or disabling an option is done by using 1 or 0 respectively.
  76 .Pp
  77 The file supports the following keywords:
  78 .Bl -tag -width 2m
  79 .It Ic autorun
  80 Launch an application in a specified workspace at start-of-day.
  81 Defined in the format ws[<idx>]:application, e.g. ws[2]:xterm launches an
  82 xterm in workspace 2.
  83 .It Ic color_focus
  84 Border color of the currently focussed window.
  85 .It Ic color_unfocus
  86 Border color of unfocussed windows.
  87 .It Ic bar_enabled
  88 Enable or disable status bar.
  89 .It Ic bar_border Ns Bq Ar x
  90 Color of the status bar border in screen
  91 .Ar x .
  92 .It Ic bar_border_width
  93 Set status bar border thickness in pixels.
  94 Disable border by setting to 0.
  95 .It Ic bar_color Ns Bq Ar x
  96 Color of the status bar window in screen
  97 .Ar x .
  98 .It Ic bar_font_color Ns Bq Ar x
  99 Color of the font in status bar in screen
 100 .Ar x .
 101 .It Ic bar_font
 102 Status bar font.
 103 .It Ic bar_action
 104 External script that populates additional information in the status bar,
 105 such as battery life.
 106 .It Ic bar_delay
 107 Update frequency, in seconds, of external script that populates the status bar.
 108 .It Ic bar_at_bottom
 109 Place the statusbar at the bottom of each region instead of the top.
 110 .It Ic bar_justify
 111 Justify the status bar text. Possible values are
 112 .Pa left ,
 113 .Pa center ,
 114 and
 115 .Pa right .
 116 .It Ic stack_enabled
 117 Enable or disable displaying the current stacking algorithm in the status bar.
 118 .It Ic clock_enabled
 119 Enable or disable displaying the clock in the status bar.
 120 Disable by setting to 0
 121 so a custom clock could be used in the
 122 .Pa bar_action
 123 script.
 124 .It Ic dialog_ratio
 125 Some applications have dialogue windows that are too small to be useful.
 126 This ratio is the screen size to what they will be resized.
 127 For example, 0.6 is 60% of the physical screen size.
 128 .It Ic keyboard_mapping
 129 Clear all key bindings and load new key bindings from the specified file.
 130 This allows you to load pre-defined key bindings for your keyboard layout.
 131 See the
 132 .Sx KEYBOARD MAPPING FILES
 133 section below for a list of keyboard mapping files that have been provided
 134 for several keyboard layouts.
 135 .It Ic layout
 136 Select layout to use at start-of-day.
 137 Defined in the format
 138 ws[idx]:master_grow:master_add:stack_inc:layout:always_raise:stack_mode, e.g.
 139 ws[2]:-4:0:1:0:horizontal sets worskspace 2 to the horizontal stack mode and
 140 shrinks the master area by 4 ticks and adds one window to the stack, while
 141 maintaining default floating window behavior.
 142 Possible stack_mode values are
 143 .Pa vertical ,
 144 .Pa horizontal
 145 and
 146 .Pa fullscreen .
 147 .Pp
 148 See
 149 .Pa master_grow ,
 150 .Pa master_shrink ,
 151 .Pa master_add ,
 152 .Pa master_del ,
 153 .Pa stack_inc ,
 154 .Pa stack_dec ,
 155 and
 156 .Pa always_raise
 157 for more information.
 158 Note that the stacking options are complicated and have side-effects.
 159 One should familiarize oneself with these commands before experimenting with the
 160 .Pa layout
 161 option.
 162 .Pp
 163 This setting is not retained at restart.
 164 .It Ic region
 165 Allocates a custom region, removing any autodetected regions which occupy the same
 166 space on the screen.
 167 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y,
 168 e.g.\& screen[1]:800x1200+0+0.
 169 .Pp
 170 To make a screen span multiple monitors, create a region big enough to cover
 171 them all, e.g. screen[1]:2048x768+0+0 makes the screen span two monitors with
 172 1024x768 resolution sitting one next to the other.
 173 .It Ic term_width
 174 Set a preferred minimum width for the terminal.
 175 If this value is greater than 0,
 176 .Nm
 177 will attempt to adjust the font sizes in the terminal to keep the terminal
 178 width above this number as the window is resized.
 179 Only
 180 .Xr xterm 1
 181 is currently supported.
 182 The
 183 .Xr xterm 1
 184 binary must not be setuid or setgid, which it is by default on most systems.
 185 Users may need to set program[term] (see the
 186 .Sx PROGRAMS
 187 section) to use an alternate copy of the
 188 .Xr xterm 1
 189 binary without the setgid bit set.
 190 .It Ic title_class_enabled
 191 Enable or disable displaying the window class in the status bar.
 192 Enable by setting to 1.
 193 .It Ic title_name_enabled
 194 Enable or disable displaying the window title in the status bar.
 195 Enable by setting to 1.
 196 .It Ic urgent_enabled
 197 Enable or disable the urgency hint.
 198 Note that many terminal emulators require this to be enabled for it to
 199 propagate.
 200 In xterm, for example, one needs to add the following line
 201 .Pa xterm.urgentOnBell: true
 202 to
 203 .Pa .Xdefaults .
 204 .It Ic window_name_enabled
 205 Enable or disable displaying the window name in the status bar.
 206 Enable by setting to 1.
 207 .It Ic verbose_layout
 208 Enable or disable displaying the current master and stack values in the status
 209 bar.
 210 Enable by setting to 1.
 211 .It Ic modkey
 212 Change mod key.
 213 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
 214 .It Ic focus_mode
 215 Using a value of
 216 .Pa follow_cursor
 217 will make the window manager focus the window
 218 under the mouse when switching workspaces and creating windows.
 219 .It Ic disable_border
 220 Remove border when bar is disabled and there is only one window on the screen.
 221 .It Ic border_width
 222 Set window border thickness in pixels.
 223 Disable all borders by setting to 0.
 224 .It Ic program Ns Bq Ar p
 225 Define new action to spawn a program
 226 .Ar p .
 227 See the
 228 .Sx PROGRAMS
 229 section below.
 230 .It Ic bind Ns Bq Ar x
 231 Bind key combo to action
 232 .Ar x .
 233 See the
 234 .Sx BINDINGS
 235 section below.
 236 .It Ic quirk Ns Bq Ar c:n
 237 Add "quirk" for windows with class
 238 .Ar c
 239 and name
 240 .Ar n .
 241 See the
 242 .Sx QUIRKS
 243 section below.
 244 .El
 245 .Pp
 246 Colors need to be specified per the
 247 .Xr XQueryColor 3
 248 specification and fonts need to be specified per the
 249 .Xr XQueryFont 3
 250 specification.
 251 .Pp
 252 To list the available fonts in your system see
 253 .Xr fc-list 1
 254 or
 255 .Xr xlsfonts 1
 256 manpages.
 257 The
 258 .Xr xfontsel 1
 259 application can help you to show the X Logical Font Description ("XLFD") used
 260 as setting in the keyword
 261 .Pa bar_font .
 262 .Sh PROGRAMS
 263 .Nm
 264 allows you to define custom actions to launch programs of your choice and then
 265 bind them the same as with built-in actions.
 266 See the
 267 .Sx BINDINGS
 268 section below.
 269 .Pp
 270 The default programs are described below:
 271 .Pp
 272 .Bl -tag -width "screenshot_wind" -offset indent -compact
 273 .It Cm term
 274 xterm
 275 .It Cm screenshot_all
 276 screenshot.sh full
 277 .It Cm screenshot_wind
 278 screenshot.sh window
 279 .It Cm lock
 280 xlock
 281 .It Cm initscr
 282 initscreen.sh
 283 .It Cm menu
 284 dmenu_run \-fn $bar_font \-nb $bar_color \-nf $bar_font_color \-sb $bar_border \-sf $bar_color
 285 .El
 286 .Pp
 287 Custom programs in the configuration file are specified as follows:
 288 .Pp
 289 .Dl program[<name>] = <progpath> [<arg> [... <arg>]]
 290 .Pp
 291 .Aq name
 292 is any identifier that does not conflict with a built-in action or keyword,
 293 .Aq progpath
 294 is the desired program, and
 295 .Aq arg
 296 is zero or more arguments to the program.
 297 .Pp
 298 The following variables represent settable values in
 299 .Nm
 300 (see the
 301 .Sx CONFIGURATION FILES
 302 section above),
 303 and may be used in the
 304 .Aq arg
 305 fields and will be substituted for values at the time the program is spawned:
 306 .Pp
 307 .Bl -tag -width "$bar_font_color" -offset indent -compact
 308 .It Cm $bar_border
 309 .It Cm $bar_color
 310 .It Cm $bar_font
 311 .It Cm $bar_font_color
 312 .It Cm $color_focus
 313 .It Cm $color_unfocus
 314 .El
 315 .Pp
 316 Example:
 317 .Bd -literal -offset indent
 318 program[ff] = /usr/local/bin/firefox http://scrotwm.org/
 319 bind[ff] = Mod+Shift+b # Now Mod+Shift+B launches firefox
 320 .Ed
 321 .Pp
 322 To undo the previous:
 323 .Bd -literal -offset indent
 324 bind[] = Mod+Shift+b
 325 program[ff] =
 326 .Ed
 327 .Sh BINDINGS
 328 .Nm
 329 provides many functions (or actions) accessed via key or mouse bindings.
 330 .Pp
 331 The current mouse bindings are described below:
 332 .Pp
 333 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
 334 .It Cm M1
 335 Focus window
 336 .It Cm M-M1
 337 Move window
 338 .It Cm M-M3
 339 Resize window
 340 .It Cm M-S-M3
 341 Resize window while maintaining it centered
 342 .El
 343 .Pp
 344 The default key bindings are described below:
 345 .Pp
 346 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
 347 .It Cm M-S- Ns Aq Cm Return
 348 term
 349 .It Cm M-p
 350 menu
 351 .It Cm M-S-q
 352 quit
 353 .It Cm M-q
 354 restart
 355 .It Cm M- Ns Aq Cm Space
 356 cycle_layout
 357 .It Cm M-S- Ns Aq Cm Space
 358 stack_reset
 359 .It Cm M-h
 360 master_shrink
 361 .It Cm M-l
 362 master_grow
 363 .It Cm M-,
 364 master_add
 365 .It Cm M-.
 366 master_del
 367 .It Cm M-S-,
 368 stack_inc
 369 .It Cm M-S-.
 370 stack_dec
 371 .It Cm M- Ns Aq Cm Return
 372 swap_main
 373 .It Xo
 374 .Cm M-j ,
 375 .Cm M- Ns Aq Cm TAB
 376 .Xc
 377 focus_next
 378 .It Xo
 379 .Cm M-k ,
 380 .Cm M-S- Ns Aq Cm TAB
 381 .Xc
 382 focus_prev
 383 .It Cm M-m
 384 focus_main
 385 .It Cm M-S-j
 386 swap_next
 387 .It Cm M-S-k
 388 swap_prev
 389 .It Cm M-b
 390 bar_toggle
 391 .It Cm M-x
 392 wind_del
 393 .It Cm M-S-x
 394 wind_kill
 395 .It Cm M- Ns Aq Ar n
 396 .Pf ws_ Ar n
 397 .It Cm M-S- Ns Aq Ar n
 398 .Pf mvws_ Ar n
 399 .It Cm M- Ns Aq Cm Right
 400 ws_next
 401 .It Cm M- Ns Aq Cm Left
 402 ws_prev
 403 .It Cm M- Ns Aq Cm Up
 404 ws_next_all
 405 .It Cm M- Ns Aq Cm Down
 406 ws_prev_all
 407 .It Cm M-a
 408 ws_prior
 409 .It Cm M-S- Ns Aq Cm Right
 410 screen_next
 411 .It Cm M-S- Ns Aq Cm Left
 412 screen_prev
 413 .It Cm M-s
 414 screenshot_all
 415 .It Cm M-S-s
 416 screenshot_wind
 417 .It Cm M-S-v
 418 version
 419 .It Cm M-t
 420 float_toggle
 421 .It Cm M-S- Ns Aq Cm Delete
 422 lock
 423 .It Cm M-S-i
 424 initscr
 425 .It Cm M-w
 426 iconify
 427 .It Cm M-S-w
 428 uniconify
 429 .It Cm M-S-r
 430 always_raise
 431 .It Cm M-v
 432 button2
 433 .It Cm M--
 434 width_shrink
 435 .It Cm M-=
 436 width_grow
 437 .It Cm M-S-
 438 height_shrink
 439 .It Cm M-S-=
 440 height_grow
 441 .It Cm M-[
 442 move_left
 443 .It Cm M-]
 444 move_right
 445 .It Cm M-S-[
 446 move_up
 447 .It Cm M-S-]
 448 move_down
 449 .It Cm M-S-/
 450 name_workspace
 451 .It Cm M-/
 452 search_workspace
 453 .It Cm M-s
 454 search_win
 455 .El
 456 .Pp
 457 The action names and descriptions are listed below:
 458 .Pp
 459 .Bl -tag -width "M-j, M-<TAB>XXXX" -offset indent -compact
 460 .It Cm term
 461 Spawn a new terminal
 462 (see
 463 .Sx PROGRAMS
 464 above).
 465 .It Cm menu
 466 Menu
 467 (see
 468 .Sx PROGRAMS
 469 above).
 470 .It Cm quit
 471 Quit
 472 .Nm .
 473 .It Cm restart
 474 Restart
 475 .Nm .
 476 .It Cm cycle_layout
 477 Cycle layout.
 478 .It Cm stack_reset
 479 Reset layout.
 480 .It Cm master_shrink
 481 Shrink master area.
 482 .It Cm master_grow
 483 Grow master area.
 484 .It Cm master_add
 485 Add windows to master area.
 486 .It Cm master_del
 487 Remove windows from master area.
 488 .It Cm stack_inc
 489 Add columns/rows to stacking area.
 490 .It Cm stack_dec
 491 Remove columns/rows from stacking area.
 492 .It Cm swap_main
 493 Move current window to master area.
 494 .It Cm focus_next
 495 Focus next window in workspace.
 496 .It Cm focus_prev
 497 Focus previous window in workspace.
 498 .It Cm focus_main
 499 Focus on main window in workspace.
 500 .It Cm swap_next
 501 Swap with next window in workspace.
 502 .It Cm swap_prev
 503 Swap with previous window in workspace.
 504 .It Cm bar_toggle
 505 Toggle status bar in all workspaces.
 506 .It Cm wind_del
 507 Delete current window in workspace.
 508 .It Cm wind_kill
 509 Destroy current window in workspace.
 510 .It Cm ws_ Ns Ar n
 511 Switch to workspace
 512 .Ar n ,
 513 where
 514 .Ar n
 515 is 1 through 10.
 516 .It Cm mvws_ Ns Ar n
 517 Move current window to workspace
 518 .Ar n ,
 519 where
 520 .Ar n
 521 is 1 through 10.
 522 .It Cm ws_next
 523 Switch to next workspace with a window in it.
 524 .It Cm ws_prev
 525 Switch to previous workspace with a window in it.
 526 .It Cm ws_next_all
 527 Switch to next workspace.
 528 .It Cm ws_prev_all
 529 Switch to previous workspace.
 530 .It Cm ws_prior
 531 Switch to last visited workspace.
 532 .It Cm screen_next
 533 Move pointer to next region.
 534 .It Cm screen_prev
 535 Move pointer to previous region.
 536 .It Cm screenshot_all
 537 Take screenshot of entire screen (if enabled)
 538 (see
 539 .Sx PROGRAMS
 540 above).
 541 .It Cm screenshot_wind
 542 Take screenshot of selected window (if enabled)
 543 (see
 544 .Sx PROGRAMS
 545 above).
 546 .It Cm version
 547 Toggle version in status bar.
 548 .It Cm float_toggle
 549 Toggle focused window between tiled and floating.
 550 .It Cm lock
 551 Lock screen
 552 (see
 553 .Sx PROGRAMS
 554 above).
 555 .It Cm initscr
 556 Reinitialize physical screens
 557 (see
 558 .Sx PROGRAMS
 559 above).
 560 .It Cm iconify
 561 Minimize (unmap) currently focused window.
 562 .It Cm uniconify
 563 Maximize (map) window returned by dmenu selection.
 564 .It Cm always_raise
 565 When set tiled windows are allowed to obscure floating windows.
 566 .It Cm button2
 567 Fake a middle mouse button click (mouse button 2).
 568 .It Cm width_shrink
 569 Shrink the width of a floating window.
 570 .It Cm width_grow
 571 Grow the width of a floating window.
 572 .It Cm height_shrink
 573 Shrink the height of a floating window.
 574 .It Cm height_grow
 575 Grow the height of a floating window.
 576 .It Cm move_left
 577 Move a floating window a step to the left.
 578 .It Cm move_right
 579 Move a floating window a step to the right.
 580 .It Cm move_up
 581 Move a floating window a step upwards.
 582 .It Cm move_down
 583 Move a floating window a step downwards.
 584 .It Cm name_workspace
 585 Name the current workspace.
 586 .It Cm search_workspace
 587 Search for a workspace.
 588 .It Cm search_win
 589 Search the windows in the current workspace.
 590 .El
 591 .Pp
 592 Custom bindings in the configuration file are specified as follows:
 593 .Pp
 594 .Dl bind[<action>] = <keys>
 595 .Pp
 596 .Aq action
 597 is one of the actions listed above (or empty) and
 598 .Aq keys
 599 is in the form of zero or more modifier keys
 600 (MOD, Mod1, Shift, etc.) and one or more normal keys
 601 (b, space, etc.), separated by "+".
 602 For example:
 603 .Bd -literal -offset indent
 604 bind[reset] = Mod4+q # bind Windows-key + q to reset
 605 bind[] = Mod1+q # unbind Alt + q
 606 .Ed
 607 .Pp
 608 Multiple key combinations may be bound to the same action.
 609 .Sh KEYBOARD MAPPING FILES
 610 Keyboard mapping files for several keyboard layouts are listed
 611 below.
 612 These files can be used with the
 613 .Pa keyboard_mapping
 614 setting to load pre-defined key bindings for the specified
 615 keyboard layout.
 616 .Pp
 617 .Bl -tag -width "scrotwm_XX.confXXX" -offset indent -compact
 618 .It Cm scrotwm_cz.conf
 619 Czech Republic keyboard layout
 620 .It Cm scrotwm_es.conf
 621 Spanish keyboard layout
 622 .It Cm scrotwm_fr.conf
 623 French keyboard layout
 624 .It Cm scrotwm_fr_ch.conf
 625 Swiss French keyboard layout
 626 .It Cm scrotwm_se.conf
 627 Swedish keyboard layout
 628 .It Cm scrotwm_us.conf
 629 United States keyboard layout
 630 .El
 631 .Sh QUIRKS
 632 .Nm
 633 provides "quirks" which handle windows that must be treated specially
 634 in a tiling window manager, such as some dialogs and fullscreen apps.
 635 .Pp
 636 The default quirks are described below:
 637 .Pp
 638 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
 639 .It Firefox\-bin:firefox\-bin
 640 TRANSSZ
 641 .It Firefox:Dialog
 642 FLOAT
 643 .It Gimp:gimp
 644 FLOAT + ANYWHERE
 645 .It MPlayer:xv
 646 FLOAT + FULLSCREEN + FOCUSPREV
 647 .It OpenOffice.org 2.4:VCLSalFrame
 648 FLOAT
 649 .It OpenOffice.org 3.1:VCLSalFrame
 650 FLOAT
 651 .It pcb:pcb
 652 FLOAT
 653 .It xine:Xine Window
 654 FLOAT + ANYWHERE
 655 .It xine:xine Panel
 656 FLOAT + ANYWHERE
 657 .It xine:xine Video Fullscreen Window
 658 FULLSCREEN + FLOAT
 659 .It Xitk:Xitk Combo
 660 FLOAT + ANYWHERE
 661 .It Xitk:Xine Window
 662 FLOAT + ANYWHERE
 663 .It XTerm:xterm
 664 XTERM_FONTADJ
 665 .El
 666 .Pp
 667 The quirks themselves are described below:
 668 .Pp
 669 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
 670 .It FLOAT
 671 This window should not be tiled, but allowed to float freely.
 672 .It TRANSSZ
 673 Adjusts size on transient windows that are too small using dialog_ratio
 674 (see
 675 .Sx CONFIGURATION FILES ) .
 676 .It ANYWHERE
 677 Allow window to position itself, uncentered.
 678 .It XTERM_FONTADJ
 679 Adjust xterm fonts when resizing.
 680 .It FULLSCREEN
 681 Remove border to allow window to use full screen size.
 682 .It FOCUSPREV
 683 On exit force focus on previously focused application not previous application
 684 in the stack.
 685 .El
 686 .Pp
 687 Custom quirks in the configuration file are specified as follows:
 688 .Pp
 689 .Dl quirk[<class>:<name>] = <quirk> [ + <quirk> ... ]
 690 .Pp
 691 .Aq class
 692 and
 693 .Aq name
 694 specify the window to which the quirk(s) apply, and
 695 .Aq quirk
 696 is one of the quirks from the list above.
 697 For example:
 698 .Bd -literal -offset indent
 699 quirk[MPlayer:xv] = FLOAT + FULLSCREEN + FOCUSPREV
 700 quirk[pcb:pcb] = NONE  # remove existing quirk
 701 .Ed
 702 .Pp
 703 You can obtain
 704 .Aq class
 705 and
 706 .Aq name
 707 by running xprop(1) and then clicking on the desired window.
 708 In the following example the main window of Firefox was clicked:
 709 .Bd -literal -offset indent
 710 $ xprop | grep WM_CLASS
 711 WM_CLASS(STRING) = "Navigator", "Firefox"
 712 .Ed
 713 .Pp
 714 Note that grepping for WM_CLASS flips class and name.
 715 In the example above the quirk entry would be:
 716 .Bd -literal -offset indent
 717 quirk[Firefox:Navigator] = FLOAT
 718 .Ed
 719 .Pp
 720 .Nm
 721 also automatically assigns quirks to windows based on the value
 722 of the window's _NET_WM_WINDOW_TYPE property as follows:
 723 .Pp
 724 .Bl -tag -width "_NET_WM_WINDOW_TYPE_TOOLBAR<TAB>XXX" -offset indent -compact
 725 .It _NET_WM_WINDOW_TYPE_DOCK
 726 FLOAT + ANYWHERE
 727 .It _NET_WM_WINDOW_TYPE_TOOLBAR
 728 FLOAT + ANYWHERE
 729 .It _NET_WM_WINDOW_TYPE_UTILITY
 730 FLOAT + ANYWHERE
 731 .It _NET_WM_WINDOW_TYPE_SPLASH
 732 FLOAT
 733 .It _NET_WM_WINDOW_TYPE_DIALOG
 734 FLOAT
 735 .El
 736 .Pp
 737 In all other cases, no automatic quirks are assigned to the window.
 738 Quirks specified in the configuration file override the automatic quirks.
 739 .Sh EWMH
 740 .Nm
 741 partially implements the Extended Window Manager Hints (EWMH) specification.
 742 This enables controlling windows as well as
 743 .Nm
 744 itself from external scripts and programs.
 745 This is achieved by
 746 .Nm
 747 responding to certain ClientMessage events.
 748 From the terminal these events
 749 can be conveniently sent using tools such as
 750 .Xr wmctrl 1
 751 and
 752 .Xr xdotool 1 .
 753 For the
 754 actual format of these ClientMessage events, see the EWMH specification.
 755 .Pp
 756 The id of the currently focused window is stored in the _NET_ACTIVE_WINDOW
 757 property of the root window.
 758 This can be used for example to retrieve the
 759 title of the currently active window with
 760 .Xr xprop 1
 761 and
 762 .Xr grep 1 :
 763 .Bd -literal -offset indent
 764 $ WINDOWID=`xprop \-root _NET_ACTIVE_WINDOW | grep \-o "0x.*"`
 765 $ xprop \-id $WINDOWID WM_NAME | grep \-o "\\".*\\""
 766 .Ed
 767 .Pp
 768 A window can be focused by sending a _NET_ACTIVE_WINDOW client message
 769 to the root window.
 770 For example, using
 771 .Xr wmctrl 1
 772 to send the message
 773 (assuming 0x4a0000b is the id of the window to be focused):
 774 .Bd -literal -offset indent
 775 $ wmctrl \-i \-a 0x4a0000b
 776 .Ed
 777 .Pp
 778 Windows can be closed by sending a _NET_CLOSE_WINDOW client message
 779 to the root window.
 780 For example, using
 781 .Xr wmctrl 1
 782 to send the message
 783 (assuming 0x4a0000b is the id of the window to be closed):
 784 .Bd -literal -offset indent
 785 $ wmctrl \-i \-c 0x4a0000b
 786 .Ed
 787 .Pp
 788 Windows can be floated and un-floated by adding or removing the
 789 _NET_WM_STATE_ABOVE atom from the _NET_WM_STATE property of the window.
 790 This can be achieved by sending a _NET_WM_STATE client message to the
 791 root window.
 792 For example, the following toggles the floating state of
 793 a window using
 794 .Xr wmctrl 1
 795 to send the message (assuming 0x4a0000b is the  id of the window floated
 796 or un-floated):
 797 .Bd -literal -offset indent
 798 $ wmctrl \-i \-r 0x4a0000b \-b toggle,_NET_WM_STATE_ABOVE
 799 .Ed
 800 .Pp
 801 Floating windows can also be resized and moved by sending a
 802 _NET_MOVERESIZE_WINDOW client message to the root window.
 803 For example,
 804 using
 805 .Xr wmctrl 1
 806 to send the message (assuming 0x4a0000b is the id of
 807 the window to be resize/moved):
 808 .Bd -literal -offset indent
 809 $ wmctrl \-i \-r 0x4a0000b \-e 0,100,50,640,480
 810 .Ed
 811 .Pp
 812 This moves the window to (100,50) and resizes it to 640x480.
 813 .Pp
 814 Any _NET_MOVERESIZE_WINDOW events received for stacked windows are ignored.
 815 .Sh SIGNALS
 816 Sending
 817 .Nm
 818 a HUP signal will restart it.
 819 .Sh FILES
 820 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
 821 .It Pa ~/.scrotwm.conf
 822 .Nm
 823 user specific settings.
 824 .It Pa /etc/scrotwm.conf
 825 .Nm
 826 global settings.
 827 .El
 828 .Sh HISTORY
 829 .Nm
 830 was inspired by xmonad & dwm.
 831 .Sh AUTHORS
 832 .An -nosplit
 833 .Nm
 834 was written by:
 835 .Pp
 836 .Bl -tag -width "Ryan Thomas McBride Aq mcbride@countersiege.com " -offset indent -compact
 837 .It Cm Marco Peereboom Aq marco@peereboom.us
 838 .It Cm Ryan Thomas McBride Aq mcbride@countersiege.com
 839 .It Cm Darrin Chandler Aq dwchandler@stilyagin.com
 840 .It Cm Pierre-Yves Ritschard Aq pyr@spootnik.org
 841 .It Cm Tuukka Kataja Aq stuge@xor.fi
 842 .It Cm Jason L. Wright Aq jason@thought.net
 843 .El