summaryrefslogtreecommitdiff
path: root/desktop/xss-lock/README
diff options
context:
space:
mode:
Diffstat (limited to 'desktop/xss-lock/README')
-rw-r--r--desktop/xss-lock/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/desktop/xss-lock/README b/desktop/xss-lock/README
new file mode 100644
index 0000000000..5a187fb578
--- /dev/null
+++ b/desktop/xss-lock/README
@@ -0,0 +1,17 @@
+This is xss-lock, a program for using an external locker as the X
+screensaver.
+
+xss-lock can be run at startup with a favorite screensaving or
+screenlocking program:
+
+ xss-lock slock
+
+xset values for screensaver onset are respected. More details can be
+found in the man page.
+
+xss-lock is a good choice for window manager-only graphical setups.
+Desktop environments with native screensaver programs can (and probably
+will) interfere with xss-lock.
+
+Optional dependency: docutils (if not installed, the man page will be
+copied in rather than built)