XTRLOCK(1)

👑 XTRLOCK(1) — the lock-your-screen-bestie manual 💅

okay so this is xtrlock, from the General Commands Manual, section 1 (that's the "general commands" girlies, iykyk). It locks your X display until you type your password, and it leaves all your windows visible. Iconic behaviour honestly.

---

✨ NAME ✨

xtrlock — lock X display until password supplied, leaving windows visible 🎀

---

🌸 SYNOPSIS 🌸

xtrlock [-b] [-f] [-F]

---

💖 DESCRIPTION 💖

So xtrlock locks the X server until you, the user, type your password at the keyboard. That's it. That's the whole vibe.

While xtrlock is running, the mouse and keyboard are grabbed, and the mouse cursor literally becomes a padlock 🔒. Output displayed by X programs, and windows put up by new X clients, continue to be visible, and any new output is displayed normally. So like, your screen doesn't go away, it's just that nobody can touch anything. Main character locked in her room energy.

The mouse and keyboard are returned when you type your password, followed by Enter or Newline. If an incorrect password is entered, the bell is sounded 🔔 (not me getting caught lacking). Pressing Backspace or Delete erases one character of a password partially typed; pressing Escape or Clear clears anything that has been entered. Very "undo my typo" of it.

If too many attempts are made in too short a time, further keystrokes generate bells and are otherwise ignored until a timeout has expired. bestie you are in timeout, go think about what you did 🙈

The X server screen saver continues to operate normally; if it comes into operation the display may be restored by the usual means of touching a key (Shift, for example) or the mouse.

---

⚠️ WARNING ⚠️

Due to limitations in the X11 protocol, xtrlock cannot intercept all keyboard and mouse events if run under a Wayland-based desktop environment. In this situation, applications that use the "legacy" X11 protocol will be locked whilst ones supporting Wayland can still be interacted with, even when xtrlock is in operation. Some keyboard shortcuts may also continue to function whilst the display is locked.

A warning is printed if such an environment is detected. For an alternative solution, please see swaylock(1) or similar. no cap, check your environment first 💀

---

✨ OPTIONS ✨

• -b — blank the screen as well as displaying the padlock. double the drama, zero the visual info 🌑
• -f — fork after locking is complete, and return success from the parent process.
• -F — force lock, e.g. if there is no password set. she does not care, she locks anyway 💅

---

🎀 X RESOURCES, CONFIGURATION 🎀

None. literally none. nothing to configure. the config is vibes only ✨

---

💀 BUGS 💀

• Additional input devices other than the keyboard and mouse are not disabled. (so your extra gizmos are out here living their truth 🙈)
• The timeouts, bitmaps and mouse cursor colour cannot be modified. she said take it or leave it.

---

🦋 SEE ALSO 🦋

X(1), Xlib Documentation.

---

🌈 AUTHOR 🌈

Ian Jackson <ian@chiark.greenend.org.uk> — an absolute legend, we stan 👑

---

💜 COPYRIGHT 💜

Copyright (C) 1993, 1994 by Ian Jackson.

Permission to use, copy, modify and distribute this software and its documentation is granted under the terms of the GNU General Public Licence, version 2 or later, as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

---

and that's the whole page, bestie 🫶 this one signs off as XTRLOCK(1) — straight out of the General Commands Manual, no version number, no date, just the classic footer flex. periodt. 💅✨