swayidle man page

swayidle ā€” Idle manager for Wayland

Synopsis

swayidle [options] [events...]

Options

-h

Show help message and quit.

-d

Enable debug output.

-w

Wait for command to finish executing before continuing, helpful for ensuring that a before-sleep command has finished before the system goes to sleep.

Note: using this option causes swayidle to block until the command finishes.

Description

swayidle listens for idle activity on your Wayland compositor and executes tasks on various idle-related events. You can specify any number of events at the command line.

Sending SIGUSR1 to swayidle will immediately enter idle state.

Events

timeout <timeout> <timeout command> [resume <resume command>]

Execute timeout command if there is no activity for <timeout> seconds.

If you specify "resume <resume command>", resume command will be run when there is activity again.

before-sleep <command>

If built with systemd support, executes command before systemd puts the computer to sleep.

Note: this only delays sleeping up to the limit set in logind.conf(5) by the option InhibitDelayMaxSec. A command that has not finished by then will continue running after resuming from sleep.

after-resume <command>

If built with systemd support, executes command after logind signals that the computer resumed from sleep.

lock <command>

If built with systemd support, executes command when logind signals that the session should be locked

unlock <command>

If built with systemd support, executes command when logind signals that the session should be unlocked

All commands are executed in a shell.

Example

  swayidle -w 
  	timeout 300 'swaylock -f -c 000000' 
  	timeout 600 'swaymsg "output * dpms off"' 
  		resume 'swaymsg "output * dpms on"' 
  	before-sleep 'swaylock -f -c 000000'

This will lock your screen after 300 seconds of inactivity, then turn off your displays after another 300 seconds, and turn your screens back on when resumed. It will also lock your screen before your computer goes to sleep.

To make sure swayidle waits for swaylock to lock the screen before it releases the inhibition lock, the -w options is used in swayidle, and -f in swaylock.

Authors

Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open source contributors. For more information about swayidle development, see https://github.com/swaywm/swayidle.

See Also

sway(5) swaymsg(1) sway-input(5) sway-output(5) sway-bar(5) loginctl(1)

Info

2019-07-27