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

   1 i3lock - slightly improved screen locker based on slock
   2 ============================
   3 i3lock improves slock by making it fork() and therefore combinable with
   4 commands to suspend your computer. Additionally, instead of turning off
   5 your screen via DPMS and/or displaying a black screen, i3lock displays a
   6 white screen so you can see if your computer failed to resume from suspend
   7 or if your screen is just locked. Also, when entering a wrong password,
   8 i3lock does not call XBell(). This is important because i3lock/slock think
   9 you’ve entered a password when resuming from suspend, at least sometimes.
  10
  11 i3lock was forked from slock-0.9
  12
  13 Requirements
  14 ------------
  15 In order to build i3lock you need the Xlib header files and the PAM development
  16 headers (libpam-dev or similar).
  17
  18
  19 Installation
  20 ------------
  21 Edit config.mk to match your local setup (slock is installed into
  22 the /usr/local namespace by default).
  23
  24 Afterwards enter the following command to build and install slock
  25 (if necessary as root):
  26
  27     make clean install
  28
  29
  30 Running i3lock
  31 -------------
  32 Simply invoke the 'i3lock' command. To get out of it, enter your password.