i3lock/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-composite0
- 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
Update README 2010-07-16 17:47:42 +02:00			`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`
s/passwords/password (Thanks xeen) 2010-07-21 01:45:11 +02:00			`to your screen by entering your password.`
Initial import of i3lock 0.9 2009-03-11 22:17:00 +01:00
Update README 2010-07-16 17:47:42 +02:00			`Many little improvements have been made to i3lock over time:`
Initial import of i3lock 0.9 2009-03-11 22:17:00 +01:00
Update README 2010-07-16 17:47:42 +02:00			`- 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)`
Initial import of i3lock 0.9 2009-03-11 22:17:00 +01:00
debian: update packaging 2010-07-16 18:22:33 +02:00			`- You can specify either a background color or a PNG image which will be`
			`displayed while your screen is locked.`
Initial import of i3lock 0.9 2009-03-11 22:17:00 +01:00
Update README 2010-07-16 17:47:42 +02:00			`- You can specify whether i3lock should bell upon a wrong password.`
Initial import of i3lock 0.9 2009-03-11 22:17:00 +01:00
Update README 2010-07-16 17:47:42 +02:00			`- i3lock uses PAM and therefore is compatible with LDAP etc.`
Initial import of i3lock 0.9 2009-03-11 22:17:00 +01:00
Update README 2010-07-16 17:47:42 +02:00			`Requirements`
			`------------`
README: remove unhelpful comment about pkg-config 2012-10-26 20:40:20 +02:00			`- pkg-config`
Update README 2010-07-16 17:47:42 +02:00			`- libxcb`
			`- libxcb-util`
			`- libpam-dev`
			`- libcairo-dev`
Fix covering of composited notifications (#96) Use the XComposite extension to get the composite overlay window, instead of just using the normal root window. This ensures that composited windows are covered. 2017-03-26 15:01:23 +02:00			`- libxcb-composite0`
document the dependency on libxcb-xinerama 2012-03-15 12:35:24 +01:00			`- libxcb-xinerama`
README: also add libev to dependencies 2012-03-15 12:47:40 +01:00			`- libev`
fix compilation on some systems (Thanks badboy) 2012-03-15 13:50:51 +01:00			`- libx11-dev`
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:24:55 +02:00			`- libx11-xcb-dev`
Add support for Compose and dead-keys with libxkbcommon 2015-02-12 00:37:23 +01:00			`- libxkbcommon >= 0.5.0`
			`- libxkbcommon-x11 >= 0.5.0`
Initial import of i3lock 0.9 2009-03-11 22:17:00 +01:00
			`Running i3lock`
			`-------------`
remove support for NOLIBCAIRO, cairo-xcb is widespread by now 2012-10-26 20:42:26 +02:00			`Simply invoke the 'i3lock' command. To get out of it, enter your password and`
			`press enter.`
README: refer to cr.i3wm.org for patches 2013-02-10 15:18:54 +01:00
			`Upstream`
			`--------`
make github the canonical i3lock repository 2014-12-26 21:02:58 +01:00			`Please submit pull requests to https://github.com/i3/i3lock`