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 Launch an application in a specified workspace at start-of-day.
84 Currently this option does not support arguments so if those are required one
85 must use a wrapper script.
86 Defined in the format ws[<idx>]:application, e.g. ws[2]:xterm launches and
89 Border color of the currently focussed window.
91 Border color of unfocussed windows.
93 Enable or disable status bar.
94 .It Cm bar_border Ns Bq Ar x
95 Color of the status bar border in screen
96 .It Cm bar_border_width
97 Set status bar border thickness in pixels.
98 Disable border by setting to 0
100 .It Cm bar_color Ns Bq Ar x
101 Color of the status bar window in screen
103 .It Cm bar_font_color Ns Bq Ar x
104 Color of the font in status bar in screen
109 External script that populates additional information in the status bar,
110 such as battery life.
112 Update frequency, in seconds, of external script that populates the status bar.
114 Place the statusbar at the bottom of each region instead of the top.
116 Enable or disable displaying the current stacking algorithm in the status bar.
118 Enable or disable displaying the clock in the status bar.
119 Disable by setting to 0
120 so a custom clock could be used in the bar_action script.
122 Some applications have dialogue windows that are too small to be useful.
123 This ratio is the screen size to what they will be resized.
124 For example, 0.6 is 60% of the physical screen size.
126 Allocates a custom region, removing any autodetected regions which occupy the same
128 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y,
129 e.g.\& screen[1]:800x1200+0+0.
131 Set a preferred minimum width for the terminal
132 If this value is greater than 0,
134 will attempt to adjust the font sizes in the terminal to keep the terminal
135 width above this number as the window is resized.
138 is currently supported.
141 binary must not be setuid or setgid, which it is by default on most systems.
142 Users may need to set program[term] (see the
144 section) to use an alternate copy of the
146 binary without the setgid bit set.
147 .It Cm title_class_enabled
148 Enable or disable displaying the window class in the status bar.
149 Enable by setting to 1
150 .It Cm title_name_enabled
151 Enable or disable displaying the window title in the status bar.
152 Enable by setting to 1
153 .It Cm window_name_enabled
154 Enable or disable displaying the window name in the status bar.
155 Enable by setting to 1
158 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
160 Using a value of follow_cursor will make the window manager focus the window
161 under the mouse when switching workspaces and creating windows.
162 .It Cm disable_border
163 Remove border when bar is disabled and there is only one window on the screen.
165 Set window border thickness in pixels.
166 Disable all borders by setting to 0
167 .It Cm program Ns Bq Ar p
168 Define new action to spawn a program
173 .It Cm bind Ns Bq Ar x
174 Bind key combo to action
179 .It Cm quirk Ns Bq Ar c:n
180 Add "quirk" for windows with class
189 Colors need to be specified per the
191 specification and fonts need to be specified per the
195 To list the available fonts in your system see
202 application can help you to show the X Logical Font Description ("XLFD") used
203 as setting in the keyword bar_font.
206 allows you to define custom actions to launch programs of your choice and then
207 bind them the same as with built-in actions.
212 The default programs are described below:
214 .Bl -tag -width "screenshot_wind" -offset indent -compact
217 .It Cm screenshot_all
219 .It Cm screenshot_wind
226 dmenu_run \-fn $bar_font \-nb $bar_color \-nf $bar_font_color \-sb $bar_border \-sf $bar_color
229 Custom programs in the configuration file are specified as follows:
231 .Dl program[<name>] = <progpath> [<arg> [... <arg>]]
234 is any identifier that does not conflict with a built-in action or keyword,
236 is the desired program, and
238 is zero or more arguments to the program.
240 The following variables represent settable values in
243 .Sx CONFIGURATION FILES
245 and may be used in the
247 fields and will be substituted for values at the time the program is spawned:
249 .Bl -tag -width "$bar_font_color" -offset indent -compact
253 .It Cm $bar_font_color
255 .It Cm $color_unfocus
259 .Bd -literal -offset indent
260 program[ff] = /usr/local/bin/firefox http://scrotwm.org/
261 bind[ff] = Mod+f # Now Mod+F launched firefox
264 To undo the previous:
265 .Bd -literal -offset indent
272 provides many functions (or actions) accessed via key or mouse bindings.
274 The current mouse bindings are described below:
276 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
284 Resize window while maintaining it centered
287 The default key bindings are described below:
289 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
290 .It Cm M-S- Ns Aq Cm Return
299 .It Cm M- Ns Aq Cm Space
301 .It Cm M-S- Ns Aq Cm Space
315 .It Cm M- Ns Aq Cm Return
324 .Cm M-S- Ns Aq Cm TAB
341 .It Cm M-S- Ns Aq Ar n
343 .It Cm M- Ns Aq Cm Right
345 .It Cm M- Ns Aq Cm Left
349 .It Cm M-S- Ns Aq Cm Right
351 .It Cm M-S- Ns Aq Cm Left
361 .It Cm M-S- Ns Aq Cm Delete
371 The action names and descriptions are listed below:
373 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
399 Add windows to master area
401 Remove windows from master area
403 Add columns/rows to stacking area
405 Remove columns/rows from stacking area
407 Move current window to master area
409 Focus next window in workspace
411 Focus previous window in workspace
413 Focus on main window in workspace
415 Swap with next window in workspace
417 Swap with previous window in workspace
419 Toggle status bar in all workspaces
421 Delete current window in workspace
423 Destroy current window in workspace
431 Move current window to workspace
437 Switch to next workspace with a window in it
439 Switch to previous workspace with a window in it
441 Switch to last visited workspace
443 Move pointer to next region
445 Move pointer to previous region
446 .It Cm screenshot_all
447 Take screenshot of entire screen (if enabled)
451 .It Cm screenshot_wind
452 Take screenshot of selected window (if enabled)
457 Toggle version in status bar
459 Toggle focused window between tiled and floating
466 Reinitialize physical screens
471 Minimize (unmap) currently focused window.
473 Maximize (map) window returned by dmenu selection.
476 Custom bindings in the configuration file are specified as follows:
478 .Dl bind[<action>] = <keys>
481 is one of the actions listed above (or empty) and
483 is in the form of zero or more modifier keys
484 (MOD, Mod1, Shift, etc.) and one or more normal keys
485 (b, space, etc.), separated by "+".
487 .Bd -literal -offset indent
488 bind[reset] = Mod4+q # bind Windows-key + q to reset
489 bind[] = Mod1+q # unbind Alt + q
492 Multiple key combinations may be bound to the same action.
495 provides "quirks" which handle windows that must be treated specially
496 in a tiling window manager, such as some dialogs and fullscreen apps.
498 The default quirks are described below:
500 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
501 .It Firefox\-bin:firefox\-bin
508 FLOAT + FULLSCREEN + FOCUSPREV
509 .It OpenOffice.org 2.4:VCLSalFrame
511 .It OpenOffice.org 3.1:VCLSalFrame
519 .It xine:xine Video Fullscreen Window
529 The quirks themselves are described below:
531 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
533 This window should not be tiled, but allowed to float freely.
535 Adjusts size on transient windows that are too small using dialog_ratio
537 .Sx CONFIGURATION FILES ) .
539 Allow window to position itself, uncentered.
541 Adjust xterm fonts when resizing.
543 Remove border to allow window to use full screen size.
545 On exit force focus on previously focused application not previous application
549 Custom quirks in the configuration file are specified as follows:
551 .Dl quirk[<class>:<name>] = <quirk> [ + <quirk> ... ]
556 specify the window to which the quirk(s) apply, and
558 is one of the quirks from the list above.
560 .Bd -literal -offset indent
561 quirk[MPlayer:xv] = FLOAT + FULLSCREEN + FOCUSPREV
562 quirk[pcb:pcb] = NONE # remove existing quirk
569 by running xprop(1) and then clicking on the desired window.
570 In the following example the main window of Firefox was clicked:
571 .Bd -literal -offset indent
572 $ xprop | grep WM_CLASS
573 WM_CLASS(STRING) = "Navigator", "Firefox"
576 Note that grepping for WM_CLASS flips class and name.
577 In the example above the quirk entry would be:
578 .Bd -literal -offset indent
579 quirk[Firefox:Navigator] = FLOAT
584 a HUP signal will retstart it.
586 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
587 .It Pa ~/.scrotwm.conf
589 user specific settings.
590 .It Pa /etc/scrotwm.conf
596 was inspired by xmonad & dwm.
602 .An Marco Peereboom Aq marco@peereboom.us ,
603 .An Ryan Thomas McBride Aq mcbride@countersiege.com
605 .An Darrin Chandler Aq dwchandler@stilyagin.com .
607 Currently the menu, invoked with