63 lines
1.5 KiB
Groff
63 lines
1.5 KiB
Groff
.TH RIVERGUILE 1 2023-11-25 "git.sr.ht/~leon_plickat/riverguile" "General Commands Manual"
|
|
.
|
|
.SH NAME
|
|
.P
|
|
riverguile \- scheme powered layout generator for river
|
|
.
|
|
.
|
|
.SH SYNOPSIS
|
|
.SY riverguile
|
|
.YS
|
|
.
|
|
.
|
|
.SH DESCRIPTION
|
|
.P
|
|
Layout generator for the
|
|
.BR river (1)
|
|
Wayland server which allows users to define layouts using guile scheme functions.
|
|
.
|
|
.P
|
|
The layout namespace is `riverguile`.
|
|
.
|
|
.P
|
|
Uppon launch, riverguile tries to eval a scheme script and checks the following
|
|
paths for it in the given order:
|
|
.IP \(bu 2
|
|
\fBlayout.scm\fR
|
|
.IP \(bu 2
|
|
\fB$XDG_CONFIG_HOME/river/layout.scm\fR
|
|
.IP \(bu 2
|
|
\fB$HOME/.config/river/layout.scm\fR
|
|
.IP \(bu 2
|
|
\fB/etc/riverguile/layout.scm\fR
|
|
.
|
|
.P
|
|
This script must contain the definition of a function
|
|
\fB(layout-demand-handler view-count usable-width usable-height)\fR and may
|
|
contain any other code the user desires.
|
|
The function must return a list containing exactly as many lists as \fBview-count\fR.
|
|
Each of those sublists must contains exactly four numerical values, which are
|
|
the x and y coordinates of the window as well as its width and height.
|
|
Window positions and dimensions get applied to rivers window list top to bottom.
|
|
.
|
|
.P
|
|
Note that the numerical values do not need to be exact, riverguile takes care
|
|
of rounding and casting for you.
|
|
.
|
|
.P
|
|
If you send riverguile a layout-command, it will try to eval it as scheme code.
|
|
.
|
|
.
|
|
.SH SEE ALSO
|
|
.BR river (1),
|
|
.BR riverctl (1),
|
|
.BR rivertile (1),
|
|
.BR guile (1)
|
|
.
|
|
.
|
|
.SH AUTHOR
|
|
.P
|
|
.MT leonhenrik.plickat@stud.uni-goettingen.de
|
|
Leon Henrik Plickat
|
|
.ME
|