]> code.delx.au - spectrwm/blob - spectrwm.1
Add new 'manual' focus_mode.
[spectrwm] / spectrwm.1
1 .\" Copyright (c) 2009-2012 Marco Peereboom <marco@peereboom.us>
2 .\" Copyright (c) 2009 Darrin Chandler <dwchandler@stilyagin.com>
3 .\" Copyright (c) 2011-2012 Reginald Kennedy <rk@rejii.com>
4 .\" Copyright (c) 2011-2012 Lawrence Teo <lteo@lteo.net>
5 .\" Copyright (c) 2011-2012 Tiago Cunha <tcunha@gmx.com>
6 .\" Copyright (c) 2012 David Hill <dhill@mindcry.org>
7 .\"
8 .\" Permission to use, copy, modify, and distribute this software for any
9 .\" purpose with or without fee is hereby granted, provided that the above
10 .\" copyright notice and this permission notice appear in all copies.
11 .\"
12 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 .\"
20 .Dd $Mdocdate: February 15 2012 $
21 .Dt SPECTRWM 1
22 .Os
23 .Sh NAME
24 .Nm spectrwm
25 .Nd window manager for X11
26 .Sh SYNOPSIS
27 .Nm spectrwm
28 .Sh DESCRIPTION
29 .Nm
30 is a minimalistic window manager that tries to stay out of the way so that
31 valuable screen real estate can be used for much more important stuff.
32 It has sane defaults and does not require one to learn a language to do any
33 configuration.
34 It was written by hackers for hackers and it strives to be small, compact and
35 fast.
36 .Pp
37 When
38 .Nm
39 starts up, it reads settings from its configuration file,
40 .Pa spectrwm.conf .
41 See the
42 .Sx CONFIGURATION FILES
43 section below.
44 .Pp
45 The following notation is used throughout this page:
46 .Pp
47 .Bl -tag -width Ds -offset indent -compact
48 .It Cm M
49 Meta
50 .It Cm S
51 Shift
52 .It Aq Cm Name
53 Named key
54 .It Cm M1
55 Mouse button 1
56 .It Cm M3
57 Mouse button 3
58 .El
59 .Pp
60 .Nm
61 is very simple in its use.
62 Most of the actions are initiated via key or mouse bindings.
63 See the
64 .Sx BINDINGS
65 section below for defaults and customizations.
66 .Sh CONFIGURATION FILES
67 .Nm
68 first tries to open the user specific file,
69 .Pa ~/.spectrwm.conf .
70 If that file is unavailable,
71 it then tries to open the global configuration file
72 .Pa /etc/spectrwm.conf .
73 .Pp
74 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
75 For example:
76 .Pp
77 .Dl color_focus = red
78 .Pp
79 Enabling or disabling an option is done by using 1 or 0 respectively.
80 .Pp
81 Colors need to be specified per the
82 .Xr XQueryColor 3
83 specification.
84 .Pp
85 The file supports the following keywords:
86 .Bl -tag -width 2m
87 .It Ic autorun
88 Launch an application in a specified workspace at start-of-day.
89 Defined in the format ws[<idx>]:application, e.g. ws[2]:xterm launches an
90 xterm in workspace 2.
91 .It Ic bar_action
92 External script that populates additional information in the status bar,
93 such as battery life.
94 .It Ic bar_at_bottom
95 Place the statusbar at the bottom of each region instead of the top.
96 .It Ic bar_border Ns Bq Ar x
97 Color of the status bar border in screen
98 .Ar x .
99 .It Ic bar_border_width
100 Set status bar border thickness in pixels.
101 Disable border by setting to 0.
102 .It Ic bar_color Ns Bq Ar x
103 Color of the status bar window in screen
104 .Ar x .
105 .It Ic bar_delay
106 Update frequency, in seconds, of external script that populates the status
107 bar.
108 .It Ic bar_enabled
109 Enable or disable status bar.
110 .It Ic bar_font
111 Font used in the status bar. Either Xft or X Logical Font Description (XLFD)
112 may be used to specify fonts. Fallback fonts may be specified by separating
113 each font with a comma. If all entries are XLFD syntax, font set will be
114 used. If at least one entry is Xft, Xft will be used. Note that if Xft is in
115 use, only the first font that successfully loads will be used regardless of
116 missing glyphs. The default is to use font set. Also note that dmenu does
117 not support Xft fonts.
118 .Pp
119 Xft examples:
120 .Bd -literal -offset indent
121 bar_font = Terminus:style=Regular:pixelsize=14:antialias=true
122
123 bar_font = -*-profont-medium-*-*-*-11-*-*-*-*-*-*-*,Terminus:pixelsize=14,\
124 -*-clean-medium-*-*-*-12-*-*-*-*-*-*-*
125 .Ed
126 .Pp
127 Font set examples:
128 .Bd -literal -offset indent
129 bar_font = -*-terminus-medium-*-*-*-14-*-*-*-*-*-*-*
130
131 bar_font = -*-profont-medium-*-*-*-11-*-*-*-*-*-*-*,\
132 -*-terminus-medium-*-*-*-14-*-*-*-*-*-*-*,\
133 -*-clean-medium-*-*-*-12-*-*-*-*-*-*-*
134 .Ed
135 .Pp
136 To list the available fonts in your system see
137 .Xr fc-list 1
138 or
139 .Xr xlsfonts 1
140 manpages.
141 The
142 .Xr xfontsel 1
143 application can help with the XLFD setting.
144 .Pp
145 .It Ic bar_font_color Ns Bq Ar x
146 Color of the font in status bar in screen
147 .Ar x .
148 .It Ic bar_format
149 Set the bar_format string and overrides
150 .Ic clock_format
151 and all of the
152 .Ic enabled
153 options.
154 The format is passed through
155 .Xr strftime 3
156 before being used.
157 It may contain the following character sequences:
158 .Bl -column "Character sequence" "Replaced with" -offset indent
159 .It Sy "Character sequence" Ta Sy "Replaced with"
160 .It Li "+<" Ta "Pad with a space"
161 .It Li "+A" Ta "Output of the external script"
162 .It Li "+C" Ta "Window class"
163 .It Li "+D" Ta "Workspace name"
164 .It Li "+F" Ta "Floating indicator"
165 .It Li "+I" Ta "Workspace index"
166 .It Li "+N" Ta "Screen number"
167 .It Li "+P" Ta "Window class and title separated by a colon"
168 .It Li "+S" Ta "Stacking algorithm"
169 .It Li "+T" Ta "Window title"
170 .It Li "+U" Ta "Urgency hint"
171 .It Li "+V" Ta "Program version"
172 .It Li "+W" Ta "Window name"
173 .It Li "++" Ta "A literal" Ql +
174 .El
175 .Pp
176 All character sequences may limit its output to a specific length, for
177 example +64A. Any characters that don't match the specification are copied
178 as-is.
179 .It Ic bar_justify
180 Justify the status bar text. Possible values are
181 .Pa left ,
182 .Pa center ,
183 and
184 .Pa right .
185 .Pp
186 Note that if the output is not
187 .Pa left
188 justified, it may not be properly aligned in some circumstances, due to the
189 white-spaces in the default static format.
190 See the
191 .Ic bar_format
192 option for more details.
193 .It Ic bind Ns Bq Ar x
194 Bind key combo to action
195 .Ar x .
196 See the
197 .Sx BINDINGS
198 section below.
199 .It Ic border_width
200 Set window border thickness in pixels.
201 Disable all borders by setting to 0.
202 .It Ic clock_enabled
203 Enable or disable displaying the clock in the status bar.
204 Disable by setting to 0
205 so a custom clock could be used in the
206 .Pa bar_action
207 script.
208 .It Ic color_focus
209 Border color of the currently focussed window.
210 .It Ic color_unfocus
211 Border color of unfocussed windows.
212 .It Ic dialog_ratio
213 Some applications have dialogue windows that are too small to be useful.
214 This ratio is the screen size to what they will be resized.
215 For example, 0.6 is 60% of the physical screen size.
216 .It Ic disable_border
217 Remove border when bar is disabled and there is only one window on the
218 screen.
219 .It Ic focus_close
220 Window to put focus when the focused window is closed.
221 Possible values are
222 .Pa first ,
223 .Pa next ,
224 .Pa previous
225 (default) and
226 .Pa last .
227 .Pa next
228 and
229 .Pa previous
230 are relative to the window that is closed.
231 .It Ic focus_close_wrap
232 Whether to allow the focus to jump to the last window when the first window
233 is closed or vice versa. Disable by setting to 0.
234 .It Ic focus_default
235 Window to put focus when no window has been focused. Possible values are
236 .Pa first
237 and
238 .Pa last
239 (default).
240 .It Ic focus_mode
241 Window focus behavior with respect to the mouse cursor. Possible values:
242 .Pp
243 .Bl -tag -width "follow_cursor" -offset indent -compact
244 .It Cm default
245 Set window focus on border crossings caused by cursor motion and
246 window interaction.
247 .It Cm follow_cursor
248 Set window focus on all cursor border crossings, including workspace switches
249 and changes to layout.
250 .It Cm manual
251 Set window focus on window interaction only.
252 .El
253 .It Ic keyboard_mapping
254 Clear all key bindings and load new key bindings from the specified file.
255 This allows you to load pre-defined key bindings for your keyboard layout.
256 See the
257 .Sx KEYBOARD MAPPING FILES
258 section below for a list of keyboard mapping files that have been provided
259 for several keyboard layouts.
260 .It Ic layout
261 Select layout to use at start-of-day. Defined in the format
262 ws[idx]:master_grow:master_add:stack_inc:layout:always_raise:stack_mode, e.g.
263 ws[2]:-4:0:1:0:horizontal sets worskspace 2 to the horizontal stack mode and
264 shrinks the master area by 4 ticks and adds one window to the stack, while
265 maintaining default floating window behavior.
266 Possible stack_mode values are
267 .Pa vertical ,
268 .Pa vertical_flip ,
269 .Pa horizontal ,
270 .Pa horizontal_flip
271 and
272 .Pa fullscreen .
273 .Pp
274 See
275 .Pa master_grow ,
276 .Pa master_shrink ,
277 .Pa master_add ,
278 .Pa master_del ,
279 .Pa stack_inc ,
280 .Pa stack_dec ,
281 and
282 .Pa always_raise
283 for more information.
284 Note that the stacking options are complicated and have side-effects. One
285 should familiarize oneself with these commands before experimenting with the
286 .Pa layout
287 option.
288 .Pp
289 This setting is not retained at restart.
290 .It Ic modkey
291 Change mod key.
292 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
293 .It Ic program Ns Bq Ar p
294 Define new action to spawn a program
295 .Ar p .
296 See the
297 .Sx PROGRAMS
298 section below.
299 .It Ic quirk Ns Bq Ar c:n
300 Add "quirk" for windows with class
301 .Ar c
302 and name
303 .Ar n .
304 See the
305 .Sx QUIRKS
306 section below.
307 .It Ic region
308 Allocates a custom region, removing any autodetected regions which occupy the
309 same space on the screen.
310 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y,
311 e.g.\& screen[1]:800x1200+0+0.
312 .Pp
313 To make a screen span multiple monitors, create a region big enough to cover
314 them all, e.g. screen[1]:2048x768+0+0 makes the screen span two monitors with
315 1024x768 resolution sitting one next to the other.
316 .It Ic spawn_position
317 Position in stack to place newly spawned windows.
318 Possible values are
319 .Pa first ,
320 .Pa next ,
321 .Pa previous
322 and
323 .Pa last
324 (default).
325 .Pa next
326 and
327 .Pa previous
328 are relative to the focused window.
329 .It Ic stack_enabled
330 Enable or disable displaying the current stacking algorithm in the status
331 bar.
332 .It Ic term_width
333 Set a preferred minimum width for the terminal.
334 If this value is greater than 0,
335 .Nm
336 will attempt to adjust the font sizes in the terminal to keep the terminal
337 width above this number as the window is resized.
338 Only
339 .Xr xterm 1
340 is currently supported.
341 The
342 .Xr xterm 1
343 binary must not be setuid or setgid, which it is by default on most systems.
344 Users may need to set program[term] (see the
345 .Sx PROGRAMS
346 section) to use an alternate copy of the
347 .Xr xterm 1
348 binary without the setgid bit set.
349 .It Ic title_class_enabled
350 Enable or disable displaying the window class in the status bar.
351 Enable by setting to 1.
352 .It Ic title_name_enabled
353 Enable or disable displaying the window title in the status bar.
354 Enable by setting to 1.
355 .It Ic urgent_enabled
356 Enable or disable the urgency hint.
357 Note that many terminal emulators require this to be enabled for it to
358 propagate.
359 In xterm, for example, one needs to add the following line
360 .Pa xterm.bellIsUrgent: true
361 to
362 .Pa .Xdefaults .
363 .It Ic verbose_layout
364 Enable or disable displaying the current master and stack values in the
365 status bar. Enable by setting to 1.
366 .It Ic window_name_enabled
367 Enable or disable displaying the window name in the status bar.
368 Enable by setting to 1.
369 .Pp
370 To prevent excessively large window names from pushing the remaining text off
371 the screen, it's limited to 64 characters, by default.
372 See the
373 .Ic bar_format
374 option for more details.
375 .It Ic workspace_limit
376 Set the total number of workspaces available. Minimum is 1, maximum is 22,
377 default is 10.
378 .El
379 .Sh PROGRAMS
380 .Nm
381 allows you to define custom actions to launch programs of your choice and
382 then bind them the same as with built-in actions.
383 See the
384 .Sx BINDINGS
385 section below.
386 .Pp
387 The default programs are described below:
388 .Pp
389 .Bl -tag -width "screenshot_wind" -offset indent -compact
390 .It Cm term
391 xterm
392 .It Cm screenshot_all
393 screenshot.sh full
394 .It Cm screenshot_wind
395 screenshot.sh window
396 .It Cm lock
397 xlock
398 .It Cm initscr
399 initscreen.sh
400 .It Cm menu
401 dmenu_run \-fn $bar_font \-nb $bar_color \-nf $bar_font_color \-sb
402 $bar_border \-sf $bar_color
403 .El
404 .Pp
405 Custom programs in the configuration file are specified as follows:
406 .Pp
407 .Dl program[<name>] = <progpath> [<arg> [... <arg>]]
408 .Pp
409 .Aq name
410 is any identifier that does not conflict with a built-in action or keyword,
411 .Aq progpath
412 is the desired program, and
413 .Aq arg
414 is zero or more arguments to the program.
415 .Pp
416 The following variables represent settable values in
417 .Nm
418 (see the
419 .Sx CONFIGURATION FILES
420 section above),
421 and may be used in the
422 .Aq arg
423 fields and will be substituted for values at the time the program is spawned:
424 .Pp
425 .Bl -tag -width "$bar_font_color" -offset indent -compact
426 .It Cm $bar_border
427 .It Cm $bar_color
428 .It Cm $bar_font
429 .It Cm $bar_font_color
430 .It Cm $color_focus
431 .It Cm $color_unfocus
432 .El
433 .Pp
434 Example:
435 .Bd -literal -offset indent
436 program[ff] = /usr/local/bin/firefox http://spectrwm.org/
437 bind[ff] = Mod+Shift+b # Now Mod+Shift+B launches firefox
438 .Ed
439 .Pp
440 To undo the previous:
441 .Bd -literal -offset indent
442 bind[] = Mod+Shift+b
443 program[ff] =
444 .Ed
445 .Sh BINDINGS
446 .Nm
447 provides many functions (or actions) accessed via key or mouse bindings.
448 .Pp
449 The current mouse bindings are described below:
450 .Pp
451 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
452 .It Cm M1
453 Focus window
454 .It Cm M-M1
455 Move window
456 .It Cm M-M3
457 Resize window
458 .It Cm M-S-M3
459 Resize window while maintaining it centered
460 .El
461 .Pp
462 The default key bindings are described below:
463 .Pp
464 .Bl -tag -width "M-j, M-<TAB>XXXXXX" -offset indent -compact
465 .It Cm M-S- Ns Aq Cm Return
466 term
467 .It Cm M-p
468 menu
469 .It Cm M-S-q
470 quit
471 .It Cm M-q
472 restart
473 .It Cm M- Ns Aq Cm Space
474 cycle_layout
475 .It Cm M-S- Ns Aq Cm \e
476 flip_layout
477 .It Cm M-S- Ns Aq Cm Space
478 stack_reset
479 .It Cm M-h
480 master_shrink
481 .It Cm M-l
482 master_grow
483 .It Cm M-,
484 master_add
485 .It Cm M-.
486 master_del
487 .It Cm M-S-,
488 stack_inc
489 .It Cm M-S-.
490 stack_dec
491 .It Cm M- Ns Aq Cm Return
492 swap_main
493 .It Xo
494 .Cm M-j ,
495 .Cm M- Ns Aq Cm TAB
496 .Xc
497 focus_next
498 .It Xo
499 .Cm M-k ,
500 .Cm M-S- Ns Aq Cm TAB
501 .Xc
502 focus_prev
503 .It Cm M-m
504 focus_main
505 .It Cm M-S-j
506 swap_next
507 .It Cm M-S-k
508 swap_prev
509 .It Cm M-b
510 bar_toggle
511 .It Cm M-x
512 wind_del
513 .It Cm M-S-x
514 wind_kill
515 .It Cm M- Ns Aq Ar 1-9,0,F1-F12
516 .Pf ws_ Aq Ar 1-22
517 .It Cm M-S- Ns Aq Ar 1-9,0,F1-F12
518 .Pf mvws_ Ns Aq Ar 1-22
519 .It Cm M- Ns Aq Cm Right
520 ws_next
521 .It Cm M- Ns Aq Cm Left
522 ws_prev
523 .It Cm M- Ns Aq Cm Up
524 ws_next_all
525 .It Cm M- Ns Aq Cm Down
526 ws_prev_all
527 .It Cm M-a
528 ws_prior
529 .It Cm M-S- Ns Aq Cm Right
530 screen_next
531 .It Cm M-S- Ns Aq Cm Left
532 screen_prev
533 .It Cm M-s
534 screenshot_all
535 .It Cm M-S-s
536 screenshot_wind
537 .It Cm M-S-v
538 version
539 .It Cm M-t
540 float_toggle
541 .It Cm M-S- Ns Aq Cm Delete
542 lock
543 .It Cm M-S-i
544 initscr
545 .It Cm M-w
546 iconify
547 .It Cm M-S-w
548 uniconify
549 .It Cm M-S-r
550 always_raise
551 .It Cm M-v
552 button2
553 .It Cm M--
554 width_shrink
555 .It Cm M-=
556 width_grow
557 .It Cm M-S--
558 height_shrink
559 .It Cm M-S-=
560 height_grow
561 .It Cm M-[
562 move_left
563 .It Cm M-]
564 move_right
565 .It Cm M-S-[
566 move_up
567 .It Cm M-S-]
568 move_down
569 .It Cm M-S-/
570 name_workspace
571 .It Cm M-/
572 search_workspace
573 .It Cm M-f
574 search_win
575 .El
576 .Pp
577 The action names and descriptions are listed below:
578 .Pp
579 .Bl -tag -width "M-j, M-<TAB>XXXX" -offset indent -compact
580 .It Cm term
581 Spawn a new terminal
582 (see
583 .Sx PROGRAMS
584 above).
585 .It Cm menu
586 Menu
587 (see
588 .Sx PROGRAMS
589 above).
590 .It Cm quit
591 Quit
592 .Nm .
593 .It Cm restart
594 Restart
595 .Nm .
596 .It Cm cycle_layout
597 Cycle layout.
598 .It Cm flip_layout
599 Swap the master and stacking areas.
600 .It Cm stack_reset
601 Reset layout.
602 .It Cm master_shrink
603 Shrink master area.
604 .It Cm master_grow
605 Grow master area.
606 .It Cm master_add
607 Add windows to master area.
608 .It Cm master_del
609 Remove windows from master area.
610 .It Cm stack_inc
611 Add columns/rows to stacking area.
612 .It Cm stack_dec
613 Remove columns/rows from stacking area.
614 .It Cm swap_main
615 Move current window to master area.
616 .It Cm focus_next
617 Focus next window in workspace.
618 .It Cm focus_prev
619 Focus previous window in workspace.
620 .It Cm focus_main
621 Focus on main window in workspace.
622 .It Cm swap_next
623 Swap with next window in workspace.
624 .It Cm swap_prev
625 Swap with previous window in workspace.
626 .It Cm bar_toggle
627 Toggle status bar in all workspaces.
628 .It Cm wind_del
629 Delete current window in workspace.
630 .It Cm wind_kill
631 Destroy current window in workspace.
632 .It Cm ws_ Ns Ar n
633 Switch to workspace
634 .Ar n ,
635 where
636 .Ar n
637 is 1 through workspace_limit.
638 .It Cm mvws_ Ns Ar n
639 Move current window to workspace
640 .Ar n ,
641 where
642 .Ar n
643 is 1 through workspace_limit.
644 .It Cm ws_next
645 Switch to next workspace with a window in it.
646 .It Cm ws_prev
647 Switch to previous workspace with a window in it.
648 .It Cm ws_next_all
649 Switch to next workspace.
650 .It Cm ws_prev_all
651 Switch to previous workspace.
652 .It Cm ws_prior
653 Switch to last visited workspace.
654 .It Cm screen_next
655 Move pointer to next region.
656 .It Cm screen_prev
657 Move pointer to previous region.
658 .It Cm screenshot_all
659 Take screenshot of entire screen (if enabled)
660 (see
661 .Sx PROGRAMS
662 above).
663 .It Cm screenshot_wind
664 Take screenshot of selected window (if enabled)
665 (see
666 .Sx PROGRAMS
667 above).
668 .It Cm version
669 Toggle version in status bar.
670 .It Cm float_toggle
671 Toggle focused window between tiled and floating.
672 .It Cm lock
673 Lock screen
674 (see
675 .Sx PROGRAMS
676 above).
677 .It Cm initscr
678 Reinitialize physical screens
679 (see
680 .Sx PROGRAMS
681 above).
682 .It Cm iconify
683 Minimize (unmap) currently focused window.
684 .It Cm uniconify
685 Maximize (map) window returned by dmenu selection.
686 .It Cm always_raise
687 When set tiled windows are allowed to obscure floating windows.
688 .It Cm button2
689 Fake a middle mouse button click (mouse button 2).
690 .It Cm width_shrink
691 Shrink the width of a floating window.
692 .It Cm width_grow
693 Grow the width of a floating window.
694 .It Cm height_shrink
695 Shrink the height of a floating window.
696 .It Cm height_grow
697 Grow the height of a floating window.
698 .It Cm move_left
699 Move a floating window a step to the left.
700 .It Cm move_right
701 Move a floating window a step to the right.
702 .It Cm move_up
703 Move a floating window a step upwards.
704 .It Cm move_down
705 Move a floating window a step downwards.
706 .It Cm name_workspace
707 Name the current workspace.
708 .It Cm search_workspace
709 Search for a workspace.
710 .It Cm search_win
711 Search the windows in the current workspace.
712 .El
713 .Pp
714 Custom bindings in the configuration file are specified as follows:
715 .Pp
716 .Dl bind[<action>] = <keys>
717 .Pp
718 .Aq action
719 is one of the actions listed above (or empty) and
720 .Aq keys
721 is in the form of zero or more modifier keys
722 (MOD, Mod1, Shift, etc.) and one or more normal keys
723 (b, space, etc.), separated by "+".
724 For example:
725 .Bd -literal -offset indent
726 bind[reset] = Mod4+q # bind Windows-key + q to reset
727 bind[] = Mod1+q # unbind Alt + q
728 .Ed
729 .Pp
730 To use the currently defined
731 .Ic modkey ,
732 specify MOD as the modifier key.
733 .Pp
734 Multiple key combinations may be bound to the same action.
735 .Pp
736 To bind non-latin characters such as å or π you must enter the xkb
737 character name instead of the character itself. Run xev, focus the window
738 and press the specific key and in the terminal output read the symbol name.
739 In the fallowing example for å:
740 .Bd -literal -offset indent
741 KeyPress event, serial 41, synthetic NO, window 0x2600001,
742 root 0x15a, subw 0x0, time 106213808, (11,5), root:(359,823),
743 state 0x0, keycode 24 (keysym 0xe5, aring), same_screen YES,
744 XLookupString gives 2 bytes: (c3 a5) "å"
745 XmbLookupString gives 2 bytes: (c3 a5) "å"
746 XFilterEvent returns: False
747 .Ed
748 .Pp
749 The xkb name is aring. In other words, in .spectrwm.conf add:
750 .Bd -literal -offset indent
751 bind[program] = MOD+aring
752 .Ed
753 .Sh KEYBOARD MAPPING FILES
754 Keyboard mapping files for several keyboard layouts are listed
755 below.
756 These files can be used with the
757 .Pa keyboard_mapping
758 setting to load pre-defined key bindings for the specified
759 keyboard layout.
760 .Pp
761 .Bl -tag -width "spectrwm_XX.confXXX" -offset indent -compact
762 .It Cm spectrwm_cz.conf
763 Czech Republic keyboard layout
764 .It Cm spectrwm_es.conf
765 Spanish keyboard layout
766 .It Cm spectrwm_fr.conf
767 French keyboard layout
768 .It Cm spectrwm_fr_ch.conf
769 Swiss French keyboard layout
770 .It Cm spectrwm_se.conf
771 Swedish keyboard layout
772 .It Cm spectrwm_us.conf
773 United States keyboard layout
774 .El
775 .Sh QUIRKS
776 .Nm
777 provides "quirks" which handle windows that must be treated specially
778 in a tiling window manager, such as some dialogs and fullscreen apps.
779 .Pp
780 The default quirks are described below:
781 .Pp
782 .Bl -tag -width "OpenOffice.org N.M:VCLSalFrame<TAB>XXX" -offset indent \
783 -compact
784 .It Firefox\-bin:firefox\-bin
785 TRANSSZ
786 .It Firefox:Dialog
787 FLOAT
788 .It Gimp:gimp
789 FLOAT + ANYWHERE
790 .It MPlayer:xv
791 FLOAT + FULLSCREEN + FOCUSPREV
792 .It OpenOffice.org 2.4:VCLSalFrame
793 FLOAT
794 .It OpenOffice.org 3.1:VCLSalFrame
795 FLOAT
796 .It pcb:pcb
797 FLOAT
798 .It xine:Xine Window
799 FLOAT + ANYWHERE
800 .It xine:xine Panel
801 FLOAT + ANYWHERE
802 .It xine:xine Video Fullscreen Window
803 FULLSCREEN + FLOAT
804 .It Xitk:Xitk Combo
805 FLOAT + ANYWHERE
806 .It Xitk:Xine Window
807 FLOAT + ANYWHERE
808 .It XTerm:xterm
809 XTERM_FONTADJ
810 .El
811 .Pp
812 The quirks themselves are described below:
813 .Pp
814 .Bl -tag -width "XTERM_FONTADJ<TAB>XXX" -offset indent -compact
815 .It FLOAT
816 This window should not be tiled, but allowed to float freely.
817 .It TRANSSZ
818 Adjusts size on transient windows that are too small using dialog_ratio
819 (see
820 .Sx CONFIGURATION FILES ) .
821 .It ANYWHERE
822 Allow window to position itself, uncentered.
823 .It XTERM_FONTADJ
824 Adjust xterm fonts when resizing.
825 .It FULLSCREEN
826 Remove border to allow window to use full screen size.
827 .It FOCUSPREV
828 On exit force focus on previously focused application not previous
829 application in the stack.
830 .El
831 .Pp
832 Custom quirks in the configuration file are specified as follows:
833 .Pp
834 .Dl quirk[<class>:<name>] = <quirk> [ + <quirk> ... ]
835 .Pp
836 .Aq class
837 and
838 .Aq name
839 specify the window to which the quirk(s) apply, and
840 .Aq quirk
841 is one of the quirks from the list above.
842 For example:
843 .Bd -literal -offset indent
844 quirk[MPlayer:xv] = FLOAT + FULLSCREEN + FOCUSPREV
845 quirk[pcb:pcb] = NONE # remove existing quirk
846 .Ed
847 .Pp
848 You can obtain
849 .Aq class
850 and
851 .Aq name
852 by running
853 .Xr xprop 1
854 and then clicking on the desired window.
855 In the following example the main window of Firefox was clicked:
856 .Bd -literal -offset indent
857 $ xprop | grep WM_CLASS
858 WM_CLASS(STRING) = "Navigator", "Firefox"
859 .Ed
860 .Pp
861 Note that grepping for WM_CLASS flips class and name.
862 In the example above the quirk entry would be:
863 .Bd -literal -offset indent
864 quirk[Firefox:Navigator] = FLOAT
865 .Ed
866 .Pp
867 .Nm
868 also automatically assigns quirks to windows based on the value
869 of the window's _NET_WM_WINDOW_TYPE property as follows:
870 .Pp
871 .Bl -tag -width "_NET_WM_WINDOW_TYPE_TOOLBAR<TAB>XXX" -offset indent -compact
872 .It _NET_WM_WINDOW_TYPE_DOCK
873 FLOAT + ANYWHERE
874 .It _NET_WM_WINDOW_TYPE_TOOLBAR
875 FLOAT + ANYWHERE
876 .It _NET_WM_WINDOW_TYPE_UTILITY
877 FLOAT + ANYWHERE
878 .It _NET_WM_WINDOW_TYPE_SPLASH
879 FLOAT
880 .It _NET_WM_WINDOW_TYPE_DIALOG
881 FLOAT
882 .El
883 .Pp
884 In all other cases, no automatic quirks are assigned to the window.
885 Quirks specified in the configuration file override the automatic quirks.
886 .Sh EWMH
887 .Nm
888 partially implements the Extended Window Manager Hints (EWMH) specification.
889 This enables controlling windows as well as
890 .Nm
891 itself from external scripts and programs.
892 This is achieved by
893 .Nm
894 responding to certain ClientMessage events.
895 From the terminal these events
896 can be conveniently sent using tools such as
897 .Xr wmctrl 1
898 and
899 .Xr xdotool 1 .
900 For the
901 actual format of these ClientMessage events, see the EWMH specification.
902 .Pp
903 The id of the currently focused window is stored in the _NET_ACTIVE_WINDOW
904 property of the root window.
905 This can be used for example to retrieve the
906 title of the currently active window with
907 .Xr xprop 1
908 and
909 .Xr grep 1 :
910 .Bd -literal -offset indent
911 $ WINDOWID=`xprop \-root _NET_ACTIVE_WINDOW | grep \-o "0x.*"`
912 $ xprop \-id $WINDOWID WM_NAME | grep \-o "\\".*\\""
913 .Ed
914 .Pp
915 A window can be focused by sending a _NET_ACTIVE_WINDOW client message
916 to the root window.
917 For example, using
918 .Xr wmctrl 1
919 to send the message
920 (assuming 0x4a0000b is the id of the window to be focused):
921 .Bd -literal -offset indent
922 $ wmctrl \-i \-a 0x4a0000b
923 .Ed
924 .Pp
925 Windows can be closed by sending a _NET_CLOSE_WINDOW client message
926 to the root window.
927 For example, using
928 .Xr wmctrl 1
929 to send the message
930 (assuming 0x4a0000b is the id of the window to be closed):
931 .Bd -literal -offset indent
932 $ wmctrl \-i \-c 0x4a0000b
933 .Ed
934 .Pp
935 Windows can be floated and un-floated by adding or removing the
936 _NET_WM_STATE_ABOVE atom from the _NET_WM_STATE property of the window.
937 This can be achieved by sending a _NET_WM_STATE client message to the
938 root window.
939 For example, the following toggles the floating state of
940 a window using
941 .Xr wmctrl 1
942 to send the message (assuming 0x4a0000b is the id of the window floated
943 or un-floated):
944 .Bd -literal -offset indent
945 $ wmctrl \-i \-r 0x4a0000b \-b toggle,_NET_WM_STATE_ABOVE
946 .Ed
947 .Pp
948 Floating windows can also be resized and moved by sending a
949 _NET_MOVERESIZE_WINDOW client message to the root window.
950 For example,
951 using
952 .Xr wmctrl 1
953 to send the message (assuming 0x4a0000b is the id of
954 the window to be resize/moved):
955 .Bd -literal -offset indent
956 $ wmctrl \-i \-r 0x4a0000b \-e 0,100,50,640,480
957 .Ed
958 .Pp
959 This moves the window to (100,50) and resizes it to 640x480.
960 .Pp
961 Any _NET_MOVERESIZE_WINDOW events received for stacked windows are ignored.
962 .Sh SIGNALS
963 Sending
964 .Nm
965 a HUP signal will restart it.
966 .Sh FILES
967 .Bl -tag -width "/etc/spectrwm.confXXX" -compact
968 .It Pa ~/.spectrwm.conf
969 .Nm
970 user specific settings.
971 .It Pa /etc/spectrwm.conf
972 .Nm
973 global settings.
974 .El
975 .Sh HISTORY
976 .Nm
977 was inspired by xmonad & dwm.
978 .Sh AUTHORS
979 .An -nosplit
980 .Nm
981 was written by:
982 .Pp
983 .Bl -tag -width "Ryan Thomas McBride Aq mcbride@countersiege.com " -offset \
984 indent -compact
985 .It Cm Marco Peereboom Aq marco@peereboom.us
986 .It Cm Ryan Thomas McBride Aq mcbride@countersiege.com
987 .It Cm Darrin Chandler Aq dwchandler@stilyagin.com
988 .It Cm Pierre-Yves Ritschard Aq pyr@spootnik.org
989 .It Cm Tuukka Kataja Aq stuge@xor.fi
990 .It Cm Jason L. Wright Aq jason@thought.net
991 .It Cm Reginald Kennedy Aq rk@rejii.com
992 .It Cm Lawrence Teo Aq lteo@lteo.net
993 .It Cm Tiago Cunha Aq tcunha@gmx.com
994 .It Cm David Hill Aq dhill@mindcry.org
995 .El