Go to file
Michael Stapelberg a5c6b2653e add CONTRIBUTING.md
…so that people know we don’t want to extend i3lock’s image handling.

related to #81, #68, #31
2016-06-03 17:28:43 +02:00
.github add CONTRIBUTING.md 2016-06-03 17:28:43 +02:00
.clang-format commit missing .clang-format 2015-03-17 08:50:50 +01:00
.gitignore add .gitignore 2012-04-07 19:41:50 +02:00
.travis.yml use trusty, install libxkbcommon-dev from wily 2015-11-07 14:50:36 +01:00
CHANGELOG update CHANGELOG 2015-05-20 09:14:39 +02:00
LICENSE update debian packaging, update copyright 2011-07-13 17:06:46 +02:00
Makefile makefile: s/README/README.md/ 2015-05-20 09:00:19 +02:00
README.md Remove libxkbfile dependency from README.md/comments 2015-11-07 14:51:02 +01:00
cursors.h clang-format -i **/*.[ch] 2015-03-16 18:47:16 +01:00
i3lock.1 Remove DPMS support in favor of a wrapper script and xset(1). 2015-08-11 21:50:42 +02:00
i3lock.c Add support for `xss-lock --transfer-sleep-lock' (#75) 2016-05-25 22:21:12 +02:00
i3lock.h clang-format -i **/*.[ch] 2015-03-16 18:47:16 +01:00
i3lock.pam use 'auth include login' instead of '@include login', the latter is debian-specific (Thanks mseed) 2011-01-23 00:11:51 +01:00
unlock_indicator.c Show unlock indicator if password was entered during PAM verification 2015-12-25 22:10:06 +01:00
unlock_indicator.h clang-format -i **/*.[ch] 2015-03-16 18:47:16 +01:00
xcb.c Flush xcb connection after opening fullscreen window (#74) 2016-05-25 22:19:17 +02:00
xcb.h Turn on the screen on successful authentication 2013-11-12 08:24:14 +01:00
xinerama.c Update copyright notices and get rid of ranges 2015-04-21 11:53:09 -04:00
xinerama.h Use (void) instead of () for functions without args (Thanks fernandotcl) 2012-04-01 12:28:28 +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.

Requirements

  • pkg-config
  • libxcb
  • libxcb-util
  • libpam-dev
  • libcairo-dev
  • libxcb-xinerama
  • 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.

Upstream

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