Skip to content

Commit e591a77

Browse files
committed
Add new page on popular configuration options
1 parent a68e4a9 commit e591a77

File tree

2 files changed

+194
-0
lines changed

2 files changed

+194
-0
lines changed

src/configuration.md

Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
# Configuration
2+
3+
This document contains some popular settings that you may wish to adopt.
4+
5+
## General
6+
7+
### Enable Dropshadows
8+
9+
```
10+
<theme>
11+
<dropShadows>yes</dropShadows>
12+
</theme>
13+
```
14+
15+
### Enable automatic window placement policy
16+
17+
```
18+
<placement>
19+
<policy>automatic</policy>
20+
</placement>
21+
```
22+
23+
## Window Switcher
24+
25+
### Show windows regardless of what workspace they are on
26+
27+
```
28+
<windowSwitcher>
29+
<allWorkspaces>yes</allWorkspaces>
30+
</windowSwitcher>
31+
```
32+
33+
## Keybinds
34+
35+
### Lock Session
36+
37+
```
38+
<keybind key="W-l" name.action="Execute" command.action="swaylock -c 000000"/>
39+
```
40+
41+
### Bind Super to a Menu
42+
43+
Supported since `0.7.3`
44+
45+
```
46+
<keybind key="Super_L" onRelease="yes">
47+
<action name="Execute" command="rofi -show drun"/>
48+
</keybind>
49+
```
50+
51+
### Screen Record
52+
53+
```
54+
<keybind key="W-F7" name.action="Execute" command.action="wf-recorder --output eDP-1"/>
55+
<keybind key="W-F8" name.action="Execute" command.action="killall SIGINT wf-recorder"/>
56+
```
57+
58+
### Alt-Tab Backwards
59+
60+
```
61+
<keybind key="S-A-Tab" name.action="PreviousWindow"/>
62+
```
63+
64+
### MoveToEdge, ShrinkToEdge and GrowToEdge
65+
66+
```
67+
<keybind key="W-Left">
68+
<action name="MoveToEdge" direction="left" snapWindows="true"/>
69+
</keybind>
70+
<keybind key="W-Right">
71+
<action name="MoveToEdge" direction="right" snapWindows="true"/>
72+
</keybind>
73+
<keybind key="W-Up">
74+
<action name="MoveToEdge" direction="up" snapWindows="true"/>
75+
</keybind>
76+
<keybind key="W-Down">
77+
<action name="MoveToEdge" direction="down" snapWindows="true"/>
78+
</keybind>
79+
<keybind key="W-S-Left">
80+
<action name="ShrinkToEdge" direction="left"/>
81+
</keybind>
82+
<keybind key="W-S-Right">
83+
<action name="GrowToEdge" direction="right"/>
84+
</keybind>
85+
<keybind key="W-S-Up">
86+
<action name="ShrinkToEdge" direction="up"/>
87+
</keybind>
88+
<keybind key="W-S-Down">
89+
<action name="GrowToEdge" direction="down"/>
90+
</keybind>
91+
```
92+
93+
### SnapToEdge
94+
95+
```
96+
<keybind key="C-W-Left">
97+
<action name="SnapToEdge" direction="left"/>
98+
</keybind>
99+
<keybind key="C-W-Right">
100+
<action name="SnapToEdge" direction="right"/>
101+
</keybind>
102+
<keybind key="C-W-Up">
103+
<action name="SnapToEdge" direction="up"/>
104+
</keybind>
105+
<keybind key="C-W-Down">
106+
<action name="SnapToEdge" direction="down"/>
107+
</keybind>
108+
```
109+
110+
### Unbind alt + arrow
111+
112+
...because they interfere with brower forward/backward binds
113+
114+
```
115+
<keybind key="A-Right"/>
116+
<keybind key="A-Left"/>
117+
<keybind key="A-Up"/>
118+
<keybind key="A-Down"/>
119+
```
120+
121+
## Mousebinds
122+
123+
### Unfosus all windows when clicking on desktop
124+
125+
This relates to `Desktop` in the sense of a layer-shell client such as `swaybg`
126+
which does not receive mouse-events.
127+
128+
Note: Clients such as `xfdesktop` and `pcmanfm --desktop` behave like this
129+
anyway.
130+
131+
```
132+
<context name="Root">
133+
<mousebind button="Left" action="Press">
134+
<action name="Unfocus"/>
135+
</mousebind>
136+
</context>
137+
```
138+
139+
### Directional maximize
140+
141+
```
142+
<context name="Top">
143+
<mousebind button="Left" action="DoubleClick">
144+
<action name="ToggleMaximize" direction="vertical"/>
145+
</mousebind>
146+
</context>
147+
<context name="Bottom">
148+
<mousebind button="Left" action="DoubleClick">
149+
<action name="ToggleMaximize" direction="vertical"/>
150+
</mousebind>
151+
</context>
152+
<context name="Left">
153+
<mousebind button="Left" action="DoubleClick">
154+
<action name="ToggleMaximize" direction="horizontal"/>
155+
</mousebind>
156+
</context>
157+
<context name="Right">
158+
<mousebind button="Left" action="DoubleClick">
159+
<action name="ToggleMaximize" direction="horizontal"/>
160+
</mousebind>
161+
</context>
162+
```
163+
164+
### Magnification
165+
166+
Supported since `0.7.3`
167+
168+
```
169+
<context name="All">
170+
<mousebind direction="W-Up" action="Scroll">
171+
<action name="ZoomIn"/>
172+
</mousebind>
173+
<mousebind direction="W-Down" action="Scroll">
174+
<action name="ZoomOut"/>
175+
</mousebind>
176+
</context>
177+
```
178+
179+
### Switch workspace with super + scroll
180+
181+
Supported since `0.7.3`
182+
183+
```
184+
<context name="All">
185+
<mousebind direction="W-Up" action="Scroll">
186+
<action name="GoToDesktop" to="right"/>
187+
</mousebind>
188+
<mousebind direction="W-Down" action="Scroll">
189+
<action name="GoToDesktop" to="left"/>
190+
</mousebind>
191+
</context>
192+
```
193+

src/more.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
- [configuration](configuration.html)
12
- [troubleshooting](troubleshooting.html)
23
- [tips and tricks](tips-and-tricks.html)
34
- [hidpi scaling](hidpi-scaling.html)

0 commit comments

Comments
 (0)