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