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
90 .It Cm bar_border_width
91 Set status bar border thickness in pixels.
92 Disable border by setting to 0
94 .It Cm bar_color Ns Bq Ar x
95 Color of the status bar window in screen
97 .It Cm bar_font_color Ns Bq Ar x
98 Color of the font in status bar in screen
103 External script that populates additional information in the status bar,
104 such as battery life.
106 Update frequency, in seconds, of external script that populates the status bar.
108 Place the statusbar at the bottom of each region instead of the top.
110 Enable or disable displaying the current stacking algorithm in the status bar.
112 Enable or disable displaying the clock in the status bar.
113 Disable by setting to 0
114 so a custom clock could be used in the bar_action script.
116 Some applications have dialogue windows that are too small to be useful.
117 This ratio is the screen size to what they will be resized.
118 For example, 0.6 is 60% of the physical screen size.
120 Allocates a custom region, removing any autodetected regions which occupy the same
122 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y,
123 e.g.\& screen[1]:800x1200+0+0.
125 Set a preferred minimum width for the terminal
126 If this value is greater than 0,
128 will attempt to adjust the font sizes in the terminal to keep the terminal
129 width above this number as the window is resized.
132 is currently supported.
135 binary must not be setuid or setgid, which it is by default on most systems.
136 Users may need to set program[term] (see the
138 section) to use an alternate copy of the
140 binary without the setgid bit set.
141 .It Cm title_class_enabled
142 Enable or disable displaying the window class in the status bar.
143 Enable by setting to 1
144 .It Cm title_name_enabled
145 Enable or disable displaying the window title in the status bar.
146 Enable by setting to 1
147 .It Cm window_name_enabled
148 Enable or disable displaying the window name in the status bar.
149 Enable by setting to 1
152 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
154 Using a value of follow_cursor will make the window manager focus the window
155 under the mouse when switching workspaces and creating windows.
156 .It Cm disable_border
157 Remove border when bar is disabled and there is only one window on the screen.
159 Set window border thickness in pixels.
160 Disable all borders by setting to 0
161 .It Cm program Ns Bq Ar p
162 Define new action to spawn a program
167 .It Cm bind Ns Bq Ar x
168 Bind key combo to action
173 .It Cm quirk Ns Bq Ar c:n
174 Add "quirk" for windows with class
183 Colors need to be specified per the
185 specification and fonts need to be specified per the
189 To list the available fonts in your system see
196 application can help you to show the X Logical Font Description ("XLFD") used
197 as setting in the keyword bar_font.
200 allows you to define custom actions to launch programs of your choice and then
201 bind them the same as with built-in actions.
206 The default programs are described below:
208 .Bl -tag -width "screenshot_wind" -offset indent -compact
211 .It Cm screenshot_all
213 .It Cm screenshot_wind
220 dmenu_run \-fn $bar_font \-nb $bar_color \-nf $bar_font_color \-sb $bar_border \-sf $bar_color
223 Custom programs in the configuration file are specified as follows:
225 .Dl program[<name>] = <progpath> [<arg> [... <arg>]]
228 is any identifier that does not conflict with a built-in action or keyword,
230 is the desired program, and
232 is zero or more arguments to the program.
234 The following variables represent settable values in
237 .Sx CONFIGURATION FILES
239 and may be used in the
241 fields and will be substituted for values at the time the program is spawned:
243 .Bl -tag -width "$bar_font_color" -offset indent -compact
247 .It Cm $bar_font_color
249 .It Cm $color_unfocus
253 .Bd -literal -offset indent
254 program[ff] = /usr/local/bin/firefox http://scrotwm.org/
255 bind[ff] = Mod+f # Now Mod+F launched firefox
258 To undo the previous:
259 .Bd -literal -offset indent
266 provides many functions (or actions) accessed via key or mouse bindings.
268 The current mouse bindings are described below:
270 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
278 Resize window while maintaining it centered
281 The default key bindings are described below:
283 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
284 .It Cm M-S- Ns Aq Cm Return
293 .It Cm M- Ns Aq Cm Space
295 .It Cm M-S- Ns Aq Cm Space
309 .It Cm M- Ns Aq Cm Return
318 .Cm M-S- Ns Aq Cm TAB
335 .It Cm M-S- Ns Aq Ar n
337 .It Cm M- Ns Aq Cm Right
339 .It Cm M- Ns Aq Cm Left
343 .It Cm M-S- Ns Aq Cm Right
345 .It Cm M-S- Ns Aq Cm Left
355 .It Cm M-S Aq Cm Delete
361 The action names and descriptions are listed below:
363 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
389 Add windows to master area
391 Remove windows from master area
393 Add columns/rows to stacking area
395 Remove columns/rows from stacking area
397 Move current window to master area
399 Focus next window in workspace
401 Focus previous window in workspace
403 Focus on main window in workspace
405 Swap with next window in workspace
407 Swap with previous window in workspace
409 Toggle status bar in all workspaces
411 Delete current window in workspace
413 Destroy current window in workspace
421 Move current window to workspace
427 Switch to next workspace with a window in it
429 Switch to previous workspace with a window in it
431 Switch to last visited workspace
433 Move pointer to next region
435 Move pointer to previous region
436 .It Cm screenshot_all
437 Take screenshot of entire screen (if enabled)
441 .It Cm screenshot_wind
442 Take screenshot of selected window (if enabled)
447 Toggle version in status bar
449 Toggle focused window between tiled and floating
456 Reinitialize physical screens
462 Custom bindings in the configuration file are specified as follows:
464 .Dl bind[<action>] = <keys>
467 is one of the actions listed above (or empty) and
469 is in the form of zero or more modifier keys
470 (MOD, Mod1, Shift, etc.) and one or more normal keys
471 (b, space, etc.), separated by "+".
473 .Bd -literal -offset indent
474 bind[reset] = Mod4+q # bind Windows-key + q to reset
475 bind[] = Mod1+q # unbind Alt + q
478 Multiple key combinations may be bound to the same action.
481 provides "quirks" which handle windows that must be treated specially
482 in a tiling window manager, such as some dialogs and fullscreen apps.
484 The default quirks are described below:
486 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent -compact
487 .It Firefox\-bin:firefox\-bin
495 .It OpenOffice.org 2.4:VCLSalFrame
497 .It OpenOffice.org 3.1:VCLSalFrame
505 .It xine:xine Video Fullscreen Window
515 The quirks themselves are described below:
517 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
519 This window should not be tiled, but allowed to float freely.
521 Adjusts size on transient windows that are too small using dialog_ratio
523 .Sx CONFIGURATION FILES ) .
525 Allow window to position itself, uncentered.
527 Adjust xterm fonts when resizing.
529 Remove border to allow window to use full screen size.
532 Custom quirks in the configuration file are specified as follows:
534 .Dl quirk[<class>:<name>] = <quirk> [ + <quirk> ... ]
539 specify the window to which the quirk(s) apply, and
541 is one of the quirks from the list above.
543 .Bd -literal -offset indent
544 quirk[MPlayer:xv] = FLOAT + FULLSCREEN # let mplayer play
545 quirk[pcb:pcb] = NONE # remove existing quirk
552 by running xprop(1) and then clicking on the desired window.
553 In the following example the main window of Firefox was clicked:
554 .Bd -literal -offset indent
555 $ xprop | grep WM_CLASS
556 WM_CLASS(STRING) = "Navigator", "Firefox"
559 Note that grepping for WM_CLASS flips class and name.
560 In the example above the quirk entry would be:
561 .Bd -literal -offset indent
562 quirk[Firefox:Navigator] = FLOAT
567 a HUP signal will retstart it.
569 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
570 .It Pa ~/.scrotwm.conf
572 user specific settings.
573 .It Pa /etc/scrotwm.conf
579 was inspired by xmonad & dwm.
585 .An Marco Peereboom Aq marco@peereboom.us ,
586 .An Ryan Thomas McBride Aq mcbride@countersiege.com
588 .An Darrin Chandler Aq dwchandler@stilyagin.com .
590 Currently the menu, invoked with