Go to file
Vincent Bernat 5627a11174 Add `-e` option to not validate empty password.
When the XF86ScreenSaver key is used to put a laptop to sleep (or to
trigger the screensaver), the key may "bounce" on resume. This is
annoying as i3lock will try to validate several empty passwords and
wait several seconds before accepting a legit password.

Some users may want to validate an empty password: PAM may rely on
other sources to unlock the screen, like the presence of a token or
the proximity of some Bluetooth device. Hence, we don't forbid this
possibility and provide an command-line option for users not willing
to validate empty passwords.
2013-08-31 20:41:12 +02:00
.gitignore add .gitignore 2012-04-07 19:41:50 +02:00
CHANGELOG update changelog for 2.5 2013-06-09 11:41:33 +02:00
LICENSE update debian packaging, update copyright 2011-07-13 17:06:46 +02:00
Makefile add xcb-atom to pkg-config calls 2013-06-09 11:48:39 +02:00
README README: refer to cr.i3wm.org for patches 2013-02-10 15:18:54 +01:00
cursors.h Move static byte arrays to xcb.c (fixes compilation warnings) 2010-07-20 23:06:54 +02:00
i3lock.1 Add `-e` option to not validate empty password. 2013-08-31 20:41:12 +02:00
i3lock.c Add `-e` option to not validate empty password. 2013-08-31 20:41:12 +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 Fix centering the indicator in the no-xinerama case 2013-03-29 10:14:01 +01:00
unlock_indicator.h Use (void) instead of () for functions without args (Thanks fernandotcl) 2012-04-01 12:28:28 +02:00
xcb.c Set window name 2013-04-11 22:54:48 +02:00
xcb.h use libxkbcommon for input handling 2012-10-26 20:39:59 +02: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

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.2.0

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

Upstream
--------
Please submit patches to http://cr.i3wm.org/