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 keybindings.
60 The current keybindings are described below:
62 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
63 .It Cm M-S- Ns Aq Cm Return
72 .It Cm M- Ns Aq Cm Space
74 .It Cm M-S- Ns Aq Cm Space
81 Add windows to master area
83 Remove windows from master area
85 Add columns/rows to stacking area
87 Remove columns/rows from stacking area
88 .It Cm M- Ns Aq Cm Return
89 Move current window to master area
94 Focus next window in workspace
99 Focus previous window in workspace
101 Focus on main window in workspace
103 Swap with next window in workspace
105 Swap with previous window in workspace
107 Toggle status bar in all workspaces
109 Delete current window in workspace
111 Destroy current window in workspace
115 .It Cm M-S- Ns Aq Ar n
116 Move current window to workspace
118 .It Cm M- Ns Aq Cm Right
119 Switch to next workspace with a window in it
120 .It Cm M- Ns Aq Cm Left
121 Switch to previous workspace with a window in it
122 .It Cm M-S- Ns Aq Cm Right
123 Move pointer to next region
124 .It Cm M-S- Ns Aq Cm Left
125 Move pointer to previous region
127 Take screenshot of entire screen (if enabled)
129 Take screenshot of selected window (if enabled)
131 Toggle version in status bar
133 Toggle focused window between tiled and floating
134 .It Cm M-S Aq Cm Delete
137 Reinitialize physical screens
145 Resize window while maintaining it centered
147 .Sh CONFIGURATION FILES
149 first tries to open the user specific file,
150 .Pa ~/.scrotwm.conf .
151 If that file is unavailable,
152 it then tries to open the global configuration file
153 .Pa /etc/scrotwm.conf .
155 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
158 .Dl color_focus = red
160 Enabling or disabling an option is done by using 1 or 0 respectively.
162 The file supports the following keywords:
164 .Bl -tag -width "screenshot_enabledXXX" -offset indent -compact
166 Border color of the currently focussed window.
168 Border color of unfocussed windows.
170 Enable or disable status bar.
171 .It Cm bar_border Ns Bq Ar x
172 Color of the status bar border in screen
174 .It Cm bar_color Ns Bq Ar x
175 Color of the status bar window in screen
177 .It Cm bar_font_color Ns Bq Ar x
178 Color of the font in status bar in screen
183 External script that populates additional information in the status bar,
184 such as battery life.
186 Update frequency, in seconds, of external script that populates the status bar.
188 External application that gets spawned when
189 .Cm M-S- Ns Aq Cm Return
192 Some applications have dialogue windows that are too small to be useful.
193 This ratio is the screen size to what they will be resized.
194 For example, 0.6 is 60% of the physical screen size.
196 Allocates a custom region, removing any autodetected regions which occupy the same
198 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y, e.g. screen[1]:800x1200+0+0.
199 .It Cm screenshot_enabled
200 Enable or disable screenshot capability.
201 .It Cm screenshot_app
202 Set to the script that will take screenshots.
203 It will be called with "full" or "window" as parameter 1 to indicate what
204 screenshot action is expected.
205 The script shall handle those cases accordingly.
207 Set a preferred minimum width for the terminal
208 If this value is greater than 0,
210 will attempt to adjust the font sizes in the terminal to keep the terminal
211 width above this number as the window is resized.
214 is currently supported.
217 binary must not be setuid or setgid, which it is by default on most systems.
218 Users may need to set spawn term to use an alternate copy of the
220 binary without the setgid bit set.
223 Colors need to be specified per the
225 specification and fonts need to be specified per the
229 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
230 .It Pa ~/.scrotwm.conf
232 user specific settings.
233 .It Pa /etc/scrotwm.conf
239 was inspired by xmonad & dwm.
245 .An Marco Peereboom Aq marco@peereboom.us
247 .An Ryan Thomas McBride Aq mcbride@countersiege.com .
249 Currently the menu, invoked with