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>]:<layout>, e.g. ws[2]:horizontal sets worskspace
126 2 to the horizontal stack mode.
127 This setting is not retained at restart.
134 Allocates a custom region, removing any autodetected regions which occupy the same
136 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y,
137 e.g.\& screen[1]:800x1200+0+0.
139 Set a preferred minimum width for the terminal
140 If this value is greater than 0,
142 will attempt to adjust the font sizes in the terminal to keep the terminal
143 width above this number as the window is resized.
146 is currently supported.
149 binary must not be setuid or setgid, which it is by default on most systems.
150 Users may need to set program[term] (see the
152 section) to use an alternate copy of the
154 binary without the setgid bit set.
155 .It Cm title_class_enabled
156 Enable or disable displaying the window class in the status bar.
157 Enable by setting to 1
158 .It Cm title_name_enabled
159 Enable or disable displaying the window title in the status bar.
160 Enable by setting to 1
161 .It Cm window_name_enabled
162 Enable or disable displaying the window name in the status bar.
163 Enable by setting to 1
166 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
168 Using a value of follow_cursor will make the window manager focus the window
169 under the mouse when switching workspaces and creating windows.
170 .It Cm disable_border
171 Remove border when bar is disabled and there is only one window on the screen.
173 Set window border thickness in pixels.
174 Disable all borders by setting to 0
175 .It Cm program Ns Bq Ar p
176 Define new action to spawn a program
181 .It Cm bind Ns Bq Ar x
182 Bind key combo to action
187 .It Cm quirk Ns Bq Ar c:n
188 Add "quirk" for windows with class
197 Colors need to be specified per the
199 specification and fonts need to be specified per the
203 To list the available fonts in your system see
210 application can help you to show the X Logical Font Description ("XLFD") used
211 as setting in the keyword bar_font.
214 allows you to define custom actions to launch programs of your choice and then
215 bind them the same as with built-in actions.
220 The default programs are described below:
222 .Bl -tag -width "screenshot_wind" -offset indent -compact
225 .It Cm screenshot_all
227 .It Cm screenshot_wind
234 dmenu_run \-fn $bar_font \-nb $bar_color \-nf $bar_font_color \-sb $bar_border \-sf $bar_color
237 Custom programs in the configuration file are specified as follows:
239 .Dl program[<name>] = <progpath> [<arg> [... <arg>]]
242 is any identifier that does not conflict with a built-in action or keyword,
244 is the desired program, and
246 is zero or more arguments to the program.
248 The following variables represent settable values in
251 .Sx CONFIGURATION FILES
253 and may be used in the
255 fields and will be substituted for values at the time the program is spawned:
257 .Bl -tag -width "$bar_font_color" -offset indent -compact
261 .It Cm $bar_font_color
263 .It Cm $color_unfocus
267 .Bd -literal -offset indent
268 program[ff] = /usr/local/bin/firefox http://scrotwm.org/
269 bind[ff] = Mod+f # Now Mod+F launched firefox
272 To undo the previous:
273 .Bd -literal -offset indent
280 provides many functions (or actions) accessed via key or mouse bindings.
282 The current mouse bindings are described below:
284 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
292 Resize window while maintaining it centered
295 The default key bindings are described below:
297 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
298 .It Cm M-S- Ns Aq Cm Return
307 .It Cm M- Ns Aq Cm Space
309 .It Cm M-S- Ns Aq Cm Space
323 .It Cm M- Ns Aq Cm Return
332 .Cm M-S- Ns Aq Cm TAB
349 .It Cm M-S- Ns Aq Ar n
351 .It Cm M- Ns Aq Cm Right
353 .It Cm M- Ns Aq Cm Left
357 .It Cm M-S- Ns Aq Cm Right
359 .It Cm M-S- Ns Aq Cm Left
369 .It Cm M-S- Ns Aq Cm Delete
379 The action names and descriptions are listed below:
381 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
407 Add windows to master area
409 Remove windows from master area
411 Add columns/rows to stacking area
413 Remove columns/rows from stacking area
415 Move current window to master area
417 Focus next window in workspace
419 Focus previous window in workspace
421 Focus on main window in workspace
423 Swap with next window in workspace
425 Swap with previous window in workspace
427 Toggle status bar in all workspaces
429 Delete current window in workspace
431 Destroy current window in workspace
439 Move current window to workspace
445 Switch to next workspace with a window in it
447 Switch to previous workspace with a window in it
449 Switch to last visited workspace
451 Move pointer to next region
453 Move pointer to previous region
454 .It Cm screenshot_all
455 Take screenshot of entire screen (if enabled)
459 .It Cm screenshot_wind
460 Take screenshot of selected window (if enabled)
465 Toggle version in status bar
467 Toggle focused window between tiled and floating
474 Reinitialize physical screens
479 Minimize (unmap) currently focused window.
481 Maximize (map) window returned by dmenu selection.
484 Custom bindings in the configuration file are specified as follows:
486 .Dl bind[<action>] = <keys>
489 is one of the actions listed above (or empty) and
491 is in the form of zero or more modifier keys
492 (MOD, Mod1, Shift, etc.) and one or more normal keys
493 (b, space, etc.), separated by "+".
495 .Bd -literal -offset indent
496 bind[reset] = Mod4+q # bind Windows-key + q to reset
497 bind[] = Mod1+q # unbind Alt + q
500 Multiple key combinations may be bound to the same action.
503 provides "quirks" which handle windows that must be treated specially
504 in a tiling window manager, such as some dialogs and fullscreen apps.
506 The default quirks are described below:
508 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
509 .It Firefox\-bin:firefox\-bin
516 FLOAT + FULLSCREEN + FOCUSPREV
517 .It OpenOffice.org 2.4:VCLSalFrame
519 .It OpenOffice.org 3.1:VCLSalFrame
527 .It xine:xine Video Fullscreen Window
537 The quirks themselves are described below:
539 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
541 This window should not be tiled, but allowed to float freely.
543 Adjusts size on transient windows that are too small using dialog_ratio
545 .Sx CONFIGURATION FILES ) .
547 Allow window to position itself, uncentered.
549 Adjust xterm fonts when resizing.
551 Remove border to allow window to use full screen size.
553 On exit force focus on previously focused application not previous application
557 Custom quirks in the configuration file are specified as follows:
559 .Dl quirk[<class>:<name>] = <quirk> [ + <quirk> ... ]
564 specify the window to which the quirk(s) apply, and
566 is one of the quirks from the list above.
568 .Bd -literal -offset indent
569 quirk[MPlayer:xv] = FLOAT + FULLSCREEN + FOCUSPREV
570 quirk[pcb:pcb] = NONE # remove existing quirk
577 by running xprop(1) and then clicking on the desired window.
578 In the following example the main window of Firefox was clicked:
579 .Bd -literal -offset indent
580 $ xprop | grep WM_CLASS
581 WM_CLASS(STRING) = "Navigator", "Firefox"
584 Note that grepping for WM_CLASS flips class and name.
585 In the example above the quirk entry would be:
586 .Bd -literal -offset indent
587 quirk[Firefox:Navigator] = FLOAT
592 a HUP signal will retstart it.
594 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
595 .It Pa ~/.scrotwm.conf
597 user specific settings.
598 .It Pa /etc/scrotwm.conf
604 was inspired by xmonad & dwm.
610 .An Marco Peereboom Aq marco@peereboom.us ,
611 .An Ryan Thomas McBride Aq mcbride@countersiege.com
613 .An Darrin Chandler Aq dwchandler@stilyagin.com .
615 Currently the menu, invoked with