Skip to content

Commit 1cc570f

Browse files
stapelbergwlhlm
authored andcommitted
recommend using xss-lock to start i3lock
related to i3#207 related to i3#311 fixes i3#310
1 parent 1855072 commit 1cc570f

File tree

2 files changed

+26
-4
lines changed

2 files changed

+26
-4
lines changed

README.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,16 @@ Requirements
5656

5757
Running i3lock
5858
-------------
59-
Simply invoke the 'i3lock' command. To get out of it, enter your password and
60-
press enter.
59+
60+
To test i3lock, you can directly run the `i3lock` command. To get out of it,
61+
enter your password and press enter.
62+
63+
For a more permanent setup, we strongly recommend using `xss-lock` so that the
64+
screen is locked *before* your laptop suspends:
65+
66+
```
67+
xss-lock --transfer-sleep-lock -- i3lock --nofork
68+
```
6169

6270
On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the
6371
authentication helpers, e.g. `/usr/libexec/auth/login_passwd`.

i3lock.1

+16-2
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,20 @@ i3lock \- improved screen locker
3131
.RB [\|\-u\|]
3232
.RB [\|\-e\|]
3333

34+
.SH RECOMMENDED USAGE
35+
.RB xss-lock
36+
.RB --transfer-sleep-lock
37+
.RB --
38+
.RB i3lock
39+
.RB --nofork
40+
41+
Using
42+
.B xss-lock
43+
ensures that your screen is locked before your laptop suspends.
44+
45+
Notably, using a systemd service file is not adequate, as it will not delay
46+
suspend until your screen is locked.
47+
3448
.SH DESCRIPTION
3549
.B i3lock
3650
is a simple screen locker like slock. After starting it, you will see a white
@@ -156,8 +170,8 @@ use a wrapper script around i3lock like the following:
156170
The \-I (-\-inactivity-timeout=seconds) was removed because it only makes sense with DPMS.
157171

158172
.SH SEE ALSO
159-
.IR xautolock(1)
160-
\- use i3lock as your screen saver
173+
.IR xss-lock(1)
174+
\- hooks up i3lock to the systemd login manager
161175

162176
.IR convert(1)
163177
\- feed a wide variety of image formats to i3lock

0 commit comments

Comments
 (0)