The world's most popular non-default computer lockscreen.
Go to file
Chris Guillott ee0f50de06 add debug make target 2016-10-14 14:47:22 -04:00
.github add CONTRIBUTING.md 2016-06-03 17:28:43 +02:00
.clang-format commit missing .clang-format 2015-03-17 08:50:50 +01:00
.gitignore also fix my gitignore lol 2016-10-01 01:09:25 -04:00
.travis.yml use trusty, install libxkbcommon-dev from wily 2015-11-07 14:50:36 +01:00
CHANGELOG update CHANGELOG 2016-06-04 19:26:57 +02:00
I3LOCK_VERSION Added version files for release tarball. Fixes #40 (#86) 2016-08-13 13:46:35 -07:00
LICENSE update debian packaging, update copyright 2011-07-13 17:06:46 +02:00
Makefile add debug make target 2016-10-14 14:47:22 -04:00
README.md Add specific apt-get command to install dependencies in Ubuntu 2016-06-19 17:22:09 -05:00
cursors.h clang-format -i **/*.[ch] 2015-03-16 18:47:16 +01:00
i3lock.1 resolve merge conflict with upstream 2016-07-20 13:02:06 -05:00
i3lock.c merge upstream 2016-10-01 01:08:08 -04:00
i3lock.h clang-format -i **/*.[ch] 2015-03-16 18:47:16 +01:00
i3lock.pam changed package so it creates an i3lock binary instead of i3lock-color as they are direct replacements 2016-03-27 13:03:07 -04:00
todo.md add option for single-display unlock indicator 2016-02-17 07:51:04 -05:00
unlock_indicator.c upstream merge 2016-10-14 10:32:24 -04:00
unlock_indicator.h Display error message when locking failed (#99) 2016-10-11 13:40:51 -07:00
xcb.c Display error message when locking failed (#99) 2016-10-11 13:40:51 -07: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 verified
      • --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
      • --separatorcolor=rrggbbaa -- Lines delimiting the highlight segments
      • --textcolor=rrggbbaa -- Text ("verifying", "wrong!")
      • --keyhlcolor=rrggbbaa -- Keypress highlight segments
      • --bshlcolor=rrggbbaa -- Backspace highlight segments
      • --line-uses-ring, -r -- the line between the inside and outer ring uses the ring color for its color
      • --line-uses-inside, -s -- the line between the inside and outer ring uses the inside color for its color
      • -S, --screen -- specifies which display to draw the unlock indicator on
    • 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
Ubuntu
sudo apt-get install pkg-config libxcb1 libpam-dev libcairo-dev libxcb-xinerama0-dev libev-dev libx11-dev libx11-xcb-dev libxkbcommon0 libxkbcommon-x11-0 libxcb-dpms0-dev libxcb-image0-dev libxcb-util0-dev libxcb-xkb-dev libxkbcommon-x11-dev

Running i3lock

Simply invoke the 'i3lock-color' command. To get out of it, enter your password and press enter.

Example usage for colors:

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

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.