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: January 25 2012 $
  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 bar_action
  84 External script that populates additional information in the status bar,
  85 such as battery life.
  86 .It Ic bar_at_bottom
  87 Place the statusbar at the bottom of each region instead of the top.
  88 .It Ic bar_border Ns Bq Ar x
  89 Color of the status bar border in screen
  90 .Ar x .
  91 .It Ic bar_border_width
  92 Set status bar border thickness in pixels.
  93 Disable border by setting to 0.
  94 .It Ic bar_color Ns Bq Ar x
  95 Color of the status bar window in screen
  96 .Ar x .
  97 .It Ic bar_delay
  98 Update frequency, in seconds, of external script that populates the status bar.
  99 .It Ic bar_enabled
 100 Enable or disable status bar.
 101 .It Ic bar_font
 102 Status bar font.
 103 .It Ic bar_font_color Ns Bq Ar x
 104 Color of the font in status bar in screen
 105 .Ar x .
 106 .It Ic bar_justify
 107 Justify the status bar text. Possible values are
 108 .Pa left ,
 109 .Pa center ,
 110 and
 111 .Pa right .
 112 .It Ic bind Ns Bq Ar x
 113 Bind key combo to action
 114 .Ar x .
 115 See the
 116 .Sx BINDINGS
 117 section below.
 118 .It Ic border_width
 119 Set window border thickness in pixels.
 120 Disable all borders by setting to 0.
 121 .It Ic clock_enabled
 122 Enable or disable displaying the clock in the status bar.
 123 Disable by setting to 0
 124 so a custom clock could be used in the
 125 .Pa bar_action
 126 script.
 127 .It Ic color_focus
 128 Border color of the currently focussed window.
 129 .It Ic color_unfocus
 130 Border color of unfocussed windows.
 131 .It Ic dialog_ratio
 132 Some applications have dialogue windows that are too small to be useful.
 133 This ratio is the screen size to what they will be resized.
 134 For example, 0.6 is 60% of the physical screen size.
 135 .It Ic disable_border
 136 Remove border when bar is disabled and there is only one window on the screen.
 137 .It Ic focus_mode
 138 Using a value of
 139 .Pa follow_cursor
 140 will make the window manager focus the window
 141 under the mouse when switching workspaces and creating windows.
 142 .It Ic keyboard_mapping
 143 Clear all key bindings and load new key bindings from the specified file.
 144 This allows you to load pre-defined key bindings for your keyboard layout.
 145 See the
 146 .Sx KEYBOARD MAPPING FILES
 147 section below for a list of keyboard mapping files that have been provided
 148 for several keyboard layouts.
 149 .It Ic layout
 150 Select layout to use at start-of-day.
 151 Defined in the format
 152 ws[idx]:master_grow:master_add:stack_inc:layout:always_raise:stack_mode, e.g.
 153 ws[2]:-4:0:1:0:horizontal sets worskspace 2 to the horizontal stack mode and
 154 shrinks the master area by 4 ticks and adds one window to the stack, while
 155 maintaining default floating window behavior.
 156 Possible stack_mode values are
 157 .Pa vertical ,
 158 .Pa horizontal
 159 and
 160 .Pa fullscreen .
 161 .Pp
 162 See
 163 .Pa master_grow ,
 164 .Pa master_shrink ,
 165 .Pa master_add ,
 166 .Pa master_del ,
 167 .Pa stack_inc ,
 168 .Pa stack_dec ,
 169 and
 170 .Pa always_raise
 171 for more information.
 172 Note that the stacking options are complicated and have side-effects.
 173 One should familiarize oneself with these commands before experimenting with the
 174 .Pa layout
 175 option.
 176 .Pp
 177 This setting is not retained at restart.
 178 .It Ic modkey
 179 Change mod key.
 180 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
 181 .It Ic program Ns Bq Ar p
 182 Define new action to spawn a program
 183 .Ar p .
 184 See the
 185 .Sx PROGRAMS
 186 section below.
 187 .It Ic quirk Ns Bq Ar c:n
 188 Add "quirk" for windows with class
 189 .Ar c
 190 and name
 191 .Ar n .
 192 See the
 193 .Sx QUIRKS
 194 section below.
 195 .It Ic region
 196 Allocates a custom region, removing any autodetected regions which occupy the same
 197 space on the screen.
 198 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y,
 199 e.g.\& screen[1]:800x1200+0+0.
 200 .Pp
 201 To make a screen span multiple monitors, create a region big enough to cover
 202 them all, e.g. screen[1]:2048x768+0+0 makes the screen span two monitors with
 203 1024x768 resolution sitting one next to the other.
 204 .It Ic stack_enabled
 205 Enable or disable displaying the current stacking algorithm in the status bar.
 206 .It Ic term_width
 207 Set a preferred minimum width for the terminal.
 208 If this value is greater than 0,
 209 .Nm
 210 will attempt to adjust the font sizes in the terminal to keep the terminal
 211 width above this number as the window is resized.
 212 Only
 213 .Xr xterm 1
 214 is currently supported.
 215 The
 216 .Xr xterm 1
 217 binary must not be setuid or setgid, which it is by default on most systems.
 218 Users may need to set program[term] (see the
 219 .Sx PROGRAMS
 220 section) to use an alternate copy of the
 221 .Xr xterm 1
 222 binary without the setgid bit set.
 223 .It Ic title_class_enabled
 224 Enable or disable displaying the window class in the status bar.
 225 Enable by setting to 1.
 226 .It Ic title_name_enabled
 227 Enable or disable displaying the window title in the status bar.
 228 Enable by setting to 1.
 229 .It Ic urgent_enabled
 230 Enable or disable the urgency hint.
 231 Note that many terminal emulators require this to be enabled for it to
 232 propagate.
 233 In xterm, for example, one needs to add the following line
 234 .Pa xterm.urgentOnBell: true
 235 to
 236 .Pa .Xdefaults .
 237 .It Ic verbose_layout
 238 Enable or disable displaying the current master and stack values in the status
 239 bar.
 240 Enable by setting to 1.
 241 .It Ic window_name_enabled
 242 Enable or disable displaying the window name in the status bar.
 243 Enable by setting to 1.
 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-f
 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 To use the currently defined
 609 .Ic modkey ,
 610 specify MOD as the modifier key.
 611 .Pp
 612 Multiple key combinations may be bound to the same action.
 613 .Sh KEYBOARD MAPPING FILES
 614 Keyboard mapping files for several keyboard layouts are listed
 615 below.
 616 These files can be used with the
 617 .Pa keyboard_mapping
 618 setting to load pre-defined key bindings for the specified
 619 keyboard layout.
 620 .Pp
 621 .Bl -tag -width "scrotwm_XX.confXXX" -offset indent -compact
 622 .It Cm scrotwm_cz.conf
 623 Czech Republic keyboard layout
 624 .It Cm scrotwm_es.conf
 625 Spanish keyboard layout
 626 .It Cm scrotwm_fr.conf
 627 French keyboard layout
 628 .It Cm scrotwm_fr_ch.conf
 629 Swiss French keyboard layout
 630 .It Cm scrotwm_se.conf
 631 Swedish keyboard layout
 632 .It Cm scrotwm_us.conf
 633 United States keyboard layout
 634 .El
 635 .Sh QUIRKS
 636 .Nm
 637 provides "quirks" which handle windows that must be treated specially
 638 in a tiling window manager, such as some dialogs and fullscreen apps.
 639 .Pp
 640 The default quirks are described below:
 641 .Pp
 642 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
 643 .It Firefox\-bin:firefox\-bin
 644 TRANSSZ
 645 .It Firefox:Dialog
 646 FLOAT
 647 .It Gimp:gimp
 648 FLOAT + ANYWHERE
 649 .It MPlayer:xv
 650 FLOAT + FULLSCREEN + FOCUSPREV
 651 .It OpenOffice.org 2.4:VCLSalFrame
 652 FLOAT
 653 .It OpenOffice.org 3.1:VCLSalFrame
 654 FLOAT
 655 .It pcb:pcb
 656 FLOAT
 657 .It xine:Xine Window
 658 FLOAT + ANYWHERE
 659 .It xine:xine Panel
 660 FLOAT + ANYWHERE
 661 .It xine:xine Video Fullscreen Window
 662 FULLSCREEN + FLOAT
 663 .It Xitk:Xitk Combo
 664 FLOAT + ANYWHERE
 665 .It Xitk:Xine Window
 666 FLOAT + ANYWHERE
 667 .It XTerm:xterm
 668 XTERM_FONTADJ
 669 .El
 670 .Pp
 671 The quirks themselves are described below:
 672 .Pp
 673 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
 674 .It FLOAT
 675 This window should not be tiled, but allowed to float freely.
 676 .It TRANSSZ
 677 Adjusts size on transient windows that are too small using dialog_ratio
 678 (see
 679 .Sx CONFIGURATION FILES ) .
 680 .It ANYWHERE
 681 Allow window to position itself, uncentered.
 682 .It XTERM_FONTADJ
 683 Adjust xterm fonts when resizing.
 684 .It FULLSCREEN
 685 Remove border to allow window to use full screen size.
 686 .It FOCUSPREV
 687 On exit force focus on previously focused application not previous application
 688 in the stack.
 689 .El
 690 .Pp
 691 Custom quirks in the configuration file are specified as follows:
 692 .Pp
 693 .Dl quirk[<class>:<name>] = <quirk> [ + <quirk> ... ]
 694 .Pp
 695 .Aq class
 696 and
 697 .Aq name
 698 specify the window to which the quirk(s) apply, and
 699 .Aq quirk
 700 is one of the quirks from the list above.
 701 For example:
 702 .Bd -literal -offset indent
 703 quirk[MPlayer:xv] = FLOAT + FULLSCREEN + FOCUSPREV
 704 quirk[pcb:pcb] = NONE  # remove existing quirk
 705 .Ed
 706 .Pp
 707 You can obtain
 708 .Aq class
 709 and
 710 .Aq name
 711 by running xprop(1) and then clicking on the desired window.
 712 In the following example the main window of Firefox was clicked:
 713 .Bd -literal -offset indent
 714 $ xprop | grep WM_CLASS
 715 WM_CLASS(STRING) = "Navigator", "Firefox"
 716 .Ed
 717 .Pp
 718 Note that grepping for WM_CLASS flips class and name.
 719 In the example above the quirk entry would be:
 720 .Bd -literal -offset indent
 721 quirk[Firefox:Navigator] = FLOAT
 722 .Ed
 723 .Pp
 724 .Nm
 725 also automatically assigns quirks to windows based on the value
 726 of the window's _NET_WM_WINDOW_TYPE property as follows:
 727 .Pp
 728 .Bl -tag -width "_NET_WM_WINDOW_TYPE_TOOLBAR<TAB>XXX" -offset indent -compact
 729 .It _NET_WM_WINDOW_TYPE_DOCK
 730 FLOAT + ANYWHERE
 731 .It _NET_WM_WINDOW_TYPE_TOOLBAR
 732 FLOAT + ANYWHERE
 733 .It _NET_WM_WINDOW_TYPE_UTILITY
 734 FLOAT + ANYWHERE
 735 .It _NET_WM_WINDOW_TYPE_SPLASH
 736 FLOAT
 737 .It _NET_WM_WINDOW_TYPE_DIALOG
 738 FLOAT
 739 .El
 740 .Pp
 741 In all other cases, no automatic quirks are assigned to the window.
 742 Quirks specified in the configuration file override the automatic quirks.
 743 .Sh EWMH
 744 .Nm
 745 partially implements the Extended Window Manager Hints (EWMH) specification.
 746 This enables controlling windows as well as
 747 .Nm
 748 itself from external scripts and programs.
 749 This is achieved by
 750 .Nm
 751 responding to certain ClientMessage events.
 752 From the terminal these events
 753 can be conveniently sent using tools such as
 754 .Xr wmctrl 1
 755 and
 756 .Xr xdotool 1 .
 757 For the
 758 actual format of these ClientMessage events, see the EWMH specification.
 759 .Pp
 760 The id of the currently focused window is stored in the _NET_ACTIVE_WINDOW
 761 property of the root window.
 762 This can be used for example to retrieve the
 763 title of the currently active window with
 764 .Xr xprop 1
 765 and
 766 .Xr grep 1 :
 767 .Bd -literal -offset indent
 768 $ WINDOWID=`xprop \-root _NET_ACTIVE_WINDOW | grep \-o "0x.*"`
 769 $ xprop \-id $WINDOWID WM_NAME | grep \-o "\\".*\\""
 770 .Ed
 771 .Pp
 772 A window can be focused by sending a _NET_ACTIVE_WINDOW client message
 773 to the root window.
 774 For example, using
 775 .Xr wmctrl 1
 776 to send the message
 777 (assuming 0x4a0000b is the id of the window to be focused):
 778 .Bd -literal -offset indent
 779 $ wmctrl \-i \-a 0x4a0000b
 780 .Ed
 781 .Pp
 782 Windows can be closed by sending a _NET_CLOSE_WINDOW client message
 783 to the root window.
 784 For example, using
 785 .Xr wmctrl 1
 786 to send the message
 787 (assuming 0x4a0000b is the id of the window to be closed):
 788 .Bd -literal -offset indent
 789 $ wmctrl \-i \-c 0x4a0000b
 790 .Ed
 791 .Pp
 792 Windows can be floated and un-floated by adding or removing the
 793 _NET_WM_STATE_ABOVE atom from the _NET_WM_STATE property of the window.
 794 This can be achieved by sending a _NET_WM_STATE client message to the
 795 root window.
 796 For example, the following toggles the floating state of
 797 a window using
 798 .Xr wmctrl 1
 799 to send the message (assuming 0x4a0000b is the  id of the window floated
 800 or un-floated):
 801 .Bd -literal -offset indent
 802 $ wmctrl \-i \-r 0x4a0000b \-b toggle,_NET_WM_STATE_ABOVE
 803 .Ed
 804 .Pp
 805 Floating windows can also be resized and moved by sending a
 806 _NET_MOVERESIZE_WINDOW client message to the root window.
 807 For example,
 808 using
 809 .Xr wmctrl 1
 810 to send the message (assuming 0x4a0000b is the id of
 811 the window to be resize/moved):
 812 .Bd -literal -offset indent
 813 $ wmctrl \-i \-r 0x4a0000b \-e 0,100,50,640,480
 814 .Ed
 815 .Pp
 816 This moves the window to (100,50) and resizes it to 640x480.
 817 .Pp
 818 Any _NET_MOVERESIZE_WINDOW events received for stacked windows are ignored.
 819 .Sh SIGNALS
 820 Sending
 821 .Nm
 822 a HUP signal will restart it.
 823 .Sh FILES
 824 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
 825 .It Pa ~/.scrotwm.conf
 826 .Nm
 827 user specific settings.
 828 .It Pa /etc/scrotwm.conf
 829 .Nm
 830 global settings.
 831 .El
 832 .Sh HISTORY
 833 .Nm
 834 was inspired by xmonad & dwm.
 835 .Sh AUTHORS
 836 .An -nosplit
 837 .Nm
 838 was written by:
 839 .Pp
 840 .Bl -tag -width "Ryan Thomas McBride Aq mcbride@countersiege.com " -offset indent -compact
 841 .It Cm Marco Peereboom Aq marco@peereboom.us
 842 .It Cm Ryan Thomas McBride Aq mcbride@countersiege.com
 843 .It Cm Darrin Chandler Aq dwchandler@stilyagin.com
 844 .It Cm Pierre-Yves Ritschard Aq pyr@spootnik.org
 845 .It Cm Tuukka Kataja Aq stuge@xor.fi
 846 .It Cm Jason L. Wright Aq jason@thought.net
 847 .It Cm Reginald Kennedy Aq rk@rejii.com
 848 .El