git.sur5r.net Git - i3/i3lock/blob - README.md

   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
   7 Many little improvements have been made to i3lock over time:
   8
   9 - i3lock forks, so you can combine it with an alias to suspend to RAM
  10   (run "i3lock && echo mem > /sys/power/state" to get a locked screen
  11    after waking up your computer from suspend to RAM)
  12
  13 - You can specify either a background color or a PNG image which will be
  14   displayed while your screen is locked.
  15
  16 - You can specify whether i3lock should bell upon a wrong password.
  17
  18 - i3lock uses PAM and therefore is compatible with LDAP etc.
  19
  20 Requirements
  21 ------------
  22 - pkg-config
  23 - libxcb
  24 - libxcb-util
  25 - libpam-dev
  26 - libcairo-dev
  27 - libxcb-xinerama
  28 - libev
  29 - libx11-dev
  30 - libx11-xcb-dev
  31 - libxkbcommon >= 0.5.0
  32 - libxkbcommon-x11 >= 0.5.0
  33
  34 Running i3lock
  35 -------------
  36 Simply invoke the 'i3lock' command. To get out of it, enter your password and
  37 press enter.
  38
  39 Upstream
  40 --------
  41 Please submit pull requests to https://github.com/i3/i3lock