xlock/README.md

# xlock screen locker

`xlock` really does nothing, it only wraps [`i3lock`](https://github.com/i3/i3lock) screen locker into [systemd](https://freedesktop.org/wiki/Software/systemd/) to allow a seamless screen lock. Your screen stays the same, the mouse pointer works, but you can't do anything. You just have to type your password, press enter and here you go .

Even if one finds out how to kill the `i3lock` process or the `xlock` one, it won't unlock your screen.

### Installation

Requirements :
- i3lock
- [scrot](https://phab.enlightenment.org/diffusion/ESVN/browse/trunk/misc/scrot;35502)

run `./install.sh` ; note that you need sudo permissions.

### How to use
The whole wrapper interfaces through a simple file at `/tmp/.unlocked`. To lock your screen, simply delete this file. After the install the service 'xlock@USER.path' with `USER` being the user that launched the install. To start it `systemctl start xlock@USER.path`, at the install it is enabled by default, thus it is launched when you boot.

To add a key binding or to automate your script lock, simply delete the `/tmp/.unlocked` file.
working demo 2019-03-02 18:47:03 +00:00			`# xlock screen locker`

transform 'exec' to a 'while' loop to avoid recursion limitations 2019-03-03 12:33:59 +00:00			`xlock` really does nothing, it only wraps [`i3lock`](https://github.com/i3/i3lock) screen locker into [systemd](https://freedesktop.org/wiki/Software/systemd/) to allow a seamless screen lock. Your screen stays the same, the mouse pointer works, but you can't do anything. You just have to type your password, press enter and here you go .
working demo 2019-03-02 18:47:03 +00:00
improve readme + make a real daemon 2019-03-03 13:01:16 +00:00			Even if one finds out how to kill the `i3lock` process or the `xlock` one, it won't unlock your screen.
working demo 2019-03-02 18:47:03 +00:00
			`### Installation`

improved readme 2019-03-02 18:54:58 +00:00			`Requirements :`
			`- i3lock`
			`- [scrot](https://phab.enlightenment.org/diffusion/ESVN/browse/trunk/misc/scrot;35502)`

transform 'exec' to a 'while' loop to avoid recursion limitations 2019-03-03 12:33:59 +00:00			run `./install.sh` ; note that you need sudo permissions.
working demo 2019-03-02 18:47:03 +00:00
			`### How to use`
transform 'exec' to a 'while' loop to avoid recursion limitations 2019-03-03 12:33:59 +00:00			The whole wrapper interfaces through a simple file at `/tmp/.unlocked`. To lock your screen, simply delete this file. After the install the service 'xlock@USER.path' with `USER` being the user that launched the install. To start it `systemctl start xlock@USER.path`, at the install it is enabled by default, thus it is launched when you boot.
working demo 2019-03-02 18:47:03 +00:00
transform 'exec' to a 'while' loop to avoid recursion limitations 2019-03-03 12:33:59 +00:00			To add a key binding or to automate your script lock, simply delete the `/tmp/.unlocked` file.