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