From 8fbafbfab5671d56dd469f2205b7906c4a7f7c7c Mon Sep 17 00:00:00 2001
From: Mattias Eriksson <snaggen@mayam.com>
Date: Tue, 17 Apr 2018 09:54:02 +0200
Subject: Idle handling for dpms/lockscreen et al

Swayidle handles idle events and allows
for dpms and lockscreen handling. It also
handles systemd sleep events, and can
raise a lockscreen on sleep

Fixes #541
---
 swayidle/swayidle.1.txt | 67 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 swayidle/swayidle.1.txt

(limited to 'swayidle/swayidle.1.txt')

diff --git a/swayidle/swayidle.1.txt b/swayidle/swayidle.1.txt
new file mode 100644
index 00000000..a32e6fd5
--- /dev/null
+++ b/swayidle/swayidle.1.txt
@@ -0,0 +1,67 @@
+/////
+vim:set ts=4 sw=4 tw=82 noet:
+/////
+:quotes.~:
+
+swayidle (1)
+============
+
+Name
+----
+swayidle - Idle manager for Wayland
+
+Synopsis
+--------
+'swayidle' [options] [events...]
+
+Options
+-------
+
+*-h*::
+	Show help message and quit.
+
+*-d*::
+	Enable debug output.
+
+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.
+
+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.
+
+All commands are executed in a shell.
+
+Example
+-------
+
+ swayidle \
+     timeout 300 'swaylock -c 000000' \
+     timeout 600 'swaymsg "output * dpms off"' \
+		resume 'swaymsg "output * dpms on"' \
+     before-sleep 'swaylock -c 000000'
+
+This will lock your screen after 300 seconds of inactivity, then turn off your
+displays after another 600 seconds, and turn your screens back on when resumed.
+It will also lock your screen before your computer goes to sleep.
+
+Authors
+-------
+
+Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
+source contributors. For more information about sway development, see
+<https://github.com/swaywm/sway>.
+
-- 
cgit v1.2.3