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 color_focus
  83 Border color of the currently focussed window.
  84 .It Cm color_unfocus
  85 Border color of unfocussed windows.
  86 .It Cm bar_enabled
  87 Enable or disable status bar.
  88 .It Cm bar_border Ns Bq Ar x
  89 Color of the status bar border in screen
  90 .Ar x .
  91 .It Cm bar_color Ns Bq Ar x
  92 Color of the status bar window in screen
  93 .Ar x .
  94 .It Cm bar_font_color Ns Bq Ar x
  95 Color of the font in status bar in screen
  96 .Ar x .
  97 .It Cm bar_font
  98 Status bar font.
  99 .It Cm bar_action
 100 External script that populates additional information in the status bar,
 101 such as battery life.
 102 .It Cm bar_delay
 103 Update frequency, in seconds, of external script that populates the status bar.
 104 .It Cm bar_at_bottom
 105 Place the statusbar at the bottom of each region instead of the top.
 106 .It Cm stack_enabled
 107 Enable or disable displaying the current stacking algorithm in the status bar.
 108 .It Cm clock_enabled
 109 Enable or disable displaying the clock in the status bar.
 110 Disable by setting to 0
 111 so a custom clock could be used in the bar_action script.
 112 .It Cm dialog_ratio
 113 Some applications have dialogue windows that are too small to be useful.
 114 This ratio is the screen size to what they will be resized.
 115 For example, 0.6 is 60% of the physical screen size.
 116 .It Cm region
 117 Allocates a custom region, removing any autodetected regions which occupy the same
 118 space on the screen.
 119 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y,
 120 e.g.\& screen[1]:800x1200+0+0.
 121 .It Cm term_width
 122 Set a preferred minimum width for the terminal
 123 If this value is greater than 0,
 124 .Nm
 125 will attempt to adjust the font sizes in the terminal to keep the terminal
 126 width above this number as the window is resized.
 127 Only
 128 .Xr xterm 1
 129 is currently supported.
 130 The
 131 .Xr xterm 1
 132 binary must not be setuid or setgid, which it is by default on most systems.
 133 Users may need to set program[term] (see the
 134 .Sx PROGRAMS
 135 section) to use an alternate copy of the
 136 .Xr xterm 1
 137 binary without the setgid bit set.
 138 .It Cm title_class_enabled
 139 Enable or disable displaying the window class in the status bar.
 140 Enable by setting to 1
 141 .It Cm title_name_enabled
 142 Enable or disable displaying the window title in the status bar.
 143 Enable by setting to 1
 144 .It Cm window_name_enabled
 145 Enable or disable displaying the window name in the status bar.
 146 Enable by setting to 1
 147 .It Cm modkey
 148 Change mod key.
 149 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
 150 .It Cm focus_mode
 151 Using a value of follow_cursor will make the window manager focus the window
 152 under the mouse when switching workspaces and creating windows.
 153 .It Cm disable_border
 154 Remove border when bar is disabled and there is only one window on the screen.
 155 .It Cm border_width
 156 Set window border thickness in pixels.
 157 Disable all borders by setting to 0
 158 .It Cm program Ns Bq Ar p
 159 Define new action to spawn a program
 160 .Ar p .
 161 See the
 162 .Sx PROGRAMS
 163 section below.
 164 .It Cm bind Ns Bq Ar x
 165 Bind key combo to action
 166 .Ar x .
 167 See the
 168 .Sx BINDINGS
 169 section below.
 170 .It Cm quirk Ns Bq Ar c:n
 171 Add "quirk" for windows with class
 172 .Ar c
 173 and name
 174 .Ar n .
 175 See the
 176 .Sx QUIRKS
 177 section below.
 178 .El
 179 .Pp
 180 Colors need to be specified per the
 181 .Xr XQueryColor 3
 182 specification and fonts need to be specified per the
 183 .Xr XQueryFont 3
 184 specification.
 185 .Pp
 186 To list the available fonts in your system see
 187 .Xr fc-list 1
 188 or
 189 .Xr xlsfonts 1
 190 manpages.
 191 The
 192 .Xr xfontsel 1
 193 application can help you to show the X Logical Font Description ("XLFD") used
 194 as setting in the keyword bar_font.
 195 .Sh PROGRAMS
 196 .Nm
 197 allows you to define custom actions to launch programs of your choice and then
 198 bind them the same as with built-in actions.
 199 See the
 200 .Sx BINDINGS
 201 section below.
 202 .Pp
 203 The default programs are described below:
 204 .Pp
 205 .Bl -tag -width "screenshot_wind" -offset indent -compact
 206 .It Cm term
 207 xterm
 208 .It Cm screenshot_all
 209 screenshot.sh full
 210 .It Cm screenshot_wind
 211 screenshot.sh window
 212 .It Cm lock
 213 xlock
 214 .It Cm initscr
 215 initscreen.sh
 216 .It Cm menu
 217 dmenu_run \-fn $bar_font \-nb $bar_color \-nf $bar_font_color \-sb $bar_border \-sf $bar_color
 218 .El
 219 .Pp
 220 Custom programs in the configuration file are specified as follows:
 221 .Pp
 222 .Dl program[<name>] = <progpath> [<arg> [... <arg>]]
 223 .Pp
 224 .Aq name
 225 is any identifier that does not conflict with a built-in action or keyword,
 226 .Aq progpath
 227 is the desired program, and
 228 .Aq arg
 229 is zero or more arguments to the program.
 230 .Pp
 231 The following variables represent settable values in
 232 .Nm
 233 (see the
 234 .Sx CONFIGURATION FILES
 235 section above),
 236 and may be used in the
 237 .Aq arg
 238 fields and will be substituted for values at the time the program is spawned:
 239 .Pp
 240 .Bl -tag -width "$bar_font_color" -offset indent -compact
 241 .It Cm $bar_border
 242 .It Cm $bar_color
 243 .It Cm $bar_font
 244 .It Cm $bar_font_color
 245 .It Cm $color_focus
 246 .It Cm $color_unfocus
 247 .El
 248 .Pp
 249 Example:
 250 .Bd -literal -offset indent
 251 program[ff] = /usr/local/bin/firefox http://scrotwm.org/
 252 bind[ff] = Mod+f # Now Mod+F launched firefox
 253 .Ed
 254 .Pp
 255 To undo the previous:
 256 .Bd -literal -offset indent
 257 bind[] = Mod+f
 258 program[ff] =
 259 .Ed
 260 .Pp
 261 .Sh BINDINGS
 262 .Nm
 263 provides many functions (or actions) accessed via key or mouse bindings.
 264 .Pp
 265 The current mouse bindings are described below:
 266 .Pp
 267 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
 268 .It Cm M1
 269 Focus window
 270 .It Cm M-M1
 271 Move window
 272 .It Cm M-M3
 273 Resize window
 274 .It Cm M-S-M3
 275 Resize window while maintaining it centered
 276 .El
 277 .Pp
 278 The default key bindings are described below:
 279 .Pp
 280 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
 281 .It Cm M-S- Ns Aq Cm Return
 282 term
 283 .It Cm M-p
 284 menu
 285 .It Cm M-S-q
 286 quit
 287 .It Cm M-q
 288 restart
 289 .Nm
 290 .It Cm M- Ns Aq Cm Space
 291 cycle_layout
 292 .It Cm M-S- Ns Aq Cm Space
 293 reset_layout
 294 .It Cm M-h
 295 master_shrink
 296 .It Cm M-l
 297 master_grow
 298 .It Cm M-,
 299 master_add
 300 .It Cm M-.
 301 master_del
 302 .It Cm M-S-,
 303 stack_inc
 304 .It Cm M-S-.
 305 stack_del
 306 .It Cm M- Ns Aq Cm Return
 307 swap_main
 308 .It Xo
 309 .Cm M-j ,
 310 .Cm M- Ns Aq Cm TAB
 311 .Xc
 312 focus_next
 313 .It Xo
 314 .Cm M-k ,
 315 .Cm M-S- Ns Aq Cm TAB
 316 .Xc
 317 focus_prev
 318 .It Cm M-m
 319 focus_main
 320 .It Cm M-S-j
 321 swap_next
 322 .It Cm M-S-k
 323 swap_prev
 324 .It Cm M-b
 325 bar_toggle
 326 .It Cm M-x
 327 wind_del
 328 .It Cm M-S-x
 329 wind_kill
 330 .It Cm M- Ns Aq Ar n
 331 .Ns ws_ Ns Ar n
 332 .It Cm M-S- Ns Aq Ar n
 333 .Ns mvws_ Ns Ar n
 334 .It Cm M- Ns Aq Cm Right
 335 ws_next
 336 .It Cm M- Ns Aq Cm Left
 337 ws_prev
 338 .It Cm M-a
 339 ws_prior
 340 .It Cm M-S- Ns Aq Cm Right
 341 screen_next
 342 .It Cm M-S- Ns Aq Cm Left
 343 screen_prev
 344 .It Cm M-s
 345 screenshot_all
 346 .It Cm M-S-s
 347 screenshot_wind
 348 .It Cm M-S-v
 349 version
 350 .It Cm M-t
 351 float_toggle
 352 .It Cm M-S Aq Cm Delete
 353 lock
 354 .It Cm M-S-i
 355 initscr
 356 .El
 357 .Pp
 358 The action names and descriptions are listed below:
 359 .Pp
 360 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
 361 .It Cm term
 362 Spawn a new terminal
 363 (see
 364 .Sx PROGRAMS
 365 above)
 366 .It Cm menu
 367 Menu
 368 (see
 369 .Sx PROGRAMS
 370 above)
 371 .It Cm quit
 372 Quit
 373 .Nm
 374 .It Cm restart
 375 Restart
 376 .Nm
 377 .It Cm cycle_layout
 378 Cycle layout
 379 .It Cm reset_layout
 380 Reset layout
 381 .It Cm master_shrink
 382 Shrink master area
 383 .It Cm master_grow
 384 Grow master area
 385 .It Cm master_add
 386 Add windows to master area
 387 .It Cm master_del
 388 Remove windows from master area
 389 .It Cm stack_inc
 390 Add columns/rows to stacking area
 391 .It Cm stack_del
 392 Remove columns/rows from stacking area
 393 .It Cm swap_main
 394 Move current window to master area
 395 .It Cm focus_next
 396 Focus next window in workspace
 397 .It Cm focus_prev
 398 Focus previous window in workspace
 399 .It Cm focus_main
 400 Focus on main window in workspace
 401 .It Cm swap_next
 402 Swap with next window in workspace
 403 .It Cm swap_prev
 404 Swap with previous window in workspace
 405 .It Cm bar_toggle
 406 Toggle status bar in all workspaces
 407 .It Cm wind_del
 408 Delete current window in workspace
 409 .It Cm wind_kill
 410 Destroy current window in workspace
 411 .It Cm ws_ Ns Ar n
 412 Switch to workspace
 413 .Ar n ,
 414 where
 415 .Ar n
 416 is 1 through 10
 417 .It Cm mvws_ Ns Ar n
 418 Move current window to workspace
 419 .Ar n ,
 420 where
 421 .Ar n
 422 is 1 through 10
 423 .It Cm ws_next
 424 Switch to next workspace with a window in it
 425 .It Cm ws_prev
 426 Switch to previous workspace with a window in it
 427 .It Cm ws_prior
 428 Switch to last visited workspace
 429 .It Cm screen_next
 430 Move pointer to next region
 431 .It Cm screen_prev
 432 Move pointer to previous region
 433 .It Cm screenshot_all
 434 Take screenshot of entire screen (if enabled)
 435 (see
 436 .Sx PROGRAMS
 437 above)
 438 .It Cm screenshot_wind
 439 Take screenshot of selected window (if enabled)
 440 (see
 441 .Sx PROGRAMS
 442 above)
 443 .It Cm version
 444 Toggle version in status bar
 445 .It Cm float_toggle
 446 Toggle focused window between tiled and floating
 447 .It Cm lock
 448 Lock screen
 449 (see
 450 .Sx PROGRAMS
 451 above)
 452 .It Cm initscr
 453 Reinitialize physical screens
 454 (see
 455 .Sx PROGRAMS
 456 above)
 457 .El
 458 .Pp
 459 Custom bindings in the configuration file are specified as follows:
 460 .Pp
 461 .Dl bind[<action>] = <keys>
 462 .Pp
 463 .Aq action
 464 is one of the actions listed above (or empty) and
 465 .Aq keys
 466 is in the form of zero or more modifier keys
 467 (MOD, Mod1, Shift, etc.) and one or more normal keys
 468 (b, space, etc.), separated by "+".
 469 For example:
 470 .Bd -literal -offset indent
 471 bind[reset] = Mod4+q # bind Windows-key + q to reset
 472 bind[] = Mod1+q # unbind Alt + q
 473 .Ed
 474 .Pp
 475 Multiple key combinations may be bound to the same action.
 476 .Sh QUIRKS
 477 .Nm
 478 provides "quirks" which handle windows that must be treated specially
 479 in a tiling window manager, such as some dialogs and fullscreen apps.
 480 .Pp
 481 The default quirks are described below:
 482 .Pp
 483 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
 484 .It Firefox\-bin:firefox\-bin
 485 TRANSSZ
 486 .It Firefox:Dialog
 487 FLOAT
 488 .It Gimp:gimp
 489 FLOAT + ANYWHERE
 490 .It MPlayer:xv
 491 FLOAT + FULLSCREEN
 492 .It OpenOffice.org 2.4:VCLSalFrame
 493 FLOAT
 494 .It OpenOffice.org 3.1:VCLSalFrame
 495 FLOAT
 496 .It pcb:pcb
 497 FLOAT
 498 .It xine:Xine Window
 499 FLOAT + ANYWHERE
 500 .It xine:xine Panel
 501 FLOAT + ANYWHERE
 502 .It xine:xine Video Fullscreen Window
 503 FULLSCREEN + FLOAT
 504 .It Xitk:Xitk Combo
 505 FLOAT + ANYWHERE
 506 .It Xitk:Xine Window
 507 FLOAT + ANYWHERE
 508 .It XTerm:xterm
 509 XTERM_FONTADJ
 510 .El
 511 .Pp
 512 The quirks themselves are described below:
 513 .Pp
 514 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
 515 .It FLOAT
 516 This window should not be tiled, but allowed to float freely.
 517 .It TRANSSZ
 518 Adjusts size on transient windows that are too small using dialog_ratio
 519 (see
 520 .Sx CONFIGURATION FILES ) .
 521 .It ANYWHERE
 522 Allow window to position itself, uncentered.
 523 .It XTERM_FONTADJ
 524 Adjust xterm fonts when resizing.
 525 .It FULLSCREEN
 526 Remove border to allow window to use full screen size.
 527 .El
 528 .Pp
 529 Custom quirks in the configuration file are specified as follows:
 530 .Pp
 531 .Dl quirk[<class>:<name>] = <quirk> [ + <quirk> ... ]
 532 .Pp
 533 .Aq class
 534 and
 535 .Aq name
 536 specify the window to which the quirk(s) apply, and
 537 .Aq quirk
 538 is one of the quirks from the list above.
 539 For example:
 540 .Bd -literal -offset indent
 541 quirk[MPlayer:xv] = FLOAT + FULLSCREEN # let mplayer play
 542 quirk[pcb:pcb] = NONE  # remove existing quirk
 543 .Ed
 544 .Pp
 545 You can obtain
 546 .Aq class
 547 and
 548 .Aq name
 549 by running xprop(1) and then clicking on the desired window.
 550 In the following example the main window of Firefox was clicked:
 551 .Bd -literal -offset indent
 552 $ xprop | grep WM_CLASS
 553 WM_CLASS(STRING) = "Navigator", "Firefox"
 554 .Ed
 555 .Pp
 556 Note that grepping for WM_CLASS flips class and name.
 557 In the example above the quirk entry would be:
 558 .Bd -literal -offset indent
 559 quirk[Firefox:Navigator] = FLOAT
 560 .Ed
 561 .Sh SIGNALS
 562 Sending
 563 .Nm
 564 a HUP signal will retstart it.
 565 .Sh FILES
 566 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
 567 .It Pa ~/.scrotwm.conf
 568 .Nm
 569 user specific settings.
 570 .It Pa /etc/scrotwm.conf
 571 .Nm
 572 global settings.
 573 .El
 574 .Sh HISTORY
 575 .Nm
 576 was inspired by xmonad & dwm.
 577 .Sh AUTHORS
 578 .An -nosplit
 579 .Pp
 580 .Nm
 581 was written by
 582 .An Marco Peereboom Aq marco@peereboom.us ,
 583 .An Ryan Thomas McBride Aq mcbride@countersiege.com
 584 and
 585 .An Darrin Chandler Aq dwchandler@stilyagin.com .
 586 .Sh BUGS
 587 Currently the menu, invoked with
 588 .Cm M-p ,
 589 depends on dmenu.