From 2ab9a397abd0afa4c6178001a6dae94027793621 Mon Sep 17 00:00:00 2001 From: Michael Stapelberg Date: Sun, 27 Feb 2022 23:55:57 +0100 Subject: [PATCH] recommend using xss-lock to start i3lock related to https://github.com/i3/i3lock/issues/207 related to https://github.com/i3/i3lock/issues/311 fixes https://github.com/i3/i3lock/issues/310 --- README.md | 12 ++++++++++-- i3lock.1 | 18 ++++++++++++++++-- 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cb2cde9..e1ee745 100644 --- a/README.md +++ b/README.md @@ -44,8 +44,16 @@ Requirements Running i3lock ------------- -Simply invoke the 'i3lock' command. To get out of it, enter your password and -press enter. + +To test i3lock, you can directly run the `i3lock` command. To get out of it, +enter your password and press enter. + +For a more permanent setup, we strongly recommend using `xss-lock` so that the +screen is locked *before* your laptop suspends: + +``` +xss-lock --transfer-sleep-lock -- i3lock --nofork +``` On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the authentication helpers, e.g. `/usr/libexec/auth/login_passwd`. diff --git a/i3lock.1 b/i3lock.1 index cefd0d8..31ff36e 100644 --- a/i3lock.1 +++ b/i3lock.1 @@ -29,6 +29,20 @@ i3lock \- improved screen locker .RB [\|\-e\|] .RB [\|\-f\|] +.SH RECOMMENDED USAGE +.RB xss-lock +.RB --transfer-sleep-lock +.RB -- +.RB i3lock +.RB --nofork + +Using +.B xss-lock +ensures that your screen is locked before your laptop suspends. + +Notably, using a systemd service file is not adequate, as it will not delay +suspend until your screen is locked. + .SH DESCRIPTION .B i3lock is a simple screen locker like slock. After starting it, you will see a white @@ -161,8 +175,8 @@ use a wrapper script around i3lock like the following: The \-I (-\-inactivity-timeout=seconds) was removed because it only makes sense with DPMS. .SH SEE ALSO -.IR xautolock(1) -\- use i3lock as your screen saver +.IR xss-lock(1) +\- hooks up i3lock to the systemd login manager .IR convert(1) \- feed a wide variety of image formats to i3lock