-
Notifications
You must be signed in to change notification settings - Fork 97
/
spectrwm.1
2396 lines (2392 loc) · 62.3 KB
/
spectrwm.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
.\" Copyright (c) 2009-2012 Marco Peereboom <[email protected]>
.\" Copyright (c) 2009 Darrin Chandler <[email protected]>
.\" Copyright (c) 2011-2024 Reginald Kennedy <[email protected]>
.\" Copyright (c) 2011-2012 Lawrence Teo <[email protected]>
.\" Copyright (c) 2011-2012 Tiago Cunha <[email protected]>
.\" Copyright (c) 2012 David Hill <[email protected]>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: July 10 2024 $
.Dt SPECTRWM 1
.Os
.Sh NAME
.Nm spectrwm
.Nd window manager for X11
.Sh SYNOPSIS
.Nm spectrwm
.Op Fl c Ar file
.Op Fl v
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl c Ar file
Specify a configuration file to load instead of scanning for one.
.It Fl d
Enable debug mode and logging to stderr.
.It Fl v
Print version and exit.
.El
.Sh DESCRIPTION
.Nm
is a minimalistic window manager that tries to stay out of the way so that
valuable screen real estate can be used for much more important stuff.
It has sane defaults and does not require one to learn a language to do any
configuration.
It was written by hackers for hackers and it strives to be small, compact and
fast.
.Pp
When
.Nm
starts up, it reads settings from its configuration file,
.Pa spectrwm.conf .
See the
.Sx CONFIGURATION FILES
section below.
.Pp
The following notation is used throughout this page:
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Cm M
Meta
.It Cm S
Shift
.It Aq Cm Name
Named key or button
.El
.Pp
.Nm
is very simple in its use.
Most of the actions are initiated via key or pointer button bindings.
See the
.Sx BINDINGS
section below for defaults and customizations.
.Sh CONFIGURATION FILES
.Nm
looks for the user-configuration file in the following order:
.Pp
.Bl -enum -offset indent -compact
.It
.Pa $XDG_CONFIG_HOME/spectrwm/spectrwm.conf
.It
.Pa ~/.config/spectrwm/spectrwm.conf
(if
.Pa $XDG_CONFIG_HOME
is either not set or empty)
.It
.Pa ~/.spectrwm.conf .
.El
.Pp
If the user-configuration file is not found,
.Nm
then looks for the global configuration file in the following order:
.Pp
.Bl -enum -offset indent -compact
.It
.Pa $XDG_CONFIG_DIRS/spectrwm/spectrwm.conf
(each colon-separated directory in
.Pa $XDG_CONFIG_DIRS )
.It
.Pa /etc/xdg/spectrwm/spectrwm.conf
(if
.Pa $XDG_CONFIG_DIRS
is either not set or empty)
.It
.Pa /etc/spectrwm.conf
.El
.Pp
The format of the file is
.Pp
.Dl Ar keyword Li = Ar setting
.Pp
Where
.Ql =
may be replaced with
.Ql +=
or
.Ql -= ,
if supported by the option.
.Pp
For example:
.Pp
.Dl color_focus = red
.Dl quirk[XTerm] += FLOAT
.Pp
Enabling or disabling an option is done by using 1 or 0 respectively.
.Pp
Colors need to be specified per the
.Xr XQueryColor 3
specification.
In addition, alpha transparency may be specified via the format
.Li rbga : Ns Ar red Ns / Ns Ar green Ns / Ns Ar blue Ns / Ns Ar alpha
(8-bit hex values)
For example, to specify a 50% transparent blue status bar background:
.Pp
.Dl bar_color = rgba:00/00/ff/7f
.Pp
Note that a compositing manager is required for alpha transparency.
.Pp
Mark option values may be wrapped in single/double quotes to prevent
whitespace trimming, specify empty strings, etc.
Literal quote/backslash characters can be escaped with a backslash
.Sq \e ,
when needed.
.Pp
Comments begin with a #.
When a literal
.Ql #
is desired in an option, then it must be escaped with a backslash, i.e. \e#
.Pp
The file supports the following keywords:
.Bl -tag -width 2m
.It Ic autorun
Launch an application in a specified workspace at start-of-day.
Defined in the format
.Li ws Ns Bo Ar idx Bc : Ns Ar application ,
e.g. ws[2]:xterm launches an
.Xr xterm 1
in workspace 2.
Specify
.Sq ws[-1]
to launch applications such as desktop managers and panels in free mode to keep
them always mapped.
.Pp
Note that
.Pa libswmhack.so
is required for "spawn-in-workspace" behavior.
See the
.Sx SWMHACK
section below for more information, tips, and workarounds if a program fails to
spawn in the specified workspace.
.It Ic bar_action
External script that populates additional information in the status bar,
such as battery life.
.It Ic bar_action_expand
Process
.Ic bar_format
character sequences in
.Ic bar_action
output; default is 0.
.It Ic bar_at_bottom
Place the statusbar at the bottom of each region instead of the top.
Default is 0.
.It Ic bar_border Ns Bq Ar x
Border color of status bar(s) on screen number
.Ar x .
Default is rgb:00/80/80.
.It Ic bar_border_free Ns Bq Ar x
Border color of a status bar for a focused region on screen number
.Ar x
when a workspace-free window is focused.
Default is rgb:80/80/00.
.It Ic bar_border_unfocus Ns Bq Ar x
Border color of status bar(s) for unfocused region(s) on screen number
.Ar x .
Default is rgb:00/40/40.
.It Ic bar_border_width
Set status bar border thickness in pixels.
Disable border by setting to 0.
.It Ic bar_color Ns Bq Ar x
Background color of status bar(s) on screen number
.Ar x .
.Pp
A comma-separated list of multiple colors can be specified.
The first value is used as the default background color.
Any of these colors can then be selected as a background color in the status
bar through the use of the markup sequence
.Ic +@bg=n;\&
where n is the color index counting from 0.
.It Ic bar_color_free Ns Bq Ar x
Background color of a status bar for a focused region on screen number
.Ar x
when a workspace-free window is focused.
.Pp
A comma-separated list of multiple colors can be specified, with the same
syntax and behavior as
.Ic bar_color .
Default is rgb:40/40/00.
.Pp
Note that
.Ic bar_color
defines the background color indices that can be used in
.Ic bar_format
markup sequences and is the fallback for colors that are left unspecified in
this option.
.It Ic bar_color_selected Ns Bq Ar x
Background color for selected
.Cm menu
items on screen number
.Ar x .
Defaults to the value of
.Ic bar_border .
.It Ic bar_color_unfocus Ns Bq Ar x
Background color of status bar(s) for unfocused region(s) on screen number
.Ar x .
.Pp
A comma-separated list of multiple colors can be specified, with the same
syntax and behavior as
.Ic bar_color
for unfocused bar(s).
Defaults to the value of
.Ic bar_color .
.Pp
Note that
.Ic bar_color
defines the background color indices that can be used in
.Ic bar_format
markup sequences and is the fallback for colors that are left unspecified in
this option.
.It Ic bar_enabled
Set default
.Ic bar_toggle
state; default is 1.
.It Ic bar_enabled_ws Ns Bq Ar x
Set default
.Ic bar_toggle_ws
state on workspace
.Ar x ;
default is 1.
.It Ic bar_font
Fonts used in the status bar.
Either Xft or X Logical Font Description (XLFD) may be used to specify fonts.
Fallback fonts may be specified by separating each font with a comma.
If all entries are in XLFD syntax, font set will be used.
If at least one entry is Xft, Xft will be used.
.Pp
The default is to use font set.
.Pp
If Xft is used, a comma-separated list of multiple fonts can be specified.
The first entry is the default font.
Any font defined here can then be selected in the status bar through the use of
the markup sequence
.Ic +@fn=n;\&
where n is the font index counting from 0.
.Pp
Also note that
.Xr dmenu 1
prior to 4.6 does not support Xft fonts.
.Pp
Xft examples:
.Bd -literal -offset indent
bar_font = Terminus:style=Regular:pixelsize=14:antialias=true
bar_font = -*-profont-medium-*-*-*-11-*-*-*-*-*-*-*,Terminus:pixelsize=14,\
-*-clean-medium-*-*-*-12-*-*-*-*-*-*-*
.Ed
.Pp
Font set examples:
.Bd -literal -offset indent
bar_font = -*-terminus-medium-*-*-*-14-*-*-*-*-*-*-*
bar_font = -*-profont-medium-*-*-*-11-*-*-*-*-*-*-*,\
-*-terminus-medium-*-*-*-14-*-*-*-*-*-*-*,\
-*-clean-medium-*-*-*-12-*-*-*-*-*-*-*
.Ed
.Pp
To list the available fonts in your system see
.Xr fc-list 1
or
.Xr xlsfonts 1
manpages.
The
.Xr xfontsel 1
application can help with the XLFD setting.
.It Ic bar_font_color Ns Bq Ar x
Foreground color of the status bar(s) on screen number
.Ar x .
.Pp
A comma-separated list of multiple colors can be specified.
The first value is used as the default foreground color.
Any of these colors can then be selected as a foreground color in the status
bar through the use of the markup sequence
.Ic +@fg=n;\&
where n is the color index counting from 0.
.It Ic bar_font_color_free Ns Bq Ar x
Foreground color of a status bar for a focused region on screen number
.Ar x
when a workspace-free window is focused.
.Pp
A comma-separated list of multiple colors can be specified, with the same
syntax and behavior as
.Ic bar_font_color .
Default is rgb:ff/ff/ff.
.Pp
Note that
.Ic bar_font_color
defines the foreground color indices that can be used in
.Ic bar_format
markup sequences and is the fallback for colors that are left unspecified in
this option.
.It Ic bar_font_color_unfocus Ns Bq Ar x
Foreground color of status bar(s) for unfocused region(s) on screen number
.Ar x .
.Pp
A comma-separated list of multiple colors can be specified, with the same
syntax and behavior as
.Ic bar_font_color
for unfocused bar(s).
Defaults to the value of
.Ic bar_font_color .
.Pp
Note that
.Ic bar_font_color
defines the foreground color indices that can be used in
.Ic bar_format
markup sequences and is the fallback for colors that are left unspecified in
this option.
.It Ic bar_font_color_selected Ns Bq Ar x
Foreground color for selected
.Cm menu
items on screen number
.Ar x .
Defaults to the value of
.Ic bar_color .
.It Ic bar_font_pua
Specify a font to override the Unicode Private Use Area code points
(U+E000 -> U+F8FF, U+F0000 -> U+FFFFD, U+100000 -> U+10FFFD).
Some fonts use these code points to provide special icon glyphs.
Available only with Xft fonts.
.It Ic bar_format
Set the bar format string, overriding
.Ic clock_format
and all of the
.Ic enabled
options.
The format is passed through
.Xr strftime 3
before being used.
It may contain the following character sequences:
.Bl -column "Character sequence" "Replaced with" -offset indent
.It Sy "Character sequence" Ta Sy "Replaced with"
.It Li "+<" Ta "Pad with a space"
.It Li "+A" Ta "Output of the external script"
.It Li "+C" Ta "Window class (from WM_CLASS)"
.It Li "+D" Ta "Workspace name"
.It Li "+F" Ta "Focus status indicator"
.It Li "+I" Ta "Workspace index"
.It Li "+L" Ta "Workspace list indicator"
.It Li "+M" Ta "Number of iconic (minimized) windows in workspace"
.It Li "+N" Ta "Screen number"
.It Li "+P" Ta "Window class and instance separated by a colon"
.It Li "+R" Ta "Region index"
.It Li "+S" Ta "Stacking algorithm"
.It Li "+T" Ta "Window instance (from WM_CLASS)"
.It Li "+U" Ta "Urgency hint"
.It Li "+V" Ta "Program version"
.It Li "+w" Ta "Number of windows in workspace"
.It Li "+W" Ta "Window name (from _NET_WM_NAME/WM_NAME)"
.It Li "+|[weight][justify]" Ta Begin new section and reset markup
sequence effects.
.Pp
.Ic weight
is a positive integer used to allocate horizontal space between 'L', 'C'
and 'R' sections (see justify).
The default weight is 1.
.Pp
.Ic justify
can have the value L, C, R or T. L, C, R are for left, center and right
justified sections respectively.
A 'T' section will limit its space usage to fit to the text.
If no value is specified for a given section, the setting from
.Ic bar_justify
is used.
.It Li "++" Ta "A literal" Ql +
.It Li "+@" Ta "Prefix for text markup sequences"
.El
.Pp
The currently recognized text markup sequences are:
.Bl -column "Character sequence" "Action" -offset indent
.It Sy "Character sequence" Ta Sy "Action"
.It Li "+@fn=n;\&" Ta Selects font n (starting at 0) from
.Ic bar_font .
.It Li "+@fg=n;\&" Ta Selects foreground color n (starting at 0) from
.Ic bar_font_color .
.It Li "+@bg=n;\&" Ta Selects background color n (starting at 0) from
.Ic bar_color .
.It Li "+@stp;\&" Ta Stops the interpretation of markup sequences.
Any markup sequence found after +@stp will appear as normal characters in the
status bar.
.El
.Pp
Note that markup sequences in
.Ic bar_action
script output will only be processed if
.Ic bar_action_expand
is enabled.
.Pp
All character sequences may limit its output to a specific length, for
example +64A.
By default, no padding/alignment is done in case the length of the replaced
string is less than the specified length (64 in the example).
The padding/alignment can be enabled using a '_' character in the sequence.
For example: +_64W, +64_W and +_64_W enable padding before (right alignment),
after (left alignment), and both before and after (center alignment) window
name, respectively.
Any characters that do not match the specification are copied as-is.
.It Ic bar_justify
Justify the status bar text.
Possible values are
.Ar left ,
.Ar center ,
and
.Ar right .
.Pp
Note that if the output is not left justified, it may not be properly aligned
in some circumstances, due to the white-spaces in the default static format.
See the
.Ic bar_format
option for more details.
.It Ic bar_workspace_limit
Set the maximum workspace index (counting from 1) to list in the status bar
workspace (+L) and urgency hint (+U) indicators.
Workspaces beyond this value will not be shown.
Default is 0 (disabled).
.It Ic bind Ns Bq Ar x
Bind key or button combo to action
.Ar x .
See the
.Sx BINDINGS
section below.
.It Ic border_width
Set window border thickness in pixels.
Disable all borders by setting to 0.
.It Ic boundary_width
Set region containment boundary width in pixels.
This is how far a window must be dragged/resized (with the pointer) beyond the
region edge before it is allowed outside the region.
Disable the window containment effect by setting to 0.
.It Ic cancelkey
Change the key used as an alternative means of terminating move/resize
operations.
Default is Escape.
.Pp
See the
.Sx BINDINGS
section below for details on how to find key names.
.It Ic click_to_raise
Enable or disable raising stacking priority when clicking on a window.
Default is 1.
.It Ic clock_enabled
Enable or disable displaying the clock in the status bar.
Disable by setting to 0 so a custom clock could be used in the
.Ic bar_action
script.
.It Ic color_focus_free
Border color of the currently focused window that is in free mode.
Default is yellow.
.It Ic color_focus_maximized_free
Border color of the currently focused maximized window that is in free mode.
Defaults to the value of
.Ic color_focus_free .
.It Ic color_unfocus_free
Border color of unfocused windows that are in free mode, default is
rgb:88/88/00.
.It Ic color_unfocus_maximized_free
Border color of unfocused maximized windows that are in free mode.
Defaults to the value of
.Ic color_unfocus_free .
.It Ic color_urgent_free
Border color of urgent windows that are in free mode.
Defaults to the value of
.Ic color_unfocus_free .
.It Ic color_urgent_maximized_free
Border color of urgent maximized windows that are in free mode.
Defaults to the value of
.Ic color_urgent_free .
.It Ic color_focus
Border color of the currently focused window.
Default is red.
.It Ic color_focus_maximized
Border color of the currently focused, maximized window.
Defaults to the value of
.Ic color_focus .
.It Ic color_unfocus
Border color of unfocused windows, default is rgb:88/88/88.
.It Ic color_unfocus_maximized
Border color of unfocused, maximized windows.
Defaults to the value of
.Ic color_unfocus .
.It Ic color_urgent
Border color of urgent windows.
Defaults to the value of
.Ic color_unfocus .
.It Ic color_urgent_maximized
Border color of urgent, maximized windows.
Defaults to the value of
.Ic color_urgent .
.It Ic cycle_visible
Include workspaces that are mapped when switching with
.Ic ws_next ,
.Ic ws_prev ,
.Ic ws_next_all ,
.Ic ws_prev_all ,
.Ic ws_next_move ,
or
.Ic ws_prev_move .
Enable by setting to 1.
.Pp
Note that mapped workspaces will be swapped unless
.Ic workspace_clamp
is enabled.
If
.Ic warp_focus
is also enabled, focus will go to the region where the workspace is mapped.
.It Ic dialog_ratio
Some applications have dialogue windows that are too small to be useful.
This ratio adjusts the window/region size ratio for transient windows
having the TRANSSZ quirk.
For example, 0.6 is 60% of the the monitor size if the current region spans
the monitor.
.It Ic disable_border
Remove border when bar is disabled and there is only one window on the region.
Enable by setting to 1.
Setting this to
.Ar always
removes the border regardless of the bar being enabled/disabled.
Defaults to 0.
.It Ic focus_close
Window to put focus when the focused window is closed.
Possible values are
.Ar first ,
.Ar next ,
.Ar previous
(default),
.Ar last
and
.Ar prior .
.Ar next
and
.Ar previous
are relative to the window that is closed.
.Ar prior
is the last focused window in the workspace.
.It Ic focus_close_wrap
Whether to allow the focus to jump to the last window when the first window
is closed or vice versa.
Disable by setting to 0.
.It Ic focus_default
Window to put focus when no window has been focused.
Possible values are
.Ar first
and
.Ar last
(default).
.It Ic focus_mark_none
Set the
.Ic bar_format
focus status indicator (+F) string to substitute when no window is focused.
Default is ''.
.It Ic focus_mark_normal
Set the
.Ic bar_format
focus status indicator (+F) string to substitute when a normal (not floating,
maximized or free) window is focused.
Default is ''.
.It Ic focus_mark_floating
Set the
.Ic bar_format
focus status indicator (+F) string to substitute when a floating window is
focused.
Default is '(f)'.
.It Ic focus_mark_free
Set the
.Ic bar_format
focus status indicator (+F) string to substitute when a window that is in
free mode is focused.
Default is '(*)'.
.It Ic focus_mark_maximized
Set the
.Ic bar_format
focus status indicator (+F) string to substitute when a maximized window is
focused.
Default is '(m)'.
.It Ic focus_mode Ns Bq Ar t
Set window focus behavior with respect to the pointer.
Possible values:
.Pp
.Bl -tag -width "default" -offset indent -compact
.It Ar default
Set window focus on border crossings caused by cursor motion and
window interaction.
.It Ar follow
Prioritize the pointer location.
Set window focus on all cursor border crossings, including workspace switches
and changes to layout.
.It Ar manual
Ignore the pointer location.
Set window focus on window interaction only.
.El
.Pp
Optionally, it is possible to adjust the focus mode for specific focus
situations.
A comma-separated list of the following situations can be specified for
.Ar t :
.Pp
.Bl -tag -width "uniconify" -offset indent -compact
.It Ar border
Pointer enters a window.
Default is
.Ar follow .
.It Ar configure
Window position/size changed by the client/EWMH.
Default is
.Ar manual .
.It Ar iconify
Window iconified.
Default is
.Ar manual .
.It Ar layout
Workspace layout changed.
Default is
.Ar manual .
.It Ar map
Window maps.
Default is
.Ar manual .
.It Ar move
Window moved to another workspace.
Default is
.Ar manual .
.It Ar startup
.Nm
(re)started.
Default is
.Ar manual .
.It Ar uniconify
Window uniconified.
Default is
.Ar manual .
.It Ar unmap
Window unmaps.
Default is
.Ar manual .
.It Ar workspace
Workspace switched.
Default is
.Ar manual .
.El
.Pp
Note that when
.Ar t
is omitted, the specified setting is applied to all focus situations.
Example:
.Bd -literal -offset indent
focus_mode = follow # Set all focus situations to 'follow'.
focus_mode[map,unmap] = manual # Change only map and unmap to 'manual'.
focus_mode = default # Reset all focus situations to respective default values.
.Ed
.It Ic fullscreen_hide_other
When a fullscreen window is focused and not in
.Ic below
state, hide unrelated windows in the same workspace.
Useful for transparent windows.
Defaults to 0.
.It Ic fullscreen_unfocus
Set handling when a fullscreen window loses focus.
Possible values:
.Pp
.Bl -tag -width "quick_belowXXX" -offset indent -compact
.It Ar none
Leave window fullscreen.
(default)
.It Ar restore
Exit fullscreen.
.It Ar iconify
Minimize/hide the window.
.It Ar float
Exit fullscreen and float window.
.It Ar below
Set
.Ic below
state on the window.
.It Ar quick_below
Set
.Ic below
state on the window, unset when refocused.
.El
.Pp
Note that this option is ignored in max layout.
.It Ic iconic_enabled
Display the number of iconic (minimized) windows in the status bar.
Enable by setting to 1.
.It Ic keyboard_mapping
Clear all key bindings (not button bindings) and load new bindings from the
specified file.
This allows you to load pre-defined key bindings for your keyboard layout.
See the
.Sx KEYBOARD MAPPING FILES
section below for a list of keyboard mapping files that have been provided
for several keyboard layouts.
.Pp
Note that
.Pa /dev/null
can be specified if you only want to clear bindings.
.It Ic layout
Select layout to use at start-of-day.
Defined in the format
.Li ws Ns Bo Ar idx Bc : Ns Ar master_grow : Ns Ar master_add : Ns Ar \
stack_inc : Ns Ar always_raise : Ns Ar stack_mode ,
e.g. ws[2]:-4:0:1:0:horizontal sets workspace 2 to the horizontal stack mode,
shrinks the master area by 4 ticks and adds one window to the stack, while
maintaining default floating window behavior.
Possible
.Ar stack_mode
values are
.Ar vertical ,
.Ar vertical_flip ,
.Ar horizontal ,
.Ar horizontal_flip ,
.Ar max
and
.Ar floating .
.Pp
See
.Ic master_grow ,
.Ic master_shrink ,
.Ic master_add ,
.Ic master_del ,
.Ic stack_inc ,
.Ic stack_dec ,
.Ic stack_balance ,
and
.Ic always_raise
for more information.
Note that the stacking options are complicated and have side-effects.
One should familiarize oneself with these commands before experimenting with
the
.Ic layout
option.
.Pp
This setting is not retained at restart.
.It Ic layout_order
Define the layout sequence used by the
.Ic cycle_layout
action.
Possible values are
.Ar vertical ,
.Ar horizontal ,
.Ar max
and
.Ar floating .
At least one value must be specified, without duplicates.
The default is
.Ar vertical , Ns Ar horizontal , Ns Ar max , Ns Ar floating .
.It Ic max_layout_maximize
Automatically maximize windows in max layout.
Note that automatic maximize behavior is disabled for windows that are
unmaximized in max layout.
Maximizing the window or resetting the layout with
.Ic stack_reset
enables it again.
Enabled by default.
Disable by setting to 0.
.It Ic maximize_hide_bar
When set to 1,
.Ic maximize_toggle
will also hide/restore the bar visibility of the affected workspace.
Defaults to 0.
.It Ic maximize_hide_other
When a maximized window is focused and not in
.Ic below
state, hide unrelated windows in the same workspace.
Useful for transparent windows.
Defaults to 0.
.It Ic maximized_unfocus
Set handling when a maximized window loses focus.
Possible values:
.Pp
.Bl -tag -width "quick_belowXXX" -offset indent -compact
.It Ar none
Leave window maximized.
.It Ar restore
Unmaximize window.
(default)
.It Ar iconify
Minimize/hide the window.
.It Ar float
Unmaximize and float window.
.It Ar below
Set
.Ic below
state on the window.
.It Ar quick_below
Set
.Ic below
state on the window, unset when refocused.
.El
.Pp
Note that this option is ignored in max layout.
.It Ic modkey
Change the current modifier value of
.Ic MOD
in
.Ic bind
entries that come later in the configuration file.
For existing bindings, the new value is substituted for the previous value.
Possible values are
.Ar Mod1
(default),
.Ar Mod2 ,
.Ar Mod3 ,
.Ar Mod4
and
.Ar Mod5 .
.Pp
.Ar Mod1
is generally the Alt key,
.Ar Mod2
is the Command key on macOS and
.Ar Mod4
is the Windows key on a PC.
The current modifier key mapping can be found by running xmodmap(1).
.It Ic name
Set the name of a workspace at start-of-day.
Defined in the format
.Li ws Ns Bo Ar idx Bc : Ns Ar name ,
e.g. ws[1]:Console sets the name of workspace 1 to
.Dq Console .
.It Ic program Ns Bq Ar p
Define new action to spawn a program
.Ar p .
See the
.Sx PROGRAMS
section below.
.It Ic quirk Ns Bq Ar c Ns Bq : Ns Ar i Ns Bq : Ns Ar n Ns Bq : Ns Ar t
Add "quirk" for windows with class
.Ar c ,
instance
.Ar i
(optional), name
.Ar n
(optional), and type
.Ar t
(optional.)
See the
.Sx QUIRKS
section below.
.It Ic region
Allocates a custom region, removing any autodetected regions that occupy the
same space on the specified logical X screen number.
Defined in the format
.Li screen Ns Bo Ar idx Ns Bc : Ns Ar width Ns x Ns Ar height Ns + Ns Ar x Ns \
+ Ns Ar y Ns Bo , Ns Ar rotation Bc ,
e.g. screen[1]:800x1200+0+0 or screen[1]:800x1200+0+0,inverted (with optional
rotation).
.Pp
To make a region span multiple monitors, create a region big enough to cover
them all, e.g. screen[1]:2048x768+0+0 makes the region span two monitors with
1024x768 resolution sitting one next to the other.
.Pp
Possible values for the optional rotation argument are
.Ar normal
(default),
.Ar left ,
.Ar inverted
and
.Ar right .
Note that rotation is used by
.Ic workspace_autorotate .
.It Ic region_padding
Pixel width of empty space within region borders.
Disable by setting to 0.
.It Ic snap_range
Set the distance in pixels a tiled/maximized window must be moved (with the
pointer) to unsnap and float freely.
Set to 0 to unsnap immediately.
Default is 25.
.It Ic spawn_flags Ns Bq Ar p
If search pattern
.Ar p
is specified, change the spawn flags of existing program entries.
If
.Ar p
is omitted, change the default spawn flags for any
.Ic program
or
.Ic autorun
entries that come later in the configuration file.
Note that
.Ar p
is interpreted as a POSIX Extended Regular Expression.
.Pp
One or more of the following flags may be specified in a comma-separated list:
.Pp
.Bl -tag -width "markcurrentXXX" -offset indent -compact
.It Ar nospawnws
When the program is spawned, do not associate the spawn workspace with the
program's windows.
.It Ar xterm_fontadj
Enables automatic font size adjustments when resizing
.Xr xterm 1
windows.
Note that this works in conjunction with the
.Ic term_width
option and the
.Ic XTERM_FONTADJ
quirk.
See the
.Ic term_width
option and
.Sx QUIRKS
section for more information.
.It Ar optional
Disable program validation.
.It Ar none
No flags specified.
.El
.Pp
The default is
.Ar none .
.Pp
In addition to the
.Ql =
operator, this option also supports
.Ql +=
and
.Ql -=
to add/remove flags instead of replacing them.
.Pp
Note that the default of associating windows with the spawn workspace and the
.Ar xterm_fontadj
flag both rely on
.Pa libswmhack.so .
See the
.Sx SWMHACK
section below for more information.
.It Ic spawn_position
Position in stack to place newly spawned windows.
Possible values are
.Ar first ,
.Ar next ,
.Ar previous
and
.Ar last
(default).
.Ar next
and
.Ar previous
are relative to the focused window.
.It Ic stack_enabled
Enable or disable displaying the current stacking algorithm in the status bar.
.It Ic stack_mark_floating
Set the
.Ar floating
layout mark for the
.Ic bar_format
stacking indicator (+S).
Default is '[~]'.
.It Ic stack_mark_horizontal
Set the
.Ar horizontal
layout mark for the
.Ic bar_format
stacking indicator (+S).
Default is '[-]'.
.It Ic stack_mark_horizontal_flip
Set the
.Ar horizontal_flip
layout mark for the
.Ic bar_format
stacking indicator (+S).
Default is '[v]'.