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 Defined in the format ws[<idx>]:application, e.g. ws[2]:xterm launches and
87 Border color of the currently focussed window.
89 Border color of unfocussed windows.
91 Enable or disable status bar.
92 .It Cm bar_border Ns Bq Ar x
93 Color of the status bar border in screen
94 .It Cm bar_border_width
95 Set status bar border thickness in pixels.
96 Disable border by setting to 0
98 .It Cm bar_color Ns Bq Ar x
99 Color of the status bar window in screen
101 .It Cm bar_font_color Ns Bq Ar x
102 Color of the font in status bar in screen
107 External script that populates additional information in the status bar,
108 such as battery life.
110 Update frequency, in seconds, of external script that populates the status bar.
112 Place the statusbar at the bottom of each region instead of the top.
114 Enable or disable displaying the current stacking algorithm in the status bar.
116 Enable or disable displaying the clock in the status bar.
117 Disable by setting to 0
118 so a custom clock could be used in the bar_action script.
120 Some applications have dialogue windows that are too small to be useful.
121 This ratio is the screen size to what they will be resized.
122 For example, 0.6 is 60% of the physical screen size.
124 Allocates a custom region, removing any autodetected regions which occupy the same
126 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y,
127 e.g.\& screen[1]:800x1200+0+0.
129 Set a preferred minimum width for the terminal
130 If this value is greater than 0,
132 will attempt to adjust the font sizes in the terminal to keep the terminal
133 width above this number as the window is resized.
136 is currently supported.
139 binary must not be setuid or setgid, which it is by default on most systems.
140 Users may need to set program[term] (see the
142 section) to use an alternate copy of the
144 binary without the setgid bit set.
145 .It Cm title_class_enabled
146 Enable or disable displaying the window class in the status bar.
147 Enable by setting to 1
148 .It Cm title_name_enabled
149 Enable or disable displaying the window title in the status bar.
150 Enable by setting to 1
151 .It Cm window_name_enabled
152 Enable or disable displaying the window name in the status bar.
153 Enable by setting to 1
156 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
158 Using a value of follow_cursor will make the window manager focus the window
159 under the mouse when switching workspaces and creating windows.
160 .It Cm disable_border
161 Remove border when bar is disabled and there is only one window on the screen.
163 Set window border thickness in pixels.
164 Disable all borders by setting to 0
165 .It Cm program Ns Bq Ar p
166 Define new action to spawn a program
171 .It Cm bind Ns Bq Ar x
172 Bind key combo to action
177 .It Cm quirk Ns Bq Ar c:n
178 Add "quirk" for windows with class
187 Colors need to be specified per the
189 specification and fonts need to be specified per the
193 To list the available fonts in your system see
200 application can help you to show the X Logical Font Description ("XLFD") used
201 as setting in the keyword bar_font.
204 allows you to define custom actions to launch programs of your choice and then
205 bind them the same as with built-in actions.
210 The default programs are described below:
212 .Bl -tag -width "screenshot_wind" -offset indent -compact
215 .It Cm screenshot_all
217 .It Cm screenshot_wind
224 dmenu_run \-fn $bar_font \-nb $bar_color \-nf $bar_font_color \-sb $bar_border \-sf $bar_color
227 Custom programs in the configuration file are specified as follows:
229 .Dl program[<name>] = <progpath> [<arg> [... <arg>]]
232 is any identifier that does not conflict with a built-in action or keyword,
234 is the desired program, and
236 is zero or more arguments to the program.
238 The following variables represent settable values in
241 .Sx CONFIGURATION FILES
243 and may be used in the
245 fields and will be substituted for values at the time the program is spawned:
247 .Bl -tag -width "$bar_font_color" -offset indent -compact
251 .It Cm $bar_font_color
253 .It Cm $color_unfocus
257 .Bd -literal -offset indent
258 program[ff] = /usr/local/bin/firefox http://scrotwm.org/
259 bind[ff] = Mod+f # Now Mod+F launched firefox
262 To undo the previous:
263 .Bd -literal -offset indent
270 provides many functions (or actions) accessed via key or mouse bindings.
272 The current mouse bindings are described below:
274 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
282 Resize window while maintaining it centered
285 The default key bindings are described below:
287 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
288 .It Cm M-S- Ns Aq Cm Return
297 .It Cm M- Ns Aq Cm Space
299 .It Cm M-S- Ns Aq Cm Space
313 .It Cm M- Ns Aq Cm Return
322 .Cm M-S- Ns Aq Cm TAB
339 .It Cm M-S- Ns Aq Ar n
341 .It Cm M- Ns Aq Cm Right
343 .It Cm M- Ns Aq Cm Left
347 .It Cm M-S- Ns Aq Cm Right
349 .It Cm M-S- Ns Aq Cm Left
359 .It Cm M-S- Ns Aq Cm Delete
369 The action names and descriptions are listed below:
371 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
397 Add windows to master area
399 Remove windows from master area
401 Add columns/rows to stacking area
403 Remove columns/rows from stacking area
405 Move current window to master area
407 Focus next window in workspace
409 Focus previous window in workspace
411 Focus on main window in workspace
413 Swap with next window in workspace
415 Swap with previous window in workspace
417 Toggle status bar in all workspaces
419 Delete current window in workspace
421 Destroy current window in workspace
429 Move current window to workspace
435 Switch to next workspace with a window in it
437 Switch to previous workspace with a window in it
439 Switch to last visited workspace
441 Move pointer to next region
443 Move pointer to previous region
444 .It Cm screenshot_all
445 Take screenshot of entire screen (if enabled)
449 .It Cm screenshot_wind
450 Take screenshot of selected window (if enabled)
455 Toggle version in status bar
457 Toggle focused window between tiled and floating
464 Reinitialize physical screens
469 Minimize (unmap) currently focused window.
471 Maximize (map) window returned by dmenu selection.
474 Custom bindings in the configuration file are specified as follows:
476 .Dl bind[<action>] = <keys>
479 is one of the actions listed above (or empty) and
481 is in the form of zero or more modifier keys
482 (MOD, Mod1, Shift, etc.) and one or more normal keys
483 (b, space, etc.), separated by "+".
485 .Bd -literal -offset indent
486 bind[reset] = Mod4+q # bind Windows-key + q to reset
487 bind[] = Mod1+q # unbind Alt + q
490 Multiple key combinations may be bound to the same action.
493 provides "quirks" which handle windows that must be treated specially
494 in a tiling window manager, such as some dialogs and fullscreen apps.
496 The default quirks are described below:
498 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
499 .It Firefox\-bin:firefox\-bin
506 FLOAT + FULLSCREEN + FOCUSPREV
507 .It OpenOffice.org 2.4:VCLSalFrame
509 .It OpenOffice.org 3.1:VCLSalFrame
517 .It xine:xine Video Fullscreen Window
527 The quirks themselves are described below:
529 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
531 This window should not be tiled, but allowed to float freely.
533 Adjusts size on transient windows that are too small using dialog_ratio
535 .Sx CONFIGURATION FILES ) .
537 Allow window to position itself, uncentered.
539 Adjust xterm fonts when resizing.
541 Remove border to allow window to use full screen size.
543 On exit force focus on previously focused application not previous application
547 Custom quirks in the configuration file are specified as follows:
549 .Dl quirk[<class>:<name>] = <quirk> [ + <quirk> ... ]
554 specify the window to which the quirk(s) apply, and
556 is one of the quirks from the list above.
558 .Bd -literal -offset indent
559 quirk[MPlayer:xv] = FLOAT + FULLSCREEN + FOCUSPREV
560 quirk[pcb:pcb] = NONE # remove existing quirk
567 by running xprop(1) and then clicking on the desired window.
568 In the following example the main window of Firefox was clicked:
569 .Bd -literal -offset indent
570 $ xprop | grep WM_CLASS
571 WM_CLASS(STRING) = "Navigator", "Firefox"
574 Note that grepping for WM_CLASS flips class and name.
575 In the example above the quirk entry would be:
576 .Bd -literal -offset indent
577 quirk[Firefox:Navigator] = FLOAT
582 a HUP signal will retstart it.
584 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
585 .It Pa ~/.scrotwm.conf
587 user specific settings.
588 .It Pa /etc/scrotwm.conf
594 was inspired by xmonad & dwm.
600 .An Marco Peereboom Aq marco@peereboom.us ,
601 .An Ryan Thomas McBride Aq mcbride@countersiege.com
603 .An Darrin Chandler Aq dwchandler@stilyagin.com .
605 Currently the menu, invoked with