You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
3moon 2821599e68 Merge branch 'compositing' 6 years ago
.github Added ISSUE_TEMPLATE.md 7 years ago
m4 Switch to autotools (#163) 8 years ago
pam Switch to autotools (#163) 8 years ago
travis Fix covering of composited notifications (#204) 6 years ago
.clang-format commit missing .clang-format 10 years ago
.gitignore Switch to autotools (#163) 8 years ago
.travis.yml travis: build in Debian sid Docker container 7 years ago
CHANGELOG Update CHANGELOG and I3LOCK_VERSION 7 years ago
I3LOCK_VERSION update I3LOCK_VERSION 7 years ago
LICENSE update debian packaging, update copyright 14 years ago
Makefile.am Add option to lock TTY switching 7 years ago
README.md Merge branch 'compositing' 6 years ago
configure.ac Fix covering of composited notifications (#204) 6 years ago
cursors.h clang-format -i **/*.[ch] 10 years ago
dpi.c Respect Xft.dpi for determining the unlock indicator’s scale factor 7 years ago
dpi.h Respect Xft.dpi for determining the unlock indicator’s scale factor 7 years ago
i3lock.1 Fix covering of composited notifications (#204) 6 years ago
i3lock.c Merge branch 'compositing' 6 years ago
i3lock.h clang-format -i **/*.[ch] 10 years ago
randr.c Rename xinerama.[ch] to randr.[ch] 8 years ago
randr.h Rename xinerama.[ch] to randr.[ch] 8 years ago
unlock_indicator.c Labels are now replaced with capital letters in the beginning 6 years ago
unlock_indicator.h display error when backspace is pressed without any input (#172) 7 years ago
xcb.c Merge branch 'compositing' 6 years ago
xcb.h SetInputFocus to the i3lock window to force-close context menus (#155) 8 years ago

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-composite0
  • 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