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 Place the statusbar at the bottom of each region instead of the top.
107 Enable or disable displaying the current stacking algorithm in the status bar.
109 Enable or disable displaying the clock in the status bar.
110 Disable by setting to 0
111 so a custom clock could be used in the bar_action script.
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.
122 Set a preferred minimum width for the terminal
123 If this value is greater than 0,
125 will attempt to adjust the font sizes in the terminal to keep the terminal
126 width above this number as the window is resized.
129 is currently supported.
132 binary must not be setuid or setgid, which it is by default on most systems.
133 Users may need to set program[term] (see the
135 section) to use an alternate copy of the
137 binary without the setgid bit set.
138 .It Cm title_class_enabled
139 Enable or disable displaying the window class in the status bar.
140 Enable by setting to 1
141 .It Cm title_name_enabled
142 Enable or disable displaying the window title in the status bar.
143 Enable by setting to 1
144 .It Cm window_name_enabled
145 Enable or disable displaying the window name in the status bar.
146 Enable by setting to 1
149 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
151 Using a value of follow_cursor will make the window manager focus the window
152 under the mouse when switching workspaces and creating windows.
153 .It Cm disable_border
154 Remove border when bar is disabled and there is only one window on the screen.
156 Set window border thickness in pixels.
157 Disable all borders by setting to 0
158 .It Cm program Ns Bq Ar p
159 Define new action to spawn a program
164 .It Cm bind Ns Bq Ar x
165 Bind key combo to action
170 .It Cm quirk Ns Bq Ar c:n
171 Add "quirk" for windows with class
180 Colors need to be specified per the
182 specification and fonts need to be specified per the
186 To list the available fonts in your system see
193 application can help you to show the X Logical Font Description ("XLFD") used
194 as setting in the keyword bar_font.
197 allows you to define custom actions to launch programs of your choice and then
198 bind them the same as with built-in actions.
203 The default programs are described below:
205 .Bl -tag -width "screenshot_wind" -offset indent -compact
208 .It Cm screenshot_all
210 .It Cm screenshot_wind
217 dmenu_run \-fn $bar_font \-nb $bar_color \-nf $bar_font_color \-sb $bar_border \-sf $bar_color
220 Custom programs in the configuration file are specified as follows:
222 .Dl program[<name>] = <progpath> [<arg> [... <arg>]]
225 is any identifier that does not conflict with a built-in action or keyword,
227 is the desired program, and
229 is zero or more arguments to the program.
231 The following variables represent settable values in
234 .Sx CONFIGURATION FILES
236 and may be used in the
238 fields and will be substituted for values at the time the program is spawned:
240 .Bl -tag -width "$bar_font_color" -offset indent -compact
244 .It Cm $bar_font_color
246 .It Cm $color_unfocus
250 .Bd -literal -offset indent
251 program[ff] = /usr/local/bin/firefox http://scrotwm.org/
252 bind[ff] = Mod+f # Now Mod+F launched firefox
255 To undo the previous:
256 .Bd -literal -offset indent
263 provides many functions (or actions) accessed via key or mouse bindings.
265 The current mouse bindings are described below:
267 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
275 Resize window while maintaining it centered
278 The default key bindings are described below:
280 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
281 .It Cm M-S- Ns Aq Cm Return
290 .It Cm M- Ns Aq Cm Space
292 .It Cm M-S- Ns Aq Cm Space
306 .It Cm M- Ns Aq Cm Return
315 .Cm M-S- Ns Aq Cm TAB
332 .It Cm M-S- Ns Aq Ar n
334 .It Cm M- Ns Aq Cm Right
336 .It Cm M- Ns Aq Cm Left
340 .It Cm M-S- Ns Aq Cm Right
342 .It Cm M-S- Ns Aq Cm Left
352 .It Cm M-S Aq Cm Delete
358 The action names and descriptions are listed below:
360 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
386 Add windows to master area
388 Remove windows from master area
390 Add columns/rows to stacking area
392 Remove columns/rows from stacking area
394 Move current window to master area
396 Focus next window in workspace
398 Focus previous window in workspace
400 Focus on main window in workspace
402 Swap with next window in workspace
404 Swap with previous window in workspace
406 Toggle status bar in all workspaces
408 Delete current window in workspace
410 Destroy current window in workspace
418 Move current window to workspace
424 Switch to next workspace with a window in it
426 Switch to previous workspace with a window in it
428 Switch to last visited workspace
430 Move pointer to next region
432 Move pointer to previous region
433 .It Cm screenshot_all
434 Take screenshot of entire screen (if enabled)
438 .It Cm screenshot_wind
439 Take screenshot of selected window (if enabled)
444 Toggle version in status bar
446 Toggle focused window between tiled and floating
453 Reinitialize physical screens
459 Custom bindings in the configuration file are specified as follows:
461 .Dl bind[<action>] = <keys>
464 is one of the actions listed above (or empty) and
466 is in the form of zero or more modifier keys
467 (MOD, Mod1, Shift, etc.) and one or more normal keys
468 (b, space, etc.), separated by "+".
470 .Bd -literal -offset indent
471 bind[reset] = Mod4+q # bind Windows-key + q to reset
472 bind[] = Mod1+q # unbind Alt + q
475 Multiple key combinations may be bound to the same action.
478 provides "quirks" which handle windows that must be treated specially
479 in a tiling window manager, such as some dialogs and fullscreen apps.
481 The default quirks are described below:
483 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
484 .It Firefox\-bin:firefox\-bin
492 .It OpenOffice.org 2.4:VCLSalFrame
494 .It OpenOffice.org 3.1:VCLSalFrame
502 .It xine:xine Video Fullscreen Window
512 The quirks themselves are described below:
514 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
516 This window should not be tiled, but allowed to float freely.
518 Adjusts size on transient windows that are too small using dialog_ratio
520 .Sx CONFIGURATION FILES ) .
522 Allow window to position itself, uncentered.
524 Adjust xterm fonts when resizing.
526 Remove border to allow window to use full screen size.
529 Custom quirks in the configuration file are specified as follows:
531 .Dl quirk[<class>:<name>] = <quirk> [ + <quirk> ... ]
536 specify the window to which the quirk(s) apply, and
538 is one of the quirks from the list above.
540 .Bd -literal -offset indent
541 quirk[MPlayer:xv] = FLOAT + FULLSCREEN # let mplayer play
542 quirk[pcb:pcb] = NONE # remove existing quirk
549 by running xprop(1) and then clicking on the desired window.
550 In the following example the main window of Firefox was clicked:
551 .Bd -literal -offset indent
552 $ xprop | grep WM_CLASS
553 WM_CLASS(STRING) = "Navigator", "Firefox"
556 Note that grepping for WM_CLASS flips class and name.
557 In the example above the quirk entry would be:
558 .Bd -literal -offset indent
559 quirk[Firefox:Navigator] = FLOAT
564 a HUP signal will retstart it.
566 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
567 .It Pa ~/.scrotwm.conf
569 user specific settings.
570 .It Pa /etc/scrotwm.conf
576 was inspired by xmonad & dwm.
582 .An Marco Peereboom Aq marco@peereboom.us ,
583 .An Ryan Thomas McBride Aq mcbride@countersiege.com
585 .An Darrin Chandler Aq dwchandler@stilyagin.com .
587 Currently the menu, invoked with