The world's most popular non-default computer lockscreen.
Go to file
Chris Guillott 986608a1fb update makefile so you can have i3lock-color installed alongside i3lock 2016-02-08 18:18:59 -05:00
.clang-format commit missing .clang-format 2015-03-17 08:50:50 +01:00
.gitignore add .gitignore 2012-04-07 19:41:50 +02:00
.travis.yml use trusty, install libxkbcommon-dev from wily 2015-11-07 14:50:36 +01:00
CHANGELOG update CHANGELOG 2015-05-20 09:14:39 +02:00
LICENSE update debian packaging, update copyright 2011-07-13 17:06:46 +02:00
Makefile update makefile so you can have i3lock-color installed alongside i3lock 2016-02-08 18:18:59 -05:00
README.md have I mentioned I'm bad at markdown? 2016-02-08 16:23:32 -05:00
cursors.h clang-format -i **/*.[ch] 2015-03-16 18:47:16 +01:00
i3lock-color.pam update makefile so you can have i3lock-color installed alongside i3lock 2016-02-08 18:18:59 -05:00
i3lock.1 Remove DPMS support in favor of a wrapper script and xset(1). 2015-08-11 21:50:42 +02:00
i3lock.c patch in i3lock-color commits 2016-02-08 15:53:29 -05:00
i3lock.h clang-format -i **/*.[ch] 2015-03-16 18:47:16 +01:00
todo.md make the readme prettier; add To-do 2016-02-08 16:12:27 -05:00
unlock_indicator.c patch in i3lock-color commits 2016-02-08 15:53:29 -05:00
unlock_indicator.h clang-format -i **/*.[ch] 2015-03-16 18:47:16 +01:00
xcb.c Remove DPMS support in favor of a wrapper script and xset(1). 2015-08-11 21:50:42 +02:00
xcb.h Turn on the screen on successful authentication 2013-11-12 08:24:14 +01:00
xinerama.c Update copyright notices and get rid of ranges 2015-04-21 11:53:09 -04:00
xinerama.h Use (void) instead of () for functions without args (Thanks fernandotcl) 2012-04-01 12:28:28 +02:00

README.md

i3lock-color - improved screen locker

This is just a re-patched version of i3lock with the commits from i3lock-color; all the credit for the color functionality goes to eBrnd !

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 also specify additional color options with the following command-line options:
      • --insidevercolor=rrggbbaa -- Inside of the circle while the password is being verified
      • --insidewrongcolor=rrggbbaa -- Inside of the circle when a wrong password was entered
      • --insidecolor=rrggbbaa -- Inside of the circle while typing/idle
      • --ringvercolor=rrggbbaa -- Outer ring while the password is being
      • --ringwrongcolor=rrggbbaa -- Outer ring when a wrong password was entered
      • --ringcolor=rrggbbaa -- Outer ring while typing/idle
      • --linecolor=rrggbbaa -- Line separating outer ring from inside of the circle and delimiting the highlight segments
      • --textcolor=rrggbbaa -- Text ("verifying", "wrong!")
      • --keyhlcolor=rrggbbaa -- Keypress highlight segments
      • --bshlcolor=rrggbbaa -- Backspace highlight segments
    • All the colors have an alpha channel now. Please keep in mind that this was not intended when the program was originally written, so making things transparent that weren't before can make it look strange.
  • 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
  • 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.

Example usage for colors:

i3lock --insidevercolor=0000a0bf --insidewrongcolor=ff8000bf --insidecolor=ffffffbf --ringvercolor=0020ffff --ringwrongcolor=4040ffff --ringcolor=404090ff --textcolor=ffffffff --linecolor=aaaaaaff --keyhlcolor=30ccccff --bshlcolor=ff8000ff

Upstream

Please submit pull requests for i3lock things to https://github.com/i3/i3lock and pull requests for color things to me at https://github.com/Arcaena/i3lock-color.