.\" Generated by scdoc 1.10.0
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "swayidle" "1" "2020-02-07"
.P
.SH NAME
.P
swayidle - Idle manager for Wayland
.P
.SH SYNOPSIS
.P
\fBswayidle\fR [options] [events...]
.P
.SH OPTIONS
.P
\fB-h\fR
.RS 4
Show help message and quit.
.P
.RE
\fB-d\fR
.RS 4
Enable debug output.
.P
.RE
\fB-w\fR
.RS 4
Wait for command to finish executing before continuing, helpful for ensuring
that a \fBbefore-sleep\fR command has finished before the system goes to sleep.
.P
Note: using this option causes swayidle to block until the command finishes.
.P
.RE
.SH DESCRIPTION
.P
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.
.P
Sending SIGUSR1 to swayidle will immediately enter idle state.
.P
.SH EVENTS
.P
\fBtimeout\fR <timeout> <timeout command> [resume <resume command>]
.RS 4
Execute \fItimeout command\fR if there is no activity for <timeout> seconds.
.P
If you specify "resume <resume command>", \fIresume command\fR will be run when
there is activity again.
.P
.RE
\fBbefore-sleep\fR <command>
.RS 4
If built with systemd support, executes \fIcommand\fR before systemd puts the
computer to sleep.
.P
Note: this only delays sleeping up to the limit set in \fBlogind.conf(5)\fR by
the option InhibitDelayMaxSec. A command that has not finished by then will
continue running after resuming from sleep.
.P
.RE
\fBafter-resume\fR <command>
.RS 4
If built with systemd support, executes \fIcommand\fR after logind signals that the
computer resumed from sleep.
.P
.RE
\fBlock\fR <command>
.RS 4
If built with systemd support, executes \fIcommand\fR when logind signals that the
session should be locked
.P
.RE
\fBunlock\fR <command>
.RS 4
If built with systemd support, executes \fIcommand\fR when logind signals that the
session should be unlocked
.P
.RE
\fBidlehint\fR <timeout>
.RS 4
If built with systemd support, set IdleHint to indcate an idle logind/elogind
session after <timeout> seconds. Adding an idlehint event will also cause
swayidle to call SetIdleHint(false) when run, on resume, unlock, etc.
.P
.RE
All commands are executed in a shell.
.P
.SH EXAMPLE
.P
.nf
.RS 4
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'
.fi
.RE
.P
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.
.P
To make sure swayidle waits for swaylock to lock the screen before it releases the
inhibition lock, the \fB-w\fR options is used in swayidle, and \fB-f\fR in swaylock.
.P
.SH AUTHORS
.P
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.
.P
.SH SEE ALSO
.P
\fBsway\fR(5) \fBswaymsg\fR(1) \fBsway-input\fR(5) \fBsway-output\fR(5) \fBsway-bar\fR(5) \fBloginctl\fR(1)