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. Disable by
105 setting to 0 so a custom clock could be used in the bar_action script.
107 External application that gets spawned when
108 .Cm M-S- Ns Aq Cm Return
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.
115 Allocates a custom region, removing any autodetected regions which occupy the same
117 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y, e.g. screen[1]:800x1200+0+0.
118 .It Cm screenshot_enabled
119 Enable or disable screenshot capability.
120 .It Cm screenshot_app
121 Set to the script that will take screenshots.
122 It will be called with "full" or "window" as parameter 1 to indicate what
123 screenshot action is expected.
124 The script shall handle those cases accordingly.
126 Set a preferred minimum width for the terminal
127 If this value is greater than 0,
129 will attempt to adjust the font sizes in the terminal to keep the terminal
130 width above this number as the window is resized.
133 is currently supported.
136 binary must not be setuid or setgid, which it is by default on most systems.
137 Users may need to set spawn term to use an alternate copy of the
139 binary without the setgid bit set.
142 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
143 .It Cm bind Ns Bq Ar x
144 Bind key combo to action
151 Colors need to be specified per the
153 specification and fonts need to be specified per the
158 provides many functions (or actions) accessed via key or mouse bindings.
160 The current mouse bindings are described below:
162 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
170 Resize window while maintaining it centered
173 The default key bindings are described below:
175 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
176 .It Cm M-S- Ns Aq Cm Return
185 .It Cm M- Ns Aq Cm Space
187 .It Cm M-S- Ns Aq Cm Space
201 .It Cm M- Ns Aq Cm Return
210 .Cm M-S- Ns Aq Cm TAB
227 .It Cm M-S- Ns Aq Ar n
229 .It Cm M- Ns Aq Cm Right
231 .It Cm M- Ns Aq Cm Left
233 .It Cm M-S- Ns Aq Cm Right
235 .It Cm M-S- Ns Aq Cm Left
245 .It Cm M-S Aq Cm Delete
251 The action names and descriptions are listed below:
253 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
273 Add windows to master area
275 Remove windows from master area
277 Add columns/rows to stacking area
279 Remove columns/rows from stacking area
281 Move current window to master area
283 Focus next window in workspace
285 Focus previous window in workspace
287 Focus on main window in workspace
289 Swap with next window in workspace
291 Swap with previous window in workspace
293 Toggle status bar in all workspaces
295 Delete current window in workspace
297 Destroy current window in workspace
305 Move current window to workspace
311 Switch to next workspace with a window in it
313 Switch to previous workspace with a window in it
315 Move pointer to next region
317 Move pointer to previous region
318 .It Cm screenshot_all
319 Take screenshot of entire screen (if enabled)
320 .It Cm screenshot_wind
321 Take screenshot of selected window (if enabled)
323 Toggle version in status bar
325 Toggle focused window between tiled and floating
329 Reinitialize physical screens
332 Custom bindings in the configuration file are specified as follows:
334 .Dl bind[<action>] = <keys>
337 is one of the actions listed above (or empty) and
339 is in the form of zero or more modifier keys
340 (MOD, Mod1, Shift, etc.) and one or more normal keys
341 (b, space, etc.), separated by "+". For example:
342 .Bd -literal -offset indent
343 bind[reset] = Mod4+q # bind Windows-key + q to reset
344 bind[] = Mod1+q # unbind Alt + q
347 Multiple key combinations may be bound to the same action.
349 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
350 .It Pa ~/.scrotwm.conf
352 user specific settings.
353 .It Pa /etc/scrotwm.conf
359 was inspired by xmonad & dwm.
365 .An Marco Peereboom Aq marco@peereboom.us ,
366 .An Ryan Thomas McBride Aq mcbride@countersiege.com
368 .An Darrin Chandler Aq dwchandler@stilyagin.com .
370 Currently the menu, invoked with