.\" Generated by scdoc 1.11.2
.\" 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 "wlogout" "1" "2022-08-07"
.P
.SH NAME
.P
wlogout - A Wayland logout menu
.P
.SH SYNOPSIS
.P
\fBwlogout\fR [options] [command]
.P
.SH OPTIONS
.P
\fB-h, --help\fR
.RS 4
Show help message and stop
.P
.RE
\fB-l, --layout\fR <layout>
.RS 4
Specify a custom layout file
.P
.RE
\fB-v, --version\fR
.RS 4
Show version number and stop
.P
.RE
\fB-C, -css\fR <css>
.RS 4
Specify a custom css file
.P
.RE
\fB-b, --buttons-per-row\fR <num>
.RS 4
Set the number of buttons per row
.P
.RE
\fB-c, --column-spacing\fR <space>
.RS 4
Set space between buttons columns
.P
.RE
\fB-r, --row-spacing\fR <space>
.RS 4
Set space between buttons rows
.P
.RE
\fB-m, --margin\fR <padding>
.RS 4
Set margin on all sides
.P
.RE
\fB-L, --margin-left\fR <padding>
.RS 4
Set margin for left of buttons
.P
.RE
\fB-R, --margin-right\fR <padding>
.RS 4
Set margin for right of buttons
.P
.RE
\fB-T, --margin-right\fR <padding>
.RS 4
Set margin for top of buttons
.P
.RE
\fB-B, --margin-right\fR <padding>
.RS 4
Set margin for bottom of buttons
.P
.RE
\fB-p, --protocol\fR <protocol>
.RS 4
Takes either layer-shell or xdg.\& 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.\&
.P
.RE
.SH DESCRIPTION
.P
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 depracated technology such as python 2; while maintaining a small code footprint.\&
.P
You can run wlogout from any Wayland environment and it should just work.\&
.P
.SH CONFIGURATION
.P
Wlogout searches for a layout and style.\&css file in the following locations, in this order:
.P
.RS 4
.ie n \{\
\h'-04'1.\h'+03'\c
.\}
.el \{\
.IP 1. 4
.\}
$XDG_CONFIG_HOME/wlogout/
.RE
.RS 4
.ie n \{\
\h'-04'2.\h'+03'\c
.\}
.el \{\
.IP 2. 4
.\}
/etc/wlogout/
.RE
.RS 4
.ie n \{\
\h'-04'3.\h'+03'\c
.\}
.el \{\
.IP 3. 4
.\}
/usr/local/etc/wlogout

.RE
.P
If unset, $XDG_CONFIG_HOME defaults to \fB~/.\&config/\fR.\&
.P
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/wlogout/\fR into  \fB~/.\&config\fR and make any changes there.\&
.P
.SH AUTHORS
.P
Maintained by Haden Collins <collinshaden@gmail.\&com> for more information about wlogout, see <https://github.\&com/ArtsyMacaw/wlogout>.\&
.P
.SH SEE ALSO
.P
\fBwlogout\fR(5)