summaryrefslogtreecommitdiff
path: root/README.md
blob: be23a9063e066e940f170f9328229f9f733344f7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
i3lock-img - improved screen locker fork with increased custom image capabilities
===============================
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.

i3lock-img 
- adds the ability to specify -k to display certain images based on 
  number of characters entered

- adds the ability to specify -a to display certain images at various
  authorization states instead of the old ugly circle

example :
  i3lock-img -a ./auth -k ./keypress -K 50
  - will display ./auth/0.png on idle, ./auth/1.png of verify, ./auth/3.png on wrong password
  - will display ./keypress/$x.png based on how man characters, $x of the password have been 
    entered up until ./auth/49.png
 
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.
  On OpenBSD i3lock uses the bsd_auth(3) framework.

Requirements
------------
- pkg-config
- libxcb
- libxcb-util
- libpam-dev
- libcairo-dev
- 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.

On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the
authentication helpers, e.g. `/usr/libexec/auth/login_passwd`.

Upstream
--------
Please submit pull requests to https://github.com/i3/i3lock