Go to file
Michael Stapelberg ef4f9e4057
Switch to autotools (#163)
This was largely copied from the i3 configure.ac and Makefile.am.
2017-12-02 10:08:54 +01:00
.github add CONTRIBUTING.md 2016-06-03 17:28:43 +02:00
m4 Switch to autotools (#163) 2017-12-02 10:08:54 +01:00
pam Switch to autotools (#163) 2017-12-02 10:08:54 +01:00
.clang-format commit missing .clang-format 2015-03-17 08:50:50 +01:00
.gitignore Switch to autotools (#163) 2017-12-02 10:08:54 +01:00
.travis.yml Switch to autotools (#163) 2017-12-02 10:08:54 +01:00
CHANGELOG Update CHANGELOG and I3LOCK_VERSION 2017-11-25 08:13:28 +01:00
I3LOCK_VERSION Update CHANGELOG and I3LOCK_VERSION 2017-11-25 08:13:28 +01:00
LICENSE update debian packaging, update copyright 2011-07-13 17:06:46 +02:00
Makefile.am Switch to autotools (#163) 2017-12-02 10:08:54 +01:00
README.md Use RandR for learning about attached monitors 2017-11-18 10:48:25 +01:00
configure.ac Switch to autotools (#163) 2017-12-02 10:08:54 +01:00
cursors.h clang-format -i **/*.[ch] 2015-03-16 18:47:16 +01:00
i3lock.1 Removed obsolete inactivity timeout (#84) 2016-07-20 07:50:07 +01:00
i3lock.c Switch to autotools (#163) 2017-12-02 10:08:54 +01:00
i3lock.h clang-format -i **/*.[ch] 2015-03-16 18:47:16 +01:00
randr.c Rename xinerama.[ch] to randr.[ch] 2017-11-18 10:51:35 +01:00
randr.h Rename xinerama.[ch] to randr.[ch] 2017-11-18 10:51:35 +01:00
unlock_indicator.c Rename xinerama.[ch] to randr.[ch] 2017-11-18 10:51:35 +01:00
unlock_indicator.h Use bsd_auth(3) instead of PAM on OpenBSD 2017-04-17 15:06:59 +02:00
xcb.c SetInputFocus to the i3lock window to force-close context menus (#155) 2017-10-22 22:16:34 +02:00
xcb.h SetInputFocus to the i3lock window to force-close context menus (#155) 2017-10-22 22:16:34 +02:00

README.md

i3lock - improved screen locker

i3lock is a simple screen locker like slock. After starting it, you will see a white screen (you can configure the color/an image). You can return to your screen by entering your password.

Many little improvements have been made to i3lock over time:

  • i3lock forks, so you can combine it with an alias to suspend to RAM (run "i3lock && echo mem > /sys/power/state" to get a locked screen after waking up your computer from suspend to RAM)

  • You can specify either a background color or a PNG image which will be displayed while your screen is locked.

  • You can specify whether i3lock should bell upon a wrong password.

  • i3lock uses PAM and therefore is compatible with LDAP etc. On OpenBSD i3lock uses the bsd_auth(3) framework.

Requirements

  • pkg-config
  • libxcb
  • libxcb-util
  • libpam-dev
  • libcairo-dev
  • libxcb-xinerama
  • libxcb-randr
  • libev
  • libx11-dev
  • libx11-xcb-dev
  • libxkbcommon >= 0.5.0
  • libxkbcommon-x11 >= 0.5.0

Running i3lock

Simply invoke the 'i3lock' command. To get out of it, enter your password and press enter.

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

Upstream

Please submit pull requests to https://github.com/i3/i3lock