From eba48b7cec388325b237fd1b5a3c6d2e04deba12 Mon Sep 17 00:00:00 2001 From: Simeon Simeonov Date: Thu, 19 Mar 2020 16:51:23 +0100 Subject: Initial merge i3lock-extended -> i3lock --- README.md | 86 ++++++++++++++++----------------------------------------------- 1 file changed, 22 insertions(+), 64 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index cb2cde9..dec2154 100644 --- a/README.md +++ b/README.md @@ -1,76 +1,34 @@ -i3lock - improved screen locker -=============================== -[i3lock](https://i3wm.org/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. +## i3lock-extended -Many little improvements have been made to i3lock over time: +i3lock-extended is a fork of i3lock (https://github.com/i3/i3lock). +It was started by Simeon Simeonov (https://simeon.simeonov.no) as a small hack, +implementing a LED-clock on top of an existing and robust screensaver. -- 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) +i3lock-extended adds some additional functionality and is a free-software +licenced under the GPL3+. Most of the code is copyrighted by Michael Stapelberg +under a different license. See LICENSE for more information\! -- You can specify either a background color or a PNG image which will be - displayed while your screen is locked. Note that i3lock is not an image -manipulation software. If you need to resize the image to fill the screen -or similar, use existing tooling to do this before passing it to i3lock. +The original README.md file from i3lock, containing installation instructions +can be found as INSTALL.md. -- 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. +### Additional features -Install -------- +- LED-clock +- Digital clock +- Elapsed time since activation +- Display-text -See [the i3lock home page](https://i3wm.org/i3lock/). +i3lock-extended includes all of the original code and features of i3lock. -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 -- libxcb-image -- libxcb-xrm +Please refer to the manual page for more details and information about the different parameters\! -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`. +### Versioning -Building i3lock ---------------- -We recommend you use the provided package from your distribution. Do not build -i3lock unless you have a reason to do so. +i3lock-extended will merge the changes and fixes coming to i3lock in the +future. -First install the dependencies listed in requirements section, then run these -commands (might need to be adapted to your OS): -``` -autoreconf --force --install - -rm -rf build/ -mkdir -p build && cd build/ - -../configure \ - --prefix=/usr \ - --sysconfdir=/etc \ - --disable-sanitizers - -make -``` - -Upstream --------- -Please submit pull requests to https://github.com/i3/i3lock +In order to create more clarity the version format for i3lock-extended will be: +\.\[a-z +extended revision if used]. -- cgit v1.3