waylogout(1)
waylogout - Graphical logout/suspend/poweroff/etc utility for Wayland
waylogout [options...]
Provides you with graphical set of options to logout/suspend/poweroff/etc in your Wayland session.
-C, --config The config file to use. By default, the following paths are checked: $HOME/.waylogout/config, $XDG_CONFIG_HOME/waylogout/config, and SYSCONFDIR/waylogout/config. All flags aside from this one are valid options 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 Fade in the logout screen.
-h, --help Show help message and quit.
-v, --version Show the version number and quit.
--scroll-sensitivity How fast selected action will change when scrolling with mouse/touch. Lower is faster; default is 8.
--instant-run Instantly run actions on key press, without confirmation with enter key.
--poweroff-command Command to run when the poweroff action is activated.
--reboot-command Command to run when the reboot action is activated.
--suspend-command Command to run when the suspend action is activated
--hibernate-command Command to run when the hibernate action is activated.
--logout-command Command to run when the logout action is activated.
--reload-command Command to run when the reload session config action is activated.
--lock-command Command to run when the lock action is activated.
--switch-user-command Command to run when the switch user action is activated.
--default-action Action to pre-select on start-up. Must be one of poweroff, reboot, suspend, hibernate, logout, reload, lock, or switch-user.
Action indicators will only appear for actions where a command has been specified, and will be displayed in the order they are configured (on the command line or in the config file).
--poweroff-label Label to display in the poweroff action indicator. Default: "power off"
--poweroff-symbol Symbol character to display in the poweroff action indicator. Default:
--reboot-label Label to display in the reboot action indicator. Default: "reboot"
--reboot-symbol Symbol character to display in the reboot action indicator. Default:
--suspend-label Label to display in the suspend action indicator. Default: "sleep"
--suspend-symbol Symbol character to display in the suspend action indicator. Default:
--hibernate-label Label to display in the hibernate action indicator. Default: "hibernate"
--hibernate-symbol Symbol character to display in the hibernate action indicator. Default:
--logout-label Label to display in the logout action indicator. Default: "logout"
--logout-symbol Symbol character to display in the logout action indicator. Default:
--reload-label Label to display in the reload session config action indicator. Default: "reload wm"
--reload-symbol Symbol character to display in the reload session config action indicator. Default:
--lock-label Label to display in the lock action indicator. Default: "lock"
--lock-symbol Symbol character to display in the lock action indicator. Default:
--switch-user-label Label to display in the switch user action indicator. Default: "switch user"
--switch-user-symbol Symbol character to display in the switch user action indicator. Default:
--cancel-label Label to display in the cancel action indicator. Default: "switch user"
--cancel-symbol Symbol character to display in the cancel action indicator. Default:
--hide-cancel Hide the cancel action.
-i, --image [[]:] 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 .
-l, --labels Always show action labels.
-R, --rows Number of rows of action indicators to display. Default: 1.
--selection-label Show action label for 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 Sets the font of the action label text.
--fa-font Sets the name of the Font Awesome font. Default is "Font Awesome 6 Free".
--label-font-size Sets a fixed font size for the action label text.
--symbol-font-size Sets a fixed font size for the action symbols.
--indicator-radius Sets the action indicator radius. The default value is 50.
--indicator-thickness Sets the action indicator thickness. The default value is 10.
--indicator-x-position Sets the horizontal centre position of the action indicator array.
--indicator-y-position Sets the vertical centre position of the action indicator array.
--indicator-separation 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 x Blur displayed images.
--effect-pixelate Pixelate displayed images.
--effect-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 : Apply a vignette effect to images. Base and factor should be numbers between 0 and 1.
--effect-compose ;;; Overlay another image to your logout screen. The position, size and gravity part is optional.
--effect-custom 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).
Shortcut keys can be customized --- see SHORTCUT KEY OPTIONS below.
Here are the defaults.
Escape 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).
u Select the switch-user action (if configured).
x Select the logout action (if configured).
Keyboard shortcuts can be customized with the following options.
Recognized modifiers are Ctrl and Alt. To indicate a shifted key, just use the upper case version of the letter. For example, a keycombo option of "Ctrl+k" means typing the K key while holding down Ctrl, while "Ctrl+K" means tying the K key while holding down both Ctrl and Shift.
The two modifiers can be combined: for example, "Ctrl+Alt+k".
For special keys you must use their keysym names --- see xkbcommon-keysyms.h and use the last part of a defined macro name as the key name.
--poweroff-shortcut Keyboard shortcut key (with optional modifiers) to select the poweroff action.
--reboot-shortcut Keyboard shortcut key (with optional modifiers) to select the reboot action.
--suspend-shortcut Keyboard shortcut key (with optional modifiers) to select the suspend action.
--hibernate-shortcut Keyboard shortcut key (with optional modifiers) to select the hibernate action.
--logout-shortcut Keyboard shortcut key (with optional modifiers) to select the logout action.
--reload-shortcut Keyboard shortcut key (with optional modifiers) to select the reload action.
--lock-shortcut Keyboard shortcut key (with optional modifiers) to select the lock action.
--switch-user-shortcut Keyboard shortcut key (with optional modifiers) to select the switch user action.
--cancel-shortcut Keyboard shortcut key (with optional modifiers) to select the cancel action.
--reverse-arrows Reverse the direction of the up/down arrows.
You can add your own custom actions using the options below. These options can be specified multiple times, but in that case should be grouped together, with each grouping containing at least a custom-command.
--custom-command Command to run for the custom action.
--custom-label Label to display for the custom action.
--custom-symbol Symbol character to display for the custom action.
--custom-shortcut Keyboard shortcut key (with optional modifiers) to select the custom action.
Written by Jeremy Sylvestre, based on the codebase of Jakub Jirutka's fork of swaylock-effects by Martin Dørum, which is in turn forked from swaylock by Drew DeVault.
For more information about waylogout development, see https://github.com/loserMcloser/waylogout.