Go to file
Michael Stapelberg 1dce3ad1c8 README is actually in markdown, so tell github that 2014-12-26 21:03:12 +01:00
.gitignore add .gitignore 2012-04-07 19:41:50 +02:00
CHANGELOG update the changelog/readme for 2.6 2014-07-18 20:24:53 +02:00
LICENSE update debian packaging, update copyright 2011-07-13 17:06:46 +02:00
Makefile listen for XKB events instead of the MappingNotify event (Thanks Ran) 2014-06-21 16:32:18 +02:00
README.md README is actually in markdown, so tell github that 2014-12-26 21:03:12 +01:00
cursors.h Move static byte arrays to xcb.c (fixes compilation warnings) 2010-07-20 23:06:54 +02:00
i3lock.1 implemented logging the number of failed attempts 2014-08-24 23:27:00 +02:00
i3lock.c Ignore password validation is pam is in wrong state 2014-10-13 17:53:49 +02:00
i3lock.h Only output text when in debug mode (fixes problems with xautolock) 2012-03-26 19:54:47 +02: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 implemented logging the number of failed attempts 2014-08-24 23:27:00 +02:00
unlock_indicator.h Extract start/stop timer code to reusable funcs 2014-03-11 09:11:20 +01:00
xcb.c Turn on the screen on successful authentication 2013-11-12 08:24:14 +01:00
xcb.h Turn on the screen on successful authentication 2013-11-12 08:24:14 +01:00
xinerama.c bugfix: free(reply) to avoid memory leak 2012-10-26 20:21:53 +02: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
  • libxkbfile-dev
  • libxkbcommon >= 0.4.0
  • libxkbcommon-x11 >= 0.4.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