feat/data-dnd e05cb15

session-lock.md RawHistoryFolder

Session locking

NeferWL supports ext-session-lock-v1 with an external locker such as swaylock or hyprlock. The locker checks the password; NeferWL hides the desktop and blocks input.

While locked

  • Only the locker gets input. Binds, clipboard requests and new captures are refused.
  • Outputs show black and the locker's surfaces only.
  • Running captures stop.
  • Ctrl+Alt+Backspace is disabled. VT switching still works.
  • A locker that uses a screenshot as background (hyprlock screenshot, swaylock-effects --screenshots) must be in the capture allowlist.

The locker is told locked only once every output shows a protected frame or is off.

If the locker dies

The session stays locked and black. Start a new locker to take over. There is no emergency unlock key and no timeout.

A locker that exits right after unlocking must do a Wayland roundtrip first, or its exit counts as a crash and the session stays locked.

Limits

  • NeferWL does not authenticate: no PAM, no stored credentials.
  • Any process running as your user can start its own locker and unlock.
  • Clipboard data and window contents a client received before the lock stay with that client.
  • The state file is not cleared while locked.
source
1# Session locking
2
3NeferWL supports `ext-session-lock-v1` with an external locker such as swaylock or hyprlock. The locker checks the password; NeferWL hides the desktop and blocks input.
4
5## While locked
6
7- Only the locker gets input. Binds, clipboard requests and new captures are refused.
8- Outputs show black and the locker's surfaces only.
9- Running captures stop.
10- `Ctrl+Alt+Backspace` is disabled. VT switching still works.
11- A locker that uses a screenshot as background (hyprlock `screenshot`, swaylock-effects `--screenshots`) must be in the [capture allowlist](capture.md#the-allowlist).
12
13The locker is told `locked` only once every output shows a protected frame or is off.
14
15## If the locker dies
16
17The session stays locked and black. Start a new locker to take over. There is no emergency unlock key and no timeout.
18
19A locker that exits right after unlocking must do a Wayland roundtrip first, or its exit counts as a crash and the session stays locked.
20
21## Limits
22
23- NeferWL does not authenticate: no PAM, no stored credentials.
24- Any process running as your user can start its own locker and unlock.
25- Clipboard data and window contents a client received before the lock stay with that client.
26- The [state file](desktop.md#state-for-scripts) is not cleared while locked.

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