summaryrefslogtreecommitdiff
path: root/README.md
blob: f4bf76646865e0fc4297ff76afa5b7a9f4f9192e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# 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, 
implementing a LED-clock on top of an existing and robust screensaver.

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\!

The original README.md file from i3lock, containing installation instructions
can be found as INSTALL.md.


## Additional features

- LED-clock
- Digital clock
- Elapsed time since activation
- Display-text

i3lock-extended includes all of the original code and features of i3lock.

Please refer to the manual page for more details and information about the different parameters\!


## Versioning

i3lock-extended will merge the changes and fixes coming to i3lock in the
future.

In order to create more clarity the version format for i3lock-extended will be:
\<extended version starting from 1>.\<i3lock version that is merged in\>[a-z
extended revision if used].


## Installation

### Gentoo

   ```bash
   layman -a sgs
   emerge x11-misc/i3lock-extended
   ```

### Fedora ( >= 31)

Set up a custom repo as described: https://pkg.pichove.org/Fedora/README.txt

Key fingerprint: A664 5797 661E 2F47 3DD3  FF06 BCE7 0555 C3BB 08F7

Install the package:

   ```bash
   sudo dnf install i3lock-extended
   ```


### From source

   ```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
   ```


### From git

   ```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
   ```


## Examples

The following invocation

   ```bash
   i3lock-extended -f -L -n -S 32 -c 000000 -F 000000 -O 00FF00 -B 7f7f7f -R 7f7f7f -G 7f7f7f -D -E
   ```

produces the following result:

![Screenshot](https://simeon.simeonov.no/programs/i3lock_extended/screenshot.png)


## Support and contributing

i3lock-extended is hosted on GitHub: https://github.com/blackm0re/i3lock-extended


## Author

Simeon Simeonov - sgs @ Freenode


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

Copyright 2020 Simeon Simeonov

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

This software includes software copyrighted by Michael Stapelberg and
distributed under a different license: See LICENSE for more information!