1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
4 <title>~/scrotwm.~.html</title>
5 <meta name="Generator" content="Vim/7.2">
6 <meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
8 <body text="#ffffff" bgcolor="#000000"><font face="monospace">
9 <font color="#ff40ff">SCROTWM(1) OpenBSD Reference Manual SCROTWM(1)</font><br>
11 <font color="#ffff00">NAME</font><br>
12 scrotwm - window manager for X11<br>
14 <font color="#ffff00">SYNOPSIS</font><br>
15 scrotwm<br>
17 <font color="#ffff00">DESCRIPTION</font><br>
18 scrotwm is a minimalistic window manager that tries to stay out of the<br>
19 way so that valuable screen real estate can be used for much more impor-<br>
20 tant stuff. It has sane defaults and does not require one to learn a<br>
21 language to do any configuration. It was written by hackers for hackers<br>
22 and it strives to be small, compact and fast.<br>
24 When scrotwm starts up, it reads settings from its configuration file,<br>
25 scrotwm.conf. See the CONFIGURATION FILES section below.<br>
27 The following notation is used throughout this page:<br>
29 M Meta<br>
30 S Shift<br>
31 <Name> Named key<br>
32 M1 Mouse button 1<br>
33 M3 Mouse button 3<br>
35 scrotwm is very simple in its use. Most of the actions are initiated via<br>
36 keybindings. The current keybindings are described below:<br>
38 M-S-<Return> Spawn a new terminal<br>
39 M-p Menu<br>
40 M-S-q Quit<br>
41 M-q Restart scrotwm<br>
42 M-<Space> Cycle layout<br>
43 M-S-<Space> Reset layout<br>
44 M-h Shrink master area<br>
45 M-l Grow master area<br>
46 M-, Add windows to master area<br>
47 M-. Remove windows from master area<br>
48 M-S-, Add columns/rows to stacking area<br>
49 M-S-. Remove columns/rows from stacking area<br>
50 M-<Return> Move current window to master area<br>
51 M-j, M-<TAB> Focus next window in workspace<br>
52 M-k, M-S-<TAB> Focus previous window in workspace<br>
53 M-m Focus on main window in workspace<br>
54 M-S-j Swap with next window in workspace<br>
55 M-S-k Swap with previous window in workspace<br>
56 M-b Toggle status bar in all workspaces<br>
57 M-x Delete current window in workspace<br>
58 M-S-x Destroy current window in workspace<br>
59 M-<n> Switch to workspace n<br>
60 M-S-<n> Move current window to workspace n<br>
61 M-<Right> Switch to next workspace with a window in it<br>
62 M-<Left> Switch to previous workspace with a window in it<br>
63 M-S-<Right> Move pointer to next region<br>
64 M-S-<Left> Move pointer to previous region<br>
65 M-s Take screenshot of entire screen (if enabled)<br>
66 M-S-s Take screenshot of selected window (if enabled)<br>
67 M-S-v Toggle version in status bar<br>
68 M-t Toggle focused window between tiled and floating<br>
69 M-S <Delete> Lock screen<br>
70 M-S-i Reinitialize physical screens<br>
71 M1 Focus window<br>
72 M-M1 Move window<br>
73 M-M3 Resize window<br>
74 M-S-M3 Resize window while maintaining it centered<br>
76 <font color="#ffff00">CONFIGURATION FILES</font><br>
77 scrotwm first tries to open the user specific file, ~/.scrotwm.conf. If<br>
78 that file is unavailable, it then tries to open the global configuration<br>
79 file /etc/scrotwm.conf.<br>
81 The format of the file is <keyword> = <setting>. For example:<br>
83 color_focus = red<br>
85 Enabling or disabling an option is done by using 1 or 0 respectively.<br>
87 The file supports the following keywords:<br>
89 color_focus Border color of the currently focussed win-<br>
90 dow.<br>
91 color_unfocus Border color of unfocussed windows.<br>
92 bar_enabled Enable or disable status bar.<br>
93 bar_border[x] Color of the status bar border in screen x.<br>
94 bar_color[x] Color of the status bar window in screen x.<br>
95 bar_font_color[x] Color of the font in status bar in screen x.<br>
96 bar_font Status bar font.<br>
97 bar_action External script that populates additional<br>
98 information in the status bar, such as bat-<br>
99 tery life.<br>
100 bar_delay Update frequency, in seconds, of external<br>
101 script that populates the status bar.<br>
102 clock_enabled Enable or disable displaying the clock in<br>
103 the status bar. Disable by setting to 0 so<br>
104 a custom clock could be used in the bar_ac-<br>
105 tion script.<br>
106 spawn_term External application that gets spawned when<br>
107 M-S-<Return> is used.<br>
108 dialog_ratio Some applications have dialogue windows that<br>
109 are too small to be useful. This ratio is<br>
110 the screen size to what they will be re-<br>
111 sized. For example, 0.6 is 60% of the phys-<br>
112 ical screen size.<br>
113 region Allocates a custom region, removing any au-<br>
114 todetected regions which occupy the same<br>
115 space on the screen. Defined in the format<br>
116 screen[<idx>]:WIDTHxHEIGHT+X+Y, e.g.<br>
117 screen[1]:800x1200+0+0.<br>
118 screenshot_enabled Enable or disable screenshot capability.<br>
119 screenshot_app Set to the script that will take screen-<br>
120 shots. It will be called with "full" or<br>
121 "window" as parameter 1 to indicate what<br>
122 screenshot action is expected. The script<br>
123 shall handle those cases accordingly.<br>
124 term_width Set a preferred minimum width for the termi-<br>
125 nal If this value is greater than 0, scrotwm<br>
126 will attempt to adjust the font sizes in the<br>
127 terminal to keep the terminal width above<br>
128 this number as the window is resized. Only<br>
129 <font color="#ff40ff">xterm(1)</font> is currently supported. The<br>
130 <font color="#ff40ff">xterm(1)</font> binary must not be setuid or set-<br>
131 gid, which it is by default on most systems.<br>
132 Users may need to set spawn term to use an<br>
133 alternate copy of the <font color="#ff40ff">xterm(1)</font> binary with-<br>
134 out the setgid bit set.<br>
135 modkey Change mod key. Mod1 is generally the ALT<br>
136 key and Mod4 is the windows key on a PC.<br>
138 Colors need to be specified per the <font color="#ff40ff">XQueryColor(3)</font> specification and<br>
139 fonts need to be specified per the <font color="#ff40ff">XQueryFont(3)</font> specification.<br>
141 <font color="#ffff00">FILES</font><br>
142 ~/.scrotwm.conf scrotwm user specific settings.<br>
143 /etc/scrotwm.conf scrotwm global settings.<br>
145 <font color="#ffff00">HISTORY</font><br>
146 scrotwm was inspired by xmonad & dwm.<br>
148 <font color="#ffff00">AUTHORS</font><br>
149 scrotwm was written by Marco Peereboom <marco@peereboom.us> and Ryan<br>
150 Thomas McBride <mcbride@countersiege.com>.<br>
152 <font color="#ffff00">BUGS</font><br>
153 Currently the menu, invoked with M-p, depends on dmenu.<br>
155 OpenBSD 4.5 February 18, 2009 3<br>