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 "title_class_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 current stacking algorithm in the status bar.
107 Enable or disable displaying the clock in the status bar.
108 Disable by setting to 0
109 so a custom clock could be used in the bar_action script.
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,
118 e.g.\& screen[1]:800x1200+0+0.
120 Set a preferred minimum width for the terminal
121 If this value is greater than 0,
123 will attempt to adjust the font sizes in the terminal to keep the terminal
124 width above this number as the window is resized.
127 is currently supported.
130 binary must not be setuid or setgid, which it is by default on most systems.
131 Users may need to set program[term] (see the
133 section) to use an alternate copy of the
135 binary without the setgid bit set.
136 .It Cm title_class_enabled
137 Enable or disable displaying the window class in the status bar.
138 Enable by setting to 1
139 .It Cm title_name_enabled
140 Enable or disable displaying the window title in the status bar.
141 Enable by setting to 1
144 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
146 Using a value of follow_cursor will make the window manager focus the window
147 under the mouse when switching workspaces and creating windows.
148 .It Cm program Ns Bq Ar p
149 Define new action to spawn a program
154 .It Cm bind Ns Bq Ar x
155 Bind key combo to action
160 .It Cm quirk Ns Bq Ar c:n
161 Add "quirk" for windows with class
170 Colors need to be specified per the
172 specification and fonts need to be specified per the
177 allows you to define custom actions to launch programs of your choice and then
178 bind them the same as with built-in actions.
183 The default programs are described below:
185 .Bl -tag -width "screenshot_wind" -offset indent -compact
188 .It Cm screenshot_all
190 .It Cm screenshot_wind
197 dmenu_run \-fn $bar_font \-nb $bar_color \-nf $bar_font_color \-sb $bar_border \-sf $bar_color
200 Custom programs in the configuration file are specified as follows:
202 .Dl program[<name>] = <progpath> [<arg> [... <arg>]]
205 is any identifier that does not conflict with a built-in action or keyword,
207 is the desired program, and
209 is zero or more arguments to the program.
211 The following variables represent settable values in
214 .Sx CONFIGURATION FILES
216 and may be used in the
218 fields and will be substituted for values at the time the program is spawned:
220 .Bl -tag -width "$bar_font_color" -offset indent -compact
224 .It Cm $bar_font_color
226 .It Cm $color_unfocus
230 .Bd -literal -offset indent
231 program[ff] = /usr/local/bin/firefox http://scrotwm.org/
232 bind[ff] = Mod+f # Now Mod+F launched firefox
235 To undo the previous:
236 .Bd -literal -offset indent
243 provides many functions (or actions) accessed via key or mouse bindings.
245 The current mouse bindings are described below:
247 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
255 Resize window while maintaining it centered
258 The default key bindings are described below:
260 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
261 .It Cm M-S- Ns Aq Cm Return
270 .It Cm M- Ns Aq Cm Space
272 .It Cm M-S- Ns Aq Cm Space
286 .It Cm M- Ns Aq Cm Return
295 .Cm M-S- Ns Aq Cm TAB
312 .It Cm M-S- Ns Aq Ar n
314 .It Cm M- Ns Aq Cm Right
316 .It Cm M- Ns Aq Cm Left
320 .It Cm M-S- Ns Aq Cm Right
322 .It Cm M-S- Ns Aq Cm Left
332 .It Cm M-S Aq Cm Delete
338 The action names and descriptions are listed below:
340 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
366 Add windows to master area
368 Remove windows from master area
370 Add columns/rows to stacking area
372 Remove columns/rows from stacking area
374 Move current window to master area
376 Focus next window in workspace
378 Focus previous window in workspace
380 Focus on main window in workspace
382 Swap with next window in workspace
384 Swap with previous window in workspace
386 Toggle status bar in all workspaces
388 Delete current window in workspace
390 Destroy current window in workspace
398 Move current window to workspace
404 Switch to next workspace with a window in it
406 Switch to previous workspace with a window in it
408 Switch to last visited workspace
410 Move pointer to next region
412 Move pointer to previous region
413 .It Cm screenshot_all
414 Take screenshot of entire screen (if enabled)
418 .It Cm screenshot_wind
419 Take screenshot of selected window (if enabled)
424 Toggle version in status bar
426 Toggle focused window between tiled and floating
433 Reinitialize physical screens
439 Custom bindings in the configuration file are specified as follows:
441 .Dl bind[<action>] = <keys>
444 is one of the actions listed above (or empty) and
446 is in the form of zero or more modifier keys
447 (MOD, Mod1, Shift, etc.) and one or more normal keys
448 (b, space, etc.), separated by "+".
450 .Bd -literal -offset indent
451 bind[reset] = Mod4+q # bind Windows-key + q to reset
452 bind[] = Mod1+q # unbind Alt + q
455 Multiple key combinations may be bound to the same action.
458 provides "quirks" which handle windows that must be treated specially
459 in a tiling window manager, such as some dialogs and fullscreen apps.
461 The default quirks are described below:
463 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
464 .It Firefox\-bin:firefox\-bin
472 .It OpenOffice.org 2.4:VCLSalFrame
474 .It OpenOffice.org 3.1:VCLSalFrame
482 .It xine:xine Video Fullscreen Window
492 The quirks themselves are described below:
494 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
496 This window should not be tiled, but allowed to float freely.
498 Adjusts size on transient windows that are too small using dialog_ratio
500 .Sx CONFIGURATION FILES ) .
502 Allow window to position itself, uncentered.
504 Adjust xterm fonts when resizing.
506 Remove border to allow window to use full screen size.
509 Custom quirks in the configuration file are specified as follows:
511 .Dl quirk[<class>:<name>] = <quirk> [ + <quirk> ... ]
516 specify the window to which the quirk(s) apply, and
518 is one of the quirks from the list above.
520 .Bd -literal -offset indent
521 quirk[MPlayer:xv] = FLOAT + FULLSCREEN # let mplayer play
522 quirk[pcb:pcb] = NONE # remove existing quirk
529 by running xprop(1) and then clicking on the desired window.
530 In the following example the main window of Firefox was clicked:
531 .Bd -literal -offset indent
532 $ xprop | grep WM_CLASS
533 WM_CLASS(STRING) = "Navigator", "Firefox"
536 Note that grepping for WM_CLASS flips class and name.
537 In the example above the quirk entry would be:
538 .Bd -literal -offset indent
539 quirk[Firefox:Navigator] = FLOAT
542 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
543 .It Pa ~/.scrotwm.conf
545 user specific settings.
546 .It Pa /etc/scrotwm.conf
552 was inspired by xmonad & dwm.
558 .An Marco Peereboom Aq marco@peereboom.us ,
559 .An Ryan Thomas McBride Aq mcbride@countersiege.com
561 .An Darrin Chandler Aq dwchandler@stilyagin.com .
563 Currently the menu, invoked with