wlogout(1)

📦
version 1.2.2 · 10 versions
, in ubuntu resolute, ubuntu stonking

🎀 NAME 🎀

wlogout — a Wayland logout menu, bestie. That's the whole vibe. A lil menu that pops up so you can yeet yourself out of your session ✨

🌸 SYNOPSIS 🌸

wlogout [options...]

💅 OPTIONS 💅

Ok so here's the whole menu of flags, no skips, no crumbs:

  • -h, --help — shows you the help message and then dips. That's it, that's the flag 🫶
  • -l, --layout <layout> — lets you point at your very own custom layout file, so it can look exactly how you want 💖
  • -v, --version — prints the version number and stops. Iconic.
  • -C, -css <css> — point it at a custom css file for your styling moment 🎀 (yes, that's really how it's written, we're not touching it)
  • -b, --buttons-per-row <num> — sets how many buttons go in each row. Grid control, periodt.
  • -c, --column-spacing <space> — sets the space between the button columns 🌈
  • -r, --row-spacing <space> — sets the space between the button rows 🌸
  • -m, --margin <padding> — sets the margin on all sides at once. One flag, four edges, efficiency queen 👑
  • -L, --margin-left <padding> — sets the margin for the left of the buttons
  • -R, --margin-right <padding> — sets the margin for the right of the buttons
  • -T, --margin-right <padding> — sets the margin for the top of the buttons
  • -B, --margin-right <padding> — sets the margin for the bottom of the buttons
  • -p, --protocol <protocol> — takes either layer-shell or xdg. The layer-shell option allows transparency effects; however, only a few compositors correctly support it. The xdg protocol will work on almost all compositors, but does not allow for transparency.
  • -s, --show-binds — will show the keybinds of a button by inserting the key needed to activate the button next to its label. So you literally see which key to press, no guessing 🔥
  • -P, --primary-monitor <num> — selects the monitor to display buttons on; monitors are numbered from 0 up.
  • -n, --no-span — stops wlogout from spanning across multiple monitors, and can be combined with --primary-monitor to only appear on one monitor. Single-monitor girlies, this one's for you 💜
Not me staring at -T and -B both saying --margin-right... the manpage really said that, twice, and I'm just the messenger 🫠 Copying it exactly as it's written, because that's the rule.

✨ DESCRIPTION ✨

So wlogout was created to replace oblogout with a native logout script for Wayland 💫 It also seeks to be a faster alternative that does not rely on deprecated technology such as python 2 — while maintaining a small code footprint. Lowkey obsessed with the restraint, ngl.

You can run wlogout from any Wayland environment and it should just work. Any of them. Fr fr 🌈

🦋 CONFIGURATION 🦋

Wlogout searches for a layout and style.css file in the following locations, in this order:

  1. $XDG_CONFIG_HOME/wlogout/
  2. /etc/wlogout/
  3. /usr/local/etc/wlogout

If unset, $XDG_CONFIG_HOME defaults to ~/.config/.

An error is raised when no layout file is found; However, the style.css file is optional. So the layout is the main character and the css is the supporting cast 💅

If you would like to customise either, it is recommended that you copy the defaults from /etc/wlogout/ into ~/.config and make any changes there. Don't edit the system ones, bestie — copy first, then go feral on your own copy 🎀

👑 AUTHORS 👑

Maintained by Haden Collins <collinshaden@gmail.com> — for more information about wlogout, see <https://github.com/ArtsyMacaw/wlogout>.

⭐ SEE ALSO ⭐

That's the whole page, bestie!! This one lives in the General Commands Manual section of the wlogout(1) page, dated 2026-01-29 — ily, go log out in style 💖✨🦋

📦 where this page comes from