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.
 
 
 
 
 
Michael Stapelberg e3f1430720 release v2.14.1 2 weeks ago
.github Switch from Travis to GitHub Actions 2 months ago
include Switch build system from autotools to meson 2 months ago
meson remove build step from meson-dist-script 1 month ago
pam Switch to autotools (#163) 5 years ago
travis Switch from Travis to GitHub Actions 2 months ago
.clang-format clang-format: disable header re-ordering 2 years ago
.gitignore Switch build system from autotools to meson 2 months ago
CHANGELOG release v2.14.1 2 weeks ago
LICENSE update debian packaging, update copyright 11 years ago
README.md update build instructions in README (#318) 2 months ago
dpi.c Respect Xft.dpi for determining the unlock indicator’s scale factor 4 years ago
i3lock.1 recommend using xss-lock to start i3lock 4 months ago
i3lock.c clang-format 2 months ago
meson.build release v2.14.1 2 weeks ago
meson_options.txt Switch build system from autotools to meson 2 months ago
randr.c Rename xinerama.[ch] to randr.[ch] 5 years ago
unlock_indicator.c unlock_indicator: only show caps lock and num lock (Thanks sandwm) (#324) 2 weeks ago
xcb.c set _NET_WM_BYPASS_COMPOSITOR hint to avoid flickering (#256) 2 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. Note that i3lock is not an image manipulation software. If you need to resize the image to fill the screen or similar, use existing tooling to do this before passing it to i3lock.

  • 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
  • libxcb-image
  • libxcb-xrm

Running i3lock

To test i3lock, you can directly run the i3lock command. To get out of it, enter your password and press enter.

For a more permanent setup, we strongly recommend using xss-lock so that the screen is locked before your laptop suspends:

xss-lock --transfer-sleep-lock -- i3lock --nofork

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):

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

meson .. -Dprefix=/usr
ninja

Upstream

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