68 lines
1.8 KiB

15 years ago
15 years ago
15 years ago
15 years ago
15 years ago
15 years ago
15 years ago
  1. i3lock - improved screen locker
  2. ===============================
  3. i3lock is a simple screen locker like slock. After starting it, you will
  4. see a white screen (you can configure the color/an image). You can return
  5. to your screen by entering your password.
  6. Many little improvements have been made to i3lock over time:
  7. - i3lock forks, so you can combine it with an alias to suspend to RAM
  8. (run "i3lock && echo mem > /sys/power/state" to get a locked screen
  9. after waking up your computer from suspend to RAM)
  10. - You can specify either a background color or a PNG image which will be
  11. displayed while your screen is locked.
  12. - You can specify whether i3lock should bell upon a wrong password.
  13. - i3lock uses PAM and therefore is compatible with LDAP etc.
  14. On OpenBSD i3lock uses the bsd_auth(3) framework.
  15. Requirements
  16. ------------
  17. - pkg-config
  18. - libxcb
  19. - libxcb-util
  20. - libpam-dev
  21. - libcairo-dev
  22. - libxcb-composite0
  23. - libxcb-xinerama
  24. - libxcb-randr
  25. - libev
  26. - libx11-dev
  27. - libx11-xcb-dev
  28. - libxkbcommon >= 0.5.0
  29. - libxkbcommon-x11 >= 0.5.0
  30. Running i3lock
  31. -------------
  32. Simply invoke the 'i3lock' command. To get out of it, enter your password and
  33. press enter.
  34. On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the
  35. authentication helpers, e.g. `/usr/libexec/auth/login_passwd`.
  36. Building i3lock
  37. ---------------
  38. We recommend you use the provided package from your distribution. Do not build
  39. i3lock unless you have a reason to do so.
  40. First install the dependencies listed in requirements section, then run these
  41. commands (might need to be adapted to your OS):
  42. ```
  43. autoreconf --force --install
  44. rm -rf build/
  45. mkdir -p build && cd build/
  46. ../configure \
  47. --prefix=/usr \
  48. --sysconfdir=/etc \
  49. --disable-sanitizers
  50. make
  51. ```
  52. Upstream
  53. --------
  54. Please submit pull requests to https://github.com/i3/i3lock