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 select layout to use at start-of-day.
125 Defined in the format
126 ws[idx]:master_grow:master_add:stack_inc:layout:always_raise:stack_mode, e.g.
127 ws[2]:-4:0:1:0:horizontal sets worskspace 2 to the horizontal stack mode and
128 shrinks the master area by 4 ticks and adds one window to the stack, while
129 maintaining default floating window behavior.
130 Possible stack_mode values are
145 for more information.
146 Note that the stacking options are complicated and have side-effects.
147 One should familiarize oneself with these commands before experimenting with the
151 This setting is not retained at restart.
153 Allocates a custom region, removing any autodetected regions which occupy the same
155 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y,
156 e.g.\& screen[1]:800x1200+0+0.
158 Set a preferred minimum width for the terminal
159 If this value is greater than 0,
161 will attempt to adjust the font sizes in the terminal to keep the terminal
162 width above this number as the window is resized.
165 is currently supported.
168 binary must not be setuid or setgid, which it is by default on most systems.
169 Users may need to set program[term] (see the
171 section) to use an alternate copy of the
173 binary without the setgid bit set.
174 .It Cm title_class_enabled
175 Enable or disable displaying the window class in the status bar.
176 Enable by setting to 1
177 .It Cm title_name_enabled
178 Enable or disable displaying the window title in the status bar.
179 Enable by setting to 1
180 .It Cm urgent_enabled
181 Enable or disable the urgency hint.
182 Note that many terminal emulators require this to be enabled for it to
183 propagate. In xterm, for example, one needs to add the following line
184 .Pa xterm.urgentOnBell: true
187 .It Cm window_name_enabled
188 Enable or disable displaying the window name in the status bar.
189 Enable by setting to 1
190 .It Cm verbose_layout
191 Enable or disable displaying the current master and stack values in the status
193 Enable by setting to 1
196 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
198 Using a value of follow_cursor will make the window manager focus the window
199 under the mouse when switching workspaces and creating windows.
200 .It Cm disable_border
201 Remove border when bar is disabled and there is only one window on the screen.
203 Set window border thickness in pixels.
204 Disable all borders by setting to 0
205 .It Cm program Ns Bq Ar p
206 Define new action to spawn a program
211 .It Cm bind Ns Bq Ar x
212 Bind key combo to action
217 .It Cm quirk Ns Bq Ar c:n
218 Add "quirk" for windows with class
227 Colors need to be specified per the
229 specification and fonts need to be specified per the
233 To list the available fonts in your system see
240 application can help you to show the X Logical Font Description ("XLFD") used
241 as setting in the keyword bar_font.
244 allows you to define custom actions to launch programs of your choice and then
245 bind them the same as with built-in actions.
250 The default programs are described below:
252 .Bl -tag -width "screenshot_wind" -offset indent -compact
255 .It Cm screenshot_all
257 .It Cm screenshot_wind
264 dmenu_run \-fn $bar_font \-nb $bar_color \-nf $bar_font_color \-sb $bar_border \-sf $bar_color
267 Custom programs in the configuration file are specified as follows:
269 .Dl program[<name>] = <progpath> [<arg> [... <arg>]]
272 is any identifier that does not conflict with a built-in action or keyword,
274 is the desired program, and
276 is zero or more arguments to the program.
278 The following variables represent settable values in
281 .Sx CONFIGURATION FILES
283 and may be used in the
285 fields and will be substituted for values at the time the program is spawned:
287 .Bl -tag -width "$bar_font_color" -offset indent -compact
291 .It Cm $bar_font_color
293 .It Cm $color_unfocus
297 .Bd -literal -offset indent
298 program[ff] = /usr/local/bin/firefox http://scrotwm.org/
299 bind[ff] = Mod+f # Now Mod+F launched firefox
302 To undo the previous:
303 .Bd -literal -offset indent
310 provides many functions (or actions) accessed via key or mouse bindings.
312 The current mouse bindings are described below:
314 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
322 Resize window while maintaining it centered
325 The default key bindings are described below:
327 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
328 .It Cm M-S- Ns Aq Cm Return
337 .It Cm M- Ns Aq Cm Space
339 .It Cm M-S- Ns Aq Cm Space
353 .It Cm M- Ns Aq Cm Return
362 .Cm M-S- Ns Aq Cm TAB
379 .It Cm M-S- Ns Aq Ar n
381 .It Cm M- Ns Aq Cm Right
383 .It Cm M- Ns Aq Cm Left
387 .It Cm M-S- Ns Aq Cm Right
389 .It Cm M-S- Ns Aq Cm Left
399 .It Cm M-S- Ns Aq Cm Delete
411 The action names and descriptions are listed below:
413 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
439 Add windows to master area
441 Remove windows from master area
443 Add columns/rows to stacking area
445 Remove columns/rows from stacking area
447 Move current window to master area
449 Focus next window in workspace
451 Focus previous window in workspace
453 Focus on main window in workspace
455 Swap with next window in workspace
457 Swap with previous window in workspace
459 Toggle status bar in all workspaces
461 Delete current window in workspace
463 Destroy current window in workspace
471 Move current window to workspace
477 Switch to next workspace with a window in it
479 Switch to previous workspace with a window in it
481 Switch to last visited workspace
483 Move pointer to next region
485 Move pointer to previous region
486 .It Cm screenshot_all
487 Take screenshot of entire screen (if enabled)
491 .It Cm screenshot_wind
492 Take screenshot of selected window (if enabled)
497 Toggle version in status bar
499 Toggle focused window between tiled and floating
506 Reinitialize physical screens
511 Minimize (unmap) currently focused window.
513 Maximize (map) window returned by dmenu selection.
515 When set tiled windows are allowed to obscure floating windows.
518 Custom bindings in the configuration file are specified as follows:
520 .Dl bind[<action>] = <keys>
523 is one of the actions listed above (or empty) and
525 is in the form of zero or more modifier keys
526 (MOD, Mod1, Shift, etc.) and one or more normal keys
527 (b, space, etc.), separated by "+".
529 .Bd -literal -offset indent
530 bind[reset] = Mod4+q # bind Windows-key + q to reset
531 bind[] = Mod1+q # unbind Alt + q
534 Multiple key combinations may be bound to the same action.
537 provides "quirks" which handle windows that must be treated specially
538 in a tiling window manager, such as some dialogs and fullscreen apps.
540 The default quirks are described below:
542 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
543 .It Firefox\-bin:firefox\-bin
550 FLOAT + FULLSCREEN + FOCUSPREV
551 .It OpenOffice.org 2.4:VCLSalFrame
553 .It OpenOffice.org 3.1:VCLSalFrame
561 .It xine:xine Video Fullscreen Window
571 The quirks themselves are described below:
573 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
575 This window should not be tiled, but allowed to float freely.
577 Adjusts size on transient windows that are too small using dialog_ratio
579 .Sx CONFIGURATION FILES ) .
581 Allow window to position itself, uncentered.
583 Adjust xterm fonts when resizing.
585 Remove border to allow window to use full screen size.
587 On exit force focus on previously focused application not previous application
591 Custom quirks in the configuration file are specified as follows:
593 .Dl quirk[<class>:<name>] = <quirk> [ + <quirk> ... ]
598 specify the window to which the quirk(s) apply, and
600 is one of the quirks from the list above.
602 .Bd -literal -offset indent
603 quirk[MPlayer:xv] = FLOAT + FULLSCREEN + FOCUSPREV
604 quirk[pcb:pcb] = NONE # remove existing quirk
611 by running xprop(1) and then clicking on the desired window.
612 In the following example the main window of Firefox was clicked:
613 .Bd -literal -offset indent
614 $ xprop | grep WM_CLASS
615 WM_CLASS(STRING) = "Navigator", "Firefox"
618 Note that grepping for WM_CLASS flips class and name.
619 In the example above the quirk entry would be:
620 .Bd -literal -offset indent
621 quirk[Firefox:Navigator] = FLOAT
625 also automatically assigns quirks to windows based on the value
626 of the window's _NET_WM_WINDOW_TYPE property as follows:
628 .Bl -tag -width "_NET_WM_WINDOW_TYPE_TOOLBAR<TAB>XXX" -offset indent -compact
629 .It _NET_WM_WINDOW_TYPE_DOCK
631 .It _NET_WM_WINDOW_TYPE_TOOLBAR
633 .It _NET_WM_WINDOW_TYPE_UTILITY
635 .It _NET_WM_WINDOW_TYPE_SPLASH
637 .It _NET_WM_WINDOW_TYPE_DIALOG
641 In all other cases, no automatic quirks are assigned to the window.
642 Quirks specified in the configuration file override the automatic quirks.
645 partially implements the Extended Window Manager Hints (EWMH) specification.
646 This enables controlling windows as well as
648 itself from external scripts and programs. This is achieved by
650 responding to certain ClientMessage events. From the terminal these events
651 can be conveniently sent using tools such as wmctrl and xdotool. For the
652 actual format of these ClientMessage events, see the EWMH specification.
654 The id of the currently focused window is stored in the _NET_ACTIVE_WINDOW
655 property of the root window. This can be used for example to retrieve the
656 title of the currently active window with xprop(1) and grep(1):
657 .Bd -literal -offset indent
658 $ WINDOWID=`xprop -root _NET_ACTIVE_WINDOW | grep -o "0x.*"`
659 $ xprop -id $WINDOWID WM_NAME | grep -o "\\".*\\""
662 A window can be focused by sending a _NET_ACTIVE_WINDOW client message
663 to the root window. For example, using wmctrl to send the message
664 (assuming 0x4a0000b is the id of the window to be focused):
665 .Bd -literal -offset indent
666 $ wmctrl -i -a 0x4a0000b
669 Windows can be closed by sending a _NET_CLOSE_WINDOW client message
670 to the root window. For example, using wmctrl to send the message
671 (assuming 0x4a0000b is the id of the window to be closed):
672 .Bd -literal -offset indent
673 $ wmctrl -i -c 0x4a0000b
676 Windows can be floated and un-floated by adding or removing the
677 _NET_WM_STATE_ABOVE atom from the _NET_WM_STATE property of the window.
678 This can be achieved by sending a _NET_WM_STATE client message to the
679 root window. For example, the following toggles the floating state of
680 a window using wmctrl to send the message (assuming 0x4a0000b is the
681 id of the window floated or un-floated):
682 .Bd -literal -offset indent
683 $ wmctrl -i -r 0x4a0000b -b toggle,_NET_WM_STATE_ABOVE
686 Floating windows can also be resized and moved by sending a
687 _NET_MOVERESIZE_WINDOW client message to the root window. For example,
688 using wmctrl to send the message (assuming 0x4a0000b is the id of
689 the window to be resize/moved):
690 .Bd -literal -offset indent
691 $ wmctrl -i -r 0x4a0000b -e 0,100,50,640,480
694 This moves the window to (100,50) and resizes it to 640x480.
696 Any _NET_MOVERESIZE_WINDOW events received for stacked windows are ignored.
701 a HUP signal will restart it.
703 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
704 .It Pa ~/.scrotwm.conf
706 user specific settings.
707 .It Pa /etc/scrotwm.conf
713 was inspired by xmonad & dwm.
719 .Bl -tag -width "Ryan Thomas McBride Aq mcbride@countersiege.com " -offset indent -compact
720 .It Cm Marco Peereboom Aq marco@peereboom.us
721 .It Cm Ryan Thomas McBride Aq mcbride@countersiege.com
722 .It Cm Darrin Chandler Aq dwchandler@stilyagin.com
723 .It Cm Pierre-Yves Ritschard Aq pyr@spootnik.org
724 .It Cm Tuukka Kataja Aq stuge@xor.fi
725 .It Cm Jason L. Wright Aq jason@thought.net
728 Currently the menu, invoked with