.\" 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 "wayout" "1" "2022-11-18" "Version 0.1.1" "Version 0.1.1"
.P
.SH NAME
wayout - Output text to a wayland desktop widget
.P
.P
.SH DESCRIPTION
Wayout takes text from standard input and outputs it to a desktop-widget on Wayland desktops.\& Periodic updates are
supported (e.\&g.\& newline separated input or any other delimiter of choice).\& The desktop widget can
be shown either on top (OSD-like functionality) or below other windows.\&
.P
A Wayland compositor must implement the Layer-Shell and XDG-Output for wayout
to work.\&
.P
.SH OPTIONS
\fB-h\fR, \fB--help\fR
.RS 4
Display help message and exit.\&
.P
.RE
\fB-V\fR, \fB--version\fR
.RS 4
Display version and exit.\&
.P
.RE
\fB-v\fR, \fB--verbose\fR
.RS 4
Increase verbosity of logging.\&
.P
.RE
\fB--background-colour\fR <colour>
.RS 4
The background colour of the clock.\& The default is "#FFFFFF".\&
.P
.RE
\fB--border-colour\fR <colour>
.RS 4
The border colour of the clock.\& The default is "#000000".\&
.P
.RE
\fB--border-size\fR <size>, \fB--border-size\fR <top> <right> <bottom> <left>
.RS 4
Set the border size.\& Requires either one argument, to set all border sizes,
or four arguments, to set the border sizes individually.\& The default border
size is 0 (no border).\&
.P
.RE
\fB--corner-radius\fR <radius>, \fB--corner-radius\fR <top-left> <top-right> <bottom-right> <bottom-left>
.RS 4
The radius of the corners.\& Expects either one argument, to set the radius
of all corners, or four arguments, to set the individual corner radii.\& If
set to sufficiently high values, wlclock will be completely round.\& Set to 0
to disable corner roundness.\& The default radius is 0.\&
.P
.RE
\fB--exclusive-zone\fR <option>
.RS 4
Exclusive zone of the surface.\& Can be "true", "false" or "stationary".\& If
"true", the compositor is informed that it should not obstruct the surface
of wlclock with other surfaces.\& If "false", the compositor is informed that
it can place other surfaces over or under the surface of wlclock.\& If
"stationary", the compositor is informed that the surface of wlclock should
not be moved to accommodate other layer shell surfaces and that it can
freely place other surfaces over or under the surface of wlclock.\& The
default is "stationary".\& The exact implementation is compositor dependant;
A compositor may choose to ignore the requested exclusive zone of surfaces.\&
.P
.RE
\fB--layer\fR <layer>
.RS 4
Layer of the layer surface.\& Can be "overlay", "top", "bottom" or
"background".\& Typically, "bottom" and "background" will be underneath
regular windows, while "top" and "overlay" will be above them, however
the exact placement on the z axis depends on the implementation of the
compositor.\& The default layer is "bottom".\&
.P
.RE
\fB--margin\fR <size>, \fB--margin\fR <top> <right> <bottom> <left>
.RS 4
Set the margin.\& Requires either one argument, to set all margins, or four
arguments, to set the margins individually.\& The default margin is 0.\&
.P
.RE
\fB--namespace\fR <namespace>
.RS 4
The namespace of the layers surface.\& Some compositors may treat layer
surfaces differently based on their namespace.\& The default is "wayout".\&
.P
.RE
\fB-input\fR
.RS 4
If this flag is set, wayout will ask the compositor to send it
input events; Otherwise (the default) mouse events pass through wayout to windows
beneath it.\&
.P
.RE
\fB--output\fR <output name>
.RS 4
Name of the output on which wlclock should be displayed.\& Output names
are compositor dependant.\& If set to "all" or "*", wlclock will be displayed
on all outputs, which is the default behaviour.\&
.P
.RE
\fB--position\fR <position>
.RS 4
Set the position of the clock.\& Can be "center", "top", "right", "bottom",
"left", "top-right", "top-left", "bottom-right" and "bottom-left".\& Defaults
to "center".\&
.P
.RE
\fB--width\fR <size>
.RS 4
The width of the widget, in pixels with borders.\& The default width is 320
.P
.RE
\fB--height\fR <size>
.RS 4
The height of the widget, in pixels with borders.\& The default height is 240
.P
.RE
\fB--font\fR <font>
.RS 4
Font pattern specification (e.\&g.\& Monospace 23)
.P
.RE
\fB--no-wrap\fR
.RS 4
Disable wordwrap
.P
.RE
\fB-l\fR, \fB--feed-line\fR
.RS 4
Update the text periodically and treat each line of the input as an update
.P
.RE
\fB-p\fR, \fB--feed-par\fR
.RS 4
Update the text periodically and treat each paragraph (parts separated by an empty line) of the input as an update
.P
.RE
\fB--feed-delimiter\fR
.RS 4
Update the text periodically, use a custom delimiter.\& If the input line corresponds to the delimiter, an update is triggered.\&
.P
.RE
\fB-i\fR, \fB--interval\fR <milliseconds>
.RS 4
The update interval in milliseconds (only used with the feed options).\&
.P
.RE
.SH COLOURS
wayout can parse hex code colours and read RGBA values directly.\&
.P
The supported formats are "#RRGGBB", "#RRGGBBAA", "0xRRGGBB" and "0xRRGGBBAA"
for hex code colours and "rgb(rrr,ggg,bbb)" and "rgba(rrr,ggg,bbb,aaa)" for RGB
colours.\&
.P
.SH MARKUP
wayout supports the Pango Text Attribute Markup Language to specify colours and markup within the text itself.\&
See https://docs.\&huihoo.\&com/api/gtk/2.\&6/pango/PangoMarkupFormat.\&html
.P
.SH AUTHORS
Maarten van Gompel <proycon@anaproy.\&nl>
Leon Henrik Plickat <leonhenrik.\&plickat@stud.\&uni-goettingen.\&de> (wlclock)
.P
.P