bluepython508/riverguile
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add manpage

Browse Source
This commit is contained in:
Leon Henrik Plickat
2023-11-25 16:33:19 +01:00
parent e55ca945a0
commit 60a0986a0b
2 changed files with 68 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -13,11 +13,12 @@ paths for it in the given order:
* `/etc/riverguile/layout.scm`
This script must contain the definition of a function
`(layout-demand-handler view-count usable-width usable-height)` and may contain
any other code the user desires. The function must return a list containing
exactly as many lists as `view-count`. Each of those sublists must contains
exactly four numerical values for `x` and `y` position of the windows as well as
their width and height. Window positions and dimensions get applied to rivers
`(layout-demand-handler view-count usable-width usable-height)` and
may contain any other code the user desires. The function must return
a list containing exactly as many lists as `view-count`. 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.
Example of valid output:

62
riverguile.1 Normal file
View File

@@ -0,0 +1,62 @@
.TH LSWT 1 2021-11-26 "git.sr.ht/~leon_plickat/lswt" "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