Go to file
Michael Stapelberg 544f535bbf add .gitignore 2012-04-07 19:41:50 +02:00
debian debian: update changelog for 2.3.1 2012-03-15 17:02:00 +01:00
.gitignore add .gitignore 2012-04-07 19:41:50 +02:00
CHANGELOG add CHANGELOG file 2012-04-01 13:14:25 +02:00
LICENSE update debian packaging, update copyright 2011-07-13 17:06:46 +02:00
Makefile add CHANGELOG file 2012-04-01 13:14:25 +02:00
README fix compilation on some systems (Thanks badboy) 2012-03-15 13:50:51 +01: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 (void) instead of () for functions without args (Thanks fernandotcl) 2012-04-01 12:28:28 +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
keysym2ucs.c Bugfix: Handle numpad keys correctly (Thanks Pascal) 2010-11-08 14:43:07 +01:00
keysym2ucs.h Initial commit of the XCB rewrite of i3lock 2010-07-16 17:35:51 +02:00
ucs2_to_utf8.c change ALL the copyrights! 2012-01-03 18:20:37 +00:00
ucs2_to_utf8.h Initial commit of the XCB rewrite of i3lock 2010-07-16 17:35:51 +02:00
unlock_indicator.c Use (void) instead of () for functions without args (Thanks fernandotcl) 2012-04-01 12:28:28 +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 Bugfix: Copy the color depth from parent (root) window instead of hardcoding to 24 (Thanks hafron) 2012-01-15 16:15:05 +00:00
xcb.h Implement Xinerama support (not used yet) 2012-01-03 23:10:56 +00:00
xinerama.c Use (void) instead of () for functions without args (Thanks fernandotcl) 2012-04-01 12:28:28 +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

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.