slock/README.md

# slock - simple screen locker

simple screen locker utility for X. 

![slock](https://i.imgur.com/2R315sM.gif)

## Requirements

In order to build slock you need the Xlib header files.

## Installation

Edit config.mk to match your local setup (slock is installed into
the /usr/local namespace by default).

Afterwards enter the following command to build and install slock
(if necessary as root):

```sh
make clean install
```

## Running slock

Simply invoke the 'slock' command. To get out of it, enter your password.

## Blur effect

This fork leverages picom's new kawase blur method instead of taking a screenshot, blur it using ImageMagick without hardware acceleration and then set it as the lock screen wallpaper.
The end result is much higher performance and much lower latency.

Currently, you will need to enable the experimental backend in picom using `picom --experimental-backends`, you can check out my picom config [here](https://github.com/khuedoan/dotfiles/blob/master/.config/picom/picom.conf#L29).
Reformat 2020-07-15 04:14:47 +00:00			`# slock - simple screen locker`

Iinitial commit 2019-06-09 11:38:11 +00:00			`simple screen locker utility for X.`

Bigger preview 2020-07-15 04:24:12 +00:00			`![slock](https://i.imgur.com/2R315sM.gif)`
Iinitial commit 2019-06-09 11:38:11 +00:00
Reformat 2020-07-15 04:14:47 +00:00			`## Requirements`

Iinitial commit 2019-06-09 11:38:11 +00:00			`In order to build slock you need the Xlib header files.`

Reformat 2020-07-15 04:14:47 +00:00			`## Installation`

Iinitial commit 2019-06-09 11:38:11 +00:00			`Edit config.mk to match your local setup (slock is installed into`
			`the /usr/local namespace by default).`

			`Afterwards enter the following command to build and install slock`
			`(if necessary as root):`

Reformat 2020-07-15 04:14:47 +00:00			```sh
			`make clean install`
			```
Iinitial commit 2019-06-09 11:38:11 +00:00
Reformat 2020-07-15 04:14:47 +00:00			`## Running slock`
Iinitial commit 2019-06-09 11:38:11 +00:00
			`Simply invoke the 'slock' command. To get out of it, enter your password.`
Add blur effect instruction 2021-04-12 01:38:41 +00:00
			`## Blur effect`

			`This fork leverages picom's new kawase blur method instead of taking a screenshot, blur it using ImageMagick without hardware acceleration and then set it as the lock screen wallpaper.`
			`The end result is much higher performance and much lower latency.`

			Currently, you will need to enable the experimental backend in picom using `picom --experimental-backends`, you can check out my picom config [here](https://github.com/khuedoan/dotfiles/blob/master/.config/picom/picom.conf#L29).