3 .\" Copyright (c) 2009 Marco Peereboom <marco@peereboom.us>
4 .\" Copyright (c) 2009 Darrin Chandler <dwchandler@stilyagin.com>
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.
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.
23 .Nd window manager for X11
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
32 It was written by hackers for hackers and it strives to be small, compact and
37 starts up, it reads settings from its configuration file,
40 .Sx CONFIGURATION FILES
43 The following notation is used throughout this page:
45 .Bl -tag -width Ds -offset indent -compact
59 is very simple in its use.
60 Most of the actions are initiated via key or mouse bindings.
63 section below for defaults and customizations.
64 .Sh CONFIGURATION FILES
66 first tries to open the user specific file,
68 If that file is unavailable,
69 it then tries to open the global configuration file
70 .Pa /etc/scrotwm.conf .
72 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
77 Enabling or disabling an option is done by using 1 or 0 respectively.
79 The file supports the following keywords:
81 .Bl -tag -width "screenshot_enabledXXX" -offset indent -compact
83 Border color of the currently focussed window.
85 Border color of unfocussed windows.
87 Enable or disable status bar.
88 .It Cm bar_border Ns Bq Ar x
89 Color of the status bar border in screen
91 .It Cm bar_color Ns Bq Ar x
92 Color of the status bar window in screen
94 .It Cm bar_font_color Ns Bq Ar x
95 Color of the font in status bar in screen
100 External script that populates additional information in the status bar,
101 such as battery life.
103 Update frequency, in seconds, of external script that populates the status bar.
105 Enable or disable displaying the clock in the status bar.
106 Disable by setting to 0
107 so a custom clock could be used in the bar_action script.
109 External application that gets spawned when
110 .Cm M-S- Ns Aq Cm Return
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.
117 Allocates a custom region, removing any autodetected regions which occupy the same
119 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y,
120 e.g.\& screen[1]:800x1200+0+0.
121 .It Cm screenshot_enabled
122 Enable or disable screenshot capability.
123 .It Cm screenshot_app
124 Set to the script that will take screenshots.
125 It will be called with "full" or "window" as parameter 1 to indicate what
126 screenshot action is expected.
127 The script shall handle those cases accordingly.
129 Set a preferred minimum width for the terminal
130 If this value is greater than 0,
132 will attempt to adjust the font sizes in the terminal to keep the terminal
133 width above this number as the window is resized.
136 is currently supported.
139 binary must not be setuid or setgid, which it is by default on most systems.
140 Users may need to set spawn term to use an alternate copy of the
142 binary without the setgid bit set.
145 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
146 .It Cm bind Ns Bq Ar x
147 Bind key combo to action
152 .It Cm quirk Ns Bq Ar c:n
153 Add "quirk" for windows with class
162 Colors need to be specified per the
164 specification and fonts need to be specified per the
169 provides many functions (or actions) accessed via key or mouse bindings.
171 The current mouse bindings are described below:
173 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
181 Resize window while maintaining it centered
184 The default key bindings are described below:
186 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
187 .It Cm M-S- Ns Aq Cm Return
196 .It Cm M- Ns Aq Cm Space
198 .It Cm M-S- Ns Aq Cm Space
212 .It Cm M- Ns Aq Cm Return
221 .Cm M-S- Ns Aq Cm TAB
238 .It Cm M-S- Ns Aq Ar n
240 .It Cm M- Ns Aq Cm Right
242 .It Cm M- Ns Aq Cm Left
244 .It Cm M-S- Ns Aq Cm Right
246 .It Cm M-S- Ns Aq Cm Left
256 .It Cm M-S Aq Cm Delete
262 The action names and descriptions are listed below:
264 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
284 Add windows to master area
286 Remove windows from master area
288 Add columns/rows to stacking area
290 Remove columns/rows from stacking area
292 Move current window to master area
294 Focus next window in workspace
296 Focus previous window in workspace
298 Focus on main window in workspace
300 Swap with next window in workspace
302 Swap with previous window in workspace
304 Toggle status bar in all workspaces
306 Delete current window in workspace
308 Destroy current window in workspace
316 Move current window to workspace
322 Switch to next workspace with a window in it
324 Switch to previous workspace with a window in it
326 Move pointer to next region
328 Move pointer to previous region
329 .It Cm screenshot_all
330 Take screenshot of entire screen (if enabled)
331 .It Cm screenshot_wind
332 Take screenshot of selected window (if enabled)
334 Toggle version in status bar
336 Toggle focused window between tiled and floating
340 Reinitialize physical screens
343 Custom bindings in the configuration file are specified as follows:
345 .Dl bind[<action>] = <keys>
348 is one of the actions listed above (or empty) and
350 is in the form of zero or more modifier keys
351 (MOD, Mod1, Shift, etc.) and one or more normal keys
352 (b, space, etc.), separated by "+".
354 .Bd -literal -offset indent
355 bind[reset] = Mod4+q # bind Windows-key + q to reset
356 bind[] = Mod1+q # unbind Alt + q
359 Multiple key combinations may be bound to the same action.
362 provides "quirks" which handle windows that must be treated specially
363 in a tiling window manager, such as some dialogs and fullscreen apps.
365 The default quirks are described below:
367 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
368 .It Firefox-bin:firefox-bin
376 .It OpenOffice.org 2.4:VCLSalFrame
378 .It OpenOffice.org 3.1:VCLSalFrame
386 .It xine:xine Video Fullscreen Window
396 The quirks themselves are described below:
398 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
400 This window should not be tiled, but allowed to float freely.
402 Adjusts size on transient windows that are too small using dialog_ratio
404 .Sx CONFIGURATION FILES ) .
406 Allow window to position itself, uncentered.
408 Adjust xterm fonts when resizing.
410 Remove border to allow window to use full screen size.
413 Custom quirks in the configuration file are specified as follows:
415 .Dl quirk[<class>:<name>] = <quirk> [ | <quirk> ... ]
420 specify the window to which the quirk(s) apply, and
422 is one of the quirks from the list above.
424 .Bd -literal -offset indent
425 quirk[MPlayer:xv] = FLOAT | FULLSCREEN # let mplayer play
426 quirk[pcb:pcb] = NONE # remove existing quirk
433 must be replaced by an underscore in the configuration.
434 The config entry for "xine:Xine Panel" would be:
435 .Bd -literal -offset indent
436 quirk[xine:Xine_Panel] = FLOAT
443 by running xprop(1) and then clicking on the desired window.
444 In the following example the main window of Firefox was clicked:
445 .Bd -literal -offset indent
446 $ xprop | grep WM_CLASS
447 WM_CLASS(STRING) = "Navigator", "Firefox"
450 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
451 .It Pa ~/.scrotwm.conf
453 user specific settings.
454 .It Pa /etc/scrotwm.conf
460 was inspired by xmonad & dwm.
466 .An Marco Peereboom Aq marco@peereboom.us ,
467 .An Ryan Thomas McBride Aq mcbride@countersiege.com
469 .An Darrin Chandler Aq dwchandler@stilyagin.com .
471 Currently the menu, invoked with