scrotwm.1

   1 .\"     $scrotwm$
   2 .\"
   3 .\" Copyright (c) 2009 Marco Peereboom <marco@peereboom.us>
   4 .\" Copyright (c) 2009 Darrin Chandler <dwchandler@stilyagin.com>
   5 .\"
   6 .\" Permission to use, copy, modify, and distribute this software for any
   7 .\" purpose with or without fee is hereby granted, provided that the above
   8 .\" copyright notice and this permission notice appear in all copies.
   9 .\"
  10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  11 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  13 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  14 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  15 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  16 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  17 .\"
  18 .Dd $Mdocdate$
  19 .Dt SCROTWM 1
  20 .Os
  21 .Sh NAME
  22 .Nm scrotwm
  23 .Nd window manager for X11
  24 .Sh SYNOPSIS
  25 .Nm scrotwm
  26 .Sh DESCRIPTION
  27 .Nm
  28 is a minimalistic window manager that tries to stay out of the way so that
  29 valuable screen real estate can be used for much more important stuff.
  30 It has sane defaults and does not require one to learn a language to do any
  31 configuration.
  32 It was written by hackers for hackers and it strives to be small, compact and
  33 fast.
  34 .Pp
  35 When
  36 .Nm
  37 starts up, it reads settings from its configuration file,
  38 .Pa scrotwm.conf .
  39 See the
  40 .Sx CONFIGURATION FILES
  41 section below.
  42 .Pp
  43 The following notation is used throughout this page:
  44 .Pp
  45 .Bl -tag -width Ds -offset indent -compact
  46 .It Cm M
  47 Meta
  48 .It Cm S
  49 Shift
  50 .It Aq Cm Name
  51 Named key
  52 .It Cm M1
  53 Mouse button 1
  54 .It Cm M3
  55 Mouse button 3
  56 .El
  57 .Pp
  58 .Nm
  59 is very simple in its use.
  60 Most of the actions are initiated via key or mouse bindings.
  61 See the
  62 .Sx BINDINGS
  63 section below for defaults and customizations.
  64 .Sh CONFIGURATION FILES
  65 .Nm
  66 first tries to open the user specific file,
  67 .Pa ~/.scrotwm.conf .
  68 If that file is unavailable,
  69 it then tries to open the global configuration file
  70 .Pa /etc/scrotwm.conf .
  71 .Pp
  72 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
  73 For example:
  74 .Pp
  75 .Dl color_focus = red
  76 .Pp
  77 Enabling or disabling an option is done by using 1 or 0 respectively.
  78 .Pp
  79 The file supports the following keywords:
  80 .Pp
  81 .Bl -tag -width "title_class_enabledXXX" -offset indent -compact
  82 .It Cm autorun
  83 Launch an application in a specified workspace at start-of-day.
  84 Defined in the format ws[<idx>]:application, e.g. ws[2]:xterm launches and
  85 xterm in workspace 2
  86 .It Cm color_focus
  87 Border color of the currently focussed window.
  88 .It Cm color_unfocus
  89 Border color of unfocussed windows.
  90 .It Cm bar_enabled
  91 Enable or disable status bar.
  92 .It Cm bar_border Ns Bq Ar x
  93 Color of the status bar border in screen
  94 .It Cm bar_border_width
  95 Set status bar border thickness in pixels.
  96 Disable border by setting to 0
  97 .Ar x .
  98 .It Cm bar_color Ns Bq Ar x
  99 Color of the status bar window in screen
 100 .Ar x .
 101 .It Cm bar_font_color Ns Bq Ar x
 102 Color of the font in status bar in screen
 103 .Ar x .
 104 .It Cm bar_font
 105 Status bar font.
 106 .It Cm bar_action
 107 External script that populates additional information in the status bar,
 108 such as battery life.
 109 .It Cm bar_delay
 110 Update frequency, in seconds, of external script that populates the status bar.
 111 .It Cm bar_at_bottom
 112 Place the statusbar at the bottom of each region instead of the top.
 113 .It Cm stack_enabled
 114 Enable or disable displaying the current stacking algorithm in the status bar.
 115 .It Cm clock_enabled
 116 Enable or disable displaying the clock in the status bar.
 117 Disable by setting to 0
 118 so a custom clock could be used in the bar_action script.
 119 .It Cm dialog_ratio
 120 Some applications have dialogue windows that are too small to be useful.
 121 This ratio is the screen size to what they will be resized.
 122 For example, 0.6 is 60% of the physical screen size.
 123 .It Cm layout
 124 select layout to use at start-of-day.
 125 Defined in the format ws[idx]:master_grow:master_add:stack_inc:layout, e.g.
 126 ws[2]:-4:0:1:horizontal sets worskspace 2 to the horizontal stack mode and
 127 shrinks the master area by 4 ticks and adds one window to the stack.
 128 Possible layout values are
 129 .Pa vertical ,
 130 .Pa horizontal
 131 and
 132 .Pa fullscreen .
 133 .Pp
 134 See
 135 .Pa master_grow ,
 136 .Pa master_shrink ,
 137 .Pa master_add ,
 138 .Pa master_del ,
 139 .Pa stack_inc ,
 140 and
 141 .Pa stack_del
 142 for more information.
 143 Note that the stacking options are complicated and have side-effects.
 144 One should familiarize oneself with these commands before experimenting with the
 145 .Pa layout
 146 option.
 147 .Pp
 148 This setting is not retained at restart.
 149 .It Cm region
 150 Allocates a custom region, removing any autodetected regions which occupy the same
 151 space on the screen.
 152 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y,
 153 e.g.\& screen[1]:800x1200+0+0.
 154 .It Cm term_width
 155 Set a preferred minimum width for the terminal
 156 If this value is greater than 0,
 157 .Nm
 158 will attempt to adjust the font sizes in the terminal to keep the terminal
 159 width above this number as the window is resized.
 160 Only
 161 .Xr xterm 1
 162 is currently supported.
 163 The
 164 .Xr xterm 1
 165 binary must not be setuid or setgid, which it is by default on most systems.
 166 Users may need to set program[term] (see the
 167 .Sx PROGRAMS
 168 section) to use an alternate copy of the
 169 .Xr xterm 1
 170 binary without the setgid bit set.
 171 .It Cm title_class_enabled
 172 Enable or disable displaying the window class in the status bar.
 173 Enable by setting to 1
 174 .It Cm title_name_enabled
 175 Enable or disable displaying the window title in the status bar.
 176 Enable by setting to 1
 177 .It Cm window_name_enabled
 178 Enable or disable displaying the window name in the status bar.
 179 Enable by setting to 1
 180 .It Cm modkey
 181 Change mod key.
 182 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
 183 .It Cm focus_mode
 184 Using a value of follow_cursor will make the window manager focus the window
 185 under the mouse when switching workspaces and creating windows.
 186 .It Cm disable_border
 187 Remove border when bar is disabled and there is only one window on the screen.
 188 .It Cm border_width
 189 Set window border thickness in pixels.
 190 Disable all borders by setting to 0
 191 .It Cm program Ns Bq Ar p
 192 Define new action to spawn a program
 193 .Ar p .
 194 See the
 195 .Sx PROGRAMS
 196 section below.
 197 .It Cm bind Ns Bq Ar x
 198 Bind key combo to action
 199 .Ar x .
 200 See the
 201 .Sx BINDINGS
 202 section below.
 203 .It Cm quirk Ns Bq Ar c:n
 204 Add "quirk" for windows with class
 205 .Ar c
 206 and name
 207 .Ar n .
 208 See the
 209 .Sx QUIRKS
 210 section below.
 211 .El
 212 .Pp
 213 Colors need to be specified per the
 214 .Xr XQueryColor 3
 215 specification and fonts need to be specified per the
 216 .Xr XQueryFont 3
 217 specification.
 218 .Pp
 219 To list the available fonts in your system see
 220 .Xr fc-list 1
 221 or
 222 .Xr xlsfonts 1
 223 manpages.
 224 The
 225 .Xr xfontsel 1
 226 application can help you to show the X Logical Font Description ("XLFD") used
 227 as setting in the keyword bar_font.
 228 .Sh PROGRAMS
 229 .Nm
 230 allows you to define custom actions to launch programs of your choice and then
 231 bind them the same as with built-in actions.
 232 See the
 233 .Sx BINDINGS
 234 section below.
 235 .Pp
 236 The default programs are described below:
 237 .Pp
 238 .Bl -tag -width "screenshot_wind" -offset indent -compact
 239 .It Cm term
 240 xterm
 241 .It Cm screenshot_all
 242 screenshot.sh full
 243 .It Cm screenshot_wind
 244 screenshot.sh window
 245 .It Cm lock
 246 xlock
 247 .It Cm initscr
 248 initscreen.sh
 249 .It Cm menu
 250 dmenu_run \-fn $bar_font \-nb $bar_color \-nf $bar_font_color \-sb $bar_border \-sf $bar_color
 251 .El
 252 .Pp
 253 Custom programs in the configuration file are specified as follows:
 254 .Pp
 255 .Dl program[<name>] = <progpath> [<arg> [... <arg>]]
 256 .Pp
 257 .Aq name
 258 is any identifier that does not conflict with a built-in action or keyword,
 259 .Aq progpath
 260 is the desired program, and
 261 .Aq arg
 262 is zero or more arguments to the program.
 263 .Pp
 264 The following variables represent settable values in
 265 .Nm
 266 (see the
 267 .Sx CONFIGURATION FILES
 268 section above),
 269 and may be used in the
 270 .Aq arg
 271 fields and will be substituted for values at the time the program is spawned:
 272 .Pp
 273 .Bl -tag -width "$bar_font_color" -offset indent -compact
 274 .It Cm $bar_border
 275 .It Cm $bar_color
 276 .It Cm $bar_font
 277 .It Cm $bar_font_color
 278 .It Cm $color_focus
 279 .It Cm $color_unfocus
 280 .El
 281 .Pp
 282 Example:
 283 .Bd -literal -offset indent
 284 program[ff] = /usr/local/bin/firefox http://scrotwm.org/
 285 bind[ff] = Mod+f # Now Mod+F launched firefox
 286 .Ed
 287 .Pp
 288 To undo the previous:
 289 .Bd -literal -offset indent
 290 bind[] = Mod+f
 291 program[ff] =
 292 .Ed
 293 .Pp
 294 .Sh BINDINGS
 295 .Nm
 296 provides many functions (or actions) accessed via key or mouse bindings.
 297 .Pp
 298 The current mouse bindings are described below:
 299 .Pp
 300 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
 301 .It Cm M1
 302 Focus window
 303 .It Cm M-M1
 304 Move window
 305 .It Cm M-M3
 306 Resize window
 307 .It Cm M-S-M3
 308 Resize window while maintaining it centered
 309 .El
 310 .Pp
 311 The default key bindings are described below:
 312 .Pp
 313 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
 314 .It Cm M-S- Ns Aq Cm Return
 315 term
 316 .It Cm M-p
 317 menu
 318 .It Cm M-S-q
 319 quit
 320 .It Cm M-q
 321 restart
 322 .Nm
 323 .It Cm M- Ns Aq Cm Space
 324 cycle_layout
 325 .It Cm M-S- Ns Aq Cm Space
 326 reset_layout
 327 .It Cm M-h
 328 master_shrink
 329 .It Cm M-l
 330 master_grow
 331 .It Cm M-,
 332 master_add
 333 .It Cm M-.
 334 master_del
 335 .It Cm M-S-,
 336 stack_inc
 337 .It Cm M-S-.
 338 stack_del
 339 .It Cm M- Ns Aq Cm Return
 340 swap_main
 341 .It Xo
 342 .Cm M-j ,
 343 .Cm M- Ns Aq Cm TAB
 344 .Xc
 345 focus_next
 346 .It Xo
 347 .Cm M-k ,
 348 .Cm M-S- Ns Aq Cm TAB
 349 .Xc
 350 focus_prev
 351 .It Cm M-m
 352 focus_main
 353 .It Cm M-S-j
 354 swap_next
 355 .It Cm M-S-k
 356 swap_prev
 357 .It Cm M-b
 358 bar_toggle
 359 .It Cm M-x
 360 wind_del
 361 .It Cm M-S-x
 362 wind_kill
 363 .It Cm M- Ns Aq Ar n
 364 .Ns ws_ Ns Ar n
 365 .It Cm M-S- Ns Aq Ar n
 366 .Ns mvws_ Ns Ar n
 367 .It Cm M- Ns Aq Cm Right
 368 ws_next
 369 .It Cm M- Ns Aq Cm Left
 370 ws_prev
 371 .It Cm M-a
 372 ws_prior
 373 .It Cm M-S- Ns Aq Cm Right
 374 screen_next
 375 .It Cm M-S- Ns Aq Cm Left
 376 screen_prev
 377 .It Cm M-s
 378 screenshot_all
 379 .It Cm M-S-s
 380 screenshot_wind
 381 .It Cm M-S-v
 382 version
 383 .It Cm M-t
 384 float_toggle
 385 .It Cm M-S- Ns Aq Cm Delete
 386 lock
 387 .It Cm M-S-i
 388 initscr
 389 .It Cm M-w
 390 iconify
 391 .It Cm M-S-w
 392 uniconify
 393 .El
 394 .Pp
 395 The action names and descriptions are listed below:
 396 .Pp
 397 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
 398 .It Cm term
 399 Spawn a new terminal
 400 (see
 401 .Sx PROGRAMS
 402 above)
 403 .It Cm menu
 404 Menu
 405 (see
 406 .Sx PROGRAMS
 407 above)
 408 .It Cm quit
 409 Quit
 410 .Nm
 411 .It Cm restart
 412 Restart
 413 .Nm
 414 .It Cm cycle_layout
 415 Cycle layout
 416 .It Cm reset_layout
 417 Reset layout
 418 .It Cm master_shrink
 419 Shrink master area
 420 .It Cm master_grow
 421 Grow master area
 422 .It Cm master_add
 423 Add windows to master area
 424 .It Cm master_del
 425 Remove windows from master area
 426 .It Cm stack_inc
 427 Add columns/rows to stacking area
 428 .It Cm stack_del
 429 Remove columns/rows from stacking area
 430 .It Cm swap_main
 431 Move current window to master area
 432 .It Cm focus_next
 433 Focus next window in workspace
 434 .It Cm focus_prev
 435 Focus previous window in workspace
 436 .It Cm focus_main
 437 Focus on main window in workspace
 438 .It Cm swap_next
 439 Swap with next window in workspace
 440 .It Cm swap_prev
 441 Swap with previous window in workspace
 442 .It Cm bar_toggle
 443 Toggle status bar in all workspaces
 444 .It Cm wind_del
 445 Delete current window in workspace
 446 .It Cm wind_kill
 447 Destroy current window in workspace
 448 .It Cm ws_ Ns Ar n
 449 Switch to workspace
 450 .Ar n ,
 451 where
 452 .Ar n
 453 is 1 through 10
 454 .It Cm mvws_ Ns Ar n
 455 Move current window to workspace
 456 .Ar n ,
 457 where
 458 .Ar n
 459 is 1 through 10
 460 .It Cm ws_next
 461 Switch to next workspace with a window in it
 462 .It Cm ws_prev
 463 Switch to previous workspace with a window in it
 464 .It Cm ws_prior
 465 Switch to last visited workspace
 466 .It Cm screen_next
 467 Move pointer to next region
 468 .It Cm screen_prev
 469 Move pointer to previous region
 470 .It Cm screenshot_all
 471 Take screenshot of entire screen (if enabled)
 472 (see
 473 .Sx PROGRAMS
 474 above)
 475 .It Cm screenshot_wind
 476 Take screenshot of selected window (if enabled)
 477 (see
 478 .Sx PROGRAMS
 479 above)
 480 .It Cm version
 481 Toggle version in status bar
 482 .It Cm float_toggle
 483 Toggle focused window between tiled and floating
 484 .It Cm lock
 485 Lock screen
 486 (see
 487 .Sx PROGRAMS
 488 above)
 489 .It Cm initscr
 490 Reinitialize physical screens
 491 (see
 492 .Sx PROGRAMS
 493 above)
 494 .It Cm iconify
 495 Minimize (unmap) currently focused window.
 496 .It Cm uniconify
 497 Maximize (map) window returned by dmenu selection.
 498 .El
 499 .Pp
 500 Custom bindings in the configuration file are specified as follows:
 501 .Pp
 502 .Dl bind[<action>] = <keys>
 503 .Pp
 504 .Aq action
 505 is one of the actions listed above (or empty) and
 506 .Aq keys
 507 is in the form of zero or more modifier keys
 508 (MOD, Mod1, Shift, etc.) and one or more normal keys
 509 (b, space, etc.), separated by "+".
 510 For example:
 511 .Bd -literal -offset indent
 512 bind[reset] = Mod4+q # bind Windows-key + q to reset
 513 bind[] = Mod1+q # unbind Alt + q
 514 .Ed
 515 .Pp
 516 Multiple key combinations may be bound to the same action.
 517 .Sh QUIRKS
 518 .Nm
 519 provides "quirks" which handle windows that must be treated specially
 520 in a tiling window manager, such as some dialogs and fullscreen apps.
 521 .Pp
 522 The default quirks are described below:
 523 .Pp
 524 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
 525 .It Firefox\-bin:firefox\-bin
 526 TRANSSZ
 527 .It Firefox:Dialog
 528 FLOAT
 529 .It Gimp:gimp
 530 FLOAT + ANYWHERE
 531 .It MPlayer:xv
 532 FLOAT + FULLSCREEN + FOCUSPREV
 533 .It OpenOffice.org 2.4:VCLSalFrame
 534 FLOAT
 535 .It OpenOffice.org 3.1:VCLSalFrame
 536 FLOAT
 537 .It pcb:pcb
 538 FLOAT
 539 .It xine:Xine Window
 540 FLOAT + ANYWHERE
 541 .It xine:xine Panel
 542 FLOAT + ANYWHERE
 543 .It xine:xine Video Fullscreen Window
 544 FULLSCREEN + FLOAT
 545 .It Xitk:Xitk Combo
 546 FLOAT + ANYWHERE
 547 .It Xitk:Xine Window
 548 FLOAT + ANYWHERE
 549 .It XTerm:xterm
 550 XTERM_FONTADJ
 551 .El
 552 .Pp
 553 The quirks themselves are described below:
 554 .Pp
 555 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
 556 .It FLOAT
 557 This window should not be tiled, but allowed to float freely.
 558 .It TRANSSZ
 559 Adjusts size on transient windows that are too small using dialog_ratio
 560 (see
 561 .Sx CONFIGURATION FILES ) .
 562 .It ANYWHERE
 563 Allow window to position itself, uncentered.
 564 .It XTERM_FONTADJ
 565 Adjust xterm fonts when resizing.
 566 .It FULLSCREEN
 567 Remove border to allow window to use full screen size.
 568 .It FOCUSPREV
 569 On exit force focus on previously focused application not previous application
 570 in the stack.
 571 .El
 572 .Pp
 573 Custom quirks in the configuration file are specified as follows:
 574 .Pp
 575 .Dl quirk[<class>:<name>] = <quirk> [ + <quirk> ... ]
 576 .Pp
 577 .Aq class
 578 and
 579 .Aq name
 580 specify the window to which the quirk(s) apply, and
 581 .Aq quirk
 582 is one of the quirks from the list above.
 583 For example:
 584 .Bd -literal -offset indent
 585 quirk[MPlayer:xv] = FLOAT + FULLSCREEN + FOCUSPREV
 586 quirk[pcb:pcb] = NONE  # remove existing quirk
 587 .Ed
 588 .Pp
 589 You can obtain
 590 .Aq class
 591 and
 592 .Aq name
 593 by running xprop(1) and then clicking on the desired window.
 594 In the following example the main window of Firefox was clicked:
 595 .Bd -literal -offset indent
 596 $ xprop | grep WM_CLASS
 597 WM_CLASS(STRING) = "Navigator", "Firefox"
 598 .Ed
 599 .Pp
 600 Note that grepping for WM_CLASS flips class and name.
 601 In the example above the quirk entry would be:
 602 .Bd -literal -offset indent
 603 quirk[Firefox:Navigator] = FLOAT
 604 .Ed
 605 .Sh SIGNALS
 606 Sending
 607 .Nm
 608 a HUP signal will retstart it.
 609 .Sh FILES
 610 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
 611 .It Pa ~/.scrotwm.conf
 612 .Nm
 613 user specific settings.
 614 .It Pa /etc/scrotwm.conf
 615 .Nm
 616 global settings.
 617 .El
 618 .Sh HISTORY
 619 .Nm
 620 was inspired by xmonad & dwm.
 621 .Sh AUTHORS
 622 .An -nosplit
 623 .Pp
 624 .Nm
 625 was written by
 626 .An Marco Peereboom Aq marco@peereboom.us ,
 627 .An Ryan Thomas McBride Aq mcbride@countersiege.com
 628 and
 629 .An Darrin Chandler Aq dwchandler@stilyagin.com .
 630 .Sh BUGS
 631 Currently the menu, invoked with
 632 .Cm M-p ,
 633 depends on dmenu.