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