swaylock-plugin(1)

📦
version 1.8.7 · 2 versions
, in nixpkgs unstable

💅 swaylock-plugin(1) — your Wayland screen locker bestie 💅

okay so gather round, because this is the manual for swaylock-plugin(1), and it is lowkey iconic. It locks your Wayland session, and it has opinions about backgrounds. Let’s go. 🫶

🌸 NAME 🌸

swaylock-plugin — screen locker for Wayland. That’s the whole gig, bestie. It locks your Wayland session. Periodt. 💅

✨ SYNOPSIS ✨

swaylock-plugin [options...]

Locks your Wayland session. That’s it, that’s the job. 🎀

🎀 OPTIONS 🎀

  • --command <cmd> — tells it which program draws the background. That program has to promptly provide a full-size background layer surface for each Wayland output. It gets a Wayland connection through the WAYLAND_SOCKET environment variable, and it will be restarted if it closes that connection. no cap, that’s the deal. 💖
  • --command-each <cmd> — same energy as --command, except the program is executed once for each output. Each instance only sees a single output, and that’s the one it should provide a surface for. Each instance also gets, through the environment variables SWAYLOCK_PLUGIN_OUTPUT_NAME and SWAYLOCK_PLUGIN_OUTPUT_DESC, the values of the compositor’s wl_output::name and wl_output::description for that instance’s output. iykyk. 🦋
  • -C, --config <path> — the config file to use. By default, these paths are checked: $HOME/.swaylock/config, $XDG_CONFIG_HOME/swaylock/config, and SYSCONFDIR/swaylock/config. All flags aside from this one are valid options in the configuration file using the format long-option=value. For options such as ignore-empty-password, just supply the long-option. All leading dashes should be omitted, and the equals sign is required for flags that take an argument. For example:
image=/usr/share/backgrounds/sway/Sway_Wallpaper_Blue_768x1024.png
scaling=center
show-failed-attempts
ring-color=#ff00ff
  • -d, --debug — enable debugging output. 🐛
  • -e, --ignore-empty-password — when an empty password is provided, do not validate it. 🙈
  • -F, --show-failed-attempts — show current count of failed authentication attempts. 💀
  • -f, --daemonize — detach from the controlling terminal after locking.
Note: this is the default behavior of i3lock. 👀
  • --grace <time> — set the duration after program start in which one can unlock the screen with just a keypress or by moving the mouse far enough (configurable with --pointer-hysteresis). The “grace period” automatically ends when the system is about to sleep or when the signal SIGUSR2 is received. By default there is no grace period. 🕰️
  • --pointer-hysteresis <distance> — specifies the minimum distance the mouse must move in a one-second period to unlock the screen during the grace period. Units are in logical pixels, and setting --pointer-hysteresis inf prevents unlocking by mouse entirely. The default value is 10. 🖱️
  • -R, --ready-fd <fd> — file descriptor to send readiness notifications to. When the session has been locked, a single newline is written to the FD. At this point, the compositor guarantees that no security sensitive content is visible on-screen. security girlie behavior fr fr. 🔒
  • -h, --help — show help message and quit. 🫶
  • -v, --version — show the version number and quit. ⭐

🌈 APPEARANCE 🌈

  • -u, --no-unlock-indicator — disable the unlock indicator. bye-bye little circle. 💅
  • -i, --image [[<output>]:]<path> — display the given image, optionally only on the given output. Use -c to set a background color. If the path potentially contains a ':', prefix it with another ':' to prevent interpreting part of it as <output>. 🎀
  • -k, --show-keyboard-layout — display the current xkb layout while typing. 🌸
  • -K, --hide-keyboard-layout — force hiding the current xkb layout while typing, even if more than one layout is configured or the show-keyboard-layout option is set. 🙈
  • -L, --disable-caps-lock-text — disable the Caps Lock text. 🔠
  • -l, --indicator-caps-lock — show the current Caps Lock state also on the indicator. 👑
  • -s, --scaling — image scaling mode: stretch, fill, fit, center, tile, solid_color. Use solid_color to display only the background color, even if a background image is specified. ✨
  • -t, --tiling — same as --scaling=tile. 🧩
  • -c, --color <rrggbb[aa]> — turn the screen into the given color instead of light gray. If -i is used, this sets the background of the image to the given color. Defaults to light gray (A3A3A3). 🎨
  • --bs-hl-color <rrggbb[aa]> — sets the color of backspace highlight segments. ⌫
  • --caps-lock-bs-hl-color <rrggbb[aa]> — sets the color of backspace highlight segments when Caps Lock is active. 💥
  • --caps-lock-key-hl-color <rrggbb[aa]> — sets the color of the key press highlight segments when Caps Lock is active. 🔥
  • --font <font> — sets the font of the text. 🖋️
  • --font-size <size> — sets a fixed font size for the indicator text. 🔢
  • --indicator-idle-visible — sets the indicator to show even if idle. 👀
  • --indicator-radius <radius> — sets the indicator radius. The default value is 50. ⭕
  • --indicator-thickness <thickness> — sets the indicator thickness. The default value is 10. 🍩
  • --indicator-x-position <x> — sets the horizontal position of the indicator. ↔️
  • --indicator-y-position <y> — sets the vertical position of the indicator. ↕️
  • --inside-color <rrggbb[aa]> — sets the color of the inside of the indicator. 💖
  • --inside-clear-color <rrggbb[aa]> — sets the color of the inside of the indicator when cleared. 🧼
  • --inside-caps-lock-color <rrggbb[aa]> — sets the color of the inside of the indicator when Caps Lock is active. 🔠
  • --inside-ver-color <rrggbb[aa]> — sets the color of the inside of the indicator when verifying. 🔍
  • --inside-wrong-color <rrggbb[aa]> — sets the color of the inside of the indicator when invalid. ❌
  • --key-hl-color <rrggbb[aa]> — sets the color of the key press highlight segments. ⌨️
  • --layout-bg-color <rrggbb[aa]> — sets the background color of the box containing the layout text. 🗂️
  • --layout-border-color <rrggbb[aa]> — sets the color of the border of the box containing the layout text. 🖼️
  • --layout-text-color <rrggbb[aa]> — sets the color of the layout text. 🔤
  • --line-color <rrggbb[aa]> — sets the color of the line between the inside and ring. ➰
  • --line-clear-color <rrggbb[aa]> — sets the color of the line between the inside and ring when cleared. 🧽
  • --line-caps-lock-color <rrggbb[aa]> — sets the color of the line between the inside and ring when Caps Lock is active. 🔐
  • --line-ver-color <rrggbb[aa]> — sets the color of the line between the inside and ring when verifying. 🔎
  • --line-wrong-color <rrggbb[aa]> — sets the color of the line between the inside and ring when invalid. 🚫
  • -n, --line-uses-inside — use the inside color for the line between the inside and ring. 🎀
  • -r, --line-uses-ring — use the ring color for the line between the inside and ring. 💍
  • --ring-color <rrggbb[aa]> — sets the color of the ring of the indicator when typing or idle. ⭕
  • --ring-clear-color <rrggbb[aa]> — sets the color of the ring of the indicator when cleared. 🧼
  • --ring-caps-lock-color <rrggbb[aa]> — sets the color of the ring of the indicator when Caps Lock is active. 🔠
  • --ring-ver-color <rrggbb[aa]> — sets the color of the ring of the indicator when verifying. 🔍
  • --ring-wrong-color <rrggbb[aa]> — sets the color of the ring of the indicator when invalid. ❌
  • --separator-color <rrggbb[aa]> — sets the color of the lines that separate highlight segments. ✂️
  • --text-color <rrggbb[aa]> — sets the color of the text. 💬
  • --text-clear-color <rrggbb[aa]> — sets the color of the text when cleared. 🧽
  • --text-caps-lock-color <rrggbb[aa]> — sets the color of the text when Caps Lock is active. 🔠
  • --text-ver-color <rrggbb[aa]> — sets the color of the text when verifying. 🔎
  • --text-wrong-color <rrggbb[aa]> — sets the color of the text when invalid. 🚫

🦋 SIGNALS 🦋

  • SIGUSR1 — unlock the screen and exit. bye bestie 👋
  • SIGUSR2 — if a grace period is used, end it immediately and require authentication to unlock. no more freebies. 🔐

👑 AUTHORS 👑

Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open source contributors. For more information about swaylock development, see https://github.com/swaywm/swaylock. 💖

💖 cute sign-off: this has been swaylock-plugin(1) from the General Commands Manual, dated 1980-01-01. stay locked and slay, bestie ✨💅
📦 where this page comes from