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