1# Configuration
2
3NeferWL reads `~/.config/neferwl/config` (or `$XDG_CONFIG_HOME/neferwl/config`). Changes apply when you save, except `startup` and `xwayland`, which apply at the next start.
4
5```sh
6neferwl --config <path>            # use another file
7neferwl validate-config [path]     # check a file
8```
9
10## Format
11
12- One `key = value` per line. `#` starts a comment.
13- Lists are comma-separated; booleans are `on` / `off`.
14- An invalid line logs a warning and keeps the default. If a key appears twice, the last one wins.
15
16See [examples/config](../examples/config) for every key with its default.
17
18## Keys
19
20| Key | Default | Meaning |
21|---|---|---|
22| `keyboard.layout`, `.variant`, `.options` | empty | xkb names, e.g. `fr`, `caps:escape` |
23| `keyboard.repeat-rate` / `.repeat-delay` | `25` / `600` | Repeats per second / delay in ms |
24| `keyboard.cmd` | `super` | Modifier meant by `cmd` in binds: `super`, `alt` or `ctrl` |
25| `terminal` | `$TERMINAL` or `foot` | Terminal command |
26| `terminal.auto-open` | `first` | Open a terminal on the first workspace (`first`), on every empty one (`all`), or never (`off`) |
27| `startup` | none | Commands run at session start, separated by `;` |
28| `xwayland` | `xwayland-satellite` | X11 support; `off` disables it |
29| `background` | `#111111` | Background color |
30| `border.width` | `2` | Border width in pixels; `0` hides borders |
31| `border.active` / `.inactive` | `#808080` / `#111111` | Border colors of the focused / other windows |
32| `floating.dim` | `0.3` | Darkening behind floating windows and the overview, 0 to 1 |
33| `layout.gaps` | `0` | Space between windows |
34| `layout.max-columns` | `2` | Columns that share the screen |
35| `layout.overflow` | `cascade` | What happens past `max-columns`: [`cascade`](#cascade) into bands below, `scroll` right, or `fixed` spiral split |
36| `layout.<output>.max-columns`, `.overflow` | layout values | Per-output layout |
37| `stash.width` | `80` | Width of the selected [stashed](#stash) window, in % of the screen (10–90) |
38| `stash.gap` | `2` | Gap around the selected stashed window, in % (0–10) |
39| `stash.dim` | `0.5` | Darkening of the stash neighbors, 0 to 1 |
40| `stash.capture` | `on` | A window opened while the stash shows joins the stash |
41| `stash.spawn-terminal` | `on` | `toggle-stash-visible` on an empty stash opens `terminal` in it |
42| `touchpad.natural-scroll` | `off` | Content follows the fingers |
43| `touchpad.tap` | `on` | Tap to click |
44| `touchpad.accel-speed` | `0` | Pointer speed, `-1` to `1` |
45| `touchpad.accel-profile` | `adaptive` | `adaptive` or `flat` |
46| `touchpad.left-handed` | `off` | Swap left and right buttons |
47| `touchpad.scroll-factor` | `1` | Scroll speed multiplier, up to `10` |
48| `mouse.natural-scroll`, `.accel-speed`, `.accel-profile`, `.left-handed` | as touchpad | Same, for mice, trackballs and trackpoints |
49| `cursor.hide-after` | `5s` | Hide the cursor after this long without motion, or `off` |
50| `animations` | `off` | **Experimental.** Animate layout changes and make swipes follow the fingers |
51| `animations.speed` | `normal` | `slow`, `normal`, `fast`, or a factor from `0.1` to `10` |
52| `focus.follow-move` | `off` | Follow a column moved to another workspace |
53| `focus.animation` | `pulse` | Brief brightening of a newly focused window, or `off`. Needs `animations = on` |
54| `focus.strength` | `0.04` | Strength of the focus pulse, `0.01` to `0.2` |
55| `workspace.<name>.monitor` | focused output | Home monitor of a named workspace |
56| `workspace.<name>.size` | `inherit` | [Smaller viewport](#workspace-size), e.g. `1920x1080` |
57| `workspace.<name>.max-columns`, `.overflow` | output values | Per-workspace layout |
58| `workspace.<name>.column.<N>` | none | Column slot: `<cells>, <command>` |
59| `rule.<name>.*` | none | [Window rules](#window-rules) |
60| `output.<name>` | `preferred` | `WxH`, `WxH@Hz`, `preferred` or `off` |
61| `output.<name>.scale` | `1` | 1 to 4, e.g. `1.5` or `4/3` |
62| `output.<name>.transform` | `normal` | `90`, `180`, `270`, `flipped`, `flipped-90`, … |
63| `output.<name>.primary` | `off` | Focused at startup |
64| `output.<name>.right-of`, `.left-of`, `.above`, `.below`, `.offset` | automatic | [Output placement](#output-placement) |
65| `output.<name>.hdr` | `off` | [HDR](#hdr) on capable displays |
66| `output.<name>.sdr-brightness` | `203` | Brightness of SDR content in HDR, in nits (80–1000) |
67| `render.direct-scanout` | `on` | Send fullscreen windows straight to the display |
68| `render.tearing` | `on` | Allow tearing for fullscreen games |
69| `render.vrr` | `on` | Variable refresh rate for fullscreen windows |
70| `render.vrr-flip-gap` | `1ms` | See [Performance](performance.md#vrr) |
71| `performance.realtime` | `on` | Real-time scheduling |
72| `log.level` / `log.debug` | `info` / empty | Log level / debug categories or `all` |
73| `bind.<keys>` | see [Default binds](#default-binds) | [Binds](#binds) |
74
75`<output>` is a connector such as `DP-2`, or a monitor key (`make model serial`).
76
77## Window rules
78
79Rules place an app's windows when they first open.
80
81| Key | Meaning |
82|---|---|
83| `rule.<name>.app-id` | Required. [Regular expression](https://pkg.go.dev/regexp/syntax) matching the whole app ID |
84| `rule.<name>.floating` | `on` to float, `off` to tile |
85| `rule.<name>.workspace` | Workspace number or name |
86| `rule.<name>.monitor` | Output |
87| `rule.<name>.width` | Column width in [cells](#column-widths), 1 to 16 |
88
89```ini
90rule.games.app-id = steam_app_.*
91rule.games.workspace = 3
92rule.chat.app-id = discord|org\.telegram\..*
93rule.chat.workspace = chat
94rule.chat.width = 1
95rule.calc.app-id = org\.gnome\.Calculator
96rule.calc.floating = on
97```
98
99- Every matching rule applies, in file order; later rules win.
100- A rule never moves your focus or view.
101- To find an app ID: `neferwl state | jq '.windows[].app_id'`.
102
103## Output placement
104
105By default, outputs sit left to right in config order. Place one against another, and use `offset` (logical pixels) to align the edges:
106
107```ini
108output.DP-2.right-of = DP-1
109output.DP-2.offset = 360    # DP-2 starts 360 px lower than DP-1
110```
111
112```
113┌────────────┐
114│            │┌─────────┐
115│    DP-1    ││  DP-2   │
116│ 2560x1440  ││1920x1080│
117│            │└─────────┘
118└────────────┘
119```
120
121`offset` moves down for `right-of`/`left-of`, and right for `above`/`below`. kanshi, wdisplays and wlr-randr override these settings until the next reload.
122
123## Workspace size
124
125`workspace.<name>.size` gives a named workspace a smaller centered viewport, for example to present at 1080p on a 4K screen:
126
127```ini
128workspace.presentation.size = 1920x1080
129bind.cmd+p = workspace presentation
130```
131
132## Touchpad
133
134| Gesture | Action |
135|---|---|
136| Three fingers left/right | Scroll columns (switch workspace in cascade) |
137| Three fingers up/down | Switch workspace (scroll bands in cascade) |
138| Four fingers up | Open the overview, or hide the stash |
139| Four fingers down | Close the overview, or show/hide the stash |
140
141A swipe moves one step at most. Other gestures (pinch, hold, two-finger scroll) go to the app under the pointer.
142
143## HDR
144
145`output.<name>.hdr = on` sends HDR10 to displays that support it. If the display, driver or GPU cannot, NeferWL falls back to SDR and logs why. NVIDIA is not supported yet.
146
147- HDR-aware apps (games, browsers, video players) can show HDR content. Some need HDR turned on in their own settings. X11 apps stay SDR.
148- The desktop stays SDR, shown at `sdr-brightness` nits.
149- Fullscreen HDR windows go straight to the display.
150- Screenshots and captures are SDR (tone-mapped).
151- If NeferWL crashes, the next compositor may show distorted colours until it sets its own colour pipeline.
152
153## Binds
154
155`bind.<keys> = <action>`. Modifiers: `cmd` (see `keyboard.cmd`), `shift`, `ctrl`, `alt`, `super`.
156
157- Keys are what your layout prints: `cmd+é` on AZERTY. Write `=`, `#` and space by name: `cmd+equal`, `cmd+numbersign`, `cmd+space`.
158- `code:N` is a physical key, the same on every layout: `code:2` to `code:10` are the digits 1 to 9.
159- Other keys use their xkb name (`wev` shows it).
160- `none` removes a default bind.
161- `spawn <command>` runs a program without a shell. See [Running commands](desktop.md#running-commands).
162- Holding a move bind repeats it: focus, move, resize and workspace steps, first after 250 ms, then 8 times a second. Toggles, spawns and closes run once. The overview's arrows and `h/j/k/l` repeat the same way.
163
164```ini
165bind.XF86AudioRaiseVolume = spawn wpctl set-volume -l 1.0 @DEFAULT_AUDIO_SINK@ 5%+
166bind.XF86AudioLowerVolume = spawn wpctl set-volume @DEFAULT_AUDIO_SINK@ 5%-
167bind.XF86AudioMute = spawn wpctl set-mute @DEFAULT_AUDIO_SINK@ toggle
168bind.XF86MonBrightnessUp = spawn brightnessctl set +5%
169bind.XF86MonBrightnessDown = spawn brightnessctl set 5%-
170```
171
172### Actions
173
174| Action | Effect |
175|---|---|
176| `spawn <command>` | Run a program |
177| `spawn-terminal` | Run `terminal` |
178| `stash <command>` | Run a program and open its window in the [stash](#stash) |
179| `close-window` | Close the focused window |
180| `toggle-fullscreen` | Fullscreen the focused window. Nothing shows above it except its own dialogs |
181| `toggle-floating` | Make the focused window [float](#free-floating-windows), or put it back in its column |
182| `toggle-window-stash` | Move the focused window to the [stash](#stash), or back to its column |
183| `toggle-stash-visible` | Show or hide the stash |
184| `toggle-overview` | Open or close the [overview](#overview) |
185| `switch-column-next` / `-prev` | Switch to the previously used column. Hold `cmd` and press again to go further back |
186| `maximize-column` | Toggle full width for the focused column |
187| `cycle-column-width` | Grow the focused column by one [cell](#column-widths), then back to equal widths |
188| `set-column-width <+N\|-N>` | Widen or narrow the focused column by N cells |
189| `set-window-height <+N%\|-N%>` | Change the focused window's share of its column |
190| `focus-column-left/right` | Focus the neighbor column, then the neighbor monitor |
191| `focus-window-up/down` | Focus the neighbor window in the column, then the neighbor workspace (band in cascade) |
192| `move-column-left/right` | Move the focused column, then to the neighbor monitor |
193| `move-window-up/down` | Move the focused window in its column |
194| `consume-or-expel-window-left/right` | Join the neighbor column, or leave the current one |
195| `focus-workspace <N>` / `-prev/-next` | Show a workspace |
196| `workspace <name>` | Show or hide a named workspace |
197| `move-column-to-workspace <N>` / `-prev/-next` | Move the focused column to a workspace |
198| `move-window-to-workspace <N>` / `-prev/-next` | Move the focused window to a workspace |
199| `move-workspace-prev/next` | Swap the workspace with its neighbor |
200| `focus-monitor-left/right/up/down` | Focus the neighbor monitor |
201| `move-workspace-to-monitor-left/right/up/down` | Move the workspace to the neighbor monitor |
202| `scale-up` / `scale-down` | Zoom the display; the scale is saved to the config |
203| `quit` | Exit NeferWL |
204
205### Default binds
206
207| Keys | Action |
208|---|---|
209| `cmd+return` | `spawn-terminal` |
210| `ctrl+cmd+space` | `spawn fuzzel` |
211| `cmd+q` | `close-window` |
212| `cmd+left/right`, `cmd+h/l` | `focus-column-left/right` |
213| `cmd+up/down`, `cmd+k/j` | `focus-window-up/down` |
214| `cmd+shift+left/right`, `cmd+shift+h/l` | `move-column-left/right` |
215| `cmd+shift+up/down`, `cmd+shift+k/j` | `move-window-up/down` |
216| `cmd+bracketleft/bracketright` | `consume-or-expel-window-left/right` |
217| `cmd+alt+left/right`, `cmd+alt+h/l` | `set-column-width -1/+1` |
218| `cmd+alt+up/down`, `cmd+alt+k/j` | `set-window-height -10%/+10%` |
219| `cmd+r` | `cycle-column-width` |
220| `cmd+f` | `maximize-column` |
221| `cmd+shift+f` | `toggle-fullscreen` |
222| `cmd+shift+space` | `toggle-floating` |
223| `cmd+s` | `toggle-stash-visible` |
224| `cmd+shift+s` | `toggle-window-stash` |
225| `cmd+o` | `toggle-overview` |
226| `cmd+tab` / `cmd+shift+tab` | `switch-column-next/prev` |
227| `cmd+1`…`9` (`code:2`…`10`) | `focus-workspace 1`…`9` |
228| `cmd+shift+1`…`9` | `move-column-to-workspace 1`…`9` |
229| `cmd+pageup/pagedown` | `focus-workspace-prev/next` |
230| `cmd+shift+pageup/pagedown` | `move-column-to-workspace-prev/next` |
231| `cmd+ctrl+arrows`, `cmd+ctrl+h/j/k/l` | `focus-monitor-*` |
232| `cmd+ctrl+shift+left/right`, `cmd+ctrl+shift+h/l` | `move-workspace-to-monitor-left/right` |
233| `cmd+ctrl+shift+up/down`, `cmd+ctrl+shift+k/j` | `move-workspace-prev/next` |
234| `cmd+code:12` / `cmd+code:13` (`-` / `=` on US) | `scale-down` / `scale-up` |
235| `ctrl+alt+backspace` | `quit` |
236
237With `keyboard.cmd = alt` or `ctrl`, the defaults that would combine `cmd` with that same modifier are dropped. Bind those actions to other keys.
238
239## Layout
240
241### Cascade
242
243The default layout. Columns sit side by side in bands of up to `max-columns`, stacked one below the other. Each band fills the screen height and keeps its columns until you move them.
244
245- Left/right focus moves within a band, then to the neighbor monitor, then to the neighbor workspace.
246- `move-column-left/right` stays in the band; at its edge the column goes to the neighbor monitor, if any.
247- Up/down moves through the windows of a column, then to the band above or below.
248- `move-window-up/down` past the column's top or bottom sends the whole column to the band above or below. It joins that band when it has room, else it gets a new band between the two.
249- A new window joins the focused band when it has room, else it gets a new band right below.
250- `cycle-column-width` in a full band makes room: the rightmost column goes to the band below (from the last column, the leftmost goes to the band above). The end of the cycle brings it back.
251- `maximize-column` gives the column a band of its own: the columns on its left go to the band above, the ones on its right to the band below. Maximizing again forms the band back.
252- A band left empty goes away. A smaller `max-columns` moves the extra columns of a band to a new band below it.
253
254### Column widths
255
256A cell is `1/max-columns` of the screen width. A column is 1 to 16 cells wide. Columns without a set width share the space equally.
257
258### Stash
259
260Each workspace has a stash: a strip of windows set aside with `toggle-window-stash`. The selected one shows centered over your columns, with its neighbors dimmed on the sides. `focus-column-left/right` or a three-finger swipe browse it. `toggle-stash-visible` or a four-finger swipe hides it.
261
262`stash <command>` runs a program and opens its window straight in the stash of the workspace you were on, selected and focused, even if you switch workspace before it appears. With `stash.spawn-terminal`, `toggle-stash-visible` or the four-finger swipe down on an empty stash does the same with `terminal`.
263
264```ini
265bind.cmd+shift+f = stash firefox
266```
267
268The window must appear within 5 seconds, otherwise it opens normally. Apps that hand a launch to an already running instance (single-instance browsers, `footclient`) open their window normally.
269
270### Free floating windows
271
272`toggle-floating` turns the focused window into a floating window that stays where you put it. On a floating window, move binds move it by 50 pixels and resize binds resize it.
273
274### Moving windows with the pointer
275
276- `cmd` + left drag moves a window. Drop it on the top or bottom of another window to stack it there, or in the middle to swap.
277- `cmd` + right drag resizes a floating window.
278- `Escape` cancels the drag.
279
280### Overview
281
282`toggle-overview` (or a four-finger swipe up) shows previews of your workspaces. Arrows, `h/j/k/l` or three-finger swipes move the selection; `Return` or a click opens it; `Escape` goes back. `close-window` and the move-to-workspace binds work on the selected preview.
283
284A workspace's stash shows as a pile of cards. Selecting the pile unfolds it into a carousel of every stashed window: a row under the workspace with `layout.overflow = cascade`, a column on its left otherwise. The selected card stays in the middle, the earlier cards before it and the later ones after it, wrapping round; a wider gap separates the newest card from the oldest. Moves along the carousel pick a card. With fewer than three cards, or on a workspace holding only stashed windows, it does not wrap round. Leaving it folds it again. Moving to another workspace selects its windows rather than a carousel that wraps round, even when its stash has the focus, so browsing workspaces never stops on one.
285
286With `layout.overflow = cascade`, workspaces sit side by side, each band of columns is a lane, and the stash sits under the lanes. Down (or fingers down on the touchpad, with natural scroll off) moves to the lane below; past the last lane it unfolds the stash. Left/right walk the cards; where the carousel does not wrap round, they go to the neighbor workspace past either end. Up leaves the stash for the last lane, at the column you came from.
287
288Otherwise, left from the first column unfolds the stash. Up/down walk the cards, the focus-workspace binds change workspace, and right goes back to the columns.