Merge pull request #136 from kaashif/openbsd-no-pam

[i3/i3lock] / README.md

diff --git a/README.md b/README.md
index b587c277183234996f51c5f296617e2480cba3de..352f4605b7b9a8eb5f16c4b4b66788859a25d97e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -16,6 +16,7 @@ Many little improvements have been made to i3lock over time:
 - You can specify whether i3lock should bell upon a wrong password.
 
 - i3lock uses PAM and therefore is compatible with LDAP etc.
+  On OpenBSD i3lock uses the bsd_auth(3) framework.
 
 Requirements
 ------------
@@ -28,15 +29,17 @@ Requirements
 - libev
 - libx11-dev
 - libx11-xcb-dev
-- libxkbfile-dev
-- libxkbcommon >= 0.4.0
-- libxkbcommon-x11 >= 0.4.0
+- libxkbcommon >= 0.5.0
+- libxkbcommon-x11 >= 0.5.0
 
 Running i3lock
 -------------
 Simply invoke the 'i3lock' command. To get out of it, enter your password and
 press enter.
 
+On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the
+authentication helpers, e.g. `/usr/libexec/auth/login_passwd`.
+
 Upstream
 --------
 Please submit pull requests to https://github.com/i3/i3lock