Scroll to navigation

HYPRLOCK(1) User Commands HYPRLOCK(1)

NAME

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

SYNOPSIS

hyprlock [options]

DESCRIPTION

hyprlock is a simple, fast, multi-threaded, and GPU-accelerated screen lock for the Hyprland compositor. It integrates seamlessly with Hyprland and supports customizable animations, input fields, widgets, and PAM authentication.

By default, hyprlock does not generate a configuration file. Without a configuration, the screen will be locked (black background) but no UI elements will be rendered. You can still unlock your session by typing your password followed by Enter.

For a usable lock screen, you must provide a configuration file.

OPTIONS

Enable verbose logging for debugging or detailed output.

Disable all non-essential logging.

Specify the configuration file to use. Overrides both the user and system defaults.

Specify the Wayland display to connect to.

Set a grace period (in seconds) before reauthentication is required.

Do not wait for resources before drawing the background (same as general:immediate_render in the config).

Disable the fade-in animation when the lock screen appears.

Show version information and exit.

Show help and exit.

CONFIGURATION

Hyprlock reads its configuration from:

~/.config/hypr/hyprlock.conf
Per-user configuration file.
/usr/share/hypr/hyprlock.conf
Example configuration (optional, may be installed by the package).

If no configuration is found, Hyprlock will still lock the session but display only a black background. To customize appearance and behavior, copy the example config from /usr/share/hypr/hyprlock.conf to your user config directory and edit it.

The configuration defines general options, authentication behavior, animations, and widgets (labels, input fields, backgrounds, images, etc.).

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

Unlocks Hyprlock (can be used from another TTY).
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/ .

Hyprlock 0.9.2