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 ws[idx]:master_grow:master_add:stack_inc:layout, e.g.
126 ws[2]:-4:0:1:horizontal sets worskspace 2 to the horizontal stack mode and
127 shrinks the master area by 4 ticks and adds one window to the stack.
128 Possible layout values are
142 for more information.
143 Note that the stacking options are complicated and have side-effects.
144 One should familiarize oneself with these commands before experimenting with the
148 This setting is not retained at restart.
150 Allocates a custom region, removing any autodetected regions which occupy the same
152 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y,
153 e.g.\& screen[1]:800x1200+0+0.
155 Set a preferred minimum width for the terminal
156 If this value is greater than 0,
158 will attempt to adjust the font sizes in the terminal to keep the terminal
159 width above this number as the window is resized.
162 is currently supported.
165 binary must not be setuid or setgid, which it is by default on most systems.
166 Users may need to set program[term] (see the
168 section) to use an alternate copy of the
170 binary without the setgid bit set.
171 .It Cm title_class_enabled
172 Enable or disable displaying the window class in the status bar.
173 Enable by setting to 1
174 .It Cm title_name_enabled
175 Enable or disable displaying the window title in the status bar.
176 Enable by setting to 1
177 .It Cm window_name_enabled
178 Enable or disable displaying the window name in the status bar.
179 Enable by setting to 1
182 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
184 Using a value of follow_cursor will make the window manager focus the window
185 under the mouse when switching workspaces and creating windows.
186 .It Cm disable_border
187 Remove border when bar is disabled and there is only one window on the screen.
189 Set window border thickness in pixels.
190 Disable all borders by setting to 0
191 .It Cm program Ns Bq Ar p
192 Define new action to spawn a program
197 .It Cm bind Ns Bq Ar x
198 Bind key combo to action
203 .It Cm quirk Ns Bq Ar c:n
204 Add "quirk" for windows with class
213 Colors need to be specified per the
215 specification and fonts need to be specified per the
219 To list the available fonts in your system see
226 application can help you to show the X Logical Font Description ("XLFD") used
227 as setting in the keyword bar_font.
230 allows you to define custom actions to launch programs of your choice and then
231 bind them the same as with built-in actions.
236 The default programs are described below:
238 .Bl -tag -width "screenshot_wind" -offset indent -compact
241 .It Cm screenshot_all
243 .It Cm screenshot_wind
250 dmenu_run \-fn $bar_font \-nb $bar_color \-nf $bar_font_color \-sb $bar_border \-sf $bar_color
253 Custom programs in the configuration file are specified as follows:
255 .Dl program[<name>] = <progpath> [<arg> [... <arg>]]
258 is any identifier that does not conflict with a built-in action or keyword,
260 is the desired program, and
262 is zero or more arguments to the program.
264 The following variables represent settable values in
267 .Sx CONFIGURATION FILES
269 and may be used in the
271 fields and will be substituted for values at the time the program is spawned:
273 .Bl -tag -width "$bar_font_color" -offset indent -compact
277 .It Cm $bar_font_color
279 .It Cm $color_unfocus
283 .Bd -literal -offset indent
284 program[ff] = /usr/local/bin/firefox http://scrotwm.org/
285 bind[ff] = Mod+f # Now Mod+F launched firefox
288 To undo the previous:
289 .Bd -literal -offset indent
296 provides many functions (or actions) accessed via key or mouse bindings.
298 The current mouse bindings are described below:
300 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
308 Resize window while maintaining it centered
311 The default key bindings are described below:
313 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
314 .It Cm M-S- Ns Aq Cm Return
323 .It Cm M- Ns Aq Cm Space
325 .It Cm M-S- Ns Aq Cm Space
339 .It Cm M- Ns Aq Cm Return
348 .Cm M-S- Ns Aq Cm TAB
365 .It Cm M-S- Ns Aq Ar n
367 .It Cm M- Ns Aq Cm Right
369 .It Cm M- Ns Aq Cm Left
373 .It Cm M-S- Ns Aq Cm Right
375 .It Cm M-S- Ns Aq Cm Left
385 .It Cm M-S- Ns Aq Cm Delete
395 The action names and descriptions are listed below:
397 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
423 Add windows to master area
425 Remove windows from master area
427 Add columns/rows to stacking area
429 Remove columns/rows from stacking area
431 Move current window to master area
433 Focus next window in workspace
435 Focus previous window in workspace
437 Focus on main window in workspace
439 Swap with next window in workspace
441 Swap with previous window in workspace
443 Toggle status bar in all workspaces
445 Delete current window in workspace
447 Destroy current window in workspace
455 Move current window to workspace
461 Switch to next workspace with a window in it
463 Switch to previous workspace with a window in it
465 Switch to last visited workspace
467 Move pointer to next region
469 Move pointer to previous region
470 .It Cm screenshot_all
471 Take screenshot of entire screen (if enabled)
475 .It Cm screenshot_wind
476 Take screenshot of selected window (if enabled)
481 Toggle version in status bar
483 Toggle focused window between tiled and floating
490 Reinitialize physical screens
495 Minimize (unmap) currently focused window.
497 Maximize (map) window returned by dmenu selection.
500 Custom bindings in the configuration file are specified as follows:
502 .Dl bind[<action>] = <keys>
505 is one of the actions listed above (or empty) and
507 is in the form of zero or more modifier keys
508 (MOD, Mod1, Shift, etc.) and one or more normal keys
509 (b, space, etc.), separated by "+".
511 .Bd -literal -offset indent
512 bind[reset] = Mod4+q # bind Windows-key + q to reset
513 bind[] = Mod1+q # unbind Alt + q
516 Multiple key combinations may be bound to the same action.
519 provides "quirks" which handle windows that must be treated specially
520 in a tiling window manager, such as some dialogs and fullscreen apps.
522 The default quirks are described below:
524 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
525 .It Firefox\-bin:firefox\-bin
532 FLOAT + FULLSCREEN + FOCUSPREV
533 .It OpenOffice.org 2.4:VCLSalFrame
535 .It OpenOffice.org 3.1:VCLSalFrame
543 .It xine:xine Video Fullscreen Window
553 The quirks themselves are described below:
555 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
557 This window should not be tiled, but allowed to float freely.
559 Adjusts size on transient windows that are too small using dialog_ratio
561 .Sx CONFIGURATION FILES ) .
563 Allow window to position itself, uncentered.
565 Adjust xterm fonts when resizing.
567 Remove border to allow window to use full screen size.
569 On exit force focus on previously focused application not previous application
573 Custom quirks in the configuration file are specified as follows:
575 .Dl quirk[<class>:<name>] = <quirk> [ + <quirk> ... ]
580 specify the window to which the quirk(s) apply, and
582 is one of the quirks from the list above.
584 .Bd -literal -offset indent
585 quirk[MPlayer:xv] = FLOAT + FULLSCREEN + FOCUSPREV
586 quirk[pcb:pcb] = NONE # remove existing quirk
593 by running xprop(1) and then clicking on the desired window.
594 In the following example the main window of Firefox was clicked:
595 .Bd -literal -offset indent
596 $ xprop | grep WM_CLASS
597 WM_CLASS(STRING) = "Navigator", "Firefox"
600 Note that grepping for WM_CLASS flips class and name.
601 In the example above the quirk entry would be:
602 .Bd -literal -offset indent
603 quirk[Firefox:Navigator] = FLOAT
608 a HUP signal will retstart it.
610 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
611 .It Pa ~/.scrotwm.conf
613 user specific settings.
614 .It Pa /etc/scrotwm.conf
620 was inspired by xmonad & dwm.
626 .An Marco Peereboom Aq marco@peereboom.us ,
627 .An Ryan Thomas McBride Aq mcbride@countersiege.com
629 .An Darrin Chandler Aq dwchandler@stilyagin.com .
631 Currently the menu, invoked with