1
0
Fork 0
mirror of https://github.com/Raymo111/i3lock-color.git synced 2025-02-24 16:06:26 -05:00
i3lock-color/README.md
Michael Stapelberg c311d1c5a3 Use RandR for learning about attached monitors
The code now tries the following options, in order:

• obtain monitors via RandR 1.5
• obtain outputs via RandR ≤ 1.4
• obtain screens via Xinerama

fixes #159
related to #101
related to #148
related to #149
2017-11-18 10:48:25 +01:00

46 lines
1.3 KiB
Markdown

i3lock - improved screen locker
===============================
i3lock is a simple screen locker like slock. After starting it, you will
see a white screen (you can configure the color/an image). You can return
to your screen by entering your password.
Many little improvements have been made to i3lock over time:
- i3lock forks, so you can combine it with an alias to suspend to RAM
(run "i3lock && echo mem > /sys/power/state" to get a locked screen
after waking up your computer from suspend to RAM)
- You can specify either a background color or a PNG image which will be
displayed while your screen is locked.
- You can specify whether i3lock should bell upon a wrong password.
- i3lock uses PAM and therefore is compatible with LDAP etc.
On OpenBSD i3lock uses the bsd_auth(3) framework.
Requirements
------------
- pkg-config
- libxcb
- libxcb-util
- libpam-dev
- libcairo-dev
- libxcb-xinerama
- libxcb-randr
- libev
- libx11-dev
- libx11-xcb-dev
- libxkbcommon >= 0.5.0
- libxkbcommon-x11 >= 0.5.0
Running i3lock
-------------
Simply invoke the 'i3lock' command. To get out of it, enter your password and
press enter.
On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the
authentication helpers, e.g. `/usr/libexec/auth/login_passwd`.
Upstream
--------
Please submit pull requests to https://github.com/i3/i3lock