swayidle
Idle management daemon for Sway
TLDR
SYNOPSIS
swayidle [options] [events]
DESCRIPTION
swayidle is an idle management daemon compatible with any Wayland compositor implementing the ext-idle-notify protocol. It triggers commands based on user inactivity, supporting multiple timeout events that execute commands after specified periods of idle time, enabling staged power management such as dimming the screen, locking, and eventually suspending.
Resume actions execute when user activity is detected after a timeout, allowing reversal of timeout effects like turning displays back on. The before-sleep and after-resume events integrate with systemd sleep/wake cycles, commonly used to ensure the screen is locked before the system suspends.
Lock and unlock events respond to session lock signals from logind, enabling coordination with external lock requests such as those from the system settings or other applications.
PARAMETERS
timeout SECONDS COMMAND
Run after idle time.resume COMMAND
Run on activity.before-sleep COMMAND
Run before suspend.after-resume COMMAND
Run after wake.lock COMMAND
Run on lock event.unlock COMMAND
Run on unlock.-w
Wait for command to finish before continuing-d
Enable debug output-C path
Path to config file (default: $XDGCONFIGHOME/swayidle/config)-S seat
Specify seat name to use
CAVEATS
Requires a Wayland compositor with ext-idle-notify support. Commands run as shell. Audio playback may prevent idle detection on some compositors.
HISTORY
swayidle is the idle manager for Sway compositor. It handles power management and screen locking triggers.
