3 .\" Copyright (c) 2009 Marco Peereboom <marco@peereboom.us>
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 .Nd window manager for X11
27 is a minimalistic window manager that tries to stay out of the way so that
28 valuable screen real estate can be used for much more important stuff.
29 It has sane defaults and does not require one to learn a language to do any
31 It was written by hackers for hackers and it strives to be small, compact and
36 starts up, it reads settings from its configuration file,
39 .Sx CONFIGURATION FILES
42 The following notation is used throughout this page:
44 .Bl -tag -width Ds -offset indent -compact
58 is very simple in its use.
59 Most of the actions are initiated via key or mouse bindings.
62 section below for defaults and customizations.
63 .Sh CONFIGURATION FILES
65 first tries to open the user specific file,
67 If that file is unavailable,
68 it then tries to open the global configuration file
69 .Pa /etc/scrotwm.conf .
71 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
76 Enabling or disabling an option is done by using 1 or 0 respectively.
78 The file supports the following keywords:
80 .Bl -tag -width "screenshot_enabledXXX" -offset indent -compact
82 Border color of the currently focussed window.
84 Border color of unfocussed windows.
86 Enable or disable status bar.
87 .It Cm bar_border Ns Bq Ar x
88 Color of the status bar border in screen
90 .It Cm bar_color Ns Bq Ar x
91 Color of the status bar window in screen
93 .It Cm bar_font_color Ns Bq Ar x
94 Color of the font in status bar in screen
99 External script that populates additional information in the status bar,
100 such as battery life.
102 Update frequency, in seconds, of external script that populates the status bar.
104 Enable or disable displaying the clock in the status bar.
105 Disable by setting to 0
106 so a custom clock could be used in the bar_action script.
108 External application that gets spawned when
109 .Cm M-S- Ns Aq Cm Return
112 Some applications have dialogue windows that are too small to be useful.
113 This ratio is the screen size to what they will be resized.
114 For example, 0.6 is 60% of the physical screen size.
116 Allocates a custom region, removing any autodetected regions which occupy the same
118 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y,
119 e.g.\& screen[1]:800x1200+0+0.
120 .It Cm screenshot_enabled
121 Enable or disable screenshot capability.
122 .It Cm screenshot_app
123 Set to the script that will take screenshots.
124 It will be called with "full" or "window" as parameter 1 to indicate what
125 screenshot action is expected.
126 The script shall handle those cases accordingly.
128 Set a preferred minimum width for the terminal
129 If this value is greater than 0,
131 will attempt to adjust the font sizes in the terminal to keep the terminal
132 width above this number as the window is resized.
135 is currently supported.
138 binary must not be setuid or setgid, which it is by default on most systems.
139 Users may need to set spawn term to use an alternate copy of the
141 binary without the setgid bit set.
144 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
145 .It Cm bind Ns Bq Ar x
146 Bind key combo to action
151 .It Cm quirk Ns Bq Ar c:n
152 Add "quirk" for windows with class
161 Colors need to be specified per the
163 specification and fonts need to be specified per the
168 provides many functions (or actions) accessed via key or mouse bindings.
170 The current mouse bindings are described below:
172 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
180 Resize window while maintaining it centered
183 The default key bindings are described below:
185 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
186 .It Cm M-S- Ns Aq Cm Return
195 .It Cm M- Ns Aq Cm Space
197 .It Cm M-S- Ns Aq Cm Space
211 .It Cm M- Ns Aq Cm Return
220 .Cm M-S- Ns Aq Cm TAB
237 .It Cm M-S- Ns Aq Ar n
239 .It Cm M- Ns Aq Cm Right
241 .It Cm M- Ns Aq Cm Left
243 .It Cm M-S- Ns Aq Cm Right
245 .It Cm M-S- Ns Aq Cm Left
255 .It Cm M-S Aq Cm Delete
261 The action names and descriptions are listed below:
263 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
283 Add windows to master area
285 Remove windows from master area
287 Add columns/rows to stacking area
289 Remove columns/rows from stacking area
291 Move current window to master area
293 Focus next window in workspace
295 Focus previous window in workspace
297 Focus on main window in workspace
299 Swap with next window in workspace
301 Swap with previous window in workspace
303 Toggle status bar in all workspaces
305 Delete current window in workspace
307 Destroy current window in workspace
315 Move current window to workspace
321 Switch to next workspace with a window in it
323 Switch to previous workspace with a window in it
325 Move pointer to next region
327 Move pointer to previous region
328 .It Cm screenshot_all
329 Take screenshot of entire screen (if enabled)
330 .It Cm screenshot_wind
331 Take screenshot of selected window (if enabled)
333 Toggle version in status bar
335 Toggle focused window between tiled and floating
339 Reinitialize physical screens
342 Custom bindings in the configuration file are specified as follows:
344 .Dl bind[<action>] = <keys>
347 is one of the actions listed above (or empty) and
349 is in the form of zero or more modifier keys
350 (MOD, Mod1, Shift, etc.) and one or more normal keys
351 (b, space, etc.), separated by "+".
353 .Bd -literal -offset indent
354 bind[reset] = Mod4+q # bind Windows-key + q to reset
355 bind[] = Mod1+q # unbind Alt + q
358 Multiple key combinations may be bound to the same action.
361 provides "quirks" which handle windows that must be treated specially
362 in a tiling window manager, such as some dialogs and fullscreen apps.
364 The default quirks are described below:
366 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
367 .It Firefox-bin:firefox-bin
375 .It OpenOffice.org 2.4:VCLSalFrame
377 .It OpenOffice.org 3.1:VCLSalFrame
385 .It xine:xine Video Fullscreen Window
395 The quirks themselves are described below:
397 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
399 This window should not be tiled, but allowed to float freely.
401 Adjusts size on transient windows that are too small using dialog_ratio
403 .Sx CONFIGURATION FILES ) .
405 Allow window to position itself, uncentered.
407 Adjust xterm fonts when resizing.
409 Remove border to allow window to use full screen size.
412 Custom quirks in the configuration file are specified as follows:
414 .Dl quirk[<class>:<name>] = <quirk> [ | <quirk> ... ]
419 specify the window to which the quirk(s) apply, and
421 is one of the quirks from the list above.
423 .Bd -literal -offset indent
424 quirk[MPlayer:xv] = FLOAT | FULLSCREEN # let mplayer play
425 quirk[pcb:pcb] = NONE # remove existing quirk
432 must be replaced by an underscore in the configuration.
433 The config entry for "xine:Xine Panel" would be:
434 .Bd -literal -offset indent
435 quirk[xine:Xine_Panel] = FLOAT
442 by running xprop(1) and then clicking on the desired window.
443 In the following example the main window of Firefox was clicked:
444 .Bd -literal -offset indent
445 $ xprop | grep WM_CLASS
446 WM_CLASS(STRING) = "Navigator", "Firefox"
449 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
450 .It Pa ~/.scrotwm.conf
452 user specific settings.
453 .It Pa /etc/scrotwm.conf
459 was inspired by xmonad & dwm.
465 .An Marco Peereboom Aq marco@peereboom.us ,
466 .An Ryan Thomas McBride Aq mcbride@countersiege.com
468 .An Darrin Chandler Aq dwchandler@stilyagin.com .
470 Currently the menu, invoked with