aboutsummaryrefslogtreecommitdiffstats
path: root/swayidle/swayidle.1.scd
diff options
context:
space:
mode:
Diffstat (limited to 'swayidle/swayidle.1.scd')
-rw-r--r--swayidle/swayidle.1.scd61
1 files changed, 61 insertions, 0 deletions
diff --git a/swayidle/swayidle.1.scd b/swayidle/swayidle.1.scd
new file mode 100644
index 00000000..5cd4a7fd
--- /dev/null
+++ b/swayidle/swayidle.1.scd
@@ -0,0 +1,61 @@
1swayidle (1)
2
3# NAME
4
5swayidle - Idle manager for Wayland
6
7# SYNOPSIS
8
9*swayidle* [options] [events...]
10
11# OPTIONS
12
13*-h*
14 Show help message and quit.
15
16*-d*
17 Enable debug output.
18
19# DESCRIPTION
20
21swayidle listens for idle activity on your Wayland compositor and executes tasks
22on various idle-related events. You can specify any number of events at the
23command line.
24
25# EVENTS
26
27*timeout* <timeout> <timeout command> [resume <resume command>]
28 Execute _timeout command_ if there is no activity for <timeout> seconds.
29
30 If you specify "resume <resume command>", _resume command_ will be run when
31 there is activity again.
32
33*before-sleep* <command>
34 If built with systemd support, executes _command_ before systemd puts the
35 computer to sleep.
36
37All commands are executed in a shell.
38
39# EXAMPLE
40
41```
42 swayidle \
43 timeout 300 'swaylock -c 000000' \
44 timeout 600 'swaymsg "output * dpms off"' \
45 resume 'swaymsg "output * dpms on"' \
46 before-sleep 'swaylock -c 000000'
47```
48
49This will lock your screen after 300 seconds of inactivity, then turn off your
50displays after another 600 seconds, and turn your screens back on when resumed.
51It will also lock your screen before your computer goes to sleep.
52
53# AUTHORS
54
55Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
56source contributors. For more information about sway development, see
57https://github.com/swaywm/sway.
58
59# SEE ALSO
60
61*sway*(5) *swaymsg*(1) *swaygrab*(1) *sway-input*(5) *sway-bar*(5)