Go to file
Orestis e30ce8e074
Merge pull request #235 from mortie/patch-1
Remove one last reference to the -r shortopt
2019-05-26 00:22:06 +03:00
.github Added ISSUE_TEMPLATE.md 2018-05-20 16:53:55 +02:00
m4 Switch to autotools (#163) 2017-12-02 10:08:54 +01:00
pam Switch to autotools (#163) 2017-12-02 10:08:54 +01:00
travis travis: build in Debian sid Docker container 2018-05-11 15:40:43 +02:00
.clang-format commit missing .clang-format 2015-03-17 08:50:50 +01:00
.gitignore Switch to autotools (#163) 2017-12-02 10:08:54 +01:00
.travis.yml travis: build in Debian sid Docker container 2018-05-11 15:40:43 +02:00
CHANGELOG Update CHANGELOG and I3LOCK_VERSION 2018-10-18 08:35:31 +02:00
I3LOCK_VERSION update I3LOCK_VERSION 2018-10-18 08:35:49 +02:00
LICENSE update debian packaging, update copyright 2011-07-13 17:06:46 +02:00
Makefile.am Add option to lock TTY switching 2018-11-29 14:22:19 +01:00
README.md Install instructions just point to the website 2019-03-18 13:22:34 -07:00
configure.ac Respect Xft.dpi for determining the unlock indicator’s scale factor 2018-05-11 13:28:06 +02:00
cursors.h clang-format -i **/*.[ch] 2015-03-16 18:47:16 +01:00
dpi.c Respect Xft.dpi for determining the unlock indicator’s scale factor 2018-05-11 13:28:06 +02:00
dpi.h Respect Xft.dpi for determining the unlock indicator’s scale factor 2018-05-11 13:28:06 +02:00
i3lock.1 Remove one last reference to the -r shortopt 2019-05-25 23:15:25 +02:00
i3lock.c Add rgbx, xrgb, bgr, etc. formats (#234) 2019-05-23 21:03:48 -04:00
i3lock.h clang-format -i **/*.[ch] 2015-03-16 18:47:16 +01:00
randr.c Rename xinerama.[ch] to randr.[ch] 2017-11-18 10:51:35 +01:00
randr.h Rename xinerama.[ch] to randr.[ch] 2017-11-18 10:51:35 +01:00
unlock_indicator.c Labels are now replaced with capital letters in the beginning 2019-01-15 00:11:19 +02:00
unlock_indicator.h display error when backspace is pressed without any input (#172) 2018-01-14 22:17:43 +01:00
xcb.c added WM_CLASS property 2019-01-15 16:10:39 -03:00
xcb.h SetInputFocus to the i3lock window to force-close context menus (#155) 2017-10-22 22:16:34 +02:00

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