Go to file
Michael Stapelberg e1d86a3279 use libxkbcommon for input handling
Thanks to Ran Benita and Daniel Stone (the libxkbcommon authors) for
answering my questions and reviewing this code.

With this commit, input handling should be more correct with using less
code (in i3lock, that is).
2012-10-26 20:39:59 +02:00
.gitignore add .gitignore 2012-04-07 19:41:50 +02:00
CHANGELOG update changelog for 2.4.1 2012-06-02 14:45:12 +02:00
LICENSE update debian packaging, update copyright 2011-07-13 17:06:46 +02:00
Makefile use libxkbcommon for input handling 2012-10-26 20:39:59 +02:00
README use libxkbcommon for input handling 2012-10-26 20:39:59 +02:00
cursors.h Move static byte arrays to xcb.c (fixes compilation warnings) 2010-07-20 23:06:54 +02:00
i3lock.1 manpage: add -u flag in synopsis 2012-03-15 13:32:56 +01:00
i3lock.c use libxkbcommon for input handling 2012-10-26 20:39:59 +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 use libxkbcommon for input handling 2012-10-26 20:39:59 +02:00
unlock_indicator.h Use (void) instead of () for functions without args (Thanks fernandotcl) 2012-04-01 12:28:28 +02:00
xcb.c use libxkbcommon for input handling 2012-10-26 20:39:59 +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 (or you can rewrite the Makefile by hand if you want to avoid it)
- 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.

Building i3lock
-------------
If you don't want to build against libcairo run "make NOLIBCAIRO=y", without
libcairo displaying images is not possible.