index.md RawHistoryFolder

NeferWL documentation

NeferWL is a small Wayland compositor in Go. Start with Configuration to set up your keyboard, outputs and workflows, then use the guides below for desktop integration, screen capture and performance.

  • Configuration: keys, actions, default bindings, layouts and HDR.
  • Desktop integration: sessions, clipboard, input methods, X11 apps, session locking and scripting.
  • Screen capture: protocols, indicator, executable allowlist and portals.
  • Performance: resource use, VRR and real-time priority.

Developer documentation: docs/dev

source
1# NeferWL documentation
2
3NeferWL is a small Wayland compositor in Go. Start with Configuration to set up your keyboard, outputs and workflows, then use the guides below for desktop integration, screen capture and performance.
4
5- [Configuration](config.md): keys, actions, default bindings, layouts and HDR.
6- [Desktop integration](desktop.md): sessions, clipboard, input methods, X11 apps, session locking and scripting.
7- [Screen capture](capture.md): protocols, indicator, executable allowlist and portals.
8- [Performance](performance.md): resource use, VRR and real-time priority.
9
10Developer documentation: [docs/dev](dev/index.md)

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 25

Tags 10

↑↓ moveenter openesc close