Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

recommend using xss-lock to start i3lock #312

Merged
merged 1 commit into from
Feb 28, 2022
Merged

recommend using xss-lock to start i3lock #312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
18 changes: 16 additions & 2 deletions i3lock.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down