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

[i3/i3lock] / README.md

diff --git a/README.md b/README.md
index eea54ea40949363bee35a951e9c6aa76ab560cd4..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.
 - 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
 ------------
 
 Requirements
 ------------


@@ -36,6 +37,9 @@ Running i3lock
 Simply invoke the 'i3lock' command. To get out of it, enter your password and
 press enter.
 
 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
 Upstream
 --------
 Please submit pull requests to https://github.com/i3/i3lock