improved screen locker
Clone or download
Pull request Compare This branch is 5 commits ahead, 55 commits behind i3:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
examples
.clang-format
.gitignore
.travis.yml
CHANGELOG
LICENSE
Makefile
README.md
button.h
cursors.h
i3lock.1
i3lock.c
i3lock.h
i3lock.pam
unlock_indicator.c
unlock_indicator.h
xcb.c
xcb.h
xinerama.c
xinerama.h

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-xinerama
  • libev
  • libx11-dev
  • libx11-xcb-dev
  • libxkbcommon >= 0.5.0
  • libxkbcommon-x11 >= 0.5.0
  • librsvg

Running i3lock

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

Creating indicator SVGs

In each state a specific object id will be rendered. Used ids are:

  • "idle"
  • "verify"
  • "fail"
  • "backspace"
  • "animXX" for frames of the typing animation, where XX is a ascending number starting at "00".
  • "fg" and "bg" for foreground and background

If the id "sequential_animation" is present, animation frames will be rendered in ascending order instead of random order.

If the id "remove_background" is present "idle", "verfiy" and "fail" won't be rendered when drawing the animation frames.

Upstream

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