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