gtklock(1)

🦋 gtklock(1) — General Commands Manual, group-chat edition 🦋

💅 NAME 💅

okay so bestie, gtklock is literally the GTK-based lockscreen for Wayland. that's the whole vibe. 💅

---

✨ SYNOPSIS ✨

gtklock [options...]

---

🎀 OPTIONS 🎀

here's the command-line menu, no cap:

• -h, --help — show help options.
• --help-config — show options available in the config. see CONFIGURATION.
• -d, --daemonize — detach from controlling terminal.
• -c, --config <path> — specify the config file to use. by default, these paths are checked in this order: $XDG_CONFIG_HOME/gtklock/config.ini and gtklock/config.ini under each directory in $XDG_CONFIG_DIRS.
• -p, --preview — enable preview mode where any password can unlock.

yes bestie, preview mode is literally "any password can unlock" — that's what the page says, so use it with intention. 💀

---

🌸 CONFIGURATION 🌸

Configuration is stored in glib key file format. Options are specified as name=value and can be used from the command-line as --name=value. All options should be under the main group.

All available options are:

• -g, --gtk-theme <string> — set the GTK theme.
• -s, --style <path> — load CSS style file.
• -x, --layout <path> — load XML layout file.
• -m, --modules <name> — load gtklock modules. module name can be an absolute path, relative path (starting with ./ or ../) or name in system directory (such as example-module.so for /usr/lib/gtklock/example-module.so). the .so suffix can be omitted.
• -b, --background <path> — load background. specified background can be overwritten by CSS.
• -t, --time-format <string> — set time format. see date(1).
• -d, --date-format <string> — set date format. see date(1).
• -f, --follow-focus — follow focus between monitors. may not work for all compositors, recommended for hyprland.
• -H, --idle-hide — hide input form when idle.
• -T, --idle-timeout <int> — idle timeout in seconds.
• -S, --start-hidden — start with input form hidden.
• -L, --lock-command — command to execute after locking. command is executed asynchronously.
• -U, --unlock-command — command to execute after unlocking. command is executed asynchronously.
• -I, --idle-command — command to execute after idle timeout. command is executed asynchronously.
• -M, --monitor-priority <name> — set monitor focus priority. option can be specified multiple times.

---

🌈 EXAMPLE 🌈

Example config:

[main]
gtk-theme=Adwaita-dark

Example style:

window {
   background-image: url("background.png");
   background-size: cover;
   background-repeat: no-repeat;
   background-position: center;
   background-color: black;
}

---

🔥 SIGNALS 🔥

• SIGUSR1 — unlock the screen and exit.

---

👑 AUTHORS 👑

Maintained by Jovan Lanik jox969@gmail.com, who is assisted by other contributors. for more information about gtklock development, see https://github.com/jovanlanik/gtklock.

---

and that's the page, bestie 💖 — this was gtklock(1), dated 2026-10-28. mwah 💋 stay cute and stay locked 🫶