slock/README.md

108 lines
5.4 KiB
Markdown
Raw Normal View History

2021-06-08 13:29:12 +02:00
Similar to [dwm-flexipatch](https://github.com/bakkeby/dwm-flexipatch) this slock 1.4 (701aa9,
2017-03-25) project has a different take on patching. It uses preprocessor directives to decide
whether or not to include a patch during build time. Essentially this means that this build, for
better or worse, contains both the patched _and_ the original code. The aim being that you can
select which patches to include and the build will contain that code and nothing more.
For example to include the `capscolor` patch then you would only need to flip this setting from 0
to 1 in [patches.h](https://github.com/bakkeby/slock-flexipatch/blob/master/patches.h):
```c
#define CAPSCOLOR_PATCH 1
```
2021-06-08 13:29:12 +02:00
Once you have found out what works for you and what doesn't then you should be in a better position
to choose patches should you want to start patching from scratch.
2021-06-08 13:29:12 +02:00
Alternatively if you have found the patches you want, but don't want the rest of the flexipatch
entanglement on your plate then you may want to have a look at
[flexipatch-finalizer](https://github.com/bakkeby/flexipatch-finalizer); a custom pre-processor
tool that removes all the unused flexipatch code leaving you with a build that contains the patches
you selected.
2021-06-08 13:29:12 +02:00
Refer to [https://tools.suckless.org/slock/](https://tools.suckless.org/slock/) for details on the
slock tool, how to install it and how it works.
---
### Changelog:
2021-09-09 11:54:37 +02:00
2021-09-09 - Added the auto-timeout, failure-command and secret-password patches
2021-09-09 10:17:00 +02:00
2021-06-08 13:29:12 +02:00
2021-06-08 - Added the color message patch
2020-08-03 17:25:50 +02:00
2020-08-03 - Added alpha, keypress_feedback and blur_pixelated_screen patches
2020-08-03 15:53:34 +02:00
2019-11-27 08:42:00 +01:00
2019-11-27 - Added xresources patch
2019-10-17 - Added capscolor, control clear, dpms, mediakeys, message, pam auth, quickcancel patches
2019-10-16 - Introduced [flexipatch-finalizer](https://github.com/bakkeby/flexipatch-finalizer)
### Patches included:
2020-08-03 17:25:50 +02:00
- [alpha](https://github.com/khuedoan/slock)
- enables transparency for slock
- intended to be combined with a compositor that can blur the transparent background
2021-09-09 11:54:37 +02:00
- [auto-timeout](https://tools.suckless.org/slock/patches/auto-timeout/)
- allows for a command to be executed after a specified time of inactivity
2020-08-03 16:56:33 +02:00
- [blur_pixelated_screen](https://tools.suckless.org/slock/patches/blur-pixelated-screen/)
- sets the lockscreen picture to a blured or pixelated screenshot
- [capscolor](https://tools.suckless.org/slock/patches/capscolor/)
- adds an additional color to indicate the state of Caps Lock
2021-06-08 13:29:12 +02:00
- [color-message](https://tools.suckless.org/slock/patches/colormessage/)
- based on the message patch this patch lets you add a message to your lock screen using
24-bit color ANSI escape codes
- [control-clear](https://tools.suckless.org/slock/patches/control-clear/)
2021-06-08 13:29:12 +02:00
- with this patch slock will no longer change to the failure color if a control key is pressed
while the buffer is empty
- this may be useful if, for example, you wake your monitor up by pressing a control key and
don't want to spoil the detection of failed unlocking attempts
- [dpms](https://tools.suckless.org/slock/patches/dpms/)
2021-06-08 13:29:12 +02:00
- interacts with the Display Power Signaling and automatically shuts down the monitor after a
configurable amount of seconds
- the monitor will automatically be activated by pressing a key or moving the mouse and the
password can be entered then
2021-09-09 10:17:00 +02:00
- [failure-command](https://tools.suckless.org/slock/patches/failure-command/)
- allows for a command to be run after a specified number of incorrect attempts
2020-08-03 15:53:34 +02:00
- [keypress_feedback](https://tools.suckless.org/slock/patches/keypress-feedback/)
- draws random blocks on the screen to display keypress feedback
- [mediakeys](https://tools.suckless.org/slock/patches/mediakeys/)
2021-06-08 13:29:12 +02:00
- allows media keys to be used while the screen is locked, e.g. adjust volume or skip to the
next song without having to unlock the screen first
- [message](https://tools.suckless.org/slock/patches/message/)
- this patch lets you add a custom message to your lock screen
- [pam-auth](https://tools.suckless.org/slock/patches/pam_auth/)
- replaces shadow support with PAM authentication support
- [quickcancel](https://tools.suckless.org/slock/patches/quickcancel/)
- cancel slock by moving the mouse within a certain time-period after slock started
- the time-period can be defined in seconds with the setting timetocancel in the config.h
2021-06-08 13:29:12 +02:00
- this can be useful if you forgot to disable xautolock during an activity that requires no
input (e.g. reading text, watching video, etc.)
2021-09-09 11:07:56 +02:00
- [secret-password](https://tools.suckless.org/slock/patches/secret-password/)
- allows for commands to be executed when the user enters special passwords
- [terminalkeys](https://tools.suckless.org/slock/patches/terminalkeys/)
2021-06-08 13:29:12 +02:00
- adds key commands that are commonly used in terminal applications (in particular the login
prompt)
- [unlockscreen](https://tools.suckless.org/slock/patches/unlock_screen/)
- this patch keeps the screen unlocked, but keeps the input locked
2021-06-08 13:29:12 +02:00
- that is, the screen is not affected by slock, but users will not be able to interact with
the X session unless they enter the correct password
2019-11-27 08:42:00 +01:00
- [xresources](https://tools.suckless.org/slock/patches/xresources/)
2020-03-29 12:24:26 +02:00
- this patch adds the ability to get colors via Xresources