Skip to content

Commit

Permalink
Sync with upstream 2.14.1 and update the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
blackm0re committed Mar 18, 2023
1 parent ffc15ca commit 66bd7af
Show file tree
Hide file tree
Showing 37 changed files with 249 additions and 1,799 deletions.
3 changes: 0 additions & 3 deletions .github/CONTRIBUTING.md

This file was deleted.

29 changes: 0 additions & 29 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

33 changes: 6 additions & 27 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,31 +1,10 @@
/i3lock
/i3lock-extended
*.o
tags
*.swp

################################################################################
# https://raw.githubusercontent.com/github/gitignore/master/Autotools.gitignore
################################################################################

# http://www.gnu.org/software/automake

Makefile.in
/ar-lib
/test-driver

# http://www.gnu.org/software/autoconf

/autom4te.cache
/autoscan.log
/autoscan-*.log
/aclocal.m4
/compile
/config.h.in
/config.guess
/config.sub
/configure
/configure.scan
/depcomp
/install-sh
/missing
/stamp-h1
# We recommend building in a subdirectory called build.
# If you chose a different directory name,
# it is up to you to arrange for it to be ignored by git,
# e.g. by listing your directory in .git/info/exclude.
/build
6 changes: 6 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
2023-03-18 i3lock-extended 2.2.14

• Fetch and sync with i3lock 2.14.1
• Update README.md


2020-12-29 i3lock-extended 2.2.13a

• Fix and sort the help (-h) string
Expand Down
1 change: 0 additions & 1 deletion I3LOCK_VERSION

This file was deleted.

24 changes: 13 additions & 11 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
i3lock - improved screen locker
===============================
[i3lock](https://i3wm.org/i3lock/)> is a simple screen locker like slock.
[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.

Expand Down Expand Up @@ -44,8 +44,16 @@ Requirements

Running i3lock
-------------
Simply invoke the 'i3lock' command. To get out of it, enter your password and
press enter.

To test i3lock, you can directly run the `i3lock` command. To get out of it,
enter your password and press enter.

For a more permanent setup, we strongly recommend using `xss-lock` so that the
screen is locked *before* your laptop suspends:

```
xss-lock --transfer-sleep-lock -- i3lock --nofork
```

On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the
authentication helpers, e.g. `/usr/libexec/auth/login_passwd`.
Expand All @@ -58,17 +66,11 @@ i3lock unless you have a reason to do so.
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
meson .. -Dprefix=/usr
ninja
```

Upstream
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
i3lock-extended
Copyright (C) 2020 Simeon Simeonov
Copyright (C) 2020-2023 Simeon Simeonov

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Expand Down
61 changes: 0 additions & 61 deletions Makefile.am

This file was deleted.

35 changes: 19 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# i3lock-extended

i3lock-extended is a fork of i3lock (https://github.com/i3/i3lock).
It was started by Simeon Simeonov (sgs @ Freenode) as a small hack,
It was started by Simeon Simeonov (sgs @ LiberaChat) as a small hack,
implementing a LED-clock on top of an existing and robust screensaver.

i3lock-extended adds some additional functionality and is a free-software
Expand Down Expand Up @@ -40,7 +40,9 @@ extended revision if used].
### Gentoo

```bash
layman -a sgs
# add sgs' custom repository using app-eselect/eselect-repository
eselect repository add sgs

emerge x11-misc/i3lock-extended
```

Expand All @@ -58,25 +60,26 @@ Install the package:
```


### From source
### From source (meson > 0.55.0)

```bash
wget https://simeon.simeonov.no/programs/i3lock_extended/downloads/i3lock-extended-<version>.tar.xz
tar Jxvf i3lock-extended-<version>.tar.xz && cd i3lock-extended-<version>
./configure --prefix=/usr --sysconfdir=/etc --disable-sanitizers
make
make install
wget https://github.com/blackm0re/i3lock_extended/releases/download/<version>/i3lock-extended-<version>.tar.xz
tar Jxvf i3lock-extended-<version>.tar.xz
cd i3lock-extended-<version>
meson setup build --prefix=/usr
meson compile -C build
sudo meson install -C build
```


### From git
### From git (meson > 0.55.0)

```bash
git clone https://github.com/blackm0re/i3lock-extended.git && cd i3lock-extended
autoreconf --force --install
./configure --prefix=/usr --sysconfdir=/etc --disable-sanitizers
make
make install
git clone https://github.com/blackm0re/i3lock-extended.git
cd i3lock-extended
meson setup build --prefix=/usr
meson compile -C build
sudo meson install -C build
```


Expand Down Expand Up @@ -112,12 +115,12 @@ i3lock-extended is hosted on GitHub: https://github.com/blackm0re/i3lock-extende

## Author

Simeon Simeonov - sgs @ Freenode
Simeon Simeonov - sgs @ LiberaChat


## [License](https://github.com/blackm0re/i3lock-extended/blob/master/LICENSE)

Copyright 2020 Simeon Simeonov
Copyright 2020-2023 Simeon Simeonov

Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html

Expand Down
Loading

0 comments on commit 66bd7af

Please sign in to comment.