README
1echinus wm.
2==========
3
40.Installation
51.Configuration file
62.config.h header
73.About panels and pagers
8
9
100.Installation
11--------------
12
13You need X11 and Xft headers to compile echinus wm and the pkg-config tool.
14Packages containing this stuff are probably named libx11-dev and libxft-dev
15(note "-dev" suffix). You need libxrandr for multihead support (can be
16disabled in config.mk if not needed). XRandr-enabled binary still works
17with single monitor configurations.
18
19# make
20# make install
21
22On new install:
23
24% mkdir ~/.echinus
25% cp -r CONFDIR ~/.echinus
26
271.Configuration file
28--------------------
29
30Name: ~/.echinus/echinusrc
31
32Main settings
33
34 Echinus*deflayout
35 Layout applied to tag if not explicitly set by tags.layout later.
36 One of: i - ifloating, f - floating, t - tiled, b - bottomstack, m - maximized.
37
38 Echinus*mwfact
39
40 Space occupied by master window in tiled layout (fraction of 1).
41
42 Echinus*nmaster
43
44 Number of clients in master area in tiled layout.
45
46 Echinus*sloppy
47
48 0 - Click to focus
49 1 - Sloppy focus for floating clients
50 2 - Sloppy focus for everything
51 3 - Sloppy focus + raise on focus
52
53 Echinus*modkey
54
55 Choose modkey. A for alt, W - winkey, S - shift, C - control
56
57Title settings
58
59 Echinus*decoratetiled - boolean (1 or 0)
60
61 Draw titles in tiled mode
62
63 Echinus*titleposition
64 Echinus*tagbar
65 Echinus*tbpos
66
67 Were removed for more general interface, see below
68
69 Echinus*titlelayout - string
70
71 Titlebar consists of 3 parts separated with dashes or
72 spaces. Left is aligned to left, center to center and
73 right to right (obviously).
74
75 Default value is "N IMC" meaning name on the left
76 iconify, maximize and close buttons on right (note
77 2 spaces).
78
79 - or ' ' (space) - skip space (space can't be
80 used as first character)
81 N - window name
82 I - iconify
83 M - maximize
84 C - close
85 T - tagbar
86
87 Examples:
88
89 -T-C - title centered, close button on right
90
91
92Color settings
93
94 Echinus*selected.border
95 Echinus*normal.border
96 Echinus*selected.bg
97 Echinus*normal.bg
98 Echinus*selected.fg
99 Echinus*normal.fg
100 Echinus*selected.button
101 Echinus*normal.button
102
103 border - color of a small border around each window
104 bg - titlebar background
105 fg - titlebar foreground
106 button - button foreground
107
108 normal - unfocused window
109 selected - window in focus
110
111Border settings
112
113 Echinus*border
114
115 width of the border, in pixels
116
117Button settings
118
119 Echinus*button.iconify.pixmap (was: Echinus*button.left.pixmap)
120 Echinus*button.maximize.pixmap (was: Echinus*button.center.pixmap)
121 Echinus*button.close.pixmap (was: Echinus*button.right.pixmap)
122
123 buttons in the titlebar, left iconifies window, center switch
124 to monocle (fullscreen) mode, right - close.
125 ~ are not allowed in pathnames.
126
127Opacity
128
129 Echinus*opacity
130
131 Opacity value for inactive windows, you need xcompmgr running to
132 see the result.
133
134Terminal app
135
136 Echinus*command (was: Echinus*terminal)
137
138 Application to run on right window click on root window.
139
140Title
141
142 Echinus*title
143
144 Titlebar height
145
146 Echinus*font
147
148 Titlebar font
149
150Tags
151
152 Echinus*tags.number
153
154 Number of tags
155
156 Echinus*tags.name{...}
157
158 Names for the tags
159
160 Echinus*tags.layout{...}
161
162 Layout per tag on start. See deflayout for possible
163 values
164
165Hacks
166
167 Echinus*hidebastards
168
169 Set to 1 to hide panels, pagers and others with
170 togglestruts function.
171
172Keybindings
173
174 Format is "[ASCW] + key", where:
175 A - Alt (mod1)
176 S - Shift
177 C - Control
178 W - Windows key
179 You can find the list of available keys in keysym.h
180 and XF86keysym.h files (usually located in
181 /usr/include/X11/), remove XK_ prefix before use.
182
183 Don't miss ' ' (space).
184
185 Echinus*togglestruts
186
187 Echinus has no bar, but this binding switches the area
188 on top or bottom which won't be covered by windows in
189 tiled or monocle mode.
190
191
192 Echinus*togglemonitor
193
194 Switch from one monitor to another.
195
196 Echinus*focusnext
197 Echinus*focusprev
198
199 Focus next and previous window
200
201 Echinus*viewprevtag
202
203 View previous tag set
204
205 Echinus*quit
206
207 Leave echinus
208
209 Echinus*restart
210
211 Restart echinus
212
213 Echinus*killclient
214
215 Close window in focus
216
217 Echinus*togglefloating
218
219 Toggle floating/tiled
220
221 Echinus*view#
222
223 View tag number #
224
225 Echinus*tag#
226
227 Tag current window with tag number #
228
229 Echinus*toggleview#
230
231 Toggle view number #
232
233 Echinus*focusview#
234
235 Toggle view number # and focus the first client
236 from it.
237
238 Echinus*viewlefttag
239 Echinus*viewrighttag
240
241 View tag on the left(right) of current
242
243 Echinus*spawn#: <key> = program
244
245 Run specified program. # is less than 64.
246
247 Echinus*moveright
248 Echinus*moveleft
249 Echinus*moveup
250 Echinus*movedown
251
252 Syntax for this is rather untrivial: x y w h. For example move right for five pixels:
253
254 Echinus*moveright: AS + l = +5 0 0 0
255
256 Echinus*resizedecx
257 Echinus*resizedecy
258 Echinus*resizeincy
259 Echinus*resizeincx
260
261 Same as above, but change second group of values. Resize by y for 5 pixels:
262
263 Echinus*resizedecy: AS + v = 0 0 0 -5
264
265 Echinus*rule#
266
267 Format is "<Window class|Window title> <tag> <isfloating> <hastitle>"
268
2692.config.h header
270-----------------
271
272Contains default values of options. You probably don't have
273to edit it.
274
275
2763.About panels and pagers
277-------------------------
278
279Echinus supports some parts of EWMH, so if the author of the pager knows
280what this magical letters mean it *should* work fine.
281
282Known to work:
283 fbpanel
284 ipager
285 ourico
286
287Known to NOT work:
288 pypanel
289