swayidle(1)

1swayidle(1)                 General Commands Manual                swayidle(1)
2
3
4

NAME

6       swayidle - Idle manager for Wayland
7

SYNOPSIS

9       swayidle [options] [events...]
10

OPTIONS

12       -h
13           Show help message and quit.
14
15       -d
16           Enable debug output.
17
18       -w
19           Wait for command to finish executing before continuing, helpful for
20           ensuring that a before-sleep command has finished before the system
21           goes to sleep.
22
23           Note: using this option causes swayidle to block until the command
24           finishes.
25

DESCRIPTION

27       swayidle listens for idle activity on your Wayland compositor and exe‐
28       cutes tasks on various idle-related events. You can specify any number
29       of events at the command line.
30
31       Sending SIGUSR1 to swayidle will immediately enter idle state.
32

EVENTS

34       timeout <timeout> <timeout command> [resume <resume command>]
35           Execute timeout command if there is no activity for <timeout> sec‐
36           onds.
37
38           If you specify "resume <resume command>", resume command will be
39           run when there is activity again.
40
41       before-sleep <command>
42           If built with systemd support, executes command before systemd puts
43           the computer to sleep.
44
45           Note: this only delays sleeping up to the limit set in
46           logind.conf(5) by the option InhibitDelayMaxSec. A command that has
47           not finished by then will continue running after resuming from
48           sleep.
49
50       after-resume <command>
51           If built with systemd support, executes command after logind sig‐
52           nals that the computer resumed from sleep.
53
54       lock <command>
55           If built with systemd support, executes command when logind signals
56           that the session should be locked
57
58       unlock <command>
59           If built with systemd support, executes command when logind signals
60           that the session should be unlocked
61
62       idlehint <timeout>
63           If built with systemd support, set IdleHint to indcate an idle
64           logind/elogind session after <timeout> seconds. Adding an idlehint
65           event will also cause swayidle to call SetIdleHint(false) when run,
66           on resume, unlock, etc.
67
68       All commands are executed in a shell.
69

EXAMPLE

71           swayidle -w
72                timeout 300 'swaylock -f -c 000000'
73                timeout 600 'swaymsg "output * dpms off"'
74                     resume 'swaymsg "output * dpms on"'
75                before-sleep 'swaylock -f -c 000000'
76
77       This will lock your screen after 300 seconds of inactivity, then turn
78       off your displays after another 300 seconds, and turn your screens back
79       on when resumed.  It will also lock your screen before your computer
80       goes to sleep.
81
82       To make sure swayidle waits for swaylock to lock the screen before it
83       releases the inhibition lock, the -w options is used in swayidle, and
84       -f in swaylock.
85

AUTHORS

87       Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other
88       open source contributors. For more information about swayidle develop‐
89       ment, see https://github.com/swaywm/swayidle.
90