diff options
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 24 |
1 files changed, 13 insertions, 11 deletions
| @@ -1,6 +1,6 @@ | |||
| 1 | i3lock - improved screen locker | 1 | i3lock - improved screen locker |
| 2 | =============================== | 2 | =============================== |
| 3 | [i3lock](https://i3wm.org/i3lock/)> is a simple screen locker like slock. | 3 | [i3lock](https://i3wm.org/i3lock/) is a simple screen locker like slock. |
| 4 | After starting it, you will see a white screen (you can configure the | 4 | After starting it, you will see a white screen (you can configure the |
| 5 | color/an image). You can return to your screen by entering your password. | 5 | color/an image). You can return to your screen by entering your password. |
| 6 | 6 | ||
| @@ -44,8 +44,16 @@ Requirements | |||
| 44 | 44 | ||
| 45 | Running i3lock | 45 | Running i3lock |
| 46 | ------------- | 46 | ------------- |
| 47 | Simply invoke the 'i3lock' command. To get out of it, enter your password and | 47 | |
| 48 | press enter. | 48 | To test i3lock, you can directly run the `i3lock` command. To get out of it, |
| 49 | enter your password and press enter. | ||
| 50 | |||
| 51 | For a more permanent setup, we strongly recommend using `xss-lock` so that the | ||
| 52 | screen is locked *before* your laptop suspends: | ||
| 53 | |||
| 54 | ``` | ||
| 55 | xss-lock --transfer-sleep-lock -- i3lock --nofork | ||
| 56 | ``` | ||
| 49 | 57 | ||
| 50 | On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the | 58 | On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the |
| 51 | authentication helpers, e.g. `/usr/libexec/auth/login_passwd`. | 59 | authentication helpers, e.g. `/usr/libexec/auth/login_passwd`. |
| @@ -58,17 +66,11 @@ i3lock unless you have a reason to do so. | |||
| 58 | First install the dependencies listed in requirements section, then run these | 66 | First install the dependencies listed in requirements section, then run these |
| 59 | commands (might need to be adapted to your OS): | 67 | commands (might need to be adapted to your OS): |
| 60 | ``` | 68 | ``` |
| 61 | autoreconf --force --install | ||
| 62 | |||
| 63 | rm -rf build/ | 69 | rm -rf build/ |
| 64 | mkdir -p build && cd build/ | 70 | mkdir -p build && cd build/ |
| 65 | 71 | ||
| 66 | ../configure \ | 72 | meson .. -Dprefix=/usr |
| 67 | --prefix=/usr \ | 73 | ninja |
| 68 | --sysconfdir=/etc \ | ||
| 69 | --disable-sanitizers | ||
| 70 | |||
| 71 | make | ||
| 72 | ``` | 74 | ``` |
| 73 | 75 | ||
| 74 | Upstream | 76 | Upstream |
