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

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