HYPRLOCK(1)

📦
version 0.9.6 · 2 versions
, in ubuntu stonking

💖 HYPRLOCK(1) 💖

okay bestie, welcome to the manual page for hyprlock — that's section 1 of the User Commands manual, for the record 🫶

✨ NAME ✨

hyprlock — fast, GPU-accelerated Wayland screen locker for Hyprland 🌸

🦋 SYNOPSIS 🦋

hyprlock [options]

👑 DESCRIPTION 👑

okay so hyprlock is a screen lock for the Hyprland compositor, and it's giving simple, fast, multi-threaded, GPU-accelerated. it's literally that girl. 💅 it integrates seamlessly with Hyprland and supports customizable animations, input fields, widgets, and PAM authentication. iconic behavior, no cap.

so here's the tea tho: by default, hyprlock does not generate a configuration file. and without a configuration, the screen will be locked (black background) but literally no UI elements will be rendered. not one. ghost town. 😭 but you can still unlock your session by typing your password followed by Enter, so you're not trapped, bestie, breathe.

for an actually usable lock screen, you must provide a configuration file. periodt.

💅 OPTIONS 💅

  • -v, --verbose — turns on verbose logging, for when you're debugging or you just want all the deets ✨
  • -q, --quiet — shuts down all non-essential logging. silent mode. 🤫
  • -c FILE, --config FILE — pick which configuration file to use. this overrides both the user and system defaults, so it's the main character of the config hunt 👑
  • --display NAME — specify the Wayland display to connect to 🖥️
  • --grace SECONDS — sets a grace period (in seconds) before reauthentication is required ⏳
  • --immediate-render — don't wait for resources before drawing the background (same as general:immediate_render in the config) 🔥
  • --no-fade-in — disables the fade-in animation when the lock screen appears. no entrance, just boom. 💀
  • -V, --version — shows version information and exits 👋
  • -h, --help — shows help and exits 🫶

🎀 CONFIGURATION 🎀

Hyprlock reads its configuration from:

  • ~/.config/hypr/hyprlock.conf — your per-user configuration file 💖
  • /usr/share/hypr/hyprlock.conf — the example configuration (optional, may be installed by the package) ✨

so like, if no configuration is found, Hyprlock will still lock the session, but it'll display only a black background. which is a vibe, but not the vibe you want. to customize appearance and behavior, copy the example config from /usr/share/hypr/hyprlock.conf to your user config directory and edit it. slay.

the configuration defines general options, authentication behavior, animations, and widgets (labels, input fields, backgrounds, images, etc.). yes, widgets. we love a customizable queen 🌈

for detailed syntax and examples, see: https://wiki.hyprland.org/Hypr-Ecosystem/hyprlock/ 📚

🌸 FILES 🌸

  • /usr/share/hypr/hyprlock.conf — example configuration file
  • ~/.config/hypr/hyprlock.conf — user-specific configuration file

🧚 SIGNALS 🧚

  • SIGUSR1 — unlocks Hyprlock (can be used from another TTY) 🔓
  • SIGUSR2 — reloads images and labels 🖼️

💜 AUTHOR 💜

this manual page was written by the Debian Hyprland maintainers <team+hyprland@tracker.debian.org>, based on the upstream documentation at https://wiki.hyprland.org/Hypr-Ecosystem/hyprlock/ . thank you for your service 🫡

and that's the whole page, bestie 🎀 brought to you by Hyprlock, living in section HYPRLOCK(1), part of the User Commands manual. go lock that screen. 💖✨

📦 where this page comes from