1# Headless mode
2
3Runs NeferWL without a screen, for tests and quick checks:
4
5```sh
6neferwl --backend=headless --screenshot /tmp/neferwl-shots
7WAYLAND_DISPLAY=<name from the log> foot
8```
9
10- `latest.png` shows the current frame. Every frame is also saved as `frame-NNNNNN.png`, so the directory grows.
11- With several outputs, each writes to `<dir>/HEADLESS-<n>/`.
12- `--timeout 5s` stops NeferWL after 5 seconds.
13- `grim` and recorders work too; see [Screen capture](capture.md).
14
15## Input scripts
16
17`--input <file>`, or `--input -` for stdin, plays one command per line:
18
19| Command | Effect |
20|---|---|
21| `type <text>` | Type text |
22| `key Super+Return` | Press a key, with optional Shift, Ctrl, Alt or Super |
23| `hold Super+h 1s` | Press a key like `key`, hold it, then release it |
24| `sleep 1s` | Wait |
25| `move <x> <y>` | Move the pointer, in output coordinates |
26| `click [left\|right\|middle]`, `down <button>`, `up <button>` | Mouse buttons |
27| `swipe up\|down\|left\|right` | Three-finger flick |
28| `swipe4 up\|down` | Four-finger flick |
29
30## Testing input methods
31
32`examples/testime` sends a preedit string, then commits text, each time an app enables text input:
33
34```sh
35WAYLAND_DISPLAY=<name> go run ./examples/testime -preedit nihon -commit 日本
36```
37
38`-count <n>` exits after n commits; `-delay` sets the time between preedit and commit.
39
40## Colour check
41
42`make color-check` renders `examples/testpattern` on a headless output and checks the colours, in SDR and in HDR (`--headless-hdr`). It needs a GPU and `/dev/udmabuf`, and is not part of `make check`.
43
44On a real screen, compare by eye:
45
46```sh
47WAYLAND_DISPLAY=<name> go run ./examples/testpattern -mode hdr -fullscreen   # or -mode sdr
48```