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.flash` | `on` | Briefly draw an inner border on the window, column or output an action changed |
54| `focus.flash-width` | `2` | Flash border width in logical pixels, `1` to `8` |
55| `focus.flash-opacity` | `0.6` | Starting opacity of the flash, `0.1` to `1` |
56| `focus.flash-duration` | `200ms` | Fade duration, `50ms` to `1s`; not scaled by `animations.speed` |
57| `focus.flash-color` | `border.active` | Flash color `#rrggbb`; empty uses `border.active` |
58| `hint.enable` | `off` | Turn on the experimental [hint mode](#hint-mode) (restart required) |
59| `hint.targets` | `clickable` | What [hint mode](#hint-mode) labels: `clickable` (links, URLs and buttons) or `links` (links and URLs only) |
60| `hint.text-click` | `ctrl+shift` | Modifiers held for clicks on links found by OCR (terminals open links on a modified click); `none` sends a plain click |
61| `hint.size` | `auto` | Label text size in logical pixels (6 to 72), or `auto` for screen pixel density |
62| `hint.background` | empty | Label background (`#rrggbb`); empty uses `border.active` |
63| `hint.foreground` | empty | Label text (`#rrggbb`); empty chooses a contrasting colour |
64| `workspace.<name>.monitor` | focused output | Home monitor of a named workspace |
65| `workspace.<name>.size` | `inherit` | [Smaller viewport](#workspace-size), e.g. `1920x1080` |
66| `workspace.<name>.max-columns`, `.overflow` | output values | Per-workspace layout |
67| `workspace.<name>.column.<N>` | none | Column slot: `<cells>, <command>` |
68| `rule.<name>.*` | none | [Window rules](#window-rules) |
69| `output.<name>` | `preferred` | `WxH`, `WxH@Hz`, `preferred` or `off` |
70| `output.<name>.scale` | `1` | 1 to 4, e.g. `1.5` or `4/3` |
71| `output.<name>.transform` | `normal` | `90`, `180`, `270`, `flipped`, `flipped-90`, … |
72| `output.<name>.primary` | `off` | Focused at startup |
73| `output.<name>.right-of`, `.left-of`, `.above`, `.below`, `.offset` | automatic | [Output placement](#output-placement) |
74| `output.<name>.hdr` | `off` | [HDR](#hdr) on capable displays |
75| `output.<name>.sdr-brightness` | `203` | Brightness of SDR content in HDR, in nits (80–1000) |
76| `render.direct-scanout` | `on` | Send fullscreen windows straight to the display |
77| `render.tearing` | `on` | Allow tearing for fullscreen games |
78| `render.vrr` | `on` | Variable refresh rate for fullscreen windows |
79| `render.vrr-flip-gap` | `1ms` | See [Performance](performance.md#vrr) |
80| `performance.realtime` | `on` | Real-time scheduling |
81| `log.level` / `log.debug` | `info` / empty | Log level / debug categories or `all` |
82| `bind.<keys>` | see [Default binds](#default-binds) | [Binds](#binds) |
83
84`<output>` is a connector such as `DP-2`, or a monitor key (`make model serial`).
85
86The focus flash marks the window, column or output an action changes with a brief
87inner border. When a flash-triggering action crosses screens, it marks the whole
88destination output, even if that output has no windows. Same-screen workspace
89switches and mouse focus do not trigger a flash.
90It runs when `animations = on`.
91
92## Window rules
93
94Rules place an app's windows when they first open.
95
96| Key | Meaning |
97|---|---|
98| `rule.<name>.app-id` | Required. [Regular expression](https://pkg.go.dev/regexp/syntax) matching the whole app ID |
99| `rule.<name>.floating` | `on` to float, `off` to tile |
100| `rule.<name>.workspace` | Workspace number or name |
101| `rule.<name>.monitor` | Output |
102| `rule.<name>.width` | Column width in [cells](#column-widths), 1 to 16 |
103
104```ini
105rule.games.app-id = steam_app_.*
106rule.games.workspace = 3
107rule.chat.app-id = discord|org\.telegram\..*
108rule.chat.workspace = chat
109rule.chat.width = 1
110rule.calc.app-id = org\.gnome\.Calculator
111rule.calc.floating = on
112```
113
114- Every matching rule applies, in file order; later rules win.
115- A rule never moves your focus or view.
116- To find an app ID: `neferwl state | jq '.windows[].app_id'`.
117
118## Output placement
119
120By default, outputs sit left to right in config order. Place one against another, and use `offset` (logical pixels) to align the edges:
121
122```ini
123output.DP-2.right-of = DP-1
124output.DP-2.offset = 360    # DP-2 starts 360 px lower than DP-1
125```
126
127```
128┌────────────┐
129│            │┌─────────┐
130│    DP-1    ││  DP-2   │
131│ 2560x1440  ││1920x1080│
132│            │└─────────┘
133└────────────┘
134```
135
136`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.
137
138## Workspace size
139
140`workspace.<name>.size` gives a named workspace a smaller centered viewport, for example to present at 1080p on a 4K screen:
141
142```ini
143workspace.presentation.size = 1920x1080
144bind.cmd+p = workspace presentation
145```
146
147## Touchpad
148
149| Gesture | Action |
150|---|---|
151| Three fingers left/right | Scroll columns (switch workspace in cascade) |
152| Three fingers up/down | Switch workspace (scroll bands in cascade) |
153| Four fingers up | Open the overview, or hide the stash |
154| Four fingers down | Close the overview, or show/hide the stash |
155
156A swipe moves one step at most. Other gestures (pinch, hold, two-finger scroll) go to the app under the pointer.
157
158## HDR
159
160`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.
161
162- HDR-aware apps (games, browsers, video players) can show HDR content. Some need HDR turned on in their own settings. X11 apps stay SDR.
163- The desktop stays SDR, shown at `sdr-brightness` nits.
164- Fullscreen HDR windows go straight to the display.
165- Screenshots and captures are SDR (tone-mapped).
166- If NeferWL crashes, the next compositor may show distorted colours until it sets its own colour pipeline.
167
168## Binds
169
170`bind.<keys> = <action>`. Modifiers: `cmd` (see `keyboard.cmd`), `shift`, `ctrl`, `alt`, `super`.
171
172- Keys are what your layout prints: `cmd+é` on AZERTY. Write `=`, `#` and space by name: `cmd+equal`, `cmd+numbersign`, `cmd+space`.
173- `code:N` is a physical key, the same on every layout: `code:2` to `code:10` are the digits 1 to 9.
174- Other keys use their xkb name (`wev` shows it).
175- `none` removes a default bind.
176- `spawn <command>` runs a program without a shell. See [Running commands](desktop.md#running-commands).
177- 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.
178
179```ini
180bind.XF86AudioRaiseVolume = spawn wpctl set-volume -l 1.0 @DEFAULT_AUDIO_SINK@ 5%+
181bind.XF86AudioLowerVolume = spawn wpctl set-volume @DEFAULT_AUDIO_SINK@ 5%-
182bind.XF86AudioMute = spawn wpctl set-mute @DEFAULT_AUDIO_SINK@ toggle
183bind.XF86MonBrightnessUp = spawn brightnessctl set +5%
184bind.XF86MonBrightnessDown = spawn brightnessctl set 5%-
185```
186
187### Actions
188
189| Action | Effect |
190|---|---|
191| `spawn <command>` | Run a program |
192| `spawn-terminal` | Run `terminal` |
193| `stash <command>` | Run a program and open its window in the [stash](#stash) |
194| `close-window` | Close the focused window |
195| `toggle-fullscreen` | Fullscreen the focused window. Nothing shows above it except its own dialogs |
196| `toggle-floating` | Make the focused window [float](#free-floating-windows), or put it back in its column |
197| `toggle-window-stash` | Move the focused window to the [stash](#stash), or back to its column |
198| `toggle-stash-visible` | Show or hide the stash |
199| `toggle-overview` | Open or close the [overview](#overview) |
200| `hint` | Label the links and buttons on the focused screen, then click the one you type ([hint mode](#hint-mode)) |
201| `switch-column-next` / `-prev` | Switch to the previously used column. Hold `cmd` and press again to go further back |
202| `maximize-column` | Toggle full width for the focused column |
203| `cycle-column-width` | Grow the focused column by one [cell](#column-widths), then back to equal widths |
204| `set-column-width <+N\|-N>` | Widen or narrow the focused column by N cells |
205| `set-window-height <+N%\|-N%>` | Change the focused window's share of its column |
206| `focus-column-left/right` | Focus the neighbor column, then the neighbor monitor |
207| `focus-window-up/down` | Focus the neighbor window in the column, then the neighbor workspace (band in cascade) |
208| `move-column-left/right` | Move the focused column, then to the neighbor monitor |
209| `move-window-up/down` | Move the focused window in its column |
210| `consume-or-expel-window-left/right` | Join the neighbor column, or leave the current one |
211| `focus-workspace <N>` / `-prev/-next` | Show a workspace |
212| `workspace <name>` | Show or hide a named workspace |
213| `move-column-to-workspace <N>` / `-prev/-next` | Move the focused column to a workspace |
214| `move-window-to-workspace <N>` / `-prev/-next` | Move the focused window to a workspace |
215| `move-workspace-prev/next` | Swap the workspace with its neighbor |
216| `focus-monitor-left/right/up/down` | Focus the neighbor monitor |
217| `move-workspace-to-monitor-left/right/up/down` | Move the workspace to the neighbor monitor |
218| `scale-up` / `scale-down` | Zoom the display; the scale is saved to the config |
219| `quit` | Exit NeferWL |
220
221### Default binds
222
223| Keys | Action |
224|---|---|
225| `cmd+return` | `spawn-terminal` |
226| `ctrl+cmd+space` | `spawn fuzzel` |
227| `cmd+q` | `close-window` |
228| `cmd+left/right`, `cmd+h/l` | `focus-column-left/right` |
229| `cmd+up/down`, `cmd+k/j` | `focus-window-up/down` |
230| `cmd+shift+left/right`, `cmd+shift+h/l` | `move-column-left/right` |
231| `cmd+shift+up/down`, `cmd+shift+k/j` | `move-window-up/down` |
232| `cmd+bracketleft/bracketright` | `consume-or-expel-window-left/right` |
233| `cmd+alt+left/right`, `cmd+alt+h/l` | `set-column-width -1/+1` |
234| `cmd+alt+up/down`, `cmd+alt+k/j` | `set-window-height -10%/+10%` |
235| `cmd+r` | `cycle-column-width` |
236| `cmd+f` | `maximize-column` |
237| `cmd+shift+f` | `toggle-fullscreen` |
238| `cmd+shift+space` | `toggle-floating` |
239| `cmd+s` | `toggle-stash-visible` |
240| `cmd+shift+s` | `toggle-window-stash` |
241| `cmd+o` | `toggle-overview` |
242| `cmd+tab` / `cmd+shift+tab` | `switch-column-next/prev` |
243| `cmd+1`…`9` (`code:2`…`10`) | `focus-workspace 1`…`9` |
244| `cmd+shift+1`…`9` | `move-column-to-workspace 1`…`9` |
245| `cmd+pageup/pagedown` | `focus-workspace-prev/next` |
246| `cmd+shift+pageup/pagedown` | `move-column-to-workspace-prev/next` |
247| `cmd+ctrl+arrows`, `cmd+ctrl+h/j/k/l` | `focus-monitor-*` |
248| `cmd+ctrl+shift+left/right`, `cmd+ctrl+shift+h/l` | `move-workspace-to-monitor-left/right` |
249| `cmd+ctrl+shift+up/down`, `cmd+ctrl+shift+k/j` | `move-workspace-prev/next` |
250| `cmd+code:12` / `cmd+code:13` (`-` / `=` on US) | `scale-down` / `scale-up` |
251| `ctrl+alt+backspace` | `quit` |
252
253With `keyboard.cmd = alt` or `ctrl`, the defaults that would combine `cmd` with that same modifier are dropped. Bind those actions to other keys.
254
255## Layout
256
257### Cascade
258
259The 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.
260
261- Left/right focus moves within a band, then to the neighbor monitor, then to the neighbor workspace.
262- `move-column-left/right` stays in the band; at its edge the column goes to the neighbor monitor, if any.
263- Up/down moves through the windows of a column, then to the band above or below.
264- `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.
265- A new window joins the focused band when it has room, else it gets a new band right below.
266- `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.
267- `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.
268- A band left empty goes away. A smaller `max-columns` moves the extra columns of a band to a new band below it.
269
270### Column widths
271
272A 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.
273
274### Stash
275
276Each 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.
277
278`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`.
279
280```ini
281bind.cmd+shift+f = stash firefox
282```
283
284The 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.
285
286### Free floating windows
287
288`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.
289
290### Moving windows with the pointer
291
292- `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.
293- `cmd` + right drag resizes a floating window.
294- `Escape` cancels the drag.
295
296### Overview
297
298`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.
299
300A 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.
301
302With `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.
303
304Otherwise, 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.
305
306## Hint mode
307
308Hint mode is experimental and off by default: set `hint.enable = on` and restart NeferWL.
309While it is off, nothing of hint mode runs or uses memory, and the `hint` bind
310logs a notice once and does nothing. A reload does not change it.
311
312`hint` labels the links and buttons on the focused output. Type a label to
313click its target; BackSpace erases a letter, Escape cancels. No bind is set
314by default; for example `bind.cmd+g = hint`.
315
316Labels use the `border.active` colour with a contrasting text colour, and
317their size follows the screen's pixel density. Each label sits just outside
318the top-left corner of its target. Links found by OCR (terminal text) are
319clicked with the `hint.text-click` modifiers held, which is how terminals open
320a link; accessibility targets get a plain click.
321
322### Where targets come from
323
324| Source | Apps | Accuracy | Speed |
325|---|---|---|---|
326| Accessibility tree (AT-SPI) | Firefox, Chromium, GTK, Qt, Electron | Exact: the app reports its own links and buttons | A few milliseconds |
327| Text recognition (OCR) | Everything else: terminals, apps without accessibility | Best effort: URLs, domains and underlined text written on screen | 150 ms or more, more on large screens |
328
329NeferWL asks the accessibility tree first. Windows it does not cover are read
330with OCR, which finds visible URLs, domains, email addresses and underlined
331text. Underlined words get a plain click, and the words of one continuous
332underline form one target; URLs keep the `hint.text-click` modifiers. OCR
333cannot see a link whose address is hidden behind plain text, and it can misread
334small or low-contrast text.
335
336### Requirements
337
338- Accessibility: NeferWL enables it lazily on the first hint scan that queries
339  app windows. Apps started before then may need restarting. Some apps need a flag:
340  - Chromium: `--force-renderer-accessibility`
341  - Electron: `ACCESSIBILITY_ENABLED=1`
342  - Qt: `QT_LINUX_ACCESSIBILITY_ALWAYS_ON=1`
343- OCR: `tesseract` and `tesseract-data-eng`. Without tesseract, OCR is off
344  and hint mode labels only apps that expose the accessibility tree.
345
346### Debugging hint mode
347
348With `hint.enable = on` and `NEFERWL_HINT_DEBUG=1` set when NeferWL starts (for example `NEFERWL_HINT_DEBUG=1 make tty`, or the variable in the launch environment), every successful scan writes three files to `$XDG_STATE_HOME/neferwl/hints/` (`~/.local/state/neferwl/hints/` when unset): `<time>-<output>.png`, the frame as scanned; `<time>-<output>.annotated.png`, the same with each target outlined (OCR links green, accessibility targets magenta, OCR window crops grey); and `<time>-<output>.json`, the targets (with their `source`, `atspi` or `ocr`) and timings. NeferWL keeps the 50 most recent scans and logs a warning at startup. The files contain the screen in clear: delete them after use.