updates readme.md
Some checks failed
Test / test (push) Has been cancelled

This commit is contained in:
Asger Geel Weirsøe
2026-05-06 15:37:53 +02:00
parent 3fae21c7a4
commit 2e40a0a23a

View File

@@ -39,13 +39,13 @@ sudo install -Dm755 /tmp/ahfail-install/libahfail_pam.so /usr/lib/ahfail/libahfa
sudo install -Dm755 /tmp/ahfail-install/ahfail-display /usr/lib/ahfail/ahfail-display sudo install -Dm755 /tmp/ahfail-install/ahfail-display /usr/lib/ahfail/ahfail-display
``` ```
Then follow the [Wayland](#linux--wayland-gtklock) or [X11](#linux--x11-i3lock-xscreensaver-etc) configuration below. Then follow the [Wayland](#Usage-linux--wayland-only-gtklock) or [X11](#usage-linux--x11-i3lock-xscreensaver-etc) configuration below.
--- ---
## Linux — Wayland (gtklock) ## Linux compile
### Install dependencies and build from source (Arch) ### Install dependencies and build from source
```bash ```bash
sudo pacman -S meson ninja rust gtk3 gstreamer gst-plugins-base gst-plugins-good gst-plugins-bad gtklock sudo pacman -S meson ninja rust gtk3 gstreamer gst-plugins-base gst-plugins-good gst-plugins-bad gtklock
@@ -58,13 +58,13 @@ Installs:
- `/usr/lib/ahfail/libahfail_pam.so` — PAM module (for X11) - `/usr/lib/ahfail/libahfail_pam.so` — PAM module (for X11)
- `/usr/lib/ahfail/ahfail-display` — standalone display binary - `/usr/lib/ahfail/ahfail-display` — standalone display binary
### Run ### Usage Linux - wayland (only gtklock)
```bash ```bash
gtklock -m /usr/lib/gtklock/ahfail-module.so gtklock -m /usr/lib/gtklock/ahfail-module.so
``` ```
### Arguments #### Arguments
Pass module arguments after `--`: Pass module arguments after `--`:
@@ -77,8 +77,8 @@ gtklock -m /usr/lib/gtklock/ahfail-module.so -- --deadzone=860,440,200,200
--- ---
## Linux X11 (i3lock, xscreensaver, etc.) ### Usage Linux - X11 (i3lock, xscreensaver, etc.)
First compile as
Add the PAM module to your screen locker's PAM service file. Use the full path — `$(libdir)/ahfail` is not in PAM's default search path. Add the PAM module to your screen locker's PAM service file. Use the full path — `$(libdir)/ahfail` is not in PAM's default search path.
**Arch / standard:** **Arch / standard:**