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
146 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
148 Using a value of follow_cursor will make the window manager focus the window
149 under the mouse when switching workspaces and creating windows.
150 .It Cm disable_border
151 Remove border when bar is disabled and there is only one window on the screen.
152 .It Cm program Ns Bq Ar p
153 Define new action to spawn a program
158 .It Cm bind Ns Bq Ar x
159 Bind key combo to action
164 .It Cm quirk Ns Bq Ar c:n
165 Add "quirk" for windows with class
174 Colors need to be specified per the
176 specification and fonts need to be specified per the
180 To list the available fonts in your system see
187 application can help you to show the X Logical Font Description ("XLFD") used
188 as setting in the keyword bar_font.
191 allows you to define custom actions to launch programs of your choice and then
192 bind them the same as with built-in actions.
197 The default programs are described below:
199 .Bl -tag -width "screenshot_wind" -offset indent -compact
202 .It Cm screenshot_all
204 .It Cm screenshot_wind
211 dmenu_run \-fn $bar_font \-nb $bar_color \-nf $bar_font_color \-sb $bar_border \-sf $bar_color
214 Custom programs in the configuration file are specified as follows:
216 .Dl program[<name>] = <progpath> [<arg> [... <arg>]]
219 is any identifier that does not conflict with a built-in action or keyword,
221 is the desired program, and
223 is zero or more arguments to the program.
225 The following variables represent settable values in
228 .Sx CONFIGURATION FILES
230 and may be used in the
232 fields and will be substituted for values at the time the program is spawned:
234 .Bl -tag -width "$bar_font_color" -offset indent -compact
238 .It Cm $bar_font_color
240 .It Cm $color_unfocus
244 .Bd -literal -offset indent
245 program[ff] = /usr/local/bin/firefox http://scrotwm.org/
246 bind[ff] = Mod+f # Now Mod+F launched firefox
249 To undo the previous:
250 .Bd -literal -offset indent
257 provides many functions (or actions) accessed via key or mouse bindings.
259 The current mouse bindings are described below:
261 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
269 Resize window while maintaining it centered
272 The default key bindings are described below:
274 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
275 .It Cm M-S- Ns Aq Cm Return
284 .It Cm M- Ns Aq Cm Space
286 .It Cm M-S- Ns Aq Cm Space
300 .It Cm M- Ns Aq Cm Return
309 .Cm M-S- Ns Aq Cm TAB
326 .It Cm M-S- Ns Aq Ar n
328 .It Cm M- Ns Aq Cm Right
330 .It Cm M- Ns Aq Cm Left
334 .It Cm M-S- Ns Aq Cm Right
336 .It Cm M-S- Ns Aq Cm Left
346 .It Cm M-S Aq Cm Delete
352 The action names and descriptions are listed below:
354 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
380 Add windows to master area
382 Remove windows from master area
384 Add columns/rows to stacking area
386 Remove columns/rows from stacking area
388 Move current window to master area
390 Focus next window in workspace
392 Focus previous window in workspace
394 Focus on main window in workspace
396 Swap with next window in workspace
398 Swap with previous window in workspace
400 Toggle status bar in all workspaces
402 Delete current window in workspace
404 Destroy current window in workspace
412 Move current window to workspace
418 Switch to next workspace with a window in it
420 Switch to previous workspace with a window in it
422 Switch to last visited workspace
424 Move pointer to next region
426 Move pointer to previous region
427 .It Cm screenshot_all
428 Take screenshot of entire screen (if enabled)
432 .It Cm screenshot_wind
433 Take screenshot of selected window (if enabled)
438 Toggle version in status bar
440 Toggle focused window between tiled and floating
447 Reinitialize physical screens
453 Custom bindings in the configuration file are specified as follows:
455 .Dl bind[<action>] = <keys>
458 is one of the actions listed above (or empty) and
460 is in the form of zero or more modifier keys
461 (MOD, Mod1, Shift, etc.) and one or more normal keys
462 (b, space, etc.), separated by "+".
464 .Bd -literal -offset indent
465 bind[reset] = Mod4+q # bind Windows-key + q to reset
466 bind[] = Mod1+q # unbind Alt + q
469 Multiple key combinations may be bound to the same action.
472 provides "quirks" which handle windows that must be treated specially
473 in a tiling window manager, such as some dialogs and fullscreen apps.
475 The default quirks are described below:
477 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
478 .It Firefox\-bin:firefox\-bin
486 .It OpenOffice.org 2.4:VCLSalFrame
488 .It OpenOffice.org 3.1:VCLSalFrame
496 .It xine:xine Video Fullscreen Window
506 The quirks themselves are described below:
508 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
510 This window should not be tiled, but allowed to float freely.
512 Adjusts size on transient windows that are too small using dialog_ratio
514 .Sx CONFIGURATION FILES ) .
516 Allow window to position itself, uncentered.
518 Adjust xterm fonts when resizing.
520 Remove border to allow window to use full screen size.
523 Custom quirks in the configuration file are specified as follows:
525 .Dl quirk[<class>:<name>] = <quirk> [ + <quirk> ... ]
530 specify the window to which the quirk(s) apply, and
532 is one of the quirks from the list above.
534 .Bd -literal -offset indent
535 quirk[MPlayer:xv] = FLOAT + FULLSCREEN # let mplayer play
536 quirk[pcb:pcb] = NONE # remove existing quirk
543 by running xprop(1) and then clicking on the desired window.
544 In the following example the main window of Firefox was clicked:
545 .Bd -literal -offset indent
546 $ xprop | grep WM_CLASS
547 WM_CLASS(STRING) = "Navigator", "Firefox"
550 Note that grepping for WM_CLASS flips class and name.
551 In the example above the quirk entry would be:
552 .Bd -literal -offset indent
553 quirk[Firefox:Navigator] = FLOAT
558 a HUP signal will retstart it.
560 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
561 .It Pa ~/.scrotwm.conf
563 user specific settings.
564 .It Pa /etc/scrotwm.conf
570 was inspired by xmonad & dwm.
576 .An Marco Peereboom Aq marco@peereboom.us ,
577 .An Ryan Thomas McBride Aq mcbride@countersiege.com
579 .An Darrin Chandler Aq dwchandler@stilyagin.com .
581 Currently the menu, invoked with