.\" Generated by scdoc 1.11.5
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "wleave" "1" "2026\-10\-23"
.PP
.SH NAME
.PP
wleave \- A Wayland logout menu
.PP
.SH SYNOPSIS
.PP
\fBwleave\fR [options] [command]
.PP
.SH OPTIONS
.PP
\fB\-h, \-\-help\fR
.RS 4
Show help message and stop
.PP
.RE
\fB\-l, \-\-layout\fR <layout>
.RS 4
Specify a custom layout file, specify \- to read the config from stdin
.PP
.RE
\fB\-\-button\-layout\fR "grid"
.RS 4
Specify the way buttons should be laid out, "grid" being the default.\& Currently, only "grid" is supported.\&
.PP
.RE
\fB\-S, \-\-service\fR
.RS 4
Run the application as a service, with all instances of wleave opening this one.\& Allows faster startup at the cost of running in the background.\&
.PP
.RE
\fB\-v, \-\-version\fR
.RS 4
Show version number and stop
.PP
.RE
\fB\-C, \-css\fR <css>
.RS 4
Specify a custom css file
.PP
.RE
\fB\-b, \-\-buttons\-per\-row\fR <num>
.RS 4
Set the number of buttons per row, or use a fraction to specify the number of rows to be used (e.\&g.\& "1/1" for all buttons in a single row, "1/5" to distribute the buttons over 5 rows)
.PP
.RE
\fB\-c, \-\-column\-spacing\fR <space>
.RS 4
Set space between buttons columns
.PP
.RE
\fB\-r, \-\-row\-spacing\fR <space>
.RS 4
Set space between buttons rows
.PP
.RE
\fB\-m, \-\-margin\fR <padding>
.RS 4
Set margin on all sides
.PP
.RE
\fB\-L, \-\-margin\-left\fR <padding>
.RS 4
Set margin for left of buttons
.PP
.RE
\fB\-R, \-\-margin\-right\fR <padding>
.RS 4
Set margin for right of buttons
.PP
.RE
\fB\-T, \-\-margin\-top\fR <padding>
.RS 4
Set margin for top of buttons
.PP
.RE
\fB\-B, \-\-margin\-bottom\fR <padding>
.RS 4
Set margin for bottom of buttons
.PP
.RE
\fB\-A, \-\-button\-aspect\-ratio\fR <ratio>
.RS 4
Set the aspect ratio of the buttons, either as a float (as a number or string) or a ratio (e.\&g.\& "5/4").\&
If unspecified, the buttons fill all available space between the margins.\&
.PP
.RE
\fB\-f, \-\-close\-on\-lost\-focus\fR
.RS 4
Closes the menu if focus is lost
.PP
.RE
\fB\-k, \-\-show\-keybinds\fR
.RS 4
Show the associated key binds for each button
.PP
.RE
\fB\-p, \-\-protocol\fR <protocol>
.RS 4
Takes layer\-shell, xdg, or none.\&
The "layer\-shell" 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.\&
The "none" option shows the window as is, without full\-screening it
.PP
.RE
\fB\-d, \-\-delay\-command\-ms\fR <number>
.RS 4
The number of milliseconds to wait after an action before the associated command is executed
.PP
.RE
\fB\-x, \-\-no\-version\-info\fR
.RS 4
Hide the version label
.PP
.RE
.SH DESCRIPTION
.PP
wleave is a Wayland\-native logout script.\& It is a modern rewrite of Wlogout and a drop\-in replacement.\&
.PP
.SH CONFIGURATION
.PP
wleave searches for a layout and style.\&css file in the following locations, in this order:
.PP
.PD 0
.IP 1. 4
$XDG_CONFIG_HOME/wleave/
.IP 2. 4
$XDG_CONFIG_HOME/wlogout/
.IP 3. 4
/etc/wleave/
.IP 4. 4
/etc/wlogout/
.IP 5. 4
/usr/local/etc/wleave
.IP 6. 4
/usr/local/etc/wlogout
.PD
.PP
If unset, $XDG_CONFIG_HOME defaults to \fB\(ti/.\&config/\fR.\&
.PP
An error is raised when no layout file is found; However, the style.\&css file is optional.\& If you would like to customise either it is recommended that you copy the defaults from \fB/etc/wleave/\fR into  \fB\(ti/.\&config\fR and make any changes there.\&
.PP
.SH AUTHORS
.PP
Based on Wlogout by Haden Collins <collinshaden@gmail.\&com>.\& For more information about wlogout, see <https://github.\&com/ArtsyMacaw/wlogout>.\&
Rewrite by Natty <natty.\&sh.\&git@gmail.\&com>, see <https://github.\&com/AMNatty/wleave>.\&
.PP
.SH SEE ALSO
.PP
\fBwleave\fR(5)