greetd-mini-wl-greeter(1)

✨ NAME ✨

greetd-mini-wl-greeter — An extremely simple raw Wayland greeter for greetd. This is the greetd-mini-wl-greeter(1) page from the General Commands Manual 💖.

🌸 SYNOPSIS 🌸

greetd-mini-wl-greeter -u user -c command [-bBCeEfFhHnoOrRw]

💅 DESCRIPTION 💅

greetd-mini-wl-greeter is a raw Wayland greeter for greetd, designed for a single user. It requires a Wayland compositor to run, such as cage(1) or sway(1). That's the whole deal, bestie — greeter business and nothing extra ✨.

🎀 OPTIONS 🎀

Color memo first, iykyk: all options which take a color expect a 3- or 6-digit hex code, e.g. F9A733 🌈.

• -u, --user <username> — the user to login as.
• -c, --command <command> — the command to run on login.
• -b, --background-image <image> — an image to use as the background. Currently only PNG images are supported.
• -B, --background-color <color> — color of the background in the absence of an image.
• -o, --outline-width <value> — width of the outlines around the border, in pixels.
• -O, --outline-color <color> — color of the outlines around the border.
• -r, --border-width <value> — width of the border in pixels.
• -R, --border-color <color> — color of the border.
• -e, --entry-padding <value> — padding around the password text in pixels.
• -E, --entry-color <color> — color of the password entry box.
• -f, --font-name <name> — font to use for the password entry.
• -F, --font-size <value> — point size of the password text.
• -T, --text-color <value> — color of the password text.
• -C, --password-character <character> — character to use to hide the password. Defaults to full-stop.
• -n, --width-characters <value> — make the password entry box big enough to fit this many characters.
• -w, --wide-layout — by default, the password entry box will be shrunk vertically to exactly fit the specified password character. Use this option if you'd rather that it got laid out like normal text, i.e. the box remains one full character tall.
• -H, --hide-cursor — hide the cursor.
• -h, --help — print help and exit.

🦋 EXAMPLES 🦋

greetd-mini-wl-greeter aims to be as fast and simple as possible by default. If none of the -f, -C or -w options are given, a simple circle will be used for the password character, avoiding the need to use Pango, thus lowering startup time. This is only likely noticeable on very slow machines however. 🐢

When using sway as the compositor for greetd-mini-greeter, something like the following sway config lines produce a nice look:

# Remove any window borders
default_border none
hide_edge_borders both

# Add a background image, to avoid a flicker of default background color
output * background /path/to/image fill

# Use the same background image for the greeter
exec greetd-mini-wl-greeter -u username -c command -b /path/to/image

Fun can be had with the -C option, as it should support any character from your locale, which is probably a UTF-8 one. For example, the Unicode "Combining Dot Below" character ( ̣ ) produces a nice effect. 🎀

👑 AUTHORS 👑

The author is Philip Jones — <philj56@gmail.com> 💖.

🌈 SEE ALSO 🌈

greetd(1) — go peek at that one too 👀.

---

That's the whole greetd-mini-wl-greeter(1) manual, dated 1980-01-01 — slay and stay hydrated 🎀✨