improved improved screen locker - "the ricing fork of i3lock"
C M4 Roff Objective-C Shell Makefile C++
Pull request Compare This branch is 182 commits ahead of i3:master.
Permalink
Failed to load latest commit information.
m4 blurring stuff should work perfectly fine now Dec 6, 2017
pam first commit towards fixing this Dec 5, 2017
.clang-format commit missing .clang-format Mar 17, 2015
.gitignore initial merge commit Dec 5, 2017
.travis.yml first commit towards fixing this Dec 5, 2017
CHANGELOG Update CHANGELOG and I3LOCK_VERSION Nov 25, 2017
I3LOCK_VERSION god i need a better versioning scheme to separate my tags vs upstream… Dec 29, 2017
LICENSE update debian packaging, update copyright Jul 13, 2011
Makefile.am merge jpeg stuff from master Dec 8, 2017
README.md update manpages and readme Dec 9, 2017
blur.c fix compiling for 32-bit machines / machine without SSE2 Dec 7, 2017
blur.h fix compiling for 32-bit machines / machine without SSE2 Dec 7, 2017
blur_simd.c fix compiling on ARM Dec 9, 2017
configure.ac Merge branch 'master' of https://github.com/i3/i3lock Dec 11, 2017
cursors.h clang-format -i **/*.[ch] Mar 16, 2015
i3lock.1 update manpages and readme Dec 9, 2017
i3lock.c potential fix to issue #45 Dec 9, 2017
i3lock.h make render thread optional Dec 8, 2017
jpg.c add support for JPEG images Dec 8, 2017
jpg.h add support for JPEG images Dec 8, 2017
lock.sh fix some leaks; update lock.sh Dec 5, 2017
lock_bar.sh fix the erroneous back_bar bug _for real_ Dec 9, 2017
randr.c Rename xinerama.[ch] to randr.[ch] Nov 18, 2017
randr.h Rename xinerama.[ch] to randr.[ch] Nov 18, 2017
screenshot.png update lock.sh, readme May 31, 2017
tinyexpr.c Made clock position freely modifiable May 19, 2017
tinyexpr.h Made clock position freely modifiable May 19, 2017
todo.md update todo Nov 21, 2017
unlock_indicator.c potential fix to issue #45 Dec 9, 2017
unlock_indicator.h make render thread optional Dec 8, 2017
xcb.c remove deps on libx11; move to a pure xcb solution for keylayout Dec 8, 2017
xcb.h remove deps on libx11; move to a pure xcb solution for keylayout Dec 8, 2017

README.md

i3lock - 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-color in action. Why are you reading this?

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 an image (JPG or PNG), 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.

Additional features in this fork

  • You can also specify additional options, as detailed in the manpage. This includes, but is not limited to, the following:
  • Color options for the following:
    • verification ring
    • interior ring color
    • ring interior line color
    • key highlight color
    • backspace highlight color
    • text colors for most/all strings
    • Changing all of the above depending on PAM's authentication status
  • Blurring the current screen and using that as the lock background
  • Showing a clock in the indicator
  • refreshing on a timer, instead of on each keypress
  • Positioning the various UI elements
  • Changing the ring radius and thickness, as well as text size
  • A new bar indicator, which replaces the ring indicator with its own set of options
    • An experimental thread for driving the redraw ticks, so that things like the bar/clock still update when PAM is blocking

Building

Before you build - check and see if there's a packaged version available for your distro (there usually is, either in a community repo/PPA).

If there's no packaged version available - think carefully, since you're using a forked screen locker at your own risk.

i3lock now uses GNU autotools for building; you'll need to do something like autoreconf -i && ./configure && make to build.

Required Packages

  • pkg-config
  • libxcb
  • libxcb-util
  • libpam-dev
  • libcairo-dev
  • libfontconfig-dev
  • libxcb-composite0
  • libxcb-composite0-dev
  • libxcb-xinerama
  • libxcb-randr
  • libev
  • libx11-xcb-dev
  • libxkbcommon >= 0.5.0
  • libxkbcommon-x11 >= 0.5.0
  • libjpeg-turbo >= 1.4.90
Aur Package

Stable

Git

Running i3lock

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

A sample script is included in this repository. Here is a short clip of that script in action!

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 for i3lock things to https://github.com/i3/i3lock and pull requests for features to me here at https://github.com/PandorasFox/i3lock-color.