2020-03-08 15:04:04 -04:00
# i3lock - improved screen locker
2020-03-08 15:04:59 -04:00
2020-03-08 15:04:04 -04:00
2020-03-08 15:04:59 -04:00
2020-03-08 15:04:04 -04:00
2020-03-12 13:08:27 -04:00
**A modern version of i3lock with color functionality by [eBrnd ](https://github.com/eBrnd/i3lock-color ), maintained for a few years by [PandorasFox ](https://github.com/PandorasFox ) and now maintained and being developed by [Raymo111 ](https://github.com/Raymo111 ).**
2020-03-08 15:04:04 -04:00
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.
2009-03-11 17:17:00 -04:00
2016-02-08 16:12:27 -05:00
Many little improvements have been made to i3lock over time:
2009-03-11 17:17:00 -04:00
2020-03-09 13:27:54 -04:00
- 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)
2020-03-15 22:05:28 -04:00
- You can specify either a background color or an image (JPG or PNG), 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, you can use something like ImageMagick combined wih `xdpyinfo` :
```bash
convert image.jpg -resize $(xdpyinfo | grep dimensions | sed -r 's/^[^0-9]*([0-9]+x[0-9]+).*$/\1/') RGB:- | i3lock --raw $(xdpyinfo | grep dimensions | sed -r 's/^[^0-9]*([0-9]+x[0-9]+).*$/\1/'):rgb --image /dev/stdin
```
2016-02-08 16:12:27 -05:00
- You can specify whether i3lock should bell upon a wrong password.
2020-03-08 15:04:04 -04:00
- i3lock uses PAM and therefore is compatible with LDAP etc. On OpenBSD, i3lock uses the bsd\_auth(3) framework.
2009-03-11 17:17:00 -04:00
2020-03-08 15:04:04 -04:00
## Additional features in i3lock-color
You can also specify additional options, as detailed in the manpage. This includes, but is not limited to:
2019-02-23 12:08:42 -05:00
2020-03-08 15:04:04 -04:00
- Color options for:
2020-03-10 11:01:36 -04:00
- 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
2020-03-09 08:52:28 -04:00
- 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
- Passthrough media keys
- A new bar indicator, which replaces the ring indicator with its own set of options
2020-03-10 11:01:36 -04:00
- An experimental thread for driving the redraw ticks, so that things like the bar/clock still update when PAM is blocking
2017-12-08 21:32:31 -05:00
2020-03-10 11:01:36 -04:00
## Dependencies
The following dependencies will need to be installed for a successful build, depending on your OS/distro.
### Ubuntu 18.04 LTS
Run this command to install all dependencies:
```
sudo apt install pkg-config libpam0g-dev libcairo2-dev libfontconfig1-dev libxcb-composite0-dev libev-dev libx11-xcb-dev libxcb-xkb-dev libxcb-xinerama0-dev libxcb-randr0-dev libxcb-image0-dev libxcb-util-dev libxcb-xrm-dev libxkbcommon-dev libxkbcommon-x11-dev libjpeg-dev
```
## Arch Linux
2020-04-18 19:48:15 -04:00
- autoconf
2020-03-10 11:01:36 -04:00
- cairo
- fontconfig
- libev
- libjpeg-turbo
- libxinerama
- libxkbcommon-x11
- libxrandr
- pam
- pkgconf
- xcb-util-image
- xcb-util-xrm
## Building i3lock-color
2017-08-15 10:30:16 -04:00
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.
2020-03-10 11:01:36 -04:00
**If you want to build a non-debug version, you should tag your build before configuring.** For example: `git tag -f "git-$(git rev-parse --short HEAD)"` will add a tag with the short commit ID, which will be used for the version info. Issues asking about ASAN/complaints about i3lock-color being slow / etc will likely be closed. i3lock-color uses GNU autotools for building.
2018-01-06 14:52:39 -05:00
2020-05-08 01:06:45 -04:00
To build i3lock-color, first install the dependencies listed above, then clone the repo and run the build script:
2020-03-08 16:45:24 -04:00
```
2020-05-08 01:06:45 -04:00
git clone https://github.com/Raymo111/i3lock-color.git
cd i3lock-color
2020-05-08 01:04:32 -04:00
chmod +x build.sh
./build.sh
2020-03-08 16:45:24 -04:00
```
2020-04-16 18:55:48 -04:00
You may choose to modify the script based on your needs/OS/distro.
2016-02-08 16:12:27 -05:00
2020-03-08 15:05:27 -04:00
## Arch Linux Packages
2020-03-08 15:04:04 -04:00
[Stable version in Community ](https://www.archlinux.org/packages/community/x86_64/i3lock-color/ )
2017-12-06 13:19:34 -05:00
2020-03-08 15:04:04 -04:00
[Git Version on AUR ](https://aur.archlinux.org/packages/i3lock-color-git/ )
2016-06-19 18:22:09 -04:00
2020-03-08 15:04:04 -04:00
## FreeBSD port
2019-09-19 07:24:27 -04:00
[i3lock-color-port ](https://github.com/rkashapov/i3lock-color-port/ )
2020-03-10 11:01:36 -04:00
## Running i3lock-color
2020-03-08 15:04:04 -04:00
Simply invoke the 'i3lock' command. To get out of it, enter your password and press enter.
2016-02-08 16:12:27 -05:00
2020-03-08 15:04:04 -04:00
A [sample script ](lock.sh ) is included in this repository. [See the script in action ](https://streamable.com/fpl46 )
2017-05-30 22:11:26 -04:00
2020-03-08 15:04:04 -04:00
On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the authentication helpers, e.g. `/usr/libexec/auth/login_passwd` .
2017-04-15 08:41:32 -04:00
2020-03-08 15:04:04 -04:00
## Upstream
Please submit pull requests for i3lock things to https://github.com/i3/i3lock and pull requests for additional features on top of regular i3lock at https://github.com/Raymo111/i3lock-color.
