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