.\" Generated by scdoc 1.11.0
.\" 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" "5" "2020-08-09"
.P
.SH NAME
.P
wlogout - layout file and options
.P
.SH LAYOUT
.P
wlogout's buttons can consist of upto six values
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
label 
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
action
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
text
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
keybind
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
height *
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
width * 
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
circular *

.RE
.P
* Optional values
.P
Label is the css selector by which the buttons may be referred to in a \fBstyle.css\fR file, action is the shell command to be executed when the button is clicked, text is the description displayed on the button, keybind is the key mapped to the button (note escape is reserved for exiting the application), height and width are values between 0.0 and 1.0 that control the location of where \fBtext\fR is displayed the default width 0.5, height 0.9, and circular is a boolean value that makes a button round. 
.P
.SH FILE
.P
The buttons values are specified in a JSON formatted file, wherein the values are used as keys and one button corresponds to one JSON object for example:
.nf
.RS 4
{
    "label" : "foo",
    "action" : "echo 'hello world'",
    "text" : "bar",
    "keybind" : "f",
    "height" : 1, 
    "width" : 1,
    "circular" : true
}
.fi
.RE
Would create a round button that has a css label of \fBfoo\fR, prints "hello world" upon being clicked, displays "bar" on the button, be bound to the key 'f', and "bar" would be shown at the bottom right corner. To create multiple buttons simply create another JSON object.
.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(1)