Skip to content
improved screen locker
Branch: master
Clone or download
Airblader Merge pull request #213 from trickeydan/patch-1
Rename Win Key to Super Key
Latest commit 78a601b Apr 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Added ISSUE_TEMPLATE.md May 20, 2018
m4 Switch to autotools (#163) Dec 2, 2017
pam Switch to autotools (#163) Dec 2, 2017
travis travis: build in Debian sid Docker container May 11, 2018
.clang-format commit missing .clang-format Mar 17, 2015
.gitignore Switch to autotools (#163) Dec 2, 2017
.travis.yml travis: build in Debian sid Docker container May 11, 2018
CHANGELOG Update CHANGELOG and I3LOCK_VERSION Oct 18, 2018
I3LOCK_VERSION update I3LOCK_VERSION Oct 18, 2018
LICENSE update debian packaging, update copyright Jul 13, 2011
Makefile.am Add option to lock TTY switching Nov 29, 2018
README.md Install instructions just point to the website Mar 18, 2019
configure.ac Respect Xft.dpi for determining the unlock indicator’s scale factor May 11, 2018
cursors.h clang-format -i **/*.[ch] Mar 16, 2015
dpi.c Respect Xft.dpi for determining the unlock indicator’s scale factor May 11, 2018
dpi.h Respect Xft.dpi for determining the unlock indicator’s scale factor May 11, 2018
i3lock.1 Add option to lock TTY switching Nov 29, 2018
i3lock.c Merge pull request #213 from trickeydan/patch-1 Apr 12, 2019
i3lock.h clang-format -i **/*.[ch] Mar 16, 2015
randr.c Rename xinerama.[ch] to randr.[ch] Nov 18, 2017
randr.h Rename xinerama.[ch] to randr.[ch] Nov 18, 2017
unlock_indicator.c Labels are now replaced with capital letters in the beginning Jan 14, 2019
unlock_indicator.h display error when backspace is pressed without any input (#172) Jan 14, 2018
xcb.c added WM_CLASS property Jan 15, 2019
xcb.h SetInputFocus to the i3lock window to force-close context menus (#155) Oct 22, 2017

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. On OpenBSD i3lock uses the bsd_auth(3) framework.

Install

See the i3lock home page.

Requirements

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

Building i3lock

We recommend you use the provided package from your distribution. Do not build i3lock unless you have a reason to do so.

First install the dependencies listed in requirements section, then run these commands (might need to be adapted to your OS):

autoreconf --force --install

rm -rf build/
mkdir -p build && cd build/

../configure \
  --prefix=/usr \
  --sysconfdir=/etc \
  --disable-sanitizers

make

Upstream

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

You can’t perform that action at this time.