Troubleshooting
Find the logs, turn on debug logging, and report a bug
When something goes wrong, start with the session log. It shows what Sweets did and any warnings or errors.
less -R +G ~/.local/state/sweets/sweets.logLogs
| Path | Content |
|---|---|
~/.local/state/sweets/sweets.log | Link to the current session's log |
~/.local/state/sweets/sessions/ | Logs of the current session and the 10 before it |
| Command | Shows |
|---|---|
less -R +G ~/.local/state/sweets/sweets.log | The whole log, opened at the newest lines |
tail -n 100 ~/.local/state/sweets/sweets.log | The last 100 lines |
tail -f ~/.local/state/sweets/sweets.log | New lines as they arrive. Press Ctrl+C to stop. |
In less, -R shows the log's colours and +G starts at the end. Press g
to jump to the top and q to quit.
Find warnings and errors:
grep -E 'WARN|ERROR' ~/.local/state/sweets/sweets.logIf you start sweets-session from a TTY, messages print in that terminal
instead of the log. Add --debug-log to keep them in the file.
To write the log somewhere else, set SWEETS_SESSION_LOG to an absolute path.
Debug log
Debug logging adds more detail about windows and drawing. Use it when the normal log doesn't explain a problem.
| Start from | How |
|---|---|
| Login manager | Pick Sweets (Debug Log) |
| TTY | sweets-session --debug-log |
To choose what is logged, set RUST_LOG before starting:
RUST_LOG=sweets=debug sweets-session --debug-logDebug logs grow quickly. Go back to the normal session once you're done.
After a crash
sweets.log points to the newest session. The session that crashed is the one
before it:
ls -t ~/.local/state/sweets/sessions/ | head -2Config problems
Check your config for errors:
sweets --check-configIn a running session, show the last config error and reload status:
sweets msg configSee Basic Configuration.
Try it in a window
You can run Sweets as a window inside your current desktop. This helps you test a config or reproduce a problem without logging out.
SWEETS_BACKEND=nested sweetsMessages print in the terminal. If your desktop catches Super shortcuts, set
mod_key_nested.
Optional socket name
Sweets normally picks a free wayland-N name. Use --socket if a test or
script needs a predictable WAYLAND_DISPLAY.
SWEETS_BACKEND=nested sweets --socket wayland-demoFor a session started from a TTY, use sweets-session --socket wayland-demo.
Pick an unused name in $XDG_RUNTIME_DIR. An existing socket or lock blocks
startup.
Report a bug
Open an issue on GitHub. Include:
- The output of
sweets msg version - The session log, ideally with debug logging on
- The steps that cause the problem
The log can contain file paths and app names. Read it before you post it.