waylogout(1)

📦
version 2023-06 · 2 versions
, in nixos 26.05

🦋 waylogout(1) · General Commands Manual 🦋

🌸 NAME 🌸

waylogout — Graphical logout/suspend/poweroff/etc utility for Wayland

✨ SYNOPSIS ✨

waylogout [options...]

Provides you with graphical set of options to
logout/suspend/poweroff/etc in your Wayland session.

💅 OPTIONS 💅

  • -C, --config <path> — the config file to use. By default, these paths get checked: $HOME/.waylogout/config, $XDG_CONFIG_HOME/waylogout/config, and SYSCONFDIR/waylogout/config. Every flag aside from this one is a valid option in the configuration file using the format long-option=value. For options such as logout-command, just supply the long-option. All leading dashes should be omitted, and the equals sign is required for flags that take an argument. 🫶
  • -d, --debug — enable debugging output.
  • --fade-in <seconds> — fade in the logout screen. ✨
  • -h, --help — show help message and quit.
  • -v, --version — show the version number and quit.
  • --scroll-sensitivity <amount> — how fast the selected action will change when scrolling with mouse/touch. Lower is faster; default is 8.
  • --poweroff-command <command> — command to run when the poweroff action is activated.
  • --reboot-command <command> — command to run when the reboot action is activated.
  • --suspend-command <command> — command to run when the suspend action is activated.
  • --hibernate-command <command> — command to run when the hibernate action is activated.
  • --logout-command <command> — command to run when the logout action is activated.
  • --reload-command <command> — command to run when the reload session config action is activated.
  • --lock-command <command> — command to run when the lock action is activated.
  • --switch-user-command <command> — command to run when the switch-user action is activated.
  • --default-action <action-name> — action to pre-select on start-up. Must be one of poweroff, reboot, suspend, hibernate, logout, reload, lock, or switch-user.

🎀 APPEARANCE 🎀

Action indicators will only appear for actions where a command has been specified, and will be displayed in the order their commands are specified. That’s the whole vibe check for indicator order, bestie.

  • --hide-cancel — hide the cancel action.
  • -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>.
  • -l, --labels — always show action labels.
  • --selection-label — show the action label for the selected action, even when --labels is not specified.
  • -S, --screenshots — display a screenshot.
  • -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 white. If -i is used, this sets the background of the image to the given color. Defaults to white (FFFFFF).
  • --font <font> — sets the font of the action label text.
  • --fa-font <font> — sets the name of the Font Awesome font. Default is Font Awesome 6 Free.
  • --label-font-size <size> — sets a fixed font size for the action label text.
  • --symbol-font-size <size> — sets a fixed font size for the action symbols.
  • --indicator-radius <radius> — sets the action indicator radius. The default value is 50.
  • --indicator-thickness <thickness> — sets the action indicator thickness. The default value is 10.
  • --indicator-x-position <x> — sets the horizontal centre position of the action indicator array.
  • --indicator-y-position <y> — sets the vertical centre position of the action indicator array.
  • --indicator-separation <sep> — sets a fixed amount of space separating action indicators.
  • --inside-color <rrggbb[aa]> — sets the color of the inside of the indicator.
  • --inside-selection-color <rrggbb[aa]> — sets the color of the inside of the selected action indicator.
  • --line-color <rrggbb[aa]> — sets the color of the line between the inside and ring.
  • --line-selection-color <rrggbb[aa]> — sets the color of the line between the inside and ring in the selected action indicator.
  • -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 action indicators.
  • --ring-selection-color <rrggbb[aa]> — sets the color of the ring of the selected action indicator.
  • --text-color <rrggbb[aa]> — sets the color of the text.
  • --text-selection-color <rrggbb[aa]> — sets the color of the text for the selected action indicator.
  • --effect-blur <radius>x<times> — blur displayed images.
  • --effect-pixelate <factor> — pixelate displayed images.
  • --effect-scale <scale> — scale the image by a factor. This can be used to make other effects faster if you don’t need the full resolution.
  • --effect-greyscale — make the displayed image greyscale.
  • --effect-vignette <base>:<factor> — apply a vignette effect to images. Base and factor should be numbers between 0 and 1.
  • --effect-compose <position>;<size>;<gravity>;<path> — overlay another image to your lock screen. The position, size and gravity part is optional.
  • --effect-custom <path> — load a custom effect from a shared object. The .so must export a void waylogout_effect(uint32_t *data, int width, int height, int scale) or an uint32_t waylogout_pixel(uint32_t pix, int x, int y, int width, int height).
  • --time-effects — measure the time it takes to run each effect.

You may select a particular action by navigating with the arrow keys, home/end, tab/shift-tab, the number keys, or the mouse scroll wheel, or by hovering the mouse pointer.

To activate the configured command for the selected action, press enter, or click the mouse (while hovering), or middle-click the mouse (anywhere). Main character selection energy, honestly.

⌨️ SHORTCUT KEYS ⌨️

  • Esc — exit without running any action command.
  • c — select the reload session config action (if configured).
  • h — select the hibernate action (if configured).
  • k — select the lock action (if configured).
  • p — select the poweroff action (if configured).
  • r — select the reboot action (if configured).
  • s — select the suspend action (if configured).
  • w — select the switch-user action (if configured).
  • x — select the logout action (if configured).

🦋 SHORTCUT KEY OPTIONS 🦋

  • --reverse-arrows — reverse the direction of the up/down arrows.

👑 AUTHORS 👑

Written by Jeremy Sylvestre, based on the codebase of swaylock-effects by Martin Dørum, which is in turn forked from upstream Swaylock by Drew DeVault. 💖

For more information about waylogout development, see https://github.com/loserMcloser/waylogout.

okay bestie, that’s the whole page — source/version waylogout(1), dated 1980-01-01. stay iconic and log out responsibly 💅✨

📦 where this page comes from