You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

67 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-xinerama
  23. - libxcb-randr
  24. - libev
  25. - libx11-dev
  26. - libx11-xcb-dev
  27. - libxkbcommon >= 0.5.0
  28. - libxkbcommon-x11 >= 0.5.0
  29. Running i3lock
  30. -------------
  31. Simply invoke the 'i3lock' command. To get out of it, enter your password and
  32. press enter.
  33. On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the
  34. authentication helpers, e.g. `/usr/libexec/auth/login_passwd`.
  35. Building i3lock
  36. ---------------
  37. We recommend you use the provided package from your distribution. Do not build
  38. i3lock unless you have a reason to do so.
  39. First install the dependencies listed in requirements section, then run these
  40. commands (might need to be adapted to your OS):
  41. ```
  42. autoreconf --force --install
  43. rm -rf build/
  44. mkdir -p build && cd build/
  45. ../configure \
  46. --prefix=/usr \
  47. --sysconfdir=/etc \
  48. --disable-sanitizers
  49. make
  50. ```
  51. Upstream
  52. --------
  53. Please submit pull requests to https://github.com/i3/i3lock