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.

73 lines
1.9 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](https://i3wm.org/i3lock/)> is a simple screen locker like slock.
  4. After starting it, you will see a white screen (you can configure the
  5. color/an image). You can return 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. Install
  16. -------
  17. See [the i3lock home page](https://i3wm.org/i3lock/).
  18. Requirements
  19. ------------
  20. - pkg-config
  21. - libxcb
  22. - libxcb-util
  23. - libpam-dev
  24. - libcairo-dev
  25. - libxcb-composite0
  26. - libxcb-xinerama
  27. - libxcb-randr
  28. - libev
  29. - libx11-dev
  30. - libx11-xcb-dev
  31. - libxkbcommon >= 0.5.0
  32. - libxkbcommon-x11 >= 0.5.0
  33. Running i3lock
  34. -------------
  35. Simply invoke the 'i3lock' command. To get out of it, enter your password and
  36. press enter.
  37. On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the
  38. authentication helpers, e.g. `/usr/libexec/auth/login_passwd`.
  39. Building i3lock
  40. ---------------
  41. We recommend you use the provided package from your distribution. Do not build
  42. i3lock unless you have a reason to do so.
  43. First install the dependencies listed in requirements section, then run these
  44. commands (might need to be adapted to your OS):
  45. ```
  46. autoreconf --force --install
  47. rm -rf build/
  48. mkdir -p build && cd build/
  49. ../configure \
  50. --prefix=/usr \
  51. --sysconfdir=/etc \
  52. --disable-sanitizers
  53. make
  54. ```
  55. Upstream
  56. --------
  57. Please submit pull requests to https://github.com/i3/i3lock